TableColumnBase

java.lang.Object
- javafx.scene.control.TableColumnBase<S,T>

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.

Direct Known Subclasses:

TableColumn, TreeTableColumn
```
public abstract class TableColumnBase<S,T>
extends java.lang.Object
```
Table-like controls (such as 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/maxWidth and width properties)
- Have its visibility toggled
- Display header text
- Display any nested columns it may contain
- Have a context menu when the user right-clicks the column header area
- Have the contents of the table be sorted (using comparator, sortable and sortType).
When instantiating a concrete subclass of TableColumnBase, perhaps the two most important properties to set are the column 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 Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`<any>`	`comparator` Comparator function used when sorting this table column.
`<any>`	`contextMenu` This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
`BooleanProperty`	`editable` Specifies whether this table column allows editing.
`<any>`	`graphic` The graphic to show in the table column to allow the user to indicate graphically what is in the column.
`StringProperty`	`id` The id of this TableColumnBase.
`DoubleProperty`	`maxWidth` The maximum width the table column is permitted to be resized to.
`DoubleProperty`	`minWidth` The minimum width the table column is permitted to be resized to.
`<any>`	`parentColumn` This read-only property will always refer to the parent of this column, in the situation where nested columns are being used.
`DoubleProperty`	`prefWidth` The preferred width of the TableColumn.
`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).
`BooleanProperty`	`resizable` Used to indicate whether the width of this column can change.
`BooleanProperty`	`sortable` A boolean property to toggle on and off the 'sortability' of this column.
`<any>`	`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.
`StringProperty`	`style` A string representation of the CSS style associated with this TableColumnBase instance.
`StringProperty`	`text` This is the text to show in the header for this column.
`BooleanProperty`	`visible` Toggling this will immediately toggle the visibility of this column, and all children columns.
`ReadOnlyDoubleProperty`	`width` The width of this column.

Field Summary

