JavaFX 27 · javafx.scene.control.TableColumnBase · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private ObjectProperty<Comparator<T>>	comparator Comparator function used when sorting this table column.
private ObjectProperty<ContextMenu>	contextMenu This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
public static final Comparator<T>	DEFAULT_COMPARATOR By default all columns will use this comparator to perform sorting.
pack-priv static final double	DEFAULT_MAX_WIDTH
pack-priv static final double	DEFAULT_MIN_WIDTH
pack-priv static final double	DEFAULT_WIDTH
private BooleanProperty	editable Specifies whether this table column allows editing.
pack-priv final EventHandlerManager	eventHandlerManager
private ObjectProperty<Node>	graphic The graphic to show in the table column to allow the user to indicate graphically what is in the column.
private StringProperty	id The id of this TableColumnBase.
private DoubleProperty	maxWidth
private DoubleProperty	minWidth The minimum width the table column is permitted to be resized to.
private ReadOnlyObjectWrapper<TableColumnBase<S, ?>>	parentColumn This read-only property will always refer to the parent of this column, in the situation where nested columns are being used.
private final DoubleProperty	prefWidth
private ObservableMap<Object, Object>	properties
private BooleanProperty	reorderable A boolean property to toggle on and off the 'reorderability' of this column (with drag and drop - reordering by modifying the appropriate `columns` list is always allowed).
private BooleanProperty	resizable Used to indicate whether the width of this column can change.
private BooleanProperty	sortable A boolean property to toggle on and off the 'sortability' of this column.
private ObjectProperty<Node>	sortNode The node to use as the "sort arrow", shown to the user in situations where the table column is part of the sort order.
private StringProperty	style A string representation of the CSS style associated with this TableColumnBase instance.
private final ObservableList<String>	styleClass
private StringProperty	text This is the text to show in the header for this column.
private static final Object	USER_DATA_KEY
private BooleanProperty	visible Toggling this will immediately toggle the visibility of this column, and all children columns.
private ReadOnlyDoubleWrapper	width

Access	Constructor and Description
protected	TableColumnBase() Creates a default TableColumn with default cell factory, comparator, and onEditCommit implementation.
protected	TableColumnBase(String The string to show when the TableColumn is placed within the TableView. text) Creates a TableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation.

Method Summary

