org.eclipse.jface.viewers.ColumnPixelData Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* 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.
*
* This class may be instantiated; it is not intended to be subclassed.
*
* @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 false for backwards compatibility, but
* the recommended practice is to specify true, and
* specify the desired width for the content of the column, rather
* than adding a fudge factor to the specified width.
*
* @since 1.0
*/
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 true if the column is resizable,
* and false 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
* true if the column is resizable, and
* false if size of the column is fixed
* @param addTrim
* true to allocate extra width to the column to
* account for trim taken by the column itself,
* false to use the given width exactly
* @since 1.0
*/
public ColumnPixelData(int widthInPixels, boolean resizable, boolean addTrim) {
super(resizable);
Assert.isTrue(widthInPixels >= 0);
this.width = widthInPixels;
this.addTrim = addTrim;
}
}