Module com.dlsc.gemsfx

Package com.dlsc.gemsfx

Class ChipView<T>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

com.dlsc.gemsfx.ChipView<T>

Type Parameters:

T - the model object represented by the chip

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class ChipView<T>
extends javafx.scene.control.Control

A small "badge-style" view representing a model object. One usage inside GemsFX is the display of the currently active filters inside FilterView.

Property Summary

Properties

Type	Property	Description
final javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay>	contentDisplay	The content display property of the chip will be bound to the same property of the label used by the chip's skin.
final javafx.beans.property.ObjectProperty<javafx.scene.Node>	graphic	The graphic node shown by the chip view.
final javafx.beans.property.ObjectProperty<Consumer<T>>	onClose	A callback consumer that will be invoked when the user clicks on the close icon of the chip.
final javafx.beans.property.StringProperty	text
final javafx.beans.property.ObjectProperty<T>	value	The value / model object represented by the chip view.

Properties inherited from class javafx.scene.control.Control

contextMenu, skin, tooltip

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, 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 inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor	Description
ChipView()

Method Summary

Modifier and Type	Method	Description
final javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay>	contentDisplayProperty()	The content display property of the chip will be bound to the same property of the label used by the chip's skin.
protected javafx.scene.control.Skin<?>	createDefaultSkin()
final javafx.scene.control.ContentDisplay	getContentDisplay()	Gets the value of the property contentDisplay.
final javafx.scene.Node	getGraphic()	Gets the value of the property graphic.
final Consumer<T>	getOnClose()	Gets the value of the property onClose.
final String	getText()	The text shown by the view.
String	getUserAgentStylesheet()
final T	getValue()	Gets the value of the property value.
final javafx.beans.property.ObjectProperty<javafx.scene.Node>	graphicProperty()	The graphic node shown by the chip view.
final javafx.beans.property.ObjectProperty<Consumer<T>>	onCloseProperty()	A callback consumer that will be invoked when the user clicks on the close icon of the chip.
final void	setContentDisplay(javafx.scene.control.ContentDisplay contentDisplay)	Sets the value of the property contentDisplay.
final void	setGraphic(javafx.scene.Node graphic)	Sets the value of the property graphic.
final void	setOnClose(Consumer<T> onClose)	Sets the value of the property onClose.
final void	setText(String text)	Sets the value of the property text.
final void	setValue(T value)	Sets the value of the property value.
final javafx.beans.property.StringProperty	textProperty()
final javafx.beans.property.ObjectProperty<T>	valueProperty()	The value / model object represented by the chip view.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, 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 inherited from class javafx.scene.Parent

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

Methods inherited from 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, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, 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, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, 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, 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, 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 inherited from class java.lang.Object

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

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Details

value

public final javafx.beans.property.ObjectProperty<T> valueProperty

The value / model object represented by the chip view.

See Also:

• getValue()
• setValue(T)

text

public final javafx.beans.property.StringProperty textProperty

See Also:

• getText()
• setText(String)

graphic

public final javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicProperty

The graphic node shown by the chip view.

See Also:

• getGraphic()
• setGraphic(Node)

contentDisplay

public final javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay> contentDisplayProperty

The content display property of the chip will be bound to the same property of the label used by the chip's skin. This property allows applications to switch to a "graphics only" mode (see ContentDisplay.GRAPHIC_ONLY).

See Also:

• getContentDisplay()
• setContentDisplay(ContentDisplay)

onClose

public final javafx.beans.property.ObjectProperty<Consumer<T>> onCloseProperty

A callback consumer that will be invoked when the user clicks on the close icon of the chip. Applications can use this property / consumer to update the UI as a result of the closing.

See Also:

• getOnClose()
• setOnClose(Consumer)

Constructor Details

ChipView

public ChipView()

Method Details

createDefaultSkin

protected javafx.scene.control.Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class javafx.scene.control.Control

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class javafx.scene.layout.Region

valueProperty

public final javafx.beans.property.ObjectProperty<T> valueProperty()

The value / model object represented by the chip view.

See Also:

• getValue()
• setValue(T)

getValue

public final T getValue()

Gets the value of the property value.

Property description:

The value / model object represented by the chip view.

setValue

public final void setValue(T value)

Sets the value of the property value.

Property description:

The value / model object represented by the chip view.

textProperty

public final javafx.beans.property.StringProperty textProperty()

See Also:

• getText()
• setText(String)

getText

public final String getText()

The text shown by the view.

Returns:

the chip view's text

setText

public final void setText(String text)

Sets the value of the property text.

Property description:

graphicProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicProperty()

The graphic node shown by the chip view.

See Also:

• getGraphic()
• setGraphic(Node)

getGraphic

public final javafx.scene.Node getGraphic()

Gets the value of the property graphic.

Property description:

The graphic node shown by the chip view.

setGraphic

public final void setGraphic(javafx.scene.Node graphic)

Sets the value of the property graphic.

Property description:

The graphic node shown by the chip view.

getContentDisplay

public final javafx.scene.control.ContentDisplay getContentDisplay()

Gets the value of the property contentDisplay.

Property description:

The content display property of the chip will be bound to the same property of the label used by the chip's skin. This property allows applications to switch to a "graphics only" mode (see ContentDisplay.GRAPHIC_ONLY).

contentDisplayProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay> contentDisplayProperty()

The content display property of the chip will be bound to the same property of the label used by the chip's skin. This property allows applications to switch to a "graphics only" mode (see ContentDisplay.GRAPHIC_ONLY).

See Also:

• getContentDisplay()
• setContentDisplay(ContentDisplay)

setContentDisplay

public final void setContentDisplay(javafx.scene.control.ContentDisplay contentDisplay)

Sets the value of the property contentDisplay.

Property description:

The content display property of the chip will be bound to the same property of the label used by the chip's skin. This property allows applications to switch to a "graphics only" mode (see ContentDisplay.GRAPHIC_ONLY).

onCloseProperty

public final javafx.beans.property.ObjectProperty<Consumer<T>> onCloseProperty()

A callback consumer that will be invoked when the user clicks on the close icon of the chip. Applications can use this property / consumer to update the UI as a result of the closing.

See Also:

• getOnClose()
• setOnClose(Consumer)

getOnClose

public final Consumer<T> getOnClose()

Gets the value of the property onClose.

Property description:

A callback consumer that will be invoked when the user clicks on the close icon of the chip. Applications can use this property / consumer to update the UI as a result of the closing.

setOnClose

public final void setOnClose(Consumer<T> onClose)

Sets the value of the property onClose.

Property description:

A callback consumer that will be invoked when the user clicks on the close icon of the chip. Applications can use this property / consumer to update the UI as a result of the closing.