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

java.lang.Object

javafx.scene.control.SkinBase<C>

javafx.scene.control.skin.LabeledSkinBase<C>

javafx.scene.control.skin.CellSkinBase<C>

javafx.scene.control.skin.TableRowSkinBase<T,C,R>

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. TableCell or TreeTableCell).

All Implemented Interfaces:

Skin<C>

Direct Known Subclasses:

TableRowSkin, TreeTableRowSkin

public abstract class TableRowSkinBase<T, C extends IndexedCell, R extends IndexedCell>
extends CellSkinBase<C>

TableRowSkinBase is the base skin class used by controls such as TableRow and TreeTableRow (the concrete classes are TableRowSkin and TreeTableRowSkin, respectively).

Since:

9

See Also:

• TableRow
• TreeTableRow
• TableRowSkin
• TreeTableRowSkin

Property Summary

Properties

Type	Property	Description
protected ObjectProperty<Node>	graphic	Returns the graphic to draw on the inside of the disclosure node.

Properties declared in class CellSkinBase

cellSize

Type	Property	Description
final ReadOnlyDoubleProperty	cellSize	The default cell size.

Constructor Summary

Constructors

Constructor	Description
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.

Method Summary

Modifier and Type	Method	Description
protected abstract R	createCell(TableColumnBase<T,?> tc)	Creates a new cell instance that is suitable for representing the given table column instance.
protected abstract TableColumnBase<T,?>	getTableColumn(R cell)	Returns the TableColumnBase instance for the given cell instance.
protected abstract ObservableList<? extends TableColumnBase>	getVisibleLeafColumns()	Returns an unmodifiable list containing the currently visible leaf columns.
protected ObjectProperty<Node>	graphicProperty()	Returns the graphic to draw on the inside of the disclosure node.
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.

Methods declared in class CellSkinBase

cellSizeProperty, getCellSize, getClassCssMetaData

Modifier and Type	Method	Description
final ReadOnlyDoubleProperty	cellSizeProperty()	The default cell size.
final double	getCellSize()	Gets the value of the cellSize property.
static List<CssMetaData<? extends Styleable, ?>>	getClassCssMetaData()	Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Methods declared in class LabeledSkinBase

computeBaselineOffset, computeMinWidth, layoutChildren, layoutLabelInArea, layoutLabelInArea, updateChildren

Modifier and Type	Method	Description
double	computeBaselineOffset(double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the baseline offset based on the first managed child.
protected double	computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Compute and return the minimum width of this Labeled.
protected void	layoutChildren(double x, double y, double w, double h)	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
protected void	layoutLabelInArea(double x, double y, double w, double h)	Performs the actual layout of the label content within the area given.
protected void	layoutLabelInArea(double x, double y, double w, double h, Pos alignment)	Performs the actual layout of the label content within the area given.
protected void	updateChildren()	Updates the children managed by LabeledSkinBase, which can be the Labeled graphic and/or a Text node.

Methods declared in class SkinBase

computeMaxHeight, computeMaxWidth, computeMinHeight, computePrefHeight, computePrefWidth, consumeMouseEvents, dispose, executeAccessibleAction, getChildren, getCssMetaData, getNode, getSkinnable, layoutInArea, layoutInArea, layoutInArea, positionInArea, positionInArea, pseudoClassStateChanged, queryAccessibleAttribute, registerChangeListener, registerInvalidationListener, registerListChangeListener, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, unregisterChangeListeners, unregisterInvalidationListeners, unregisterListChangeListeners

Modifier and Type	Method	Description
protected double	computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the maximum allowable height of the Skin, based on the provided width.
protected double	computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the maximum allowable width of the Skin, based on the provided height.
protected double	computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the minimum allowable height of the Skin, based on the provided width.
protected double	computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the preferred height of this SkinBase.
protected double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the preferred width of this SkinBase.
protected final void	consumeMouseEvents(boolean value)	Determines whether all mouse events should be automatically consumed.
void	dispose()	Called when a previously installed skin is about to be removed from its associated control.
protected void	executeAccessibleAction(AccessibleAction action, Object... parameters)	This method is called by the assistive technology to request the action indicated by the argument should be executed.
final ObservableList<Node>	getChildren()	Returns the children of the skin.
List<CssMetaData<? extends Styleable, ?>>	getCssMetaData()	This method should delegate to Node.getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.
final Node	getNode()	Gets the Node which represents this Skin.
final C	getSkinnable()	Gets the Skinnable to which this Skin is assigned.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)	Utility method which positions the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)	Utility method which positions the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
final void	pseudoClassStateChanged(PseudoClass pseudoClass, boolean active)	Used to specify that a pseudo-class of this Node has changed.
protected Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)	This method is called by the assistive technology to request the value for an attribute.
protected final void	registerChangeListener(ObservableValue<?> observable, Consumer<ObservableValue<?>> operation)	Registers an operation to perform when the given observable sends a change event.
protected final void	registerInvalidationListener(Observable observable, Consumer<Observable> operation)	Registers an operation to perform when the given observable sends an invalidation event.
protected final void	registerListChangeListener(ObservableList<?> observableList, Consumer<ListChangeListener.Change<?>> operation)	Registers an operation to perform when the given observableList sends a list change event.
protected double	snappedBottomInset()	Utility method to get the bottom inset which includes padding and border inset.
protected double	snappedLeftInset()	Utility method to get the left inset which includes padding and border inset.
protected double	snappedRightInset()	Utility method to get the right inset which includes padding and border inset.
protected double	snappedTopInset()	Utility method to get the top inset which includes padding and border inset.
protected double	snapPosition(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapPositionX() and snapPositionY()
protected double	snapPositionX(double value)	Convenience method for accessing the snapPositionX() method on the skinnable.
protected double	snapPositionY(double value)	Convenience method for accessing the snapPositionY() method on the skinnable.
protected double	snapSize(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapSizeX() and snapSizeY()
protected double	snapSizeX(double value)	Convenience method for accessing the snapSizeX() method on the skinnable.
protected double	snapSizeY(double value)	Convenience method for accessing the snapSizeY() method on the skinnable.
protected double	snapSpace(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapSpaceX() and snapSpaceY()
protected double	snapSpaceX(double value)	Convenience method for accessing the snapSpaceX() method on the skinnable.
protected double	snapSpaceY(double value)	Convenience method for accessing the snapSpaceY() method on the skinnable.
protected final Consumer<ObservableValue<?>>	unregisterChangeListeners(ObservableValue<?> observable)	Unregisters all operations that have been registered using SkinBase.registerChangeListener(ObservableValue, Consumer) for the given observable.
protected final Consumer<Observable>	unregisterInvalidationListeners(Observable observable)	Unregisters all operations that have been registered using SkinBase.registerInvalidationListener(Observable, Consumer) for the given observable.
protected final Consumer<ListChangeListener.Change<?>>	unregisterListChangeListeners(ObservableList<?> observableList)	Unregisters all operations that have been registered using SkinBase.registerListChangeListener(ObservableList, Consumer) for the given observableList.

Methods declared in class Object

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

Methods declared in interface Skin

install

Modifier and Type	Method	Description
default void	install()	Called once when Skin is set.

Property Details

graphic

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.

See Also:

• graphicProperty()

Constructor Details

TableRowSkinBase

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 - The control that this skin should be installed onto.

Method Details

createCell

protected abstract R createCell(TableColumnBase<T,?> tc)

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

Parameters:

tc - the table column

Returns:

the created cell

updateCell

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 - The cell for which we want to inform it of its owner row.

row - The row which will be set on the given cell.

getTableColumn

protected abstract TableColumnBase<T,?> getTableColumn(R cell)

Returns the TableColumnBase instance for the given cell instance.

Parameters:

cell - The cell for which a TableColumn is desired.

Returns:

the table column

getVisibleLeafColumns

protected abstract ObservableList<? extends TableColumnBase> getVisibleLeafColumns()

Returns an unmodifiable list containing the currently visible leaf columns.

Returns:

the list of visible leaf columns

graphicProperty

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:

the graphic to draw on the inside of the disclosure node