- Type Parameters:
- S- The type of the UI control (e.g. the type of the 'row').
- T- The type of the content in all cells in this table column.
- All Implemented Interfaces:
- Styleable,- EventTarget
- Direct Known Subclasses:
- TableColumn,- TreeTableColumn
@IDProperty("id")
public abstract class TableColumnBase<S,T>
extends Object
implements EventTarget, Styleable
TableView and TreeTableView) are
 made up of zero or more instances of a concrete TableColumnBase subclass
 (TableColumn and TreeTableColumn, respectively). Each
 table column in a table is responsible for displaying (and editing) the contents
 of that column. As well as being responsible for displaying and editing data
 for a single column, a table column also contains the necessary properties to:
 - Be resized (using minWidth/prefWidth/maxWidthandwidthproperties)
- Have its visibilitytoggled
- Display header text
- Display any nested columnsit may contain
- Have a context menuwhen the user right-clicks the column header area
- Have the contents of the table be sorted (using
      comparator,sortableand sortType).
text
 (what to show in the column header area), and the column
 cell value factory (which is used to populate individual cells in the
 column). Refer to the class documentation for TableColumn and
 TreeTableColumn for more information.- Since:
- JavaFX 8.0
- See Also:
- TableColumn,- TreeTableColumn,- TablePositionBase
- 
Property SummaryProperties Type Property Description ObjectProperty<Comparator<T>>comparatorComparator function used when sorting this table column.ObjectProperty<ContextMenu>contextMenuThis menu will be shown whenever the user right clicks within the header area of this TableColumnBase.BooleanPropertyeditableSpecifies whether this table column allows editing.ObjectProperty<Node>graphicThe graphic to show in the table column to allow the user to indicate graphically what is in the column.StringPropertyidThe id of this TableColumnBase.DoublePropertymaxWidthThe maximum width the table column is permitted to be resized to.DoublePropertyminWidthThe minimum width the table column is permitted to be resized to.ReadOnlyObjectProperty<TableColumnBase<S,?>>parentColumnThis read-only property will always refer to the parent of this column, in the situation where nested columns are being used.DoublePropertyprefWidthThe preferred width of the TableColumn.BooleanPropertyreorderableA boolean property to toggle on and off the 'reorderability' of this column (with drag and drop - reordering by modifying the appropriatecolumnslist is always allowed).BooleanPropertyresizableUsed to indicate whether the width of this column can change.BooleanPropertysortableA boolean property to toggle on and off the 'sortability' of this column.ObjectProperty<Node>sortNodeThe node to use as the "sort arrow", shown to the user in situations where the table column is part of the sort order.StringPropertystyleA string representation of the CSS style associated with this TableColumnBase instance.StringPropertytextThis is the text to show in the header for this column.BooleanPropertyvisibleToggling this will immediately toggle the visibility of this column, and all children columns.ReadOnlyDoublePropertywidthThe width of this column.
- 
Field SummaryFields Modifier and Type Field Description static ComparatorDEFAULT_COMPARATORBy default all columns will use this comparator to perform sorting.
- 
Constructor SummaryConstructors Modifier Constructor Description protectedTableColumnBase()Creates a default TableColumn with default cell factory, comparator, and onEditCommit implementation.protectedTableColumnBase(String text)Creates a TableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation.
- 
Method SummaryModifier and Type Method Description <E extends Event>
 voidaddEventHandler(EventType<E> eventType, EventHandler<E> eventHandler)Registers an event handler to this table column.EventDispatchChainbuildEventDispatchChain(EventDispatchChain tail)Construct an event dispatch chain for this target.ObjectProperty<Comparator<T>>comparatorProperty()Comparator function used when sorting this table column.ObjectProperty<ContextMenu>contextMenuProperty()This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.BooleanPropertyeditableProperty()Specifies whether this table column allows editing.TgetCellData(int index)Returns the actual value for a cell at a given row index (and which belongs to this table column).TgetCellData(S item)Returns the actual value for a cell from the given item.abstract ObservableValue<T>getCellObservableValue(int index)Attempts to return an ObservableValue<T> for the item in the given index (which is of type S).abstract ObservableValue<T>getCellObservableValue(S item)Attempts to return an ObservableValue<T> for the given item (which is of type S).abstract ObservableList<? extends TableColumnBase<S,?>>getColumns()This enables support for nested columns, which can be useful to group together related data.Comparator<T>getComparator()Gets the value of the property comparator.ContextMenugetContextMenu()Gets the value of the property contextMenu.NodegetGraphic()Gets the value of the property graphic.StringgetId()Gets the value of the property id.doublegetMaxWidth()Gets the value of the property maxWidth.doublegetMinWidth()Gets the value of the property minWidth.TableColumnBase<S,?>getParentColumn()Gets the value of the property parentColumn.doublegetPrefWidth()Gets the value of the property prefWidth.ObservableMap<Object,Object>getProperties()Returns an observable map of properties on this table column for use primarily by application developers.ObservableSet<PseudoClass>getPseudoClassStates()Return the pseudo-class state of this Styleable.NodegetSortNode()Gets the value of the property sortNode.StringgetStyle()Gets the value of the property style.ObservableList<String>getStyleClass()A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.StringgetText()Gets the value of the property text.ObjectgetUserData()Returns a previously set Object property, or null if no such property has been set using thesetUserData(java.lang.Object)method.doublegetWidth()Gets the value of the property width.ObjectProperty<Node>graphicProperty()The graphic to show in the table column to allow the user to indicate graphically what is in the column.booleanhasProperties()Tests if this table column has properties.StringPropertyidProperty()The id of this TableColumnBase.booleanisEditable()Gets the value of the property editable.booleanisReorderable()Gets the value of the property reorderable.booleanisResizable()Gets the value of the property resizable.booleanisSortable()Gets the value of the property sortable.booleanisVisible()Gets the value of the property visible.DoublePropertymaxWidthProperty()The maximum width the table column is permitted to be resized to.DoublePropertyminWidthProperty()The minimum width the table column is permitted to be resized to.ReadOnlyObjectProperty<TableColumnBase<S,?>>parentColumnProperty()This read-only property will always refer to the parent of this column, in the situation where nested columns are being used.DoublePropertyprefWidthProperty()The preferred width of the TableColumn.<E extends Event>
 voidremoveEventHandler(EventType<E> eventType, EventHandler<E> eventHandler)Unregisters a previously registered event handler from this table column.BooleanPropertyreorderableProperty()A boolean property to toggle on and off the 'reorderability' of this column (with drag and drop - reordering by modifying the appropriatecolumnslist is always allowed).BooleanPropertyresizableProperty()Used to indicate whether the width of this column can change.voidsetComparator(Comparator<T> value)Sets the value of the property comparator.voidsetContextMenu(ContextMenu value)Sets the value of the property contextMenu.voidsetEditable(boolean value)Sets the value of the property editable.voidsetGraphic(Node value)Sets the value of the property graphic.voidsetId(String value)Sets the value of the property id.voidsetMaxWidth(double value)Sets the value of the property maxWidth.voidsetMinWidth(double value)Sets the value of the property minWidth.voidsetPrefWidth(double value)Sets the value of the property prefWidth.voidsetReorderable(boolean value)Sets the value of the property reorderable.voidsetResizable(boolean value)Sets the value of the property resizable.voidsetSortable(boolean value)Sets the value of the property sortable.voidsetSortNode(Node value)Sets the value of the property sortNode.voidsetStyle(String value)Sets the value of the property style.voidsetText(String value)Sets the value of the property text.voidsetUserData(Object value)Convenience method for setting a single Object property that can be retrieved at a later date.voidsetVisible(boolean value)Sets the value of the property visible.BooleanPropertysortableProperty()A boolean property to toggle on and off the 'sortability' of this column.ObjectProperty<Node>sortNodeProperty()The node to use as the "sort arrow", shown to the user in situations where the table column is part of the sort order.StringPropertystyleProperty()A string representation of the CSS style associated with this TableColumnBase instance.StringPropertytextProperty()This is the text to show in the header for this column.BooleanPropertyvisibleProperty()Toggling this will immediately toggle the visibility of this column, and all children columns.ReadOnlyDoublePropertywidthProperty()The width of this column.Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javafx.css.StyleablegetCssMetaData, getStyleableNode, getStyleableParent, getTypeSelector