Modifier and Type	Method and Description
public <E extends Event> void	addEventFilter(EventType<E> eventType, EventHandler<? super E> eventHandler) Overrides default javafx.event.EventTarget.addEventFilter. Registers an event filter for this target.
public <E extends Event> void	addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler) Overrides default javafx.event.EventTarget.addEventHandler. Registers an event handler for this target.
public EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail) Implements javafx.event.EventTarget.buildEventDispatchChain. Construct an event dispatch chain for this target.
public final ObjectProperty<Comparator<T>>	comparatorProperty()
public final ObjectProperty<ContextMenu>	contextMenuProperty()
pack-priv void	doSetWidth(double width)
public final BooleanProperty	editableProperty()
public final T	Returns: The data that belongs to the cell at the intersection of the given row index and the table column that this method is called on. getCellData(final int The row index for which the data is required. index) Returns the actual value for a cell at a given row index (and which belongs to this table column).
public final T	Returns: The data that should be used in a specific cell in this column, based on the item passed in as an argument. getCellData(final S The item from which a value of type T should be extracted. item) Returns the actual value for a cell from the given item.
public abstract ObservableValue<T>	Returns: An ObservableValue<T> for this specific table column. getCellObservableValue(int The index of the item (of type S) for which an ObservableValue<T> is sought. index) Attempts to return an ObservableValue<T> for the item in the given index (which is of type S).
public abstract ObservableValue<T>	Returns: An ObservableValue<T> for this specific table column. getCellObservableValue(S The item (of type S) for which an ObservableValue<T> is sought. item) Attempts to return an ObservableValue<T> for the given item (which is of type S).
public abstract ObservableList<? extends TableColumnBase<S, ?>>	Returns: An ObservableList containing TableColumnBase instances (or subclasses) that are the children of this TableColumnBase. If these children TableColumnBase instances are set as visible, they will appear beneath this table column. getColumns() This enables support for nested columns, which can be useful to group together related data.
public final Comparator<T>	getComparator()
public final ContextMenu	getContextMenu()
public final Node	getGraphic()
public final String	getId() Implements javafx.css.Styleable.getId. The id of this `Styleable`.
public final double	getMaxWidth()
public final double	getMinWidth()
public final TableColumnBase<S, ?>	getParentColumn()
public final double	getPrefWidth()
public final ObservableMap<Object, Object>	Returns: an observable map of properties on this table column for use primarily by application developers getProperties() Returns an observable map of properties on this table column for use primarily by application developers.
public final ObservableSet<PseudoClass>	getPseudoClassStates() Implements javafx.css.Styleable.getPseudoClassStates. Return the pseudo-class state of this Styleable.
public final Node	getSortNode()
public final String	getStyle() Implements javafx.css.Styleable.getStyle. A string representation of the CSS style associated with this specific `Node`.
public ObservableList<String>	getStyleClass() Implements javafx.css.Styleable.getStyleClass. A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.
public final String	getText()
public Object	Returns: The Object that was previously set, or null if no property has been set or if null was set. getUserData() Returns a previously set Object property, or null if no such property has been set using the `TableColumnBase#setUserData(java.lang.Object)` method.
public final double	getWidth()
public final ObjectProperty<Node>	graphicProperty()
public boolean	Returns: true if node has properties. hasProperties() Tests if this table column has properties.
public final StringProperty	idProperty()
public final boolean	isEditable()
public final boolean	isReorderable()
public final boolean	isResizable()
public final boolean	isSortable()
public final boolean	isVisible()
public final DoubleProperty	Returns: maximum width property maxWidthProperty() The maximum width the table column is permitted to be resized to.
public final DoubleProperty	minWidthProperty()
public final ReadOnlyObjectProperty<TableColumnBase<S, ?>>	parentColumnProperty()
private ReadOnlyObjectWrapper<TableColumnBase<S, ?>>	parentColumnPropertyImpl()
public final DoubleProperty	Returns: preferred width property prefWidthProperty() The preferred width of the TableColumn.
public <E extends Event> void	removeEventFilter(EventType<E> eventType, EventHandler<? super E> eventHandler) Overrides default javafx.event.EventTarget.removeEventFilter. Unregisters a previously registered event filter from this target.
public <E extends Event> void	removeEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler) Overrides default javafx.event.EventTarget.removeEventHandler. Unregisters a previously registered event handler from this target.
public final BooleanProperty	reorderableProperty()
public final BooleanProperty	resizableProperty()
public final void	setComparator(Comparator<T> value)
public final void	setContextMenu(ContextMenu value)
public final void	setEditable(boolean value)
public final void	setGraphic(Node value)
public final void	setId(String value)
public final void	setMaxWidth(double value)
public final void	setMinWidth(double value)
pack-priv void	setParentColumn(TableColumnBase<S, ?> value)
public final void	setPrefWidth(double value)
public final void	setReorderable(boolean value)
public final void	setResizable(boolean value)
public final void	setSortable(boolean value)
public final void	setSortNode(Node value)
public final void	setStyle(String value)
public final void	setText(String value)
public void	setUserData(Object The value to be stored - this can later be retrieved by calling `TableColumnBase#getUserData()`. value) Convenience method for setting a single Object property that can be retrieved at a later date.
public final void	setVisible(boolean value)
pack-priv void	setWidth(double value)
public final BooleanProperty	sortableProperty()
public final ObjectProperty<Node>	sortNodeProperty()
public final StringProperty	styleProperty()
public final StringProperty	textProperty()
pack-priv void	updateColumnWidths()
public final BooleanProperty	visibleProperty()
public final ReadOnlyDoubleProperty	Returns: the width property widthProperty() The width of this column.

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

Field Detail

comparator	back to summary
private ObjectProperty<Comparator<T>> comparator Comparator function used when sorting this table column. The two Objects given as arguments are the cell data for two individual cells in this column.

contextMenu	back to summary
private ObjectProperty<ContextMenu> contextMenu This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.

DEFAULT_COMPARATOR	back to summary
public static final Comparator<T> DEFAULT_COMPARATOR By default all columns will use this comparator to perform sorting. This comparator simply performs null checks, and checks if the object is `Comparable`. If it is, the `Comparable#compareTo(java.lang.Object)` method is called, otherwise this method will defer to `Collator#compare(java.lang.String, java.lang.String)`.

DEFAULT_MAX_WIDTH	back to summary
pack-priv static final double DEFAULT_MAX_WIDTH

