Top Description Fields Constructors Methods
javafx.scene.control.skin

public abstract Class TableRowSkinBase<T, C extends IndexedCell<T>, R extends IndexedCell<T>>

extends CellSkinBase<C extends IndexedCell<T>>
Class Inheritance
Known Direct Subclasses
javafx.scene.control.skin.TreeTableRowSkin, javafx.scene.control.skin.TableRowSkin
Type Parameters
<T>
The type of the cell (i.e. the generic type of the IndexedCell subclass).
<C>
The cell type (e.g. TableRow or TreeTableRow)
<R>
The type of cell that is contained within each row (e.g. javafx.scene.control.TableCell or javafx.scene.control.TreeTableCell).
Imports
java.lang.ref.Reference, .WeakReference, java.util.*, com.sun.javafx.PlatformUtil, javafx.animation.FadeTransition, javafx.beans.property.ObjectProperty, javafx.collections.ObservableList, javafx.css.StyleOrigin, .StyleableObjectProperty, javafx.geometry.Insets, .Pos, javafx.scene.Node, .Parent, javafx.scene.control.*, javafx.util.Duration, com.sun.javafx.tk.Toolkit
TableRowSkinBase is the base skin class used by controls such as javafx.scene.control.TableRow and javafx.scene.control.TreeTableRow (the concrete classes are TableRowSkin and TreeTableRowSkin, respectively).
Since
9
See Also
javafx.scene.control.TableRow, javafx.scene.control.TreeTableRow, TableRowSkin, TreeTableRowSkin

Field Summary

Modifier and TypeField and Description
pack-priv final List<R>
cells

pack-priv WeakHashMap<TableColumnBase<S, T>, Reference<R>>
cellsMap

private static final int
DEFAULT_FULL_REFRESH_COUNTER

private static boolean
DO_ANIMATIONS

private static final Duration
FADE_DURATION

pack-priv double
fixedCellSize

pack-priv boolean
fixedCellSizeEnabled

private int
fullRefreshCounter

private static boolean
IS_STUB_TOOLKIT

pack-priv boolean
isDirty

pack-priv static final Map<TableColumnBase<?, ?>, Double>
maxDisclosureWidthMap

pack-priv boolean
updateCells

Inherited from javafx.scene.control.skin.CellSkinBase:
DEFAULT_CELL_SIZE

Constructor Summary

AccessConstructor and Description
public
TableRowSkinBase(C
The control that this skin should be installed onto.
control)

Creates a new instance of TableRowSkinBase, although note that this instance does not handle any behavior / input mappings - this needs to be handled appropriately by subclasses.

Method Summary

Modifier and TypeMethod and Description
pack-priv final void
checkState()

protected double
computeMaxHeight(double
The width of the Skin, in case this value might dictate the maximum height.
width, double
the pixel snapped top inset
topInset, double
the pixel snapped right inset
rightInset, double
the pixel snapped bottom inset
bottomInset, double
the pixel snapped left inset
leftInset)

Overrides javafx.scene.control.skin.LabeledSkinBase.computeMaxHeight.

Computes the maximum allowable height of the Skin, based on the provided width.

protected double
computeMinHeight(double
The width of the Skin, in case this value might dictate the minimum height.
width, double
the pixel snapped top inset
topInset, double
the pixel snapped right inset
rightInset, double
the pixel snapped bottom inset
bottomInset, double
the pixel snapped left inset
leftInset)

Overrides javafx.scene.control.skin.LabeledSkinBase.computeMinHeight.

Computes the minimum allowable height of the Skin, based on the provided width.

protected double
computePrefHeight(double
the width that should be used if preferred height depends on it
width, double
the pixel snapped top inset
topInset, double
the pixel snapped right inset
rightInset, double
the pixel snapped bottom inset
bottomInset, double
the pixel snapped left inset
leftInset)

Overrides javafx.scene.control.skin.LabeledSkinBase.computePrefHeight.

Calculates the preferred height of this SkinBase.

protected double
computePrefWidth(double
the height that should be used if preferred width depends on it
height, double
the pixel snapped top inset
topInset, double
the pixel snapped right inset
rightInset, double
the pixel snapped bottom inset
bottomInset, double
the pixel snapped left inset
leftInset)

