javafx.scene.control.skin

Class TableViewSkinBase<M,S,C extends Control,I extends <any>,TC extends <any>>

java.lang.Object

<any>

javafx.scene.control.skin.VirtualContainerBase<C,I>

javafx.scene.control.skin.TableViewSkinBase<M,S,C,I,TC>

Type Parameters:

M - The type of the item stored in each row (for TableView, this is the type of the items list, and for TreeTableView, this is the type of the TreeItem).

S - The type of the item, as represented by the selection model (for TableView, this is, again, the type of the items list, and for TreeTableView, this is TreeItem typed to the same type as M).

C - The type of the virtualised control (e.g TableView, TreeTableView)

I - The type of cell used by this virtualised control (e.g. TableRow, TreeTableRow)

TC - The type of TableColumnBase used by this virtualised control (e.g. TableColumn, TreeTableColumn)

Direct Known Subclasses:

TableViewSkin, TreeTableViewSkin

public abstract class TableViewSkinBase<M,S,C extends Control,I extends <any>,TC extends <any>>
extends VirtualContainerBase<C,I>

TableViewSkinBase is the base skin class used by controls such as javafx.scene.control.TableView and javafx.scene.control.TreeTableView (the concrete classes are TableViewSkin and TreeTableViewSkin, respectively).

Since:

9

See Also:

TableView, TreeTableView, TableViewSkin, TreeTableViewSkin

Field Summary

Fields

Modifier and Type	Field and Description
private Region	columnReorderLine This region is used to overlay atop the table when the user is performing a column resize operation or a column reordering operation.
private Region	columnReorderOverlay A region which is resized and positioned such that it perfectly matches the dimensions of any TableColumn that is being reordered by the user.
private boolean	contentWidthDirty
private java.lang.String	EMPTY_TABLE_TEXT * Internal Fields * *
(package private) VirtualFlow<I>	flow
private static double	GOLDEN_RATIO_MULTIPLIER * Static Fields * *
private static boolean	IS_PANNABLE
private int	itemCount
private InvalidationListener	itemsChangeListener
(package private) boolean	needCellsReconfigured
(package private) boolean	needCellsRecreated
private java.lang.String	NO_COLUMNS_TEXT
private Label	placeholderLabel
private StackPane	placeholderRegion Region placed over the top of the flow (and possibly the header row) if there is no data and/or there are no columns specified.
private <any>	propertiesMapListener * Listeners * *
private <any>	rowCountListener
private <any>	rowFactory
private TableHeaderRow	tableHeaderRow The entire header region for all columns.
private int	visibleColCount
private <any>	visibleLeafColumnsListener
private WeakInvalidationListener	weakItemsChangeListener
private <any>	weakRowCountListener
private <any>	weakVisibleLeafColumnsListener
private WeakInvalidationListener	weakWidthListener
private InvalidationListener	widthListener

Constructor Summary

Constructors

Constructor and Description
TableViewSkinBase(C control)

Method Summary