Fields
Modifier and Type	Field and Description
`private <any>`	`comparator` Comparator function used when sorting this table column.
`private <any>`	`contextMenu` This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
`static java.util.Comparator`	`DEFAULT_COMPARATOR` By default all columns will use this comparator to perform sorting.
`(package private) static double`	`DEFAULT_MAX_WIDTH`
`(package private) static double`	`DEFAULT_MIN_WIDTH`
`(package private) static double`	`DEFAULT_WIDTH` * Static properties and methods * *
`private BooleanProperty`	`editable` Specifies whether this table column allows editing.
`(package private) EventHandlerManager`	`eventHandlerManager` * Instance Variables * *
`private <any>`	`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 <any>`	`parentColumn` This read-only property will always refer to the parent of this column, in the situation where nested columns are being used.
`private DoubleProperty`	`prefWidth`
`private <any>`	`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 <any>`	`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 <any>`	`styleClass`
`private StringProperty`	`text` This is the text to show in the header for this column.
`private static java.lang.Object`	`USER_DATA_KEY`
`private BooleanProperty`	`visible` Toggling this will immediately toggle the visibility of this column, and all children columns.
`private ReadOnlyDoubleWrapper`	`width`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TableColumnBase()` Creates a default TableColumn with default cell factory, comparator, and onEditCommit implementation.
`protected`	`TableColumnBase(java.lang.String text)` Creates a TableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`<E extends Event> void`	`addEventHandler(<any> eventType, <any> eventHandler)` Registers an event handler to this table column.
`EventDispatchChain`	`buildEventDispatchChain(EventDispatchChain tail)`
`<any>`	`comparatorProperty()` Comparator function used when sorting this table column.
`<any>`	`contextMenuProperty()` This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
`(package private) void`	`doSetWidth(double width)` * Private Implementation * *
`BooleanProperty`	`editableProperty()` Specifies whether this table column allows editing.
`T`	`getCellData(int index)` Returns the actual value for a cell at a given row index (and which belongs to this table column).
`T`	`getCellData(S item)` Returns the actual value for a cell from the given item.
`abstract <any>`	`getCellObservableValue(int index)` Attempts to return an ObservableValue<T> for the item in the given index (which is of type S).
`abstract <any>`	`getCellObservableValue(S item)` Attempts to return an ObservableValue<T> for the given item (which is of type S).
`abstract <any>`	`getColumns()` This enables support for nested columns, which can be useful to group together related data.
`java.util.Comparator<T>`	`getComparator()` Gets the value of the property comparator.
`ContextMenu`	`getContextMenu()` Gets the value of the property contextMenu.
`Node`	`getGraphic()` Gets the value of the property graphic.
`java.lang.String`	`getId()` Gets the value of the property id.
`double`	`getMaxWidth()` Gets the value of the property maxWidth.
`double`	`getMinWidth()` Gets the value of the property minWidth.
`TableColumnBase<S,?>`	`getParentColumn()` Gets the value of the property parentColumn.
`double`	`getPrefWidth()` Gets the value of the property prefWidth.
`<any>`	`getProperties()` Returns an observable map of properties on this table column for use primarily by application developers.
`<any>`	`getPseudoClassStates()`
`Node`	`getSortNode()` Gets the value of the property sortNode.
`java.lang.String`	`getStyle()` Gets the value of the property style.
`<any>`	`getStyleClass()` A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.
`java.lang.String`	`getText()` Gets the value of the property text.
`java.lang.Object`	`getUserData()` Returns a previously set Object property, or null if no such property has been set using the `setUserData(java.lang.Object)` method.
`double`	`getWidth()` Gets the value of the property width.
`<any>`	`graphicProperty()` The graphic to show in the table column to allow the user to indicate graphically what is in the column.
`boolean`	`hasProperties()` Tests if this table column has properties.
`StringProperty`	`idProperty()` The id of this TableColumnBase.
`boolean`	`isEditable()` Gets the value of the property editable.
`boolean`	`isReorderable()` Gets the value of the property reorderable.
`boolean`	`isResizable()` Gets the value of the property resizable.
`boolean`	`isSortable()` Gets the value of the property sortable.
`boolean`	`isVisible()` Gets the value of the property visible.
`DoubleProperty`	`maxWidthProperty()` The maximum width the table column is permitted to be resized to.
`DoubleProperty`	`minWidthProperty()` The minimum width the table column is permitted to be resized to.
`<any>`	`parentColumnProperty()` This read-only property will always refer to the parent of this column, in the situation where nested columns are being used.
`private <any>`	`parentColumnPropertyImpl()`
`DoubleProperty`	`prefWidthProperty()` The preferred width of the TableColumn.
`<E extends Event> void`	`removeEventHandler(<any> eventType, <any> eventHandler)` Unregisters a previously registered event handler from this table column.
`BooleanProperty`	`reorderableProperty()` 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).
`BooleanProperty`	`resizableProperty()` Used to indicate whether the width of this column can change.
`void`	`setComparator(java.util.Comparator<T> value)` Sets the value of the property comparator.
`void`	`setContextMenu(ContextMenu value)` Sets the value of the property contextMenu.
`void`	`setEditable(boolean value)` Sets the value of the property editable.
`void`	`setGraphic(Node value)` Sets the value of the property graphic.
`void`	`setId(java.lang.String value)` Sets the value of the property id.
`void`	`setMaxWidth(double value)` Sets the value of the property maxWidth.
`void`	`setMinWidth(double value)` Sets the value of the property minWidth.
`(package private) void`	`setParentColumn(TableColumnBase<S,?> value)`
`void`	`setPrefWidth(double value)` Sets the value of the property prefWidth.
`void`	`setReorderable(boolean value)` Sets the value of the property reorderable.
`void`	`setResizable(boolean value)` Sets the value of the property resizable.
`void`	`setSortable(boolean value)` Sets the value of the property sortable.
`void`	`setSortNode(Node value)` Sets the value of the property sortNode.
`void`	`setStyle(java.lang.String value)` Sets the value of the property style.
`void`	`setText(java.lang.String value)` Sets the value of the property text.
`void`	`setUserData(java.lang.Object value)` Convenience method for setting a single Object property that can be retrieved at a later date.
`void`	`setVisible(boolean value)` Sets the value of the property visible.
`(package private) void`	`setWidth(double value)`
`BooleanProperty`	`sortableProperty()` A boolean property to toggle on and off the 'sortability' of this column.
`<any>`	`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.
`StringProperty`	`styleProperty()` A string representation of the CSS style associated with this TableColumnBase instance.
`StringProperty`	`textProperty()` This is the text to show in the header for this column.
`(package private) void`	`updateColumnWidths()`
`BooleanProperty`	`visibleProperty()` Toggling this will immediately toggle the visibility of this column, and all children columns.
`ReadOnlyDoubleProperty`	`widthProperty()` The width of this column.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - text
```
public final StringProperty textProperty
```
    This is the text to show in the header for this column.
    
    See Also:
    
    getText(), setText(String)
  - visible
```
public final BooleanProperty visibleProperty
```
    Toggling this will immediately toggle the visibility of this column, and all children columns.
    
    See Also:
    
    isVisible(), setVisible(boolean)
  - parentColumn