Overrides javafx.scene.control.skin.LabeledSkinBase.computePrefWidth.

Calculates the preferred width of this SkinBase.

protected abstract R

Returns:

the created cell
createCell(TableColumnBase<T, ?>
the table column
tc)

Creates a new cell instance that is suitable for representing the given table column instance.

private R
createCellAndCache(TableColumnBase<T, ?> col)

private void
fadeIn(final Node node)

private void
fadeOut(final Node node)

pack-priv Node
getDisclosureNode()

pack-priv int
getIndentationLevel(C control)

pack-priv double
getIndentationPerLevel()

protected abstract TableColumnBase<T, ?>

Returns:

the table column
getTableColumn(R
The cell for which a TableColumn is desired.
cell)

Returns the TableColumnBase instance for the given cell instance.

pack-priv TableColumnBase<S, T>
getTreeColumn()

Returns the table column that should show the disclosure nodes and / or a graphic.

pack-priv VirtualFlow<C>
getVirtualFlow()

protected abstract ObservableList<? extends TableColumnBase<S, T>>

Returns:

the list of visible leaf columns
getVisibleLeafColumns()

Returns an unmodifiable list containing the currently visible leaf columns.

protected ObjectProperty<Node>

Returns:

the graphic to draw on the inside of the disclosure node
graphicProperty()

Returns the graphic to draw on the inside of the disclosure node.

private boolean
isColumnPartiallyOrFullyVisible(TableColumnBase<S, T> col)

pack-priv boolean
isDirty()

pack-priv boolean
isDisclosureNodeVisible()

Used to represent whether a disclosure node is visible for _this_ table row.

pack-priv boolean
isIndentationRequired()

Used to represent whether the current virtual flow owner is wanting indentation to be used in this table row.

pack-priv boolean
isShowRoot()

protected void
layoutChildren(double
the x position
x, double
the y position
y, final double
the width
w, final double
the height
h)

Overrides javafx.scene.control.skin.LabeledSkinBase.layoutChildren.

The Layout algorithm works like this: - Get the labeled w/h, graphic w/h, text w/h - Compute content w/h based on graphicVPos, graphicHPos, graphicTextGap, and graphic w/h and text w/h - (Note that the text content has been pre-truncated where necessary) - compute content x/y based on content w/h and labeled w/h and the labeled's hpos and vpos - position the graphic and text

private void
recreateCells()

private void
requestCellUpdate()

pack-priv void
setDirty(boolean dirty)

protected abstract void
updateCell(R
The cell for which we want to inform it of its owner row.
cell, C
The row which will be set on the given cell.
row)

A method to allow the given cell to be told that it is a member of the given row.

pack-priv void
updateCells(boolean resetChildren)

private void
updateLeafColumns()

Inherited from javafx.scene.control.skin.CellSkinBase:
cellSizePropertygetCellSizegetClassCssMetaDatagetCssMetaData

Field Detail

cellsback to summary
pack-priv final List<R> cells
cellsMapback to summary
pack-priv WeakHashMap<TableColumnBase<S, T>, Reference<R>> cellsMap
DEFAULT_FULL_REFRESH_COUNTERback to summary
private static final int DEFAULT_FULL_REFRESH_COUNTER
DO_ANIMATIONSback to summary
private static boolean DO_ANIMATIONS
FADE_DURATIONback to summary
private static final Duration FADE_DURATION
fixedCellSizeback to summary
pack-priv double fixedCellSize
fixedCellSizeEnabledback to summary
pack-priv boolean fixedCellSizeEnabled
fullRefreshCounterback to summary
private int fullRefreshCounter
IS_STUB_TOOLKITback to summary
private static boolean IS_STUB_TOOLKIT
isDirtyback to summary
pack-priv boolean isDirty
maxDisclosureWidthMapback to summary
pack-priv static final Map<TableColumnBase<?, ?>, Double> maxDisclosureWidthMap
updateCellsback to summary
pack-priv boolean updateCells

Constructor Detail

TableRowSkinBaseback to summary
public TableRowSkinBase(C control)

Creates a new instance of TableRowSkinBase, although note that this instance does not handle any behavior / input mappings - this needs to be handled appropriately by subclasses.

Parameters
control:C

The control that this skin should be installed onto.

Method Detail

