org.eclipse.jface.viewers.ColumnPixelData.java Source code

Introduction

Here is the source code for org.eclipse.jface.viewers.ColumnPixelData.java

Source

/*******************************************************************************
 * Copyright (c) 2000, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.viewers;

import org.eclipse.core.runtime.Assert;

/**
 * Describes the width of a table column in pixels, and
 * whether the column is resizable.
 * <p>
 * This class may be instantiated; it is not intended to be subclassed.
 * </p>
 * @noextend This class is not intended to be subclassed by clients.
 */
public class ColumnPixelData extends ColumnLayoutData {

    /**
     * The column's width in pixels.
     */
    public int width;

    /**
     * Whether to allocate extra width to the column to account for
     * trim taken by the column itself.
     * The default is <code>false</code> for backwards compatibility, but
     * the recommended practice is to specify <code>true</code>, and
     * specify the desired width for the content of the column, rather
     * than adding a fudge factor to the specified width.
     *
     * @since 3.1
     */
    public boolean addTrim = false;

    /**
     * Creates a resizable column width of the given number of pixels.
     *
     * @param widthInPixels the width of column in pixels
     */
    public ColumnPixelData(int widthInPixels) {
        this(widthInPixels, true, false);
    }

    /**
     * Creates a column width of the given number of pixels.
     *
     * @param widthInPixels the width of column in pixels
     * @param resizable <code>true</code> if the column is resizable,
     *   and <code>false</code> if size of the column is fixed
     */
    public ColumnPixelData(int widthInPixels, boolean resizable) {
        this(widthInPixels, resizable, false);
    }

    /**
     * Creates a column width of the given number of pixels.
     *
     * @param widthInPixels
     *            the width of column in pixels
     * @param resizable
     *            <code>true</code> if the column is resizable, and
     *            <code>false</code> if size of the column is fixed
     * @param addTrim
     *            <code>true</code> to allocate extra width to the column to
     *            account for trim taken by the column itself,
     *            <code>false</code> to use the given width exactly
     * @since 3.1
     */
    public ColumnPixelData(int widthInPixels, boolean resizable, boolean addTrim) {
        super(resizable);
        Assert.isTrue(widthInPixels >= 0);
        this.width = widthInPixels;
        this.addTrim = addTrim;
    }
}