```
public final <any> parentColumnProperty
```
    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() and TreeTableColumn.getColumns().
    
    See Also:
    
    getParentColumn()
  - contextMenu
```
public final <any> contextMenuProperty
```
    This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
    
    See Also:
    
    getContextMenu(), setContextMenu(ContextMenu)
  - id
```
public final StringProperty idProperty
```
    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.
    
    See Also:
    
    getId(), setId(String)
  - style
```
public final StringProperty styleProperty
```
    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.
    
    See Also:
    
    getStyle(), setStyle(String)
  - graphic
```
public final <any> graphicProperty
```
    The graphic to show in the table column to allow the user to indicate graphically what is in the column.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - sortNode
```
public final <any> 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. 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.
    
    See Also:
    
    getSortNode(), setSortNode(Node)
  - width
```
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.
    
    See Also:
    
    getWidth()
  - minWidth
```
public final DoubleProperty minWidthProperty
```
    The minimum width the table column is permitted to be resized to.
    
    See Also:
    
    getMinWidth(), setMinWidth(double)
  - prefWidth
```
public final DoubleProperty prefWidthProperty
```
    The preferred width of the TableColumn.
    
    See Also:
    
    getPrefWidth(), setPrefWidth(double)
  - maxWidth
```
public final DoubleProperty maxWidthProperty
```
    The maximum width the table column is permitted to be resized to.
    
    See Also:
    
    getMaxWidth(), setMaxWidth(double)
  - resizable
```
public final BooleanProperty resizableProperty
```
    Used 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)
  - sortable
```
public final BooleanProperty sortableProperty
```
    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.
    
    See Also:
    
    isSortable(), setSortable(boolean)
  - reorderable
```
public final BooleanProperty reorderableProperty
```
    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
    
    See Also:
    
    isReorderable(), setReorderable(boolean)
  - comparator
```
public final <any> comparatorProperty
```
    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.
    
    See Also:
    
    getComparator(), setComparator(Comparator)
  - editable
```
public final BooleanProperty editableProperty
```
    Specifies whether this table column allows editing. This, unlike TableView.editableProperty() and TreeTableView.editableProperty(), is true by default.
    
    See Also:
    
    isEditable(), setEditable(boolean)
- Field Detail
  - DEFAULT_WIDTH
```
static final double DEFAULT_WIDTH
```
    * Static properties and methods * *
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MIN_WIDTH
```
static final double DEFAULT_MIN_WIDTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_WIDTH
```
static final double DEFAULT_MAX_WIDTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_COMPARATOR
```
public static final java.util.Comparator 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).
  - eventHandlerManager
```
final EventHandlerManager eventHandlerManager
```
    * Instance Variables * *
  - text
```
private StringProperty text
```
    This is the text to show in the header for this column.
  - visible
```
private BooleanProperty visible
```
    Toggling this will immediately toggle the visibility of this column, and all children columns.
  - parentColumn
```
private <any> 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 TableColumn.getColumns() and TreeTableColumn.getColumns().
  - contextMenu
```
private <any> contextMenu
```
    This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
  - id
```
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.
  - style
```
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.
  - styleClass
```
private final <any> styleClass
```
  - graphic
```
private <any> graphic
```
    The graphic to show in the table column to allow the user to indicate graphically what is in the column.
  - sortNode
```
private <any> 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.
  - width
```
private ReadOnlyDoubleWrapper width
```
  - minWidth
```
private DoubleProperty minWidth
```
    The minimum width the table column is permitted to be resized to.
  - prefWidth
```
private final DoubleProperty prefWidth
```
  - maxWidth
```
private DoubleProperty maxWidth
```
  - resizable
```
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
```
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.
  - reorderable
```
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
  - comparator
