Module org.controlsfx.controls

Package org.controlsfx.control.spreadsheet

Class SpreadsheetColumn

java.lang.Object

org.controlsfx.control.spreadsheet.SpreadsheetColumn

public final 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 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.

See Also:

SpreadsheetView

Property Summary

Properties

Type	Property	Description
ObjectProperty	filter
DoubleProperty	maxWidth	Return the Property related to the maximum width of this SpreadsheetColumn.
DoubleProperty	minWidth	Return the Property related to the minimum width of this SpreadsheetColumn.
ReadOnlyDoubleProperty	width	Return the Property related to the actual width of the column.

Method Summary

Modifier and Type	Method	Description
ObjectProperty	filterProperty()
void	fitColumn()	If the column is resizable, it will compute the optimum width for all the visible cells to be visible.
Filter	getFilter()	Gets the value of the property filter.
double	getMaxWidth()	Return the maximum width for this SpreadsheetColumn.
double	getMinWidth()	Return the minimum width for this SpreadsheetColumn.
double	getWidth()	Return the actual width of the column.
boolean	isColumnFixable()	Indicate whether this column can be frozen or not.
boolean	isFixed()	Return whether this column is frozen or not.
DoubleProperty	maxWidthProperty()	Return the Property related to the maximum width of this SpreadsheetColumn.
DoubleProperty	minWidthProperty()	Return the Property related to the minimum width of this SpreadsheetColumn.
void	setFilter(Filter filter)	Sets the value of the property filter.
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.
void	setMaxWidth(double value)	Set the maximum width for this SpreadsheetColumn.
void	setMinWidth(double value)	Set the minimum width for this SpreadsheetColumn.
void	setPrefWidth(double width)	Set the width of this column.
void	setResizable(boolean b)	If this column can be resized by the user
ReadOnlyDoubleProperty	widthProperty()	Return the Property related to the actual width of the column.

Methods inherited from class java.lang.Object

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

Property Detail

width

public final ReadOnlyDoubleProperty widthProperty

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

See Also:

getWidth()

minWidth

public final DoubleProperty minWidthProperty

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

See Also:

getMinWidth(), setMinWidth(double)

maxWidth

public final DoubleProperty maxWidthProperty

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

See Also:

getMaxWidth(), setMaxWidth(double)

filter

public ObjectProperty filterProperty

See Also:

getFilter(), setFilter(Filter)

Method Detail

isFixed

public boolean isFixed()

Return whether this column is frozen or not.

Returns:

true if this column is frozen.

setFixed

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.

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

widthProperty

public final ReadOnlyDoubleProperty widthProperty()

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

See Also:

getWidth()

setMinWidth

public final void setMinWidth(double value)

Set the minimum width for this SpreadsheetColumn.

Parameters:

value -

getMinWidth

public final double getMinWidth()

Return the minimum width for this SpreadsheetColumn.

Returns:

the minimum width for this SpreadsheetColumn.

minWidthProperty

public final DoubleProperty minWidthProperty()

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

See Also:

getMinWidth(), setMinWidth(double)

maxWidthProperty

public final DoubleProperty maxWidthProperty()

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

See Also:

getMaxWidth(), setMaxWidth(double)

setMaxWidth

public final void setMaxWidth(double value)

Set the maximum width for this SpreadsheetColumn.

Parameters:

value -

getMaxWidth

public final double getMaxWidth()

Return the maximum width for this SpreadsheetColumn.

Returns:

the maximum width for this SpreadsheetColumn.

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 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:

true if this column is freezable.

setFilter

public void setFilter(Filter filter)

Sets the value of the property filter.

Property description:

getFilter

public Filter getFilter()

Gets the value of the property filter.

Property description:

filterProperty

public ObjectProperty filterProperty()

See Also:

getFilter(), setFilter(Filter)