DEFAULT_MIN_WIDTH	back to summary
pack-priv static final double DEFAULT_MIN_WIDTH

DEFAULT_WIDTH	back to summary
pack-priv static final double DEFAULT_WIDTH

editable	back to summary
private BooleanProperty editable Specifies whether this table column allows editing. This, unlike `TableView#editableProperty()` and `TreeTableView#editableProperty()`, is true by default.

eventHandlerManager	back to summary
pack-priv final EventHandlerManager eventHandlerManager

graphic	back to summary
private ObjectProperty<Node> graphic The graphic to show in the table column to allow the user to indicate graphically what is in the column.

id back to summary

id	back to summary
private StringProperty id The id of this TableColumnBase. This simple string identifier is useful for finding a specific TableColumnBase within a UI control that uses TableColumnBase instances. The default value is `null`. Default Value null

private StringProperty id

The id of this TableColumnBase. This simple string identifier is useful for finding a specific TableColumnBase within a UI control that uses TableColumnBase instances. The default value is null.

Default Value: null

maxWidth	back to summary
private DoubleProperty maxWidth

minWidth	back to summary
private DoubleProperty minWidth The minimum width the table column is permitted to be resized to.

parentColumn back to summary

parentColumn	back to summary
private ReadOnlyObjectWrapper<TableColumnBase<S, ?>> parentColumn This read-only property will always refer to the parent of this column, in the situation where nested columns are being used. In the currently existing subclasses, to create a nested column is simply a matter of placing the relevant TableColumnBase instances inside the columns ObservableList (for example, see `javafx.scene.control.TableColumn#getColumns()` and `javafx.scene.control.TreeTableColumn#getColumns()`.

private ReadOnlyObjectWrapper<TableColumnBase<S, ?>> parentColumn

This read-only property will always refer to the parent of this column, in the situation where nested columns are being used.

In the currently existing subclasses, to create a nested column is simply a matter of placing the relevant TableColumnBase instances inside the columns ObservableList (for example, see javafx.scene.control.TableColumn#getColumns() and javafx.scene.control.TreeTableColumn#getColumns().

prefWidth	back to summary
private final DoubleProperty prefWidth

properties	back to summary
private ObservableMap<Object, Object> properties

reorderable back to summary

reorderable	back to summary
private BooleanProperty reorderable A boolean property to toggle on and off the 'reorderability' of this column (with drag and drop - reordering by modifying the appropriate `columns` list is always allowed). When this property is true, this column can be reordered by users simply by dragging and dropping the columns into their desired positions. When this property is false, this ability to drag and drop columns is not available. Since 9

private BooleanProperty reorderable

A boolean property to toggle on and off the 'reorderability' of this column (with drag and drop - reordering by modifying the appropriate columns list is always allowed). When this property is true, this column can be reordered by users simply by dragging and dropping the columns into their desired positions. When this property is false, this ability to drag and drop columns is not available.

Since: 9

resizable	back to summary
private BooleanProperty resizable Used to indicate whether the width of this column can change. It is up to the resizing policy to enforce this however.

sortable back to summary

sortable	back to summary
private BooleanProperty sortable A boolean property to toggle on and off the 'sortability' of this column. When this property is true, this column can be included in sort operations. If this property is false, it will not be included in sort operations, even if it is contained within the sort order list of the underlying UI control (e.g. `TableView#getSortOrder()` or `TreeTableView#getSortOrder()`). For example, iIf a TableColumn instance is contained within the TableView sortOrder ObservableList, and its sortable property toggles state, it will force the TableView to perform a sort, as it is likely the view will need updating.

private BooleanProperty sortable

A boolean property to toggle on and off the 'sortability' of this column. When this property is true, this column can be included in sort operations. If this property is false, it will not be included in sort operations, even if it is contained within the sort order list of the underlying UI control (e.g. TableView#getSortOrder() or TreeTableView#getSortOrder()).

For example, iIf a TableColumn instance is contained within the TableView sortOrder ObservableList, and its sortable property toggles state, it will force the TableView to perform a sort, as it is likely the view will need updating.

sortNode back to summary

sortNode	back to summary
private ObjectProperty<Node> sortNode The node to use as the "sort arrow", shown to the user in situations where the table column is part of the sort order. It may be the only item in the sort order, or it may be a secondary, tertiary, or latter sort item, and the node should reflect this visually. This is only used in the case of the table column being in the sort order (refer to, for example, `TableView#getSortOrder()` and `TreeTableView#getSortOrder()`). If not specified, the table column skin implementation is responsible for providing a default sort node. The sort node is commonly seen represented as a triangle that rotates on screen to indicate whether the table column is part of the sort order, and if so, whether the sort is ascending or descending, and what position in the sort order it is in.

private ObjectProperty<Node> sortNode

The node to use as the "sort arrow", shown to the user in situations where the table column is part of the sort order. It may be the only item in the sort order, or it may be a secondary, tertiary, or latter sort item, and the node should reflect this visually. This is only used in the case of the table column being in the sort order (refer to, for example, TableView#getSortOrder() and TreeTableView#getSortOrder()). If not specified, the table column skin implementation is responsible for providing a default sort node.

The sort node is commonly seen represented as a triangle that rotates on screen to indicate whether the table column is part of the sort order, and if so, whether the sort is ascending or descending, and what position in the sort order it is in.

style	back to summary
private StringProperty style A string representation of the CSS style associated with this TableColumnBase instance. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule. Parsing this style might not be supported on some limited platforms. It is recommended to use a standalone CSS file instead. Default Value empty string

style

back to summary

private StringProperty style

A string representation of the CSS style associated with this TableColumnBase instance. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.

Parsing this style might not be supported on some limited platforms. It is recommended to use a standalone CSS file instead.

Default Value: empty string

styleClass	back to summary
private final ObservableList<String> styleClass

text	back to summary
private StringProperty text This is the text to show in the header for this column.

USER_DATA_KEY	back to summary
private static final Object USER_DATA_KEY

visible	back to summary
private BooleanProperty visible Toggling this will immediately toggle the visibility of this column, and all children columns.

width	back to summary
private ReadOnlyDoubleWrapper width

Constructor Detail

TableColumnBase	back to summary
protected TableColumnBase() Creates a default TableColumn with default cell factory, comparator, and onEditCommit implementation.

TableColumnBase	back to summary
protected TableColumnBase(String text) Creates a TableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation. Parameters text:String The string to show when the TableColumn is placed within the TableView.

TableColumnBase

back to summary

protected TableColumnBase(String text)

Creates a TableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation.

Parameters

text:String: The string to show when the TableColumn is placed within the TableView.

Method Detail

addEventFilter back to summary

addEventFilter	back to summary
public <E extends Event> void addEventFilter(EventType<E> eventType, EventHandler<? super E> eventHandler) Overrides default javafx.event.EventTarget.addEventFilter. Doc from javafx.event.EventTarget.addEventFilter. Registers an event filter for this target. The filter is called when the target receives an `Event` of the specified type during the capturing phase of event delivery. Annotations @Override

public <E extends Event> void addEventFilter(EventType<E> eventType, EventHandler<? super E> eventHandler)

Overrides default javafx.event.EventTarget.addEventFilter.

Doc from javafx.event.EventTarget.addEventFilter.

Registers an event filter for this target.

The filter is called when the target receives an Event of the specified type during the capturing phase of event delivery.

Annotations

@Override

addEventHandler back to summary

addEventHandler	back to summary
public <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler) Overrides default javafx.event.EventTarget.addEventHandler. Doc from javafx.event.EventTarget.addEventHandler. Registers an event handler for this target. The handler is called when the target receives an `Event` of the specified type during the bubbling phase of event delivery. Annotations @Override

public <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)

Overrides default javafx.event.EventTarget.addEventHandler.

Doc from javafx.event.EventTarget.addEventHandler.

Registers an event handler for this target.

The handler is called when the target receives an Event of the specified type during the bubbling phase of event delivery.

Annotations

@Override

buildEventDispatchChain back to summary

buildEventDispatchChain	back to summary
public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail) Implements javafx.event.EventTarget.buildEventDispatchChain. Doc from javafx.event.EventTarget.buildEventDispatchChain. Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this `EventTarget`. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an `EventDispatcher` for itself to the chain. In the case the event target is part of some hierarchy, the chain for it is usually built from event dispatchers collected from the root of the hierarchy to the event target. The event dispatch chain is constructed by modifications to the provided initial event dispatch chain. The returned chain should have the initial chain at its end so the dispatchers should be prepended to the initial chain. The caller shouldn't assume that the initial chain remains unchanged nor that the returned value will reference a different chain. Annotations @Override

public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)

