javafx.scene.control.cell

Class CheckBoxTableCell<S,T>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.control.Control

javafx.scene.control.Labeled

javafx.scene.control.Cell<T>

javafx.scene.control.IndexedCell<T>

javafx.scene.control.TableCell<S,T>

javafx.scene.control.cell.CheckBoxTableCell<S,T>

Type Parameters:

T - The type of the elements contained within the TableColumn.

All Implemented Interfaces:

EventTarget, Skinnable

public class CheckBoxTableCell<S,T>
extends TableCell<S,T>

A class containing a TableCell implementation that draws a CheckBox node inside the cell, optionally with a label to indicate what the checkbox represents.

By default, the CheckBoxTableCell is rendered with a CheckBox centred in the TableColumn. If a label is required, it is necessary to provide a non-null StringConverter instance to the CheckBoxTableCell(Callback, StringConverter) constructor.

To construct an instance of this class, it is necessary to provide a Callback that, given an object of type T, will return an ObservableProperty<Boolean> that represents whether the given item is selected or not. This ObservableValue will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the ObservableValue, if it changes externally).

Since:

2.2

Property Summary

Properties

Type	Property and Description
ObjectProperty<StringConverter<T>>	converter The StringConverter property.
ObjectProperty<Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>>>	selectedStateCallback Property representing the Callback that is bound to by the CheckBox shown on screen.

Properties inherited from class javafx.scene.control.TableCell

tableColumn, tableRow, tableView

Properties inherited from class javafx.scene.control.IndexedCell

index

Properties inherited from class javafx.scene.control.Cell

editable, editing, empty, item, selected

Properties inherited from class javafx.scene.control.Labeled

alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText

Properties inherited from class javafx.scene.control.Control

contextMenu, height, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth, skinClassName, skin, tooltip, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

Field Summary

Fields inherited from class javafx.scene.control.Control

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor and Description
CheckBoxTableCell() Creates a default CheckBoxTableCell.
CheckBoxTableCell(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedProperty) Creates a default CheckBoxTableCell with a custom Callback to retrieve an ObservableValue for a given cell index.
CheckBoxTableCell(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedProperty, StringConverter<T> converter) Creates a CheckBoxTableCell with a custom string converter.

Method Summary

Methods

Modifier and Type	Method and Description
ObjectProperty<StringConverter<T>>	converterProperty() The StringConverter property.
static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>>	forTableColumn(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedProperty) Creates a cell factory for use in a TableColumn cell factory.
static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>>	forTableColumn(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedProperty, boolean showLabel) Creates a cell factory for use in a TableColumn cell factory.
static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>>	forTableColumn(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedProperty, StringConverter<T> converter) Creates a cell factory for use in a TableColumn cell factory.
static <S> Callback<TableColumn<S,java.lang.Boolean>,TableCell<S,java.lang.Boolean>>	forTableColumn(TableColumn<S,java.lang.Boolean> column) Creates a cell factory for use in a TableColumn cell factory.
StringConverter<T>	getConverter() Returns the StringConverter used in this cell.
Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>>	getSelectedStateCallback() Returns the Callback that is bound to by the CheckBox shown on screen.
ObjectProperty<Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>>>	selectedStateCallbackProperty() Property representing the Callback that is bound to by the CheckBox shown on screen.
void	setConverter(StringConverter<T> value) Sets the StringConverter to be used in this cell.
void	setSelectedStateCallback(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> value) Sets the Callback that is bound to by the CheckBox shown on screen.
void	updateItem(T item, boolean empty) Updates the item associated with this Cell.

Methods inherited from class javafx.scene.control.TableCell

cancelEdit, commitEdit, getTableColumn, getTableRow, getTableView, layoutChildren, startEdit, tableColumnProperty, tableRowProperty, tableViewProperty, updateSelected, updateTableColumn, updateTableRow, updateTableView

Methods inherited from class javafx.scene.control.IndexedCell

getIndex, indexProperty, updateIndex

Methods inherited from class javafx.scene.control.Cell

editableProperty, editingProperty, emptyProperty, getItem, isEditable, isEditing, isEmpty, isSelected, itemProperty, selectedProperty, setEditable, setItem

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getContentBias, getContentDisplay, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getLabelPadding, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, underlineProperty, wrapTextProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getSkin, getTooltip, getUserAgentStylesheet, getWidth, heightProperty, intersects, isResizable, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, setContextMenu, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPrefHeight, setPrefSize, setPrefWidth, setSkin, setSkinClassName, setTooltip, setWidth, skinClassNameProperty, skinProperty, tooltipProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, setNeedsLayout

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToSceneTransformProperty, lookupAll, managedProperty, mouseTransparentProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

converter

public final ObjectProperty<StringConverter<T>> converterProperty

The StringConverter property.

See Also:

getConverter(), setConverter(StringConverter)

selectedStateCallback

public final ObjectProperty<Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>>> selectedStateCallbackProperty

Property representing the Callback that is bound to by the CheckBox shown on screen.

See Also:

getSelectedStateCallback(), setSelectedStateCallback(Callback)

Constructor Detail

CheckBoxTableCell

public CheckBoxTableCell()

Creates a default CheckBoxTableCell.

CheckBoxTableCell

public CheckBoxTableCell(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedProperty)

Creates a default CheckBoxTableCell with a custom Callback to retrieve an ObservableValue for a given cell index.

