- java.lang.Object
-
- javafx.scene.Node
-
- javafx.scene.Parent
-
- javafx.scene.layout.Region
-
- javafx.scene.control.Control
-
- javafx.scene.control.Labeled
-
- javafx.scene.control.Cell<T>
-
- javafx.scene.control.IndexedCell<T>
-
- javafx.scene.control.ListCell<T>
-
- javafx.scene.control.cell.ChoiceBoxListCell<T>
-
- Type Parameters:
T- The type of the elements contained within the ListView.
- All Implemented Interfaces:
Styleable,EventTarget,Skinnable
public class ChoiceBoxListCell<T> extends ListCell<T>
A class containing aListCellimplementation that draws aChoiceBoxnode inside the cell.By default, the ChoiceBoxListCell is rendered as a
Labelwhen not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire list cell.To create a ChoiceBoxListCell, it is necessary to provide zero or more items that will be shown to the user when the
ChoiceBoxmenu is showing. These items must be of the same type as the ListView items sequence, such that upon selection, they replace the existing value in theitemslist.- Since:
- JavaFX 2.2
-
-
Property Summary
Properties Type Property Description ObjectProperty<StringConverter<T>>converterTheStringConverterproperty.-
Properties declared in class javafx.scene.control.IndexedCell
index
-
Properties declared in class javafx.scene.control.Labeled
alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, lineSpacing, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText
-
Properties declared in class javafx.scene.control.Control
contextMenu, skin, tooltip
-
Properties declared in class javafx.scene.layout.Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width
-
Properties declared in class javafx.scene.Parent
needsLayout
-
Properties declared in class javafx.scene.Node
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, 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, viewOrder, visible
-
-
Field Summary
-
Fields declared in class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE
-
Fields declared in class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT
-
-
Constructor Summary
Constructors Constructor Description ChoiceBoxListCell()Creates a default ChoiceBoxListCell with an empty items list.ChoiceBoxListCell(ObservableList<T> items)Creates a defaultChoiceBoxListCellinstance with the given items being used to populate theChoiceBoxwhen it is shown.ChoiceBoxListCell(StringConverter<T> converter, ObservableList<T> items)Creates aChoiceBoxListCellinstance with the given items being used to populate theChoiceBoxwhen it is shown, and theStringConverterbeing used to convert the item in to a user-readable form.ChoiceBoxListCell(StringConverter<T> converter, T... items)Creates aChoiceBoxListCellinstance with the given items being used to populate theChoiceBoxwhen it is shown, and theStringConverterbeing used to convert the item in to a user-readable form.ChoiceBoxListCell(T... items)Creates a defaultChoiceBoxListCellinstance with the given items being used to populate theChoiceBoxwhen it is shown.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ObjectProperty<StringConverter<T>>converterProperty()TheStringConverterproperty.static <T> Callback<ListView<T>,ListCell<T>>forListView(ObservableList<T> items)Creates a ChoiceBox cell factory for use inListViewcontrols.static <T> Callback<ListView<T>,ListCell<T>>forListView(StringConverter<T> converter, ObservableList<T> items)Creates a ChoiceBox cell factory for use inListViewcontrols.static <T> Callback<ListView<T>,ListCell<T>>forListView(StringConverter<T> converter, T... items)Creates a ChoiceBox cell factory for use inListViewcontrols.static <T> Callback<ListView<T>,ListCell<T>>forListView(T... items)Creates a ChoiceBox cell factory for use inListViewcontrols.StringConverter<T>getConverter()Returns theStringConverterused in this cell.ObservableList<T>getItems()Returns the items to be displayed in the ChoiceBox when it is showing.voidsetConverter(StringConverter<T> value)Sets theStringConverterto be used in this cell.-
Methods declared in class javafx.scene.control.ListCell
getListView, listViewProperty, updateListView
-
Methods declared in class javafx.scene.control.IndexedCell
getIndex, indexProperty, updateIndex
-
Methods declared in class javafx.scene.control.Cell
cancelEdit, commitEdit, editableProperty, editingProperty, emptyProperty, getInitialFocusTraversable, getItem, isEditable, isEditing, isEmpty, isItemChanged, isSelected, itemProperty, selectedProperty, setEditable, setItem, startEdit, updateItem, updateSelected
-
Methods declared in class javafx.scene.control.Labeled
alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getInitialAlignment, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, underlineProperty, wrapTextProperty
-
Methods declared in class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, contextMenuProperty, createDefaultSkin, getContextMenu, getCssMetaData, getTooltip, isResizable, setContextMenu, setTooltip, skinProperty, tooltipProperty
-
Methods declared in class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computePrefHeight, computePrefWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
-
Methods declared in class javafx.scene.Parent
getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, layoutChildren, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
-
Methods declared in class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, 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, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookup, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, 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, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty
-
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods declared in interface javafx.css.Styleable
getStyleableNode, getStyleClass
-
-
-
-
Property Detail
-
converter
public final ObjectProperty<StringConverter<T>> converterProperty
TheStringConverterproperty.- See Also:
getConverter(),setConverter(StringConverter)
-
-
Constructor Detail
-
ChoiceBoxListCell
public ChoiceBoxListCell()
Creates a default ChoiceBoxListCell with an empty items list.
-
ChoiceBoxListCell
@SafeVarargs public ChoiceBoxListCell(T... items)
Creates a defaultChoiceBoxListCellinstance with the given items being used to populate theChoiceBoxwhen it is shown.- Parameters:
items- The items to show in the ChoiceBox popup menu when selected by the user.
-
ChoiceBoxListCell
@SafeVarargs public ChoiceBoxListCell(StringConverter<T> converter, T... items)
Creates aChoiceBoxListCellinstance with the given items being used to populate theChoiceBoxwhen it is shown, and theStringConverterbeing used to convert the item in to a user-readable form.- Parameters:
converter- AStringConverterthat can convert an item of type T into a user-readable string so that it may then be shown in the ChoiceBox popup menu.items- The items to show in the ChoiceBox popup menu when selected by the user.
-
ChoiceBoxListCell
public ChoiceBoxListCell(ObservableList<T> items)
Creates a defaultChoiceBoxListCellinstance with the given items being used to populate theChoiceBoxwhen it is shown.- Parameters:
items- The items to show in the ChoiceBox popup menu when selected by the user.
-
ChoiceBoxListCell
public ChoiceBoxListCell(StringConverter<T> converter, ObservableList<T> items)
Creates aChoiceBoxListCellinstance with the given items being used to populate theChoiceBoxwhen it is shown, and theStringConverterbeing used to convert the item in to a user-readable form.- Parameters:
converter- AStringConverterthat can convert an item of type T into a user-readable string so that it may then be shown in the ChoiceBox popup menu.items- The items to show in the ChoiceBox popup menu when selected by the user.
-
-
Method Detail
-
forListView
@SafeVarargs public static <T> Callback<ListView<T>,ListCell<T>> forListView(T... items)
Creates a ChoiceBox cell factory for use inListViewcontrols. By default, the ChoiceBoxCell is rendered as aLabelwhen not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire list cell.- Type Parameters:
T- The type of the elements contained within the ListView.- Parameters:
items- Zero or more items that will be shown to the user when theChoiceBoxmenu is showing. These items must be of the same type as the ListView items list, such that upon selection, they replace the existing value in theitemslist.- Returns:
- A
Callbackthat will return a ListCell that is able to work on the type of element contained within the ListView.
-
forListView
@SafeVarargs public static <T> Callback<ListView<T>,ListCell<T>> forListView(StringConverter<T> converter, T... items)
Creates a ChoiceBox cell factory for use inListViewcontrols. By default, the ChoiceBoxCell is rendered as aLabelwhen not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire list cell.- Type Parameters:
T- The type of the elements contained within the ListView.- Parameters:
converter- AStringConverterto convert the given item (of type T) to a String for displaying to the user.items- Zero or more items that will be shown to the user when theChoiceBoxmenu is showing. These items must be of the same type as the ListView items list, such that upon selection, they replace the existing value in theitemslist.- Returns:
- A
Callbackthat will return a ListCell that is able to work on the type of element contained within the ListView.
-
forListView
public static <T> Callback<ListView<T>,ListCell<T>> forListView(ObservableList<T> items)
Creates a ChoiceBox cell factory for use inListViewcontrols. By default, the ChoiceBoxCell is rendered as aLabelwhen not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire list cell.- Type Parameters:
T- The type of the elements contained within the ListView.- Parameters:
items- AnObservableListcontaining zero or more items that will be shown to the user when theChoiceBoxmenu is showing. These items must be of the same type as the ListView items sequence, such that upon selection, they replace the existing value in theitemslist.- Returns:
- A
Callbackthat will return a ListCell that is able to work on the type of element contained within the ListView.
-
forListView
public static <T> Callback<ListView<T>,ListCell<T>> forListView(StringConverter<T> converter, ObservableList<T> items)
Creates a ChoiceBox cell factory for use inListViewcontrols. By default, the ChoiceBoxCell is rendered as aLabelwhen not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire list cell.- Type Parameters:
T- The type of the elements contained within the ListView.- Parameters:
converter- AStringConverterto convert the given item (of type T) to a String for displaying to the user.items- AnObservableListcontaining zero or more items that will be shown to the user when theChoiceBoxmenu is showing. These items must be of the same type as the ListView items sequence, such that upon selection, they replace the existing value in theitemslist.- Returns:
- A
Callbackthat will return a ListCell that is able to work on the type of element contained within the ListView.
-
converterProperty
public final ObjectProperty<StringConverter<T>> converterProperty()
TheStringConverterproperty.- See Also:
getConverter(),setConverter(StringConverter)
-
setConverter
public final void setConverter(StringConverter<T> value)
Sets theStringConverterto be used in this cell.- Parameters:
value- theStringConverterto be used in this cell
-
getConverter
public final StringConverter<T> getConverter()
Returns theStringConverterused in this cell.- Returns:
- the
StringConverterused in this cell
-
getItems
public ObservableList<T> getItems()
Returns the items to be displayed in the ChoiceBox when it is showing.- Returns:
- the items to be displayed in the ChoiceBox when it is showing
-
-