checkStateback to summary
pack-priv final void checkState()
computeMaxHeightback to summary
protected double computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.skin.LabeledSkinBase.computeMaxHeight.

Doc from javafx.scene.control.skin.LabeledSkinBase.computeMaxHeight.

Computes the maximum allowable height of the Skin, based on the provided width.

Parameters
width:double

Doc from javafx.scene.control.SkinBase.computeMaxHeight.

The width of the Skin, in case this value might dictate the maximum height.

topInset:double

Doc from javafx.scene.control.SkinBase.computeMaxHeight.

the pixel snapped top inset

rightInset:double

Doc from javafx.scene.control.SkinBase.computeMaxHeight.

the pixel snapped right inset

bottomInset:double

Doc from javafx.scene.control.SkinBase.computeMaxHeight.

the pixel snapped bottom inset

leftInset:double

Doc from javafx.scene.control.SkinBase.computeMaxHeight.

the pixel snapped left inset

Returns:double

Doc from javafx.scene.control.SkinBase.computeMaxHeight.

A double representing the maximum height of this Skin.

Annotations
@Override
computeMinHeightback to summary
protected double computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.skin.LabeledSkinBase.computeMinHeight.

Doc from javafx.scene.control.skin.LabeledSkinBase.computeMinHeight.

Computes the minimum allowable height of the Skin, based on the provided width.

Parameters
width:double

Doc from javafx.scene.control.SkinBase.computeMinHeight.

The width of the Skin, in case this value might dictate the minimum height.

topInset:double

Doc from javafx.scene.control.SkinBase.computeMinHeight.

the pixel snapped top inset

rightInset:double

Doc from javafx.scene.control.SkinBase.computeMinHeight.

the pixel snapped right inset

bottomInset:double

Doc from javafx.scene.control.SkinBase.computeMinHeight.

the pixel snapped bottom inset

leftInset:double

Doc from javafx.scene.control.SkinBase.computeMinHeight.

the pixel snapped left inset

Returns:double

Doc from javafx.scene.control.SkinBase.computeMinHeight.

A double representing the minimum height of this Skin.

Annotations
@Override
computePrefHeightback to summary
protected double computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.skin.LabeledSkinBase.computePrefHeight.

Doc from javafx.scene.control.skin.LabeledSkinBase.computePrefHeight.

Calculates the preferred height of this SkinBase. The default implementation calculates this height as the height of the area occupied by its managed children when they are positioned at their current positions at their preferred heights.

Parameters
width:double

Doc from javafx.scene.control.SkinBase.computePrefHeight.

the width that should be used if preferred height depends on it

topInset:double

Doc from javafx.scene.control.SkinBase.computePrefHeight.

the pixel snapped top inset

rightInset:double

Doc from javafx.scene.control.SkinBase.computePrefHeight.

the pixel snapped right inset

bottomInset:double

Doc from javafx.scene.control.SkinBase.computePrefHeight.

the pixel snapped bottom inset

leftInset:double

Doc from javafx.scene.control.SkinBase.computePrefHeight.

the pixel snapped left inset

Returns:double

Doc from javafx.scene.control.SkinBase.computePrefHeight.

the calculated preferred height

Annotations
@Override
computePrefWidthback to summary
protected double computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.skin.LabeledSkinBase.computePrefWidth.

Doc from javafx.scene.control.skin.LabeledSkinBase.computePrefWidth.

Calculates the preferred width of this SkinBase. The default implementation calculates this width as the width of the area occupied by its managed children when they are positioned at their current positions at their preferred widths.

Parameters
height:double

Doc from javafx.scene.control.SkinBase.computePrefWidth.

the height that should be used if preferred width depends on it

topInset:double

Doc from javafx.scene.control.SkinBase.computePrefWidth.

the pixel snapped top inset

rightInset:double

Doc from javafx.scene.control.SkinBase.computePrefWidth.

the pixel snapped right inset

bottomInset:double

Doc from javafx.scene.control.SkinBase.computePrefWidth.

the pixel snapped bottom inset

leftInset:double

Doc from javafx.scene.control.SkinBase.computePrefWidth.

the pixel snapped left inset

Returns:double

Doc from javafx.scene.control.SkinBase.computePrefWidth.

the calculated preferred width