Parameters:

getSelectedProperty - A Callback that will return an ObservableValue given an index from the TableColumn.

CheckBoxTableCell

public CheckBoxTableCell(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedProperty,
                 StringConverter<T> converter)

Creates a CheckBoxTableCell with a custom string converter.

Parameters:

getSelectedProperty - A Callback that will return a ObservableValue given an index from the TableColumn.

converter - A StringConverter that, given an object of type T, will return a String that can be used to represent the object visually.

Method Detail

forTableColumn

public static <S> Callback<TableColumn<S,java.lang.Boolean>,TableCell<S,java.lang.Boolean>> forTableColumn(TableColumn<S,java.lang.Boolean> column)

Creates a cell factory for use in a TableColumn cell factory. This method requires that the TableColumn be of type Boolean.

When used in a TableColumn, the CheckBoxCell is rendered with a CheckBox centered in the column.

The ObservableValue<Boolean> contained within each cell in the column will be bound bidirectionally. This means that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the ObservableValue<Boolean>, if it changes externally).

Returns:

A Callback that will return a TableCell that is able to work on the type of element contained within the TableColumn.

forTableColumn

public static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> forTableColumn(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedProperty)

Creates a cell factory for use in a TableColumn cell factory. This method requires that the TableColumn be of type ObservableValue<Boolean>.

When used in a TableColumn, the CheckBoxCell is rendered with a CheckBox centered in the column.

Type Parameters:

T - The type of the elements contained within the TableColumn instance.

Parameters:

getSelectedProperty - A Callback that, given an object of type TableColumn<S,T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not. This ObservableValue<Boolean> will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the ObservableValue<Boolean>, if it changes externally).

Returns:

A Callback that will return a TableCell that is able to work on the type of element contained within the TableColumn.

forTableColumn

public static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> forTableColumn(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedProperty,
                                                             boolean showLabel)

Creates a cell factory for use in a TableColumn cell factory. This method requires that the TableColumn be of type ObservableValue<Boolean>.

When used in a TableColumn, the CheckBoxCell is rendered with a CheckBox centered in the column.

Type Parameters:

T - The type of the elements contained within the TableColumn instance.

Parameters:

getSelectedProperty - A Callback that, given an object of type TableColumn<S,T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not. This ObservableValue<Boolean> will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the ObservableValue<Boolean>, if it changes externally).

showLabel - In some cases, it may be desirable to show a label in the TableCell beside the CheckBox. By default a label is not shown, but by setting this to true the item in the cell will also have toString() called on it. If this is not the desired behavior, consider using forTableColumn(javafx.util.Callback, javafx.util.StringConverter), which allows for you to provide a callback that specifies the label for a given row item.

Returns:

A Callback that will return a TableCell that is able to work on the type of element contained within the TableColumn.

forTableColumn

public static <S,T> Callback<TableColumn<S,T>,TableCell<S,T>> forTableColumn(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedProperty,
                                                             StringConverter<T> converter)

Creates a cell factory for use in a TableColumn cell factory. This method requires that the TableColumn be of type ObservableValue<Boolean>.

When used in a TableColumn, the CheckBoxCell is rendered with a CheckBox centered in the column.

Type Parameters:

T - The type of the elements contained within the TableColumn instance.

Parameters:

getSelectedProperty - A Callback that, given an object of type TableColumn<S,T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not. This ObservableValue<Boolean> will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the ObservableValue<Boolean>, if it changes externally).

converter - A StringConverter that, give an object of type T, will return a String that can be used to represent the object visually. The default implementation in forTableColumn(Callback, boolean) (when showLabel is true) is to simply call .toString() on all non-null items (and to just return an empty string in cases where the given item is null).

Returns:

A Callback that will return a TableCell that is able to work on the type of element contained within the TableColumn.

converterProperty

public final ObjectProperty<StringConverter<T>> converterProperty()

The StringConverter property.

See Also:

getConverter(), setConverter(StringConverter)

setConverter

public final void setConverter(StringConverter<T> value)

Sets the StringConverter to be used in this cell.

getConverter

public final StringConverter<T> getConverter()

Returns the StringConverter used in this cell.

selectedStateCallbackProperty

public final ObjectProperty<Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>>> selectedStateCallbackProperty()

Property representing the Callback that is bound to by the CheckBox shown on screen.

See Also:

getSelectedStateCallback(), setSelectedStateCallback(Callback)

setSelectedStateCallback

public final void setSelectedStateCallback(Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> value)

Sets the Callback that is bound to by the CheckBox shown on screen.

getSelectedStateCallback

public final Callback<java.lang.Integer,ObservableValue<java.lang.Boolean>> getSelectedStateCallback()

Returns the Callback that is bound to by the CheckBox shown on screen.

updateItem

public void updateItem(T item,
              boolean empty)

Updates the item associated with this Cell. This method should only be called by Skin implementations of ListView, TableView, TreeView, or other controls using Cells. It is not intended to be called by application developers.

Because null is a perfectly valid value in the application domain, Cell needs some way to distinguish whether or not the cell actually holds a value. The empty flag indicates this. It is an error to supply a non-null item but a true value for empty.

Overrides:

updateItem in class Cell<T>

Parameters:

item - The new item for the cell

empty - whether or not this cell represents data from the list. If it is empty, then it does not represent any domain data, but is a cell being used to render an "empty" row.