```
private <any> 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.
  - editable
```
private BooleanProperty editable
```
    Specifies whether this table column allows editing. This, unlike TableView.editableProperty() and TreeTableView.editableProperty(), is true by default.
  - USER_DATA_KEY
```
private static final java.lang.Object USER_DATA_KEY
```
  - properties
```
private <any> properties
```
- Constructor Detail
  - TableColumnBase
```
protected TableColumnBase()
```
    Creates a default TableColumn with default cell factory, comparator, and onEditCommit implementation.
  - TableColumnBase
```
protected TableColumnBase(java.lang.String text)
```
    Creates 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 Detail
  - textProperty
```
public final StringProperty textProperty()
```
    This is the text to show in the header for this column.
    
    See Also:
    
    getText(), setText(String)
  - setText
```
public final void setText(java.lang.String value)
```
    Sets the value of the property text.
  - getText
```
public final java.lang.String getText()
```
    Gets the value of the property text.
  - setVisible
```
public final void setVisible(boolean value)
```
    Sets the value of the property visible.
  - isVisible
```
public final boolean isVisible()
```
    Gets the value of the property visible.
  - visibleProperty
```
public final BooleanProperty visibleProperty()
```
    Toggling this will immediately toggle the visibility of this column, and all children columns.
    
    See Also:
    
    isVisible(), setVisible(boolean)
  - setParentColumn
```
void setParentColumn(TableColumnBase<S,?> value)
```
  - getParentColumn
```
public final TableColumnBase<S,?> getParentColumn()
```
    Gets the value of the property parentColumn.
  - parentColumnProperty
```
public final <any> parentColumnProperty()
```
    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() and TreeTableColumn.getColumns().
    
    See Also:
    
    getParentColumn()
  - parentColumnPropertyImpl
```
private <any> parentColumnPropertyImpl()
```
  - setContextMenu
```
public final void setContextMenu(ContextMenu value)
```
    Sets the value of the property contextMenu.
  - getContextMenu
```
public final ContextMenu getContextMenu()
```
    Gets the value of the property contextMenu.
  - contextMenuProperty
```
public final <any> contextMenuProperty()
```
    This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
    
    See Also:
    
    getContextMenu(), setContextMenu(ContextMenu)
  - setId
```
public final void setId(java.lang.String value)
```
    Sets the value of the property id.
  - getId
```
public final java.lang.String getId()
```
    Gets the value of the property id.
  - idProperty
```
public final StringProperty idProperty()
```
    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.
    
    See Also:
    
    getId(), setId(String)
  - setStyle
```
public final void setStyle(java.lang.String value)
```
    Sets the value of the property style.
  - getStyle
```
public final java.lang.String getStyle()
```
    Gets the value of the property style.
  - styleProperty
```
public final StringProperty styleProperty()
```
    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.
    
    See Also:
    
    getStyle(), setStyle(String)
  - getStyleClass
```
public <any> 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.
    
    See Also:
    
    CSS3 class selectors
  - setGraphic
```
public final void setGraphic(Node value)
```
    Sets the value of the property graphic.
  - getGraphic
```
public final Node getGraphic()
```
    Gets the value of the property graphic.
  - graphicProperty
```
public final <any> graphicProperty()
```
    The graphic to show in the table column to allow the user to indicate graphically what is in the column.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - setSortNode
```
public final void setSortNode(Node value)
```
    Sets the value of the property sortNode.
  - getSortNode
```
public final Node getSortNode()
```
    Gets the value of the property sortNode.
  - sortNodeProperty
```
public final <any> 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. 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.
    
    See Also:
    
    getSortNode(), setSortNode(Node)
  - widthProperty
```
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.
    
    See Also:
    
    getWidth()
  - getWidth
```
public final double getWidth()
```
    Gets the value of the property width.
  - setWidth
```
void setWidth(double value)
```
  - setMinWidth
```
public final void setMinWidth(double value)
```
    Sets the value of the property minWidth.
  - getMinWidth
```
public final double getMinWidth()
```
    Gets the value of the property minWidth.
  - minWidthProperty
```
public final DoubleProperty minWidthProperty()
```
    The minimum width the table column is permitted to be resized to.
    
    See Also:
    
    getMinWidth(), setMinWidth(double)
  - prefWidthProperty
```
public final DoubleProperty prefWidthProperty()
```
    The preferred width of the TableColumn.
    
    See Also:
    
    getPrefWidth(), setPrefWidth(double)
  - setPrefWidth
```
public final void setPrefWidth(double value)
```
    Sets the value of the property prefWidth.
  - getPrefWidth
```
public final double getPrefWidth()
```
    Gets the value of the property prefWidth.
  - maxWidthProperty
```
public final DoubleProperty maxWidthProperty()
```
    The maximum width the table column is permitted to be resized to.
    
    See Also:
    
    getMaxWidth(), setMaxWidth(double)
  - setMaxWidth
```
public final void setMaxWidth(double value)
```
    Sets the value of the property maxWidth.
  - getMaxWidth
```
public final double getMaxWidth()
```
    Gets the value of the property maxWidth.
  - resizableProperty
```
public final BooleanProperty resizableProperty()
```
    Used 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)
  - setResizable
```
public final void setResizable(boolean value)
```
    Sets the value of the property resizable.
  - isResizable
```
public final boolean isResizable()
```
    Gets the value of the property resizable.
  - sortableProperty