Annotations
@Override
createCellback to summary
protected abstract R createCell(TableColumnBase<T, ?> tc)

Creates a new cell instance that is suitable for representing the given table column instance.

Parameters
tc:TableColumnBase<T, ?>

the table column

Returns:R

the created cell

createCellAndCacheback to summary
private R createCellAndCache(TableColumnBase<T, ?> col)
fadeInback to summary
private void fadeIn(final Node node)
fadeOutback to summary
private void fadeOut(final Node node)
getDisclosureNodeback to summary
pack-priv Node getDisclosureNode()
getIndentationLevelback to summary
pack-priv int getIndentationLevel(C control)
getIndentationPerLevelback to summary
pack-priv double getIndentationPerLevel()
getTableColumnback to summary
protected abstract TableColumnBase<T, ?> getTableColumn(R cell)

Returns the TableColumnBase instance for the given cell instance.

Parameters
cell:R

The cell for which a TableColumn is desired.

Returns:TableColumnBase<T, ?>

the table column

getTreeColumnback to summary
pack-priv TableColumnBase<S, T> getTreeColumn()

Returns the table column that should show the disclosure nodes and / or a graphic. By default this is the left-most column.

getVirtualFlowback to summary
pack-priv VirtualFlow<C> getVirtualFlow()
getVisibleLeafColumnsback to summary
protected abstract ObservableList<? extends TableColumnBase<S, T>> getVisibleLeafColumns()

Returns an unmodifiable list containing the currently visible leaf columns.

Returns:ObservableList<? extends TableColumnBase<S, T>>

the list of visible leaf columns

graphicPropertyback to summary
protected ObjectProperty<Node> graphicProperty()

Returns the graphic to draw on the inside of the disclosure node. Null is acceptable when no graphic should be shown. Commonly this is the graphic associated with a TreeItem (i.e. treeItem.getGraphic()), rather than a graphic associated with a cell.

Returns:ObjectProperty<Node>

the graphic to draw on the inside of the disclosure node

isColumnPartiallyOrFullyVisibleback to summary
private boolean isColumnPartiallyOrFullyVisible(TableColumnBase<S, T> col)
isDirtyback to summary
pack-priv boolean isDirty()
isDisclosureNodeVisibleback to summary
pack-priv boolean isDisclosureNodeVisible()

Used to represent whether a disclosure node is visible for _this_ table row. Not to be confused with isIndentationRequired(), which is the more general API.

isIndentationRequiredback to summary
pack-priv boolean isIndentationRequired()

Used to represent whether the current virtual flow owner is wanting indentation to be used in this table row.

isShowRootback to summary
pack-priv boolean isShowRoot()
layoutChildrenback to summary
protected void layoutChildren(double x, double y, final double w, final double h)

Overrides javafx.scene.control.skin.LabeledSkinBase.layoutChildren.

Doc from javafx.scene.control.skin.LabeledSkinBase.layoutChildren.

The Layout algorithm works like this: - Get the labeled w/h, graphic w/h, text w/h - Compute content w/h based on graphicVPos, graphicHPos, graphicTextGap, and graphic w/h and text w/h - (Note that the text content has been pre-truncated where necessary) - compute content x/y based on content w/h and labeled w/h and the labeled's hpos and vpos - position the graphic and text

Parameters
x:double

Doc from javafx.scene.control.SkinBase.layoutChildren.

the x position

y:double

Doc from javafx.scene.control.SkinBase.layoutChildren.

the y position

w:double

Doc from javafx.scene.control.SkinBase.layoutChildren.

the width

h:double

Doc from javafx.scene.control.SkinBase.layoutChildren.

the height

Annotations
@Override
recreateCellsback to summary
private void recreateCells()
requestCellUpdateback to summary
private void requestCellUpdate()
setDirtyback to summary
pack-priv void setDirty(boolean dirty)
updateCellback to summary
protected abstract void updateCell(R cell, C row)

A method to allow the given cell to be told that it is a member of the given row. How this is implemented is dependent on the actual cell implementation.

Parameters
cell:R

The cell for which we want to inform it of its owner row.

row:C

The row which will be set on the given cell.

updateCellsback to summary
pack-priv void updateCells(boolean resetChildren)
updateLeafColumnsback to summary
private void updateLeafColumns()