Implements javafx.event.EventTarget.buildEventDispatchChain.

Doc from javafx.event.EventTarget.buildEventDispatchChain.

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

In the case the event target is part of some hierarchy, the chain for it is usually built from event dispatchers collected from the root of the hierarchy to the event target.

The event dispatch chain is constructed by modifications to the provided initial event dispatch chain. The returned chain should have the initial chain at its end so the dispatchers should be prepended to the initial chain.

The caller shouldn't assume that the initial chain remains unchanged nor that the returned value will reference a different chain.

Annotations

@Override

comparatorProperty	back to summary
public final ObjectProperty<Comparator<T>> comparatorProperty()

contextMenuProperty	back to summary
public final ObjectProperty<ContextMenu> contextMenuProperty()

doSetWidth	back to summary
pack-priv void doSetWidth(double width)

editableProperty	back to summary
public final BooleanProperty editableProperty()

getCellData	back to summary
public final T getCellData(final int index) Returns the actual value for a cell at a given row index (and which belongs to this table column). Parameters index:int The row index for which the data is required. Returns:T The data that belongs to the cell at the intersection of the given row index and the table column that this method is called on.

getCellData

back to summary

public final T getCellData(final int index)

Returns the actual value for a cell at a given row index (and which belongs to this table column).

Parameters