- 
Property Details- 
textThis is the text to show in the header for this column.- See Also:
- getText(),- setText(String)
 
- 
visibleToggling this will immediately toggle the visibility of this column, and all children columns.- See Also:
- isVisible(),- setVisible(boolean)
 
- 
parentColumnThis 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 TableColumn.getColumns()andTreeTableColumn.getColumns().- See Also:
- getParentColumn()
 
- 
contextMenuThis menu will be shown whenever the user right clicks within the header area of this TableColumnBase.- See Also:
- getContextMenu(),- setContextMenu(ContextMenu)
 
- 
idThe 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 isnull.- Default value:
- null
- See Also:
- getId(),- setId(String)
 
- 
styleA 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
- See Also:
- getStyle(),- setStyle(String)
 
- 
graphicThe graphic to show in the table column to allow the user to indicate graphically what is in the column. - See Also:
- getGraphic(),- setGraphic(Node)
 
- 
sortNodeThe 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()andTreeTableView.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. - See Also:
- getSortNode(),- setSortNode(Node)
 
- 
widthThe 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.- See Also:
- getWidth()
 
- 
minWidthThe minimum width the table column is permitted to be resized to.- See Also:
- getMinWidth(),- setMinWidth(double)
 
- 
prefWidthThe preferred width of the TableColumn.- See Also:
- getPrefWidth(),- setPrefWidth(double)
 
