Module com.gluonhq.charm.glisten

Package com.gluonhq.charm.glisten.control

Class Chip

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

com.gluonhq.charm.glisten.control.Chip

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

@DefaultProperty("text")
public class Chip
extends Control

Chips represent complex entities in small blocks, such as a contact. They can contain a photo, short title string, and brief information. They can also either be deletable, i.e. present a delete button, or not.

Since:

2.0.0

Property Summary

Properties

Type	Property	Description
BooleanProperty	deletable	Indicates whether this Chip is deletable.
StyleableObjectProperty<Image>	graphic	An optional graphic for the Chip
ObjectProperty<EventHandler<ActionEvent>>	onDeleteAction	The action that is to be invoked when the user presses the delete button
StringProperty	text	The text to display in the Chip.

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
Chip()	Creates a non deletable Chip with an empty string for its label.
Chip(String text)	Creates a non deletable Chip with the specified label.
Chip(String text, boolean isDeletable)

Method Summary

Modifier and Type	Method	Description
protected Skin<?>	createDefaultSkin()
BooleanProperty	deletableProperty()	Indicates whether this Chip is deletable.
static List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()
List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
Image	getGraphic()	Gets the value of the property graphic.
EventHandler<ActionEvent>	getOnDeleteAction()	Gets the value of the property onDeleteAction.
String	getText()	Gets the value of the property text.
StyleableObjectProperty<Image>	graphicProperty()	An optional graphic for the Chip
boolean	isDeletable()	Gets the value of the property deletable.
ObjectProperty<EventHandler<ActionEvent>>	onDeleteActionProperty()	The action that is to be invoked when the user presses the delete button
void	setDeletable(boolean value)	Sets the value of the property deletable.
void	setGraphic(Image value)	Sets the value of the property graphic.
void	setOnDeleteAction(EventHandler<ActionEvent> onClose)	Sets the value of the property onDeleteAction.
void	setText(String value)	Sets the value of the property text.
StringProperty	textProperty()	The text to display in the Chip.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, 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, 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 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 Detail

deletable

public final BooleanProperty deletableProperty

Indicates whether this Chip is deletable.

See Also:

isDeletable(), setDeletable(boolean)

text

public final StringProperty textProperty

The text to display in the Chip.

See Also:

getText(), setText(String)

onDeleteAction

public final ObjectProperty<EventHandler<ActionEvent>> onDeleteActionProperty

The action that is to be invoked when the user presses the delete button

See Also:

getOnDeleteAction(), setOnDeleteAction(EventHandler)

graphic

public final StyleableObjectProperty<Image> graphicProperty

An optional graphic for the Chip

See Also:

getGraphic(), setGraphic(Image)

Constructor Detail

Chip

public Chip()

Creates a non deletable Chip with an empty string for its label.

Chip

public Chip(String text)

Creates a non deletable Chip with the specified label.

Parameters:

text - The label string of the control.

Chip

public Chip(String text,
            boolean isDeletable)

Method Detail

deletableProperty

public final BooleanProperty deletableProperty()

Indicates whether this Chip is deletable.

See Also:

isDeletable(), setDeletable(boolean)

setDeletable

public final void setDeletable(boolean value)

Sets the value of the property deletable.

Property description:

Indicates whether this Chip is deletable.

isDeletable

public final boolean isDeletable()

Gets the value of the property deletable.

Property description:

Indicates whether this Chip is deletable.

textProperty

public final StringProperty textProperty()

The text to display in the Chip.

See Also:

getText(), setText(String)

setText

public final void setText(String value)

Sets the value of the property text.

Property description:

The text to display in the Chip.

getText

public final String getText()

Gets the value of the property text.

Property description:

The text to display in the Chip.

onDeleteActionProperty

public final ObjectProperty<EventHandler<ActionEvent>> onDeleteActionProperty()

The action that is to be invoked when the user presses the delete button

See Also:

getOnDeleteAction(), setOnDeleteAction(EventHandler)

setOnDeleteAction

public final void setOnDeleteAction(EventHandler<ActionEvent> onClose)

Sets the value of the property onDeleteAction.

Property description:

The action that is to be invoked when the user presses the delete button

getOnDeleteAction

public final EventHandler<ActionEvent> getOnDeleteAction()

Gets the value of the property onDeleteAction.

Property description:

The action that is to be invoked when the user presses the delete button

graphicProperty

public final StyleableObjectProperty<Image> graphicProperty()

An optional graphic for the Chip

See Also:

getGraphic(), setGraphic(Image)

setGraphic

public final void setGraphic(Image value)

Sets the value of the property graphic.

Property description:

An optional graphic for the Chip

getGraphic

public final Image getGraphic()

Gets the value of the property graphic.

Property description:

An optional graphic for the Chip

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

getClassCssMetaData

public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()

Returns:

The CssMetaData associated with this class, which may include the CssMetaData of its super classes.

Since:

JavaFX 8.0

getControlCssMetaData

public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()

Overrides:

getControlCssMetaData in class Control

Since:

JavaFX 8.0