index:int: The row index for which the data is required.

Returns:T

The data that belongs to the cell at the intersection of the given row index and the table column that this method is called on.

getCellData	back to summary
public final T getCellData(final S item) Returns the actual value for a cell from the given item. Parameters item:S The item from which a value of type T should be extracted. Returns:T The data that should be used in a specific cell in this column, based on the item passed in as an argument.

getCellData

back to summary

public final T getCellData(final S item)

Returns the actual value for a cell from the given item.

Parameters

item:S: The item from which a value of type T should be extracted.

Returns:T

The data that should be used in a specific cell in this column, based on the item passed in as an argument.

getCellObservableValue back to summary

getCellObservableValue	back to summary
public abstract ObservableValue<T> getCellObservableValue(int index) Attempts to return an ObservableValue<T> for the item in the given index (which is of type S). In other words, this method expects to receive an integer value that is greater than or equal to zero, and less than the size of the underlying data model. If the index is valid, this method will return an ObservableValue<T> for this specific column. This is achieved by calling the `cell value factory`, and returning whatever it returns when passed a `CellDataFeatures` (see, for example, the CellDataFeatures classes belonging to `TableColumn` and `TreeTableColumn` for more information). Parameters index:int The index of the item (of type S) for which an ObservableValue<T> is sought. Returns:ObservableValue<T> An ObservableValue<T> for this specific table column.

public abstract ObservableValue<T> getCellObservableValue(int index)

Attempts to return an ObservableValue<T> for the item in the given index (which is of type S). In other words, this method expects to receive an integer value that is greater than or equal to zero, and less than the size of the underlying data model. If the index is valid, this method will return an ObservableValue<T> for this specific column.

This is achieved by calling the cell value factory, and returning whatever it returns when passed a CellDataFeatures (see, for example, the CellDataFeatures classes belonging to TableColumn and TreeTableColumn for more information).

Parameters

index:int: The index of the item (of type S) for which an ObservableValue<T> is sought.

Returns:ObservableValue<T>

An ObservableValue<T> for this specific table column.

getCellObservableValue back to summary

getCellObservableValue	back to summary
public abstract ObservableValue<T> getCellObservableValue(S item) Attempts to return an ObservableValue<T> for the given item (which is of type S). In other words, this method expects to receive an object from the underlying data model for the entire 'row' in the table, and it must return an ObservableValue<T> for the value in this specific column. This is achieved by calling the `cell value factory`, and returning whatever it returns when passed a `CellDataFeatures` (see, for example, the CellDataFeatures classes belonging to `TableColumn` and `TreeTableColumn` for more information). Parameters item:S The item (of type S) for which an ObservableValue<T> is sought. Returns:ObservableValue<T> An ObservableValue<T> for this specific table column.

public abstract ObservableValue<T> getCellObservableValue(S item)

Attempts to return an ObservableValue<T> for the given item (which is of type S). In other words, this method expects to receive an object from the underlying data model for the entire 'row' in the table, and it must return an ObservableValue<T> for the value in this specific column.

Parameters

item:S: The item (of type S) for which an ObservableValue<T> is sought.

Returns:ObservableValue<T>

