ControlsFX 11.2.2 · org.controlsfx.control.spreadsheet.SpreadsheetColumn

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 freeze 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 freezing constraints.

If the column can be frozen, 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 freeze it.

Screenshot

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

Screenshot of SpreadsheetColumn

Field Summary

Modifier and Type	Field and Description
private final boolean	canFix
pack-priv final TableColumn<ObservableList<SpreadsheetCell>, SpreadsheetCell>	column
private final ObjectProperty<Filter>	filterProperty
private MenuItem	fixItem
private final Integer	indexColumn
private final SpreadsheetView	spreadsheetView Private Fields * *

Access	Constructor and Description
pack-priv	SpreadsheetColumn(final TableColumn<ObservableList<SpreadsheetCell>, SpreadsheetCell> column, final SpreadsheetView spreadsheetView, final Integer indexColumn, Grid grid) Creates a new SpreadsheetColumn.

Method Summary

Modifier and Type	Method and Description
public ObjectProperty<T>	filterProperty()
public void	fitColumn() If the column is resizable, it will compute the optimum width for all the visible cells to be visible.
private ContextMenu	Returns: a context menu. getColumnContextMenu() Generate a context Menu in order to freeze/unfreeze some column It is shown when right-clicking on the column header
public Filter	getFilter()
public final double	Returns: the maximum width for this SpreadsheetColumn. getMaxWidth() Return the maximum width for this SpreadsheetColumn.
public final double	Returns: the minimum width for this SpreadsheetColumn. getMinWidth() Return the minimum width for this SpreadsheetColumn.
private String	getText()
public double	Returns: the actual width of the column getWidth() Return the actual width of the column.
private boolean	Returns: if it's freezable. initCanFix(Grid grid) Verify that you can freeze this column.
public boolean	Returns: true if this column is freezable. isColumnFixable() Indicate whether this column can be frozen or not.
public boolean	Returns: true if this column is frozen. isFixed() Return whether this column is frozen or not.
public final DoubleProperty	Returns: the Property related to the maximum width of this SpreadsheetColumn. maxWidthProperty() Return the Property related to the maximum width of this SpreadsheetColumn.
public final DoubleProperty	Returns: the Property related to the minimum width of this SpreadsheetColumn. minWidthProperty() Return the Property related to the minimum width of this SpreadsheetColumn.
public void	setFilter(Filter filter)
public void	setFixed(boolean fixed) Freeze this column to the left if possible, although it is recommended that you call `isColumnFixable()` before trying to freeze a column.
public final void	setMaxWidth(double value) Set the maximum width for this SpreadsheetColumn.
public final void	setMinWidth(double value) Set the minimum width for this SpreadsheetColumn.
public void	setPrefWidth(double width) Set the width of this column.
public void	setResizable(boolean b) If this column can be resized by the user
private void	setText(String text) Private Methods * *
public final ReadOnlyDoubleProperty	Returns: the Property related to the actual width of the column. widthProperty() Return the Property related to the actual width of the column.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

canFix	back to summary
private final boolean canFix

column	back to summary
pack-priv final TableColumn<ObservableList<SpreadsheetCell>, SpreadsheetCell> column

filterProperty	back to summary
private final ObjectProperty<Filter> filterProperty

fixItem	back to summary
private MenuItem fixItem

indexColumn	back to summary
private final Integer indexColumn

spreadsheetView	back to summary
private final SpreadsheetView spreadsheetView Private Fields * *

Constructor Detail

SpreadsheetColumn	back to summary
pack-priv SpreadsheetColumn(final TableColumn<ObservableList<SpreadsheetCell>, SpreadsheetCell> column, final SpreadsheetView spreadsheetView, final Integer indexColumn, Grid grid) Creates a new SpreadsheetColumn.

Method Detail

filterProperty	back to summary
public ObjectProperty<T> filterProperty()

fitColumn	back to summary
public void fitColumn() If the column is resizable, it will compute the optimum width for all the visible cells to be visible.

getColumnContextMenu	back to summary
private ContextMenu getColumnContextMenu() Generate a context Menu in order to freeze/unfreeze some column It is shown when right-clicking on the column header Returns:ContextMenu a context menu.

getColumnContextMenu

back to summary

private ContextMenu getColumnContextMenu()

Generate a context Menu in order to freeze/unfreeze some column It is shown when right-clicking on the column header

Returns:ContextMenu: a context menu.

getFilter	back to summary
public Filter getFilter()

getMaxWidth	back to summary
public final double getMaxWidth() Return the maximum width for this SpreadsheetColumn. Returns:double the maximum width for this SpreadsheetColumn.