```
public final BooleanProperty sortableProperty()
```
    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.
    
    See Also:
    
    isSortable(), setSortable(boolean)
  - setSortable
```
public final void setSortable(boolean value)
```
    Sets the value of the property sortable.
  - isSortable
```
public final boolean isSortable()
```
    Gets the value of the property sortable.
  - reorderableProperty
```
public final BooleanProperty reorderableProperty()
```
    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
    
    See Also:
    
    isReorderable(), setReorderable(boolean)
  - setReorderable
```
public final void setReorderable(boolean value)
```
    Sets the value of the property reorderable.
    
    Since:
    
    9
  - isReorderable
```
public final boolean isReorderable()
```
    Gets the value of the property reorderable.
    
    Since:
    
    9
  - comparatorProperty
```
public final <any> comparatorProperty()
```
    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.
    
    See Also:
    
    getComparator(), setComparator(Comparator)
  - setComparator
```
public final void setComparator(java.util.Comparator<T> value)
```
    Sets the value of the property comparator.
  - getComparator
```
public final java.util.Comparator<T> getComparator()
```
    Gets the value of the property comparator.
  - setEditable
```
public final void setEditable(boolean value)
```
    Sets the value of the property editable.
  - isEditable
```
public final boolean isEditable()
```
    Gets the value of the property editable.
  - editableProperty
```
public final BooleanProperty editableProperty()
```
    Specifies whether this table column allows editing. This, unlike TableView.editableProperty() and TreeTableView.editableProperty(), is true by default.
    
    See Also:
    
    isEditable(), setEditable(boolean)
  - getProperties
```
public final <any> getProperties()
```
    Returns 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
  - hasProperties
```
public boolean hasProperties()
```
    Tests if this table column has properties.
    
    Returns:
    
    true if node has properties.
  - setUserData
```
public void setUserData(java.lang.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 getUserData().
    
    Parameters:
    
    value - The value to be stored - this can later be retrieved by calling getUserData().
  - getUserData
```
public java.lang.Object getUserData()
```
    Returns a previously set Object property, or null if no such property has been set using the setUserData(java.lang.Object) method.
    
    Returns:
    
    The Object that was previously set, or null if no property has been set or if null was set.
  - getColumns
```
public abstract <any> 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:
    
    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.
  - getCellData
```
public final T getCellData(int index)
```
    Returns 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.
  - getCellData
```
public final T getCellData(S item)
```
    Returns 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.
  - getCellObservableValue
```
public abstract <any> 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 - The index of the item (of type S) for which an ObservableValue<T> is sought.
    
    Returns:
    
    An ObservableValue<T> for this specific table column.
  - getCellObservableValue
```
public abstract <any> 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 - The item (of type S) for which an ObservableValue<T> is sought.
    
    Returns:
    
    An ObservableValue<T> for this specific table column.
  - buildEventDispatchChain
```
public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)
```
  - addEventHandler
```
public <E extends Event> void addEventHandler(<any> eventType,
                                              <any> 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:
    
    java.lang.NullPointerException - if the event type or handler is null
  - removeEventHandler
```
public <E extends Event> void removeEventHandler(<any> eventType,
                                                 <any> 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:
    
    java.lang.NullPointerException - if the event type or handler is null
  - doSetWidth
```
void doSetWidth(double width)
```
    * Private Implementation * *
  - updateColumnWidths
```
void updateColumnWidths()
```
  - getPseudoClassStates
```
public final <any> getPseudoClassStates()
```

Class TableColumnBase<S,T>

Property Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

text

visible

parentColumn

contextMenu

id

style

graphic

sortNode

width

minWidth

prefWidth

maxWidth

resizable

sortable

reorderable

comparator

editable

Field Detail

DEFAULT_WIDTH

DEFAULT_MIN_WIDTH

DEFAULT_MAX_WIDTH

DEFAULT_COMPARATOR

eventHandlerManager

text

visible

parentColumn

contextMenu

id

style

styleClass

graphic

sortNode

width

minWidth

prefWidth

maxWidth

resizable

sortable

reorderable

comparator

editable

USER_DATA_KEY

properties

Constructor Detail

TableColumnBase

TableColumnBase

Method Detail

textProperty

setText

getText

setVisible

isVisible

visibleProperty

setParentColumn

getParentColumn

parentColumnProperty

parentColumnPropertyImpl

setContextMenu

getContextMenu

contextMenuProperty

setId

getId

idProperty

setStyle

getStyle

styleProperty

getStyleClass

setGraphic

getGraphic

graphicProperty

setSortNode

getSortNode

sortNodeProperty