Modifier and Type	Method and Description
private void	checkContentWidthState()
protected double	computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
protected double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)
protected TableHeaderRow	createTableHeaderRow() Creates a new TableHeaderRow instance.
void	dispose()
(package private) Region	getColumnReorderLine()
private <any>	getFocusedCell()
private <any>	getFocusModel()
private <any>	getSelectionModel()
(package private) TableHeaderRow	getTableHeaderRow() * Private implementation * *
private <any>	getVisibleLeafColumns()
(package private) void	horizontalScroll()
private boolean	isCellFocused(int row)
private boolean	isCellSelected(int row)
private boolean	isLeadIndex(boolean isFocusDriven, int index)
protected void	layoutChildren(double x, double y, double w, double h)
(package private) void	onFocusNextCell()
(package private) void	onFocusPreviousCell()
(package private) void	onMoveToFirstCell()
(package private) void	onMoveToLastCell()
(package private) int	onScrollPageDown(boolean isFocusDriven) Function used to scroll the container down by one 'page', although if this is a horizontal container, then the scrolling will be to the right.
(package private) int	onScrollPageUp(boolean isFocusDriven) Function used to scroll the container up by one 'page', although if this is a horizontal container, then the scrolling will be to the left.
(package private) void	onSelectLeftCell()
(package private) void	onSelectNextCell()
(package private) void	onSelectPreviousCell()
(package private) void	onSelectRightCell()
protected java.lang.Object	queryAccessibleAttribute(AccessibleAttribute attribute, java.lang.Object... parameters)
private void	refreshView()
(package private) void	scrollHorizontally()
(package private) void	scrollHorizontally(TC col)
private void	updateContentWidth()
protected void	updateItemCount() This method is called when it is possible that the item count has changed (i.e.
(package private) void	updatePlaceholderRegionVisibility()
private void	updateTableItems(<any> oldList, <any> newList)
private void	updateVisibleColumnCount() Keeps track of how many leaf columns are currently visible in this table.
private void	updateVisibleLeafColumnWidthListeners(java.util.List<? extends TC> added, java.util.List<? extends TC> removed)

Methods inherited from class javafx.scene.control.skin.VirtualContainerBase

checkState, createVirtualFlow, getItemCount, getMaxCellWidth, getVirtualFlow, getVirtualFlowPreferredHeight, markItemCountDirty, requestRebuildCells

Methods inherited from class java.lang.Object

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

Field Detail

GOLDEN_RATIO_MULTIPLIER

private static final double GOLDEN_RATIO_MULTIPLIER

* Static Fields * *

See Also:

Constant Field Values

IS_PANNABLE

private static final boolean IS_PANNABLE

EMPTY_TABLE_TEXT

private final java.lang.String EMPTY_TABLE_TEXT

* Internal Fields * *

NO_COLUMNS_TEXT

private final java.lang.String NO_COLUMNS_TEXT

flow

VirtualFlow<I extends <any>> flow

contentWidthDirty

private boolean contentWidthDirty

columnReorderLine

private Region columnReorderLine

This region is used to overlay atop the table when the user is performing a column resize operation or a column reordering operation. It is a line that runs the height of the table to indicate either the final width of of the selected column, or the position the column will be 'dropped' into when the reordering operation completes.

columnReorderOverlay

private Region columnReorderOverlay

A region which is resized and positioned such that it perfectly matches the dimensions of any TableColumn that is being reordered by the user. This is useful, for example, as a semi-transparent overlay to give feedback to the user as to which column is currently being moved.

tableHeaderRow

private TableHeaderRow tableHeaderRow

The entire header region for all columns. This header region handles column reordering and resizing. It also handles the positioning and resizing of thte columnReorderLine and columnReorderOverlay.

rowFactory

private <any> rowFactory

placeholderRegion

private StackPane placeholderRegion

Region placed over the top of the flow (and possibly the header row) if there is no data and/or there are no columns specified.

placeholderLabel

private Label placeholderLabel

visibleColCount

private int visibleColCount

needCellsRecreated

boolean needCellsRecreated

needCellsReconfigured

boolean needCellsReconfigured

itemCount

private int itemCount

propertiesMapListener

private <any> propertiesMapListener

* Listeners * *

rowCountListener

private <any> rowCountListener

visibleLeafColumnsListener

private <any> visibleLeafColumnsListener

widthListener

private InvalidationListener widthListener

itemsChangeListener

private InvalidationListener itemsChangeListener

weakRowCountListener

private <any> weakRowCountListener

weakVisibleLeafColumnsListener

private <any> weakVisibleLeafColumnsListener

weakWidthListener

private WeakInvalidationListener weakWidthListener

weakItemsChangeListener

private WeakInvalidationListener weakItemsChangeListener

Constructor Detail

TableViewSkinBase

public TableViewSkinBase(C control)

Parameters:

control - the control

Method Detail

dispose

public void dispose()

computePrefHeight

protected double computePrefHeight(double width,
                                   double topInset,
                                   double rightInset,
                                   double bottomInset,
                                   double leftInset)

computePrefWidth

protected double computePrefWidth(double height,
                                  double topInset,
                                  double rightInset,
                                  double bottomInset,
                                  double leftInset)

layoutChildren

protected void layoutChildren(double x,
                              double y,
                              double w,
                              double h)

Overrides:

layoutChildren in class VirtualContainerBase<C extends Control,I extends <any>>

createTableHeaderRow

protected TableHeaderRow createTableHeaderRow()

Creates a new TableHeaderRow 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 TableHeaderRow instance.

getTableHeaderRow

final TableHeaderRow getTableHeaderRow()

* Private implementation * *

getSelectionModel

private <any> getSelectionModel()

getFocusModel

private <any> getFocusModel()

getFocusedCell

private <any> getFocusedCell()

getVisibleLeafColumns

private <any> getVisibleLeafColumns()

updateItemCount

protected void updateItemCount()

This method is called when it is possible that the item count has changed (i.e. scrolling has occurred, the control has resized, etc). This method should recalculate the item count and store that for future use by the VirtualContainerBase.getItemCount() method.

Specified by:

updateItemCount in class VirtualContainerBase<C extends Control,I extends <any>>

checkContentWidthState

private void checkContentWidthState()

horizontalScroll

void horizontalScroll()

onFocusPreviousCell

void onFocusPreviousCell()

onFocusNextCell

void onFocusNextCell()

onSelectPreviousCell

void onSelectPreviousCell()

onSelectNextCell

void onSelectNextCell()

onSelectLeftCell

void onSelectLeftCell()

onSelectRightCell

void onSelectRightCell()

onMoveToFirstCell

void onMoveToFirstCell()

onMoveToLastCell

void onMoveToLastCell()

updateTableItems

private void updateTableItems(<any> oldList,
                              <any> newList)

getColumnReorderLine

Region getColumnReorderLine()

onScrollPageDown

int onScrollPageDown(boolean isFocusDriven)

Function used to scroll the container down by one 'page', although if this is a horizontal container, then the scrolling will be to the right.

onScrollPageUp

int onScrollPageUp(boolean isFocusDriven)

Function used to scroll the container up by one 'page', although if this is a horizontal container, then the scrolling will be to the left.

isLeadIndex

private boolean isLeadIndex(boolean isFocusDriven,
                            int index)

updateVisibleColumnCount

private void updateVisibleColumnCount()

Keeps track of how many leaf columns are currently visible in this table.

updateVisibleLeafColumnWidthListeners

private void updateVisibleLeafColumnWidthListeners(java.util.List<? extends TC> added,
                                                   java.util.List<? extends TC> removed)

updatePlaceholderRegionVisibility

final void updatePlaceholderRegionVisibility()

updateContentWidth

private void updateContentWidth()

refreshView

private void refreshView()

scrollHorizontally

void scrollHorizontally()

scrollHorizontally

void scrollHorizontally(TC col)

isCellSelected

private boolean isCellSelected(int row)

isCellFocused

private boolean isCellFocused(int row)

queryAccessibleAttribute

protected java.lang.Object queryAccessibleAttribute(AccessibleAttribute attribute,
                                                    java.lang.Object... parameters)