T - The type of the elements contained within the ListView.public class CheckBoxListCell<T> extends ListCell<T>
ListCell implementation that draws a
CheckBox node inside the cell, optionally with a label to indicate
what the checkbox represents.
The CheckBoxListCell is rendered with a CheckBox on the left-hand side of
the ListView, and the text related to the list item taking up all
remaining horizontal space.
To construct an instance of this class, it is necessary to provide a
Callback that, given an object of type T, will return a
ObservableValue<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
| Type | Property and Description |
|---|---|
ObjectProperty<StringConverter<T>> |
converter
The
StringConverter property. |
ObjectProperty<Callback<T,ObservableValue<java.lang.Boolean>>> |
selectedStateCallback
Property representing the
Callback that is bound to by the
CheckBox shown on screen. |
indexalignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapTextcontextMenu, height, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth, skinClassName, skin, tooltip, widthneedsLayoutblendMode, 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, visibleUSE_COMPUTED_SIZE, USE_PREF_SIZE| Constructor and Description |
|---|
CheckBoxListCell()
Creates a default CheckBoxListCell.
|
CheckBoxListCell(Callback<T,ObservableValue<java.lang.Boolean>> getSelectedProperty)
Creates a default CheckBoxListCell.
|
CheckBoxListCell(Callback<T,ObservableValue<java.lang.Boolean>> getSelectedProperty,
StringConverter<T> converter)
Creates a CheckBoxListCell with a custom string converter.
|
| Modifier and Type | Method and Description |
|---|---|
ObjectProperty<StringConverter<T>> |
converterProperty()
The
StringConverter property. |
static <T> Callback<ListView<T>,ListCell<T>> |
forListView(Callback<T,ObservableValue<java.lang.Boolean>> getSelectedProperty)
Creates a cell factory for use in ListView controls.
|
static <T> Callback<ListView<T>,ListCell<T>> |
forListView(Callback<T,ObservableValue<java.lang.Boolean>> getSelectedProperty,
StringConverter<T> converter)
Creates a cell factory for use in ListView controls.
|
StringConverter<T> |
getConverter()
Returns the
StringConverter used in this cell. |
Callback<T,ObservableValue<java.lang.Boolean>> |
getSelectedStateCallback()
Returns the
Callback that is bound to by the CheckBox shown on screen. |
ObjectProperty<Callback<T,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<T,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.
|
cancelEdit, commitEdit, getListView, listViewProperty, startEdit, updateListViewgetIndex, indexProperty, updateIndexeditableProperty, editingProperty, emptyProperty, getItem, isEditable, isEditing, isEmpty, isSelected, itemProperty, selectedProperty, setEditable, setItem, updateSelectedalignmentProperty, 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, wrapTextPropertycomputeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getSkin, getTooltip, getUserAgentStylesheet, getWidth, heightProperty, intersects, isResizable, layoutChildren, 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, widthPropertygetChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, setNeedsLayoutaddEventFilter, 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, visiblePropertypublic final ObjectProperty<StringConverter<T>> converterProperty
StringConverter property.getConverter(),
setConverter(StringConverter)public final ObjectProperty<Callback<T,ObservableValue<java.lang.Boolean>>> selectedStateCallbackProperty
Callback that is bound to by the
CheckBox shown on screen.public CheckBoxListCell()
public CheckBoxListCell(Callback<T,ObservableValue<java.lang.Boolean>> getSelectedProperty)
getSelectedProperty - A Callback that will return an
ObservableValue<Boolean> given an item from the ListView.public CheckBoxListCell(Callback<T,ObservableValue<java.lang.Boolean>> getSelectedProperty, StringConverter<T> converter)
getSelectedProperty - A Callback that will return an
ObservableValue<Boolean> given an item from the ListView.converter - A StringConverter that, given an object of type T, will
return a String that can be used to represent the object visually.public static <T> Callback<ListView<T>,ListCell<T>> forListView(Callback<T,ObservableValue<java.lang.Boolean>> getSelectedProperty)
CheckBoxListCell is rendered with a CheckBox on the
left-hand side of the ListView, with the text related to the list item
taking up all remaining horizontal space.T - The type of the elements contained within the ListView.getSelectedProperty - A Callback that, given an object of
type T (which is a value taken out of the
ListView<T>.items list),
will return an ObservableValue<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).Callback that will return a ListCell that is able to
work on the type of element contained within the ListView items list.public static <T> Callback<ListView<T>,ListCell<T>> forListView(Callback<T,ObservableValue<java.lang.Boolean>> getSelectedProperty, StringConverter<T> converter)
CheckBoxListCell is rendered with a CheckBox on the
left-hand side of the ListView, with the text related to the list item
taking up all remaining horizontal space.T - The type of the elements contained within the ListView.getSelectedProperty - A Callback that, given an object
of type T (which is a value taken out of the
ListView<T>.items list),
will return an ObservableValue<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).converter - A StringConverter that, give an object of type T, will
return a String that can be used to represent the object visually.Callback that will return a ListCell that is able to
work on the type of element contained within the ListView.public final ObjectProperty<StringConverter<T>> converterProperty()
StringConverter property.getConverter(),
setConverter(StringConverter)public final void setConverter(StringConverter<T> value)
StringConverter to be used in this cell.public final StringConverter<T> getConverter()
StringConverter used in this cell.public final ObjectProperty<Callback<T,ObservableValue<java.lang.Boolean>>> selectedStateCallbackProperty()
Callback that is bound to by the
CheckBox shown on screen.public final void setSelectedStateCallback(Callback<T,ObservableValue<java.lang.Boolean>> value)
Callback that is bound to by the CheckBox shown on screen.public final Callback<T,ObservableValue<java.lang.Boolean>> getSelectedStateCallback()
Callback that is bound to by the CheckBox shown on screen.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.
updateItem in class Cell<T>item - The new item for the cellempty - 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.Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.