getMaxWidth

back to summary

public final double getMaxWidth()

Return the maximum width for this SpreadsheetColumn.

Returns:double: the maximum width for this SpreadsheetColumn.

getMinWidth	back to summary
public final double getMinWidth() Return the minimum width for this SpreadsheetColumn. Returns:double the minimum width for this SpreadsheetColumn.

getMinWidth

back to summary

public final double getMinWidth()

Return the minimum width for this SpreadsheetColumn.

Returns:double: the minimum width for this SpreadsheetColumn.

getText	back to summary
private String getText()

getWidth	back to summary
public double getWidth() Return the actual width of the column. Returns:double the actual width of the column

getWidth

back to summary

public double getWidth()

Return the actual width of the column.

Returns:double: the actual width of the column

initCanFix	back to summary
private boolean initCanFix(Grid grid) Verify that you can freeze this column. Returns:boolean if it's freezable.

initCanFix

back to summary

private boolean initCanFix(Grid grid)

Verify that you can freeze this column.

Returns:boolean: if it's freezable.

isColumnFixable back to summary

isColumnFixable	back to summary
public boolean isColumnFixable() Indicate whether this column can be frozen or not. Call that method before calling `setFixed(boolean)` or adding an item to `SpreadsheetView#getFixedColumns()`. A column cannot be frozen alone if any cell inside the column has a column span superior to one. Returns:boolean true if this column is freezable.

public boolean isColumnFixable()

Indicate whether this column can be frozen or not. Call that method before calling setFixed(boolean) or adding an item to SpreadsheetView#getFixedColumns(). A column cannot be frozen alone if any cell inside the column has a column span superior to one.

Returns:boolean: true if this column is freezable.

isFixed	back to summary
public boolean isFixed() Return whether this column is frozen or not. Returns:boolean true if this column is frozen.

isFixed

back to summary

public boolean isFixed()

Return whether this column is frozen or not.

Returns:boolean: true if this column is frozen.

maxWidthProperty	back to summary
public final DoubleProperty maxWidthProperty() Return the Property related to the maximum width of this SpreadsheetColumn. Returns:DoubleProperty the Property related to the maximum width of this SpreadsheetColumn.

maxWidthProperty

back to summary

public final DoubleProperty maxWidthProperty()

Return the Property related to the maximum width of this SpreadsheetColumn.

Returns:DoubleProperty: the Property related to the maximum width of this SpreadsheetColumn.

minWidthProperty	back to summary
public final DoubleProperty minWidthProperty() Return the Property related to the minimum width of this SpreadsheetColumn. Returns:DoubleProperty the Property related to the minimum width of this SpreadsheetColumn.

minWidthProperty

back to summary

public final DoubleProperty minWidthProperty()

Return the Property related to the minimum width of this SpreadsheetColumn.

Returns:DoubleProperty: the Property related to the minimum width of this SpreadsheetColumn.

setFilter	back to summary
public void setFilter(Filter filter)

setFixed back to summary

setFixed	back to summary
public void setFixed(boolean fixed) Freeze this column to the left if possible, although it is recommended that you call `isColumnFixable()` before trying to freeze a column. If you want to freeze several columns (because of a span for example), add all the columns directly in `SpreadsheetView#getFixedColumns()`. Always use `SpreadsheetView#areSpreadsheetColumnsFixable(java.util.List)` before.

public void setFixed(boolean fixed)

Freeze this column to the left if possible, although it is recommended that you call isColumnFixable() before trying to freeze a column. If you want to freeze several columns (because of a span for example), add all the columns directly in SpreadsheetView#getFixedColumns(). Always use SpreadsheetView#areSpreadsheetColumnsFixable(java.util.List) before.

setMaxWidth	back to summary
public final void setMaxWidth(double value) Set the maximum width for this SpreadsheetColumn.

setMinWidth	back to summary
public final void setMinWidth(double value) Set the minimum width for this SpreadsheetColumn.

setPrefWidth	back to summary
public void setPrefWidth(double width) Set the width of this column.

setResizable	back to summary
public void setResizable(boolean b) If this column can be resized by the user

setText	back to summary
private void setText(String text) Private Methods * *

widthProperty	back to summary
public final ReadOnlyDoubleProperty widthProperty() Return the Property related to the actual width of the column. Returns:ReadOnlyDoubleProperty the Property related to the actual width of the column.

widthProperty

back to summary

public final ReadOnlyDoubleProperty widthProperty()

Return the Property related to the actual width of the column.

Returns:ReadOnlyDoubleProperty: the Property related to the actual width of the column.

public final Class SpreadsheetColumn

Configuration

Screenshot

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail