Class ChipsViewContainer

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.layout.FlowPane
com.dlsc.gemsfx.ChipsViewContainer
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget
public class ChipsViewContainer extends javafx.scene.layout.FlowPane
A container used for displaying several ChipView instances. This view is usually used in combination with a parent filter view (e.g. SimpleFilterView). The view also manages a hyperlink for clearing the current selection settings iin the parent view. The view manages its own visibility based on whether there are any chip views to show or not.
See Also:

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ListProperty<ChipView<?>>
    chips
    The list of chip views that will be shown by the view.
    final javafx.beans.property.StringProperty
    clearText
    A property storing the text for the hyperlink that is being used to clear the view.
    final javafx.beans.property.ObjectProperty<Runnable>
    onClear
    A callback that will be invoked when the user clicks on the "clear" hyperlink.

    Properties inherited from class javafx.scene.layout.FlowPane

    alignment, columnHalignment, hgap, orientation, prefWrapLength, rowValignment, vgap

    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
    Modifier and Type
    Field
    Description
    final javafx.beans.property.ObjectProperty<Runnable>
    onClear
     

    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
    ChipsViewContainer()
    Constructs a new chips view container.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ListProperty<ChipView<?>>
    chipsProperty()
    The list of chip views that will be shown by the view.
    final javafx.beans.property.StringProperty
    clearTextProperty()
    A property storing the text for the hyperlink that is being used to clear the view.
    final javafx.collections.ObservableList<ChipView<?>>
    getChips()
    Gets the value of the chips property.
    final String
    getClearText()
    Gets the value of the clearText property.
    final Runnable
    getOnClear()
    Gets the value of the onClear property.
    String
    getUserAgentStylesheet()
     
    final javafx.beans.property.ObjectProperty<Runnable>
    onClearProperty()
    A callback that will be invoked when the user clicks on the "clear" hyperlink.
    final void
    setChips(javafx.collections.ObservableList<ChipView<?>> chips)
    Sets the value of the chips property.
    final void
    setClearText(String clearText)
    Sets the value of the clearText property.
    final void
    setOnClear(Runnable onClear)
    Sets the value of the onClear property.

    Methods inherited from class javafx.scene.layout.FlowPane

    alignmentProperty, clearConstraints, columnHalignmentProperty, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getClassCssMetaData, getColumnHalignment, getContentBias, getCssMetaData, getHgap, getMargin, getOrientation, getPrefWrapLength, getRowValignment, getVgap, hgapProperty, layoutChildren, orientationProperty, prefWrapLengthProperty, requestLayout, rowValignmentProperty, setAlignment, setColumnHalignment, setHgap, setMargin, setOrientation, setPrefWrapLength, setRowValignment, setVgap, vgapProperty

    Methods inherited from class javafx.scene.layout.Pane

    getChildren

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, 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

    getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, 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, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, 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, requestFocusTraversal, 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 Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

  • Field Details

    • onClear

      public final javafx.beans.property.ObjectProperty<Runnable> onClear

  • Constructor Details

    • ChipsViewContainer

      public ChipsViewContainer()
      Constructs a new chips view container.

  • Method Details

    • getUserAgentStylesheet

      public String getUserAgentStylesheet()
      Overrides:
      getUserAgentStylesheet in class javafx.scene.layout.Region

    • getChips

      public final javafx.collections.ObservableList<ChipView<?>> getChips()
      Gets the value of the chips property.
      Property description:
      The list of chip views that will be shown by the view.
      Returns:
      the value of the chips property
      See Also:

    • chipsProperty

      public final javafx.beans.property.ListProperty<ChipView<?>> chipsProperty()
      The list of chip views that will be shown by the view.
      Returns:
      the chip views
      See Also:

    • setChips

      public final void setChips(javafx.collections.ObservableList<ChipView<?>> chips)
      Sets the value of the chips property.
      Property description:
      The list of chip views that will be shown by the view.
      Parameters:
      chips - the value for the chips property
      See Also:

    • getOnClear

      public final Runnable getOnClear()
      Gets the value of the onClear property.
      Property description:
      A callback that will be invoked when the user clicks on the "clear" hyperlink.
      Returns:
      the value of the onClear property
      See Also:

    • onClearProperty

      public final javafx.beans.property.ObjectProperty<Runnable> onClearProperty()
      A callback that will be invoked when the user clicks on the "clear" hyperlink.
      Returns:
      the "on clear" callback
      See Also:

    • setOnClear

      public final void setOnClear(Runnable onClear)
      Sets the value of the onClear property.
      Property description:
      A callback that will be invoked when the user clicks on the "clear" hyperlink.
      Parameters:
      onClear - the value for the onClear property
      See Also:

    • getClearText

      public final String getClearText()
      Gets the value of the clearText property.
      Property description:
      A property storing the text for the hyperlink that is being used to clear the view.
      Returns:
      the value of the clearText property
      See Also:

    • clearTextProperty

      public final javafx.beans.property.StringProperty clearTextProperty()
      A property storing the text for the hyperlink that is being used to clear the view.
      Returns:
      the text property used for the text of the hyperlink used to clear the view
      See Also:

    • setClearText

      public final void setClearText(String clearText)
      Sets the value of the clearText property.
      Property description:
      A property storing the text for the hyperlink that is being used to clear the view.
      Parameters:
      clearText - the value for the clearText property
      See Also: