TableHeaderRow

java.lang.Object
- StackPane
- - javafx.scene.control.skin.TableHeaderRow

```
public class TableHeaderRow
extends StackPane
```
Region responsible for painting the entire row of column headers.

Since:

9

See Also:

javafx.scene.control.TableView, TableViewSkin, javafx.scene.control.TreeTableView, TreeTableViewSkin

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`(package private) BooleanProperty`	`reordering` * Properties * *
`private <any>`	`rootHeader`

Field Summary

Fields
Modifier and Type	Field and Description
`private Rectangle`	`clip`
`(package private) boolean`	`columnDragLock` There are two different mouse dragged event handlers in the header code.
`private java.util.Map<TableColumnBase,CheckMenuItem>`	`columnMenuItems`
`private ContextMenu`	`columnPopupMenu` PopupMenu shown to users to allow for them to hide/show columns in the table.
`private InvalidationListener`	`columnTextListener`
`private Pane`	`cornerRegion` This is the region where the user can interact with to show/hide columns.
`private StackPane`	`dragHeader` This is the ghosted region representing the table column that is being dragged.
`private Label`	`dragHeaderLabel`
`private Region`	`filler`
`private VirtualFlow`	`flow`
`private java.lang.String`	`MENU_SEPARATOR` * Private Fields * *
`private BooleanProperty`	`reordering` * Properties * *
`private TableColumnHeader`	`reorderingRegion`
`private <any>`	`rootHeader`
`private double`	`scrollX`
`private ListChangeListener`	`tableColumnsListener`
`private InvalidationListener`	`tablePaddingListener`
`(package private) TableViewSkinBase<?,?,?,?,?>`	`tableSkin`
`private double`	`tableWidth`
`private InvalidationListener`	`tableWidthListener` * Listeners * *
`private ListChangeListener`	`visibleLeafColumnsListener`
`private WeakInvalidationListener`	`weakColumnTextListener`
`private WeakListChangeListener`	`weakTableColumnsListener`
`private WeakInvalidationListener`	`weakTablePaddingListener`
`private WeakInvalidationListener`	`weakTableWidthListener`
`private WeakListChangeListener`	`weakVisibleLeafColumnsListener`

Constructor Summary

Constructors
Constructor and Description
`TableHeaderRow(TableViewSkinBase skin)` Creates a new TableHeaderRow instance to visually represent the column header area of controls such as `javafx.scene.control.TableView` and `javafx.scene.control.TreeTableView`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected double`	`computeMinHeight(double width)`
`protected double`	`computePrefHeight(double width)`
`protected double`	`computePrefWidth(double height)`
`private void`	`createMenuItem(<any> col)`
`protected NestedTableColumnHeader`	`createRootHeader()` Creates a new NestedTableColumnHeader instance.
`(package private) TableColumnHeader`	`getColumnHeaderFor(<any> col)`
`private TableColumnHeader`	`getColumnHeaderFor(<any> col, TableColumnHeader currentHeader)`
`private java.util.List<<any>>`	`getLeafColumns(<any> col)`
`(package private) TableColumnHeader`	`getReorderingRegion()` * Private Implementation * *
`(package private) NestedTableColumnHeader`	`getRootHeader()`
`private java.lang.String`	`getText(java.lang.String text, TableColumnBase col)`
`private boolean`	`isColumnVisibleInHeader(TableColumnBase col, java.util.List columns)`
`(package private) boolean`	`isReordering()`
`protected void`	`layoutChildren()`
`private void`	`rebuildColumnMenu()`
`private void`	`remove(<any> col)`
`(package private) BooleanProperty`	`reorderingProperty()` * Properties * *
`private <any>`	`rootHeaderProperty()`
`(package private) void`	`setDragHeaderX(double dragHeaderX)`
`(package private) void`	`setReordering(boolean value)`
`(package private) void`	`setReorderingColumn(TableColumnBase rc)`
`(package private) void`	`setReorderingRegion(TableColumnHeader reorderingRegion)`
`private void`	`setRootHeader(NestedTableColumnHeader value)`
`(package private) void`	`updateScrollX()`
`private void`	`updateTableColumnListeners(java.util.List<? extends <any>> added, java.util.List<? extends <any>> removed)`
`private void`	`updateTableWidth()`

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

- Property Detail
  - reordering
```
final BooleanProperty reorderingProperty
```
    * Properties * *
  - rootHeader
```
private final <any> rootHeaderProperty
```
- Field Detail
  - MENU_SEPARATOR
```
private final java.lang.String MENU_SEPARATOR
```
    * Private Fields * *
  - flow
```
private final VirtualFlow flow
```
  - tableSkin
```
final TableViewSkinBase<?,?,?,?,?> tableSkin
```
  - columnMenuItems
```
private java.util.Map<TableColumnBase,CheckMenuItem> columnMenuItems
```
  - scrollX
```
private double scrollX
```
  - tableWidth
```
private double tableWidth
```
  - clip
```
private Rectangle clip
```
  - reorderingRegion
```
private TableColumnHeader reorderingRegion
```
  - dragHeader
```
private StackPane dragHeader
```
    This is the ghosted region representing the table column that is being dragged. It moves along the x-axis but is fixed in the y-axis.
  - dragHeaderLabel
```
private final Label dragHeaderLabel
```
  - filler
```
private Region filler
```
  - cornerRegion
```
private Pane cornerRegion
```
    This is the region where the user can interact with to show/hide columns. It is positioned in the top-right hand corner of the TableHeaderRow, and when clicked shows a PopupMenu consisting of all leaf columns.
  - columnPopupMenu
```
private ContextMenu columnPopupMenu
```
    PopupMenu shown to users to allow for them to hide/show columns in the table.
  - columnDragLock
```
boolean columnDragLock
```
    There are two different mouse dragged event handlers in the header code. Firstly, the column reordering functionality, and secondly, the column resizing functionality. Because these are handled in separate classes and with separate event handlers, we occasionally run into the issue where both event handlers were being called, resulting in bad UX. To remove this issue, we lock when the column dragging happens, and prevent resize operations from taking place.
  - tableWidthListener
```
private InvalidationListener tableWidthListener
```
    * Listeners * *
  - tablePaddingListener
```
private InvalidationListener tablePaddingListener
```
  - visibleLeafColumnsListener
```
private ListChangeListener visibleLeafColumnsListener
```
  - tableColumnsListener
```
private final ListChangeListener tableColumnsListener
```
  - columnTextListener
```
private final InvalidationListener columnTextListener
```
  - weakTableWidthListener
```
private final WeakInvalidationListener weakTableWidthListener
```
  - weakTablePaddingListener
```
private final WeakInvalidationListener weakTablePaddingListener
```
  - weakVisibleLeafColumnsListener
```
private final WeakListChangeListener weakVisibleLeafColumnsListener
```
  - weakTableColumnsListener
```
private final WeakListChangeListener weakTableColumnsListener
```
  - weakColumnTextListener
```
private final WeakInvalidationListener weakColumnTextListener
```
  - reordering
```
private BooleanProperty reordering
```
    * Properties * *
  - rootHeader
```
private <any> rootHeader
```
- Constructor Detail
  - TableHeaderRow
```
public TableHeaderRow(TableViewSkinBase skin)
```
    Creates a new TableHeaderRow instance to visually represent the column header area of controls such as javafx.scene.control.TableView and javafx.scene.control.TreeTableView.
    
    Parameters:
    
    skin - The skin used by the UI control.
- Method Detail
  - setReordering
```
final void setReordering(boolean value)
```
  - isReordering
```
final boolean isReordering()
```
  - reorderingProperty
```
final BooleanProperty reorderingProperty()
```
    * Properties * *
  - rootHeaderProperty
```
private final <any> rootHeaderProperty()
```
  - getRootHeader
```
final NestedTableColumnHeader getRootHeader()
```
  - setRootHeader
```
private final void setRootHeader(NestedTableColumnHeader value)
```
  - layoutChildren
```
protected void layoutChildren()
```
  - computePrefWidth
```
protected double computePrefWidth(double height)
```
  - computeMinHeight
```
protected double computeMinHeight(double width)
```
  - computePrefHeight
```
protected double computePrefHeight(double width)
```
  - updateScrollX
```
void updateScrollX()
```
  - updateTableWidth
```
private void updateTableWidth()
```
  - createRootHeader
```
protected NestedTableColumnHeader createRootHeader()
```
    Creates a new NestedTableColumnHeader instance. By default this method should not be overridden, but in some circumstances it makes sense (e.g. testing, or when extreme customization is desired).
    
    Returns:
    
    A new NestedTableColumnHeader instance.
  - getReorderingRegion
```
TableColumnHeader getReorderingRegion()
```
    * Private Implementation * *
  - setReorderingColumn
```
void setReorderingColumn(TableColumnBase rc)
```
  - setReorderingRegion
```
void setReorderingRegion(TableColumnHeader reorderingRegion)
```
  - setDragHeaderX
```
void setDragHeaderX(double dragHeaderX)
```
  - getColumnHeaderFor
```
TableColumnHeader getColumnHeaderFor(<any> col)
```
  - getColumnHeaderFor
```
private TableColumnHeader getColumnHeaderFor(<any> col,
                                             TableColumnHeader currentHeader)
```
  - updateTableColumnListeners
```
private void updateTableColumnListeners(java.util.List<? extends <any>> added,
                                        java.util.List<? extends <any>> removed)
```
  - remove
```
private void remove(<any> col)
```
  - rebuildColumnMenu
```
private void rebuildColumnMenu()
```
  - getLeafColumns
```
private java.util.List<<any>> getLeafColumns(<any> col)
```
  - createMenuItem
```
private void createMenuItem(<any> col)
```
  - getText
```
private java.lang.String getText(java.lang.String text,
                                 TableColumnBase col)
```
  - isColumnVisibleInHeader
```
private boolean isColumnVisibleInHeader(TableColumnBase col,
                                        java.util.List columns)
```

Class TableHeaderRow

Property Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

reordering

rootHeader

Field Detail

MENU_SEPARATOR

flow

tableSkin

columnMenuItems

scrollX

tableWidth

clip

reorderingRegion

dragHeader

dragHeaderLabel

filler

cornerRegion

columnPopupMenu

columnDragLock

tableWidthListener

tablePaddingListener

visibleLeafColumnsListener

tableColumnsListener

columnTextListener

weakTableWidthListener

weakTablePaddingListener

weakVisibleLeafColumnsListener

weakTableColumnsListener

weakColumnTextListener

reordering

rootHeader

Constructor Detail

TableHeaderRow

Method Detail

setReordering

isReordering

reorderingProperty

rootHeaderProperty

getRootHeader

setRootHeader

layoutChildren

computePrefWidth

computeMinHeight

computePrefHeight

updateScrollX

updateTableWidth

createRootHeader

getReorderingRegion

setReorderingColumn

setReorderingRegion

setDragHeaderX

getColumnHeaderFor

getColumnHeaderFor

updateTableColumnListeners

remove

rebuildColumnMenu

getLeafColumns

createMenuItem

getText

isColumnVisibleInHeader