An ObservableValue<T> for this specific table column.

getColumns	back to summary
public abstract ObservableList<? extends TableColumnBase<S, ?>> getColumns() This enables support for nested columns, which can be useful to group together related data. For example, we may have a 'Name' column with two nested columns for 'First' and 'Last' names. This has no impact on the table as such - all column indices point to the leaf columns only, and it isn't possible to sort using the parent column, just the leaf columns. In other words, this is purely a visual feature. Returns:ObservableList<? extends TableColumnBase<S, ?>> An ObservableList containing TableColumnBase instances (or subclasses) that are the children of this TableColumnBase. If these children TableColumnBase instances are set as visible, they will appear beneath this table column.

getColumns

back to summary

public abstract ObservableList<? extends TableColumnBase<S, ?>> getColumns()

This enables support for nested columns, which can be useful to group together related data. For example, we may have a 'Name' column with two nested columns for 'First' and 'Last' names.

This has no impact on the table as such - all column indices point to the leaf columns only, and it isn't possible to sort using the parent column, just the leaf columns. In other words, this is purely a visual feature.

Returns:ObservableList<? extends TableColumnBase<S, ?>>: An ObservableList containing TableColumnBase instances (or subclasses) that are the children of this TableColumnBase. If these children TableColumnBase instances are set as visible, they will appear beneath this table column.

getComparator	back to summary
public final Comparator<T> getComparator()

getContextMenu	back to summary
public final ContextMenu getContextMenu()

getGraphic	back to summary
public final Node getGraphic()

getId back to summary

getId	back to summary
public final String getId() Implements javafx.css.Styleable.getId. Doc from javafx.css.Styleable.getId. The id of this `Styleable`. This simple string identifier is useful for finding a specific Node within the scene graph. While the id of a Node should be unique within the scene graph, this uniqueness is not enforced. This is analogous to the "id" attribute on an HTML element (CSS ID Specification). For example, if a Node is given the id of "myId", then the lookup method can be used to find this node as follows: `scene.lookup("#myId");`. Annotations @Override

public final String getId()

Implements javafx.css.Styleable.getId.

Doc from javafx.css.Styleable.getId.

The id of this Styleable. This simple string identifier is useful for finding a specific Node within the scene graph. While the id of a Node should be unique within the scene graph, this uniqueness is not enforced. This is analogous to the "id" attribute on an HTML element (CSS ID Specification).

For example, if a Node is given the id of "myId", then the lookup method can be used to find this node as follows: scene.lookup("#myId");.

Annotations

@Override

getMaxWidth	back to summary
public final double getMaxWidth()

getMinWidth	back to summary
public final double getMinWidth()

getParentColumn	back to summary
public final TableColumnBase<S, ?> getParentColumn()

getPrefWidth	back to summary
public final double getPrefWidth()

getProperties

back to summary

public final ObservableMap<Object, Object> getProperties()

Returns an observable map of properties on this table column for use primarily by application developers.

Returns:ObservableMap<Object, Object>: an observable map of properties on this table column for use primarily by application developers

getPseudoClassStates

back to summary

public final ObservableSet<PseudoClass> getPseudoClassStates()

Implements javafx.css.Styleable.getPseudoClassStates.

Doc from javafx.css.Styleable.getPseudoClassStates.

Return the pseudo-class state of this Styleable. CSS assumes this set is read-only.

Annotations

@Override

getSortNode	back to summary
public final Node getSortNode()

getStyle back to summary

public final String getStyle()

Implements javafx.css.Styleable.getStyle.

Doc from javafx.css.Styleable.getStyle.

A string representation of the CSS style associated with this specific Node. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.

Annotations

@Override

getStyleClass

back to summary

public ObservableList<String> getStyleClass()

Implements javafx.css.Styleable.getStyleClass.

A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine. This variable is analogous to the "class" attribute on an HTML element and, as such, each element of the list is a style class to which this Node belongs.

Annotations

@Override

See Also

CSS3 class selectors

getText	back to summary
public final String getText()

getUserData back to summary

public Object getUserData()

Returns a previously set Object property, or null if no such property has been set using the TableColumnBase#setUserData(java.lang.Object) method.

Returns:Object: The Object that was previously set, or null if no property has been set or if null was set.

getWidth	back to summary
public final double getWidth()

graphicProperty	back to summary
public final ObjectProperty<Node> graphicProperty()

hasProperties

back to summary