- 
maxWidthThe maximum width the table column is permitted to be resized to.- See Also:
- getMaxWidth(),- setMaxWidth(double)
 
- 
resizableUsed to indicate whether the width of this column can change. It is up to the resizing policy to enforce this however.- See Also:
- isResizable(),- setResizable(boolean)
 
- 
sortableA 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()orTreeTableView.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. - See Also:
- isSortable(),- setSortable(boolean)
 
- 
reorderableA boolean property to toggle on and off the 'reorderability' of this column (with drag and drop - reordering by modifying the appropriatecolumnslist 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
- See Also:
- isReorderable(),- setReorderable(boolean)
 
- 
comparatorComparator function used when sorting this table column. The two Objects given as arguments are the cell data for two individual cells in this column.- See Also:
- getComparator(),- setComparator(Comparator)
 
- 
editableSpecifies whether this table column allows editing. This, unlikeTableView.editableProperty()andTreeTableView.editableProperty(), is true by default.- See Also:
- isEditable(),- setEditable(boolean)
 
 
- 
- 
Field Details- 
DEFAULT_COMPARATORBy default all columns will use this comparator to perform sorting. This comparator simply performs null checks, and checks if the object isComparable. If it is, theComparable.compareTo(java.lang.Object)method is called, otherwise this method will defer toCollator.compare(java.lang.String, java.lang.String).
 
- 
- 
Constructor Details- 
TableColumnBaseprotected TableColumnBase()Creates a default TableColumn with default cell factory, comparator, and onEditCommit implementation.
- 
TableColumnBaseCreates a TableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation.- Parameters:
- text- The string to show when the TableColumn is placed within the TableView.
 
 
- 
- 
Method Details- 
textPropertyThis is the text to show in the header for this column.- See Also:
- getText(),- setText(String)
 
- 
setTextSets the value of the property text.- Property description:
- This is the text to show in the header for this column.
 
- 
getTextGets the value of the property text.- Property description:
- This is the text to show in the header for this column.
 
- 
setVisiblepublic final void setVisible(boolean value)Sets the value of the property visible.- Property description:
- Toggling this will immediately toggle the visibility of this column, and all children columns.
 
- 
isVisiblepublic final boolean isVisible()Gets the value of the property visible.- Property description:
- Toggling this will immediately toggle the visibility of this column, and all children columns.
 
- 
visiblePropertyToggling this will immediately toggle the visibility of this column, and all children columns.- See Also:
- isVisible(),- setVisible(boolean)
 
- 
getParentColumnGets the value of the property parentColumn.- Property description:
- 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 TableColumn.getColumns()andTreeTableColumn.getColumns().
 
- 
parentColumnPropertyThis 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 TableColumn.getColumns()andTreeTableColumn.getColumns().- See Also:
- getParentColumn()
 
- 
setContextMenuSets the value of the property contextMenu.- Property description:
- This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
 
- 
getContextMenuGets the value of the property contextMenu.- Property description:
- This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
 
- 
contextMenuPropertyThis menu will be shown whenever the user right clicks within the header area of this TableColumnBase.- See Also:
- getContextMenu(),- setContextMenu(ContextMenu)
 
- 
setIdSets the value of the property id.- Property description:
- 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
 
- 
getIdGets the value of the property id.- Specified by:
- getIdin interface- Styleable
- Property description:
- 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
- Returns:
- the id of this Styleable
 
- 
idPropertyThe 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 isnull.- Default value:
- null
- See Also:
- getId(),- setId(String)
 
- 
setStyleSets the value of the property style.- Property description:
- 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
 
- 
getStyleGets the value of the property style.- Specified by:
- getStylein interface- Styleable
- Property description:
- 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
- Returns:
- a string representation of the CSS style associated with this
 specific Node
 
- 
stylePropertyA 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
- See Also:
- getStyle(),- setStyle(String)
 
- 
getStyleClassA 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.- Specified by:
- getStyleClassin interface- Styleable
- Returns:
- a list of String identifiers which can be used to logically group Nodes, specifically for an external style engine
- See Also:
- CSS3 class selectors
 
- 
setGraphicSets the value of the property graphic.- Property description:
- The graphic to show in the table column to allow the user to indicate graphically what is in the column. 
 
- 
getGraphicGets the value of the property graphic.- Property description:
- The graphic to show in the table column to allow the user to indicate graphically what is in the column. 
 
- 
graphicPropertyThe graphic to show in the table column to allow the user to indicate graphically what is in the column. - See Also:
- getGraphic(),- setGraphic(Node)
 
- 
setSortNodeSets the value of the property sortNode.- Property description:
- 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. 
 
- 
getSortNodeGets the value of the property sortNode.- Property description:
- 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. 
 
- 
sortNodePropertyThe 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()andTreeTableView.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. - See Also:
- getSortNode(),- setSortNode(Node)
 
- 
widthPropertyThe 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.- See Also:
- getWidth()
 
- 
getWidthpublic final double getWidth()Gets the value of the property width.- Property description:
- 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.
 
- 
setMinWidthpublic final void setMinWidth(double value)Sets the value of the property minWidth.- Property description:
- The minimum width the table column is permitted to be resized to.
 
- 
getMinWidthpublic final double getMinWidth()Gets the value of the property minWidth.- Property description:
- The minimum width the table column is permitted to be resized to.
 
- 
minWidthPropertyThe minimum width the table column is permitted to be resized to.- See Also:
- getMinWidth(),- setMinWidth(double)
 
- 
prefWidthPropertyThe preferred width of the TableColumn.- See Also:
- getPrefWidth(),- setPrefWidth(double)
 
- 
setPrefWidthpublic final void setPrefWidth(double value)Sets the value of the property prefWidth.- Property description:
- The preferred width of the TableColumn.
 
- 
getPrefWidthpublic final double getPrefWidth()Gets the value of the property prefWidth.- Property description:
- The preferred width of the TableColumn.
 
- 
maxWidthPropertyThe maximum width the table column is permitted to be resized to.- See Also:
- getMaxWidth(),- setMaxWidth(double)
 
- 
setMaxWidthpublic final void setMaxWidth(double value)Sets the value of the property maxWidth.- Property description:
- The maximum width the table column is permitted to be resized to.
 
- 
getMaxWidthpublic final double getMaxWidth()Gets the value of the property maxWidth.- Property description:
- The maximum width the table column is permitted to be resized to.
 
- 
resizablePropertyUsed to indicate whether the width of this column can change. It is up to the resizing policy to enforce this however.- See Also:
- isResizable(),- setResizable(boolean)
 
- 
setResizablepublic final void setResizable(boolean value)Sets the value of the property resizable.- Property description:
- Used to indicate whether the width of this column can change. It is up to the resizing policy to enforce this however.
 
- 
isResizablepublic final boolean isResizable()Gets the value of the property resizable.- Property description:
- Used to indicate whether the width of this column can change. It is up to the resizing policy to enforce this however.
 
- 
sortablePropertyA 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()orTreeTableView.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. - See Also:
- isSortable(),- setSortable(boolean)
 
- 
setSortablepublic final void setSortable(boolean value)Sets the value of the property sortable.- Property description:
- 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. 
 
- 
isSortablepublic final boolean isSortable()Gets the value of the property sortable.- Property description:
- 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. 
 
- 
reorderablePropertyA boolean property to toggle on and off the 'reorderability' of this column (with drag and drop - reordering by modifying the appropriatecolumnslist 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
- See Also:
- isReorderable(),- setReorderable(boolean)
 
- 
setReorderablepublic final void setReorderable(boolean value)Sets the value of the property reorderable.- Property description:
- A boolean property to toggle on and off the 'reorderability' of this column
 (with drag and drop - reordering by modifying the appropriate columnslist 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
 
- 
isReorderablepublic final boolean isReorderable()Gets the value of the property reorderable.- Property description:
- A boolean property to toggle on and off the 'reorderability' of this column
 (with drag and drop - reordering by modifying the appropriate columnslist 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
 
- 
comparatorPropertyComparator function used when sorting this table column. The two Objects given as arguments are the cell data for two individual cells in this column.- See Also:
- getComparator(),- setComparator(Comparator)
 
- 
setComparatorSets the value of the property comparator.- Property description:
- 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.
 
- 
getComparatorGets the value of the property comparator.- Property description:
- 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.
 
- 
setEditablepublic final void setEditable(boolean value)Sets the value of the property editable.- Property description:
- Specifies whether this table column allows editing. This, unlike
 TableView.editableProperty()andTreeTableView.editableProperty(), is true by default.
 
- 
isEditablepublic final boolean isEditable()Gets the value of the property editable.- Property description:
- Specifies whether this table column allows editing. This, unlike
 TableView.editableProperty()andTreeTableView.editableProperty(), is true by default.
 
- 
editablePropertySpecifies whether this table column allows editing. This, unlikeTableView.editableProperty()andTreeTableView.editableProperty(), is true by default.- See Also:
- isEditable(),- setEditable(boolean)
 
- 
getPropertiesReturns an observable map of properties on this table column for use primarily by application developers.- Returns:
- an observable map of properties on this table column for use primarily by application developers
 
- 
hasPropertiespublic boolean hasProperties()Tests if this table column has properties.- Returns:
- true if node has properties.
 
- 
setUserDataConvenience 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 callinggetUserData().- Parameters:
- value- The value to be stored - this can later be retrieved by calling- getUserData().
 
- 
getUserDataReturns a previously set Object property, or null if no such property has been set using thesetUserData(java.lang.Object)method.- Returns:
- The Object that was previously set, or null if no property has been set or if null was set.
 
- 
getColumnsThis 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:
- 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.
 
- 
getCellDataReturns the actual value for a cell at a given row index (and which belongs to this table column).- Parameters:
- index- The row index for which the data is required.
- 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.
 
- 
getCellDataReturns the actual value for a cell from the given item.- Parameters:
- item- The item from which a value of type T should be extracted.
- Returns:
- The data that should be used in a specific cell in this column, based on the item passed in as an argument.
 
- 
getCellObservableValueAttempts 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 aCellDataFeatures(see, for example, the CellDataFeatures classes belonging toTableColumnandTreeTableColumnfor more information).- Parameters:
- index- The index of the item (of type S) for which an ObservableValue<T> is sought.
- Returns:
- An ObservableValue<T> for this specific table column.
 
- 
getCellObservableValueAttempts 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 aCellDataFeatures(see, for example, the CellDataFeatures classes belonging toTableColumnandTreeTableColumnfor more information).- Parameters:
- item- The item (of type S) for which an ObservableValue<T> is sought.
- Returns:
- An ObservableValue<T> for this specific table column.
 
- 
buildEventDispatchChainConstruct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at thisEventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add anEventDispatcherfor 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. - Specified by:
- buildEventDispatchChainin interface- EventTarget
- Parameters:
- tail- the initial chain to build from
- Returns:
- the resulting event dispatch chain for this target
 
- 
addEventHandlerpublic <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<E> eventHandler)Registers an event handler to this table column. The TableColumnBase class allows registration of listeners which will be notified when editing occurs. Note however that TableColumnBase is not a Node, and therefore no visual events will be fired on it.- Type Parameters:
- E- The type of event
- Parameters:
- eventType- the type of the events to receive by the handler
- eventHandler- the handler to register
- Throws:
- NullPointerException- if the event type or handler is null
 
- 
removeEventHandlerpublic <E extends Event> void removeEventHandler(EventType<E> eventType, EventHandler<E> eventHandler)Unregisters a previously registered event handler from this table column. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.- Type Parameters:
- E- The type of event
- Parameters:
- eventType- the event type from which to unregister
- eventHandler- the handler to unregister
- Throws:
- NullPointerException- if the event type or handler is null
 
- 
getPseudoClassStatesReturn the pseudo-class state of this Styleable. CSS assumes this set is read-only.- Specified by:
- getPseudoClassStatesin interface- Styleable
- Returns:
- the pseudo-class state
 
 
-