org.controlsfx.control.spreadsheet

Class SpreadsheetColumn

java.lang.Object

org.controlsfx.control.spreadsheet.SpreadsheetColumn

public class SpreadsheetColumn
extends Object

A SpreadsheetView is made up of a number of SpreadsheetColumn instances.

Configuration

SpreadsheetColumns are instantiated by the SpreadsheetView itself, so there is no public constructor for this class. To access the available columns, you need to call SpreadsheetView.getColumns().

SpreadsheetColumn gives you the ability to modify some aspects of the column, for example the width or resizability of the column.

You have the ability to fix this column at the left of the SpreadsheetView by calling setFixed(boolean). But you are strongly advised to check if it is possible with isColumnFixable() before calling setFixed(boolean). Take a look at the SpreadsheetView description to understand the fixing constraints.

If the column can be fixed, a dot is displayed in the header and a ContextMenu will appear if the user right-clicks on it. If not, nothing will appear and the user will not have the possibility to fix it.

Screenshot

The column A is fixed and is covering column B and partially column C. The context menu is being shown and offers the possibility to unfix the column.

See Also:

SpreadsheetView

Method Summary

Modifier and Type	Method and Description
void	fitColumn() If the column is resizable, it will compute the optimum width for all the visible cells to be visible.
double	getWidth() Return the actual width of the column.
boolean	isColumnFixable() Indicate whether this column can be fixed or not.
boolean	isFixed() Return whether this column is fixed or not.
void	setFixed(boolean fixed) Fix this column to the left if possible, although it is recommended that you call isColumnFixable() before trying to fix a column.
void	setPrefWidth(double width) Set the width of this column.
void	setResizable(boolean b) If this column can be resized by the user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isFixed

public boolean isFixed()

Return whether this column is fixed or not.

Returns:

true if this column is fixed.

setFixed

public void setFixed(boolean fixed)

Fix this column to the left if possible, although it is recommended that you call isColumnFixable() before trying to fix a column.

Parameters:

fixed -

setPrefWidth

public void setPrefWidth(double width)

Set the width of this column.

Parameters:

width -

getWidth

public double getWidth()

Return the actual width of the column.

Returns:

the actual width of the column

setResizable

public void setResizable(boolean b)

If this column can be resized by the user

Parameters:

b -

fitColumn

public void fitColumn()

If the column is resizable, it will compute the optimum width for all the visible cells to be visible.

isColumnFixable

public boolean isColumnFixable()

Indicate whether this column can be fixed or not. Call that method before calling setFixed(boolean) or adding an item to SpreadsheetView.getFixedColumns().

Returns:

true if this column is fixable.