public boolean hasProperties()

Tests if this table column has properties.

Returns:boolean: true if node has properties.

idProperty	back to summary
public final StringProperty idProperty()

isEditable	back to summary
public final boolean isEditable()

isReorderable	back to summary
public final boolean isReorderable()

isResizable	back to summary
public final boolean isResizable()

isSortable	back to summary
public final boolean isSortable()

isVisible	back to summary
public final boolean isVisible()

maxWidthProperty

back to summary

public final DoubleProperty maxWidthProperty()

The maximum width the table column is permitted to be resized to.

Returns:DoubleProperty: maximum width property

minWidthProperty	back to summary
public final DoubleProperty minWidthProperty()

parentColumnProperty	back to summary
public final ReadOnlyObjectProperty<TableColumnBase<S, ?>> parentColumnProperty()

parentColumnPropertyImpl	back to summary
private ReadOnlyObjectWrapper<TableColumnBase<S, ?>> parentColumnPropertyImpl()

prefWidthProperty

back to summary

public final DoubleProperty prefWidthProperty()

The preferred width of the TableColumn.

Returns:DoubleProperty: preferred width property

removeEventFilter back to summary

public <E extends Event> void removeEventFilter(EventType<E> eventType, EventHandler<? super E> eventHandler)

Overrides default javafx.event.EventTarget.removeEventFilter.

Doc from javafx.event.EventTarget.removeEventFilter.

Unregisters a previously registered event filter from this target.

Since it is possible to register a single EventHandler instance for different event types, the caller needs to specify the event type from which the filter should be unregistered.

Annotations

@Override

removeEventHandler back to summary

public <E extends Event> void removeEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)

Overrides default javafx.event.EventTarget.removeEventHandler.

Doc from javafx.event.EventTarget.removeEventHandler.

Unregisters a previously registered event handler from this target.

Since it is possible to register a single EventHandler instance for different event types, the caller needs to specify the event type from which the handler should be unregistered.

Annotations

@Override

reorderableProperty	back to summary
public final BooleanProperty reorderableProperty()

resizableProperty	back to summary
public final BooleanProperty resizableProperty()

setComparator	back to summary
public final void setComparator(Comparator<T> value)

setContextMenu	back to summary
public final void setContextMenu(ContextMenu value)

setEditable	back to summary
public final void setEditable(boolean value)

setGraphic	back to summary
public final void setGraphic(Node value)

setId	back to summary
public final void setId(String value)

setMaxWidth	back to summary
public final void setMaxWidth(double value)

setMinWidth	back to summary
public final void setMinWidth(double value)

setParentColumn	back to summary
pack-priv void setParentColumn(TableColumnBase<S, ?> value)

setPrefWidth	back to summary
public final void setPrefWidth(double value)

setReorderable	back to summary
public final void setReorderable(boolean value)

setResizable	back to summary
public final void setResizable(boolean value)

setSortable	back to summary
public final void setSortable(boolean value)

setSortNode	back to summary
public final void setSortNode(Node value)

setStyle	back to summary
public final void setStyle(String value)

setText	back to summary
public final void setText(String value)

setUserData back to summary

public void setUserData(Object value)

Convenience method for setting a single Object property that can be retrieved at a later date. This is functionally equivalent to calling the getProperties().put(Object key, Object value) method. This can later be retrieved by calling TableColumnBase#getUserData().

Parameters

value:Object: The value to be stored - this can later be retrieved by calling TableColumnBase#getUserData().

setVisible	back to summary
public final void setVisible(boolean value)

setWidth	back to summary
pack-priv void setWidth(double value)

sortableProperty	back to summary
public final BooleanProperty sortableProperty()

sortNodeProperty	back to summary
public final ObjectProperty<Node> sortNodeProperty()

styleProperty	back to summary
public final StringProperty styleProperty()

textProperty	back to summary
public final StringProperty textProperty()

updateColumnWidths	back to summary
pack-priv void updateColumnWidths()

visibleProperty	back to summary
public final BooleanProperty visibleProperty()

widthProperty

back to summary

public final ReadOnlyDoubleProperty widthProperty()

The width of this column. Modifying this will result in the column width adjusting visually. It is recommended to not bind this property to an external property, as that will result in the column width not being adjustable by the user through dragging the left and right borders of column headers.

Returns:ReadOnlyDoubleProperty: the width property

public abstract Class TableColumnBase<S, T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail