Module com.iamsoft.util.ui
Package com.iamsoft.util.ui.javafx

Class SearchBox

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.layout.HBox
com.iamsoft.util.ui.javafx.SearchBox
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget
Direct Known Subclasses:
CodeAreaSearchBox
public class SearchBox extends javafx.scene.layout.HBox
'Search' field.

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.BooleanProperty
    displaySearchResultInfo
     
    final javafx.beans.property.ObjectProperty<BiFunction<String,String,javafx.collections.ObservableList<String>>>
    findSuggestionsFactory
     
    final javafx.beans.property.StringProperty
    findSuggestionsId
     

    Properties inherited from class javafx.scene.layout.HBox

    alignment, fillHeight, spacing

    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
    static final String
    FIND_TEXT
     
    protected static final javafx.scene.image.Image
    MATCH_CASE_ICON
     
    protected static final String
    MATCH_CASE_TEXT
     
    static final javafx.scene.input.KeyCombination
    NEXT_ACCELERATOR
     
    protected static final javafx.scene.image.Image
    NEXT_ICON
     
    protected static final String
    NEXT_TEXT
     
    protected static final javafx.scene.image.Image
    PLAIN_ICON
     
    protected static final String
    PLAIN_TEXT
     
    static final javafx.scene.input.KeyCombination
    PREV_ACCELERATOR
     
    protected static final javafx.scene.image.Image
    PREV_ICON
     
    protected static final String
    PREV_TEXT
     
    protected static final javafx.scene.image.Image
    REGEX_ICON
     
    protected static final String
    REGEX_TEXT
     
    protected static final javafx.scene.image.Image
    XPATH_ICON
     
    protected static final String
    XPATH_TEXT
     

    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
    SearchBox()
     
    SearchBox(Function<FindTextFieldSupport,AbstractTableFindSupport> pCreateFindSupport)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.controlsfx.control.action.Action
    createFindAction(javafx.beans.property.BooleanProperty pToolBarVisible)
     
    protected javafx.scene.control.ToggleButton
    createMatchCaseBtn()
     
    protected javafx.scene.control.Button
    createNextBtn()
     
    protected javafx.scene.control.ToggleButton
    createPlainTextBtn()
     
    protected javafx.scene.control.Button
    createPrevBtn()
     
    protected javafx.scene.control.ToggleButton
    createRegexBtn()
     
    protected javafx.scene.control.ToggleButton
    createXPathBtn()
     
    javafx.beans.property.BooleanProperty
    displaySearchResultInfoProperty()
     
    final javafx.beans.property.ObjectProperty<BiFunction<String,String,javafx.collections.ObservableList<String>>>
    findSuggestionsFactoryProperty()
     
    final javafx.beans.property.StringProperty
    findSuggestionsIdProperty()
     
    void
    fireNextBtn()
     
    void
    firePrevBtn()
     
    boolean
    getDisplaySearchResultInfo()
    Gets the value of the property displaySearchResultInfo.
    final BiFunction<String,String,javafx.collections.ObservableList<String>>
    getFindSuggestionsFactory()
    Gets the value of the property findSuggestionsFactory.
    final String
    getFindSuggestionsId()
    Gets the value of the property findSuggestionsId.
    javafx.scene.control.TextField
    getFindTextField()
     
    FindTextFieldSupport
    getFindTextFieldSupport()
     
    final javafx.scene.control.Label
    getFindTextFieldWrapper()
    A wrapper which can be used as a workaround for showing default cursor for 'error' badge (bug 1835).
    javafx.scene.control.ToggleButton
    getMatchCaseBtn()
     
    javafx.scene.control.Button
    getNextBtn()
     
    final javafx.scene.control.ToggleButton
    getPlainTextBtn()
     
    javafx.scene.control.Button
    getPrevBtn()
     
    final javafx.scene.control.ToggleButton
    getRegexBtn()
     
    org.controlsfx.control.SegmentedButton
    getSearchTypeBtn()
     
    AbstractTableFindSupport
    getTableFindSupport()
     
    final javafx.scene.control.ToggleButton
    getXPathBtn()
     
    void
    requestFind(javafx.beans.property.BooleanProperty pToolBarVisible)
    Sets the tool bar to be visible (if it is not) and requests the focus for the find text field.
    void
    setDisplaySearchResultInfo(boolean pDisplaySearchResultInfo)
    Sets the value of the property displaySearchResultInfo.
    final void
    setFindSuggestionsFactory(BiFunction<String,String,javafx.collections.ObservableList<String>> pFactory)
    Sets the value of the property findSuggestionsFactory.
    final void
    setFindSuggestionsId(String pId)
    Sets the value of the property findSuggestionsId.
    void
    setTableFindSupport(AbstractTableFindSupport pTableFindSupport)
     

    Methods inherited from class javafx.scene.layout.HBox

    alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, fillHeightProperty, getAlignment, getBaselineOffset, getClassCssMetaData, getContentBias, getCssMetaData, getHgrow, getMargin, getSpacing, isFillHeight, layoutChildren, requestLayout, setAlignment, setFillHeight, setHgrow, setMargin, setSpacing, spacingProperty

    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, getUserAgentStylesheet, 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

    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, 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

  • Field Details

    • PREV_TEXT

      protected static final String PREV_TEXT
      See Also:

    • PREV_ICON

      protected static final javafx.scene.image.Image PREV_ICON

    • PREV_ACCELERATOR

      public static final javafx.scene.input.KeyCombination PREV_ACCELERATOR

    • NEXT_TEXT

      protected static final String NEXT_TEXT
      See Also:

    • NEXT_ICON

      protected static final javafx.scene.image.Image NEXT_ICON

    • NEXT_ACCELERATOR

      public static final javafx.scene.input.KeyCombination NEXT_ACCELERATOR

    • MATCH_CASE_TEXT

      protected static final String MATCH_CASE_TEXT
      See Also:

    • MATCH_CASE_ICON

      protected static final javafx.scene.image.Image MATCH_CASE_ICON

    • REGEX_TEXT

      protected static final String REGEX_TEXT
      See Also:

    • REGEX_ICON

      protected static final javafx.scene.image.Image REGEX_ICON

    • PLAIN_TEXT

      protected static final String PLAIN_TEXT
      See Also:

    • PLAIN_ICON

      protected static final javafx.scene.image.Image PLAIN_ICON

    • XPATH_TEXT

      protected static final String XPATH_TEXT
      See Also:

    • XPATH_ICON

      protected static final javafx.scene.image.Image XPATH_ICON

    • FIND_TEXT

      public static final String FIND_TEXT
      See Also:

  • Constructor Details

  • Method Details

    • getFindTextFieldSupport

      public FindTextFieldSupport getFindTextFieldSupport()

    • getFindTextField

      public javafx.scene.control.TextField getFindTextField()

    • getFindTextFieldWrapper

      public final javafx.scene.control.Label getFindTextFieldWrapper()
      A wrapper which can be used as a workaround for showing default cursor for 'error' badge (bug 1835).

    • getPrevBtn

      public javafx.scene.control.Button getPrevBtn()

    • getNextBtn

      public javafx.scene.control.Button getNextBtn()

    • getMatchCaseBtn

      public javafx.scene.control.ToggleButton getMatchCaseBtn()

    • getPlainTextBtn

      public final javafx.scene.control.ToggleButton getPlainTextBtn()

    • getRegexBtn

      public final javafx.scene.control.ToggleButton getRegexBtn()

    • getXPathBtn

      public final javafx.scene.control.ToggleButton getXPathBtn()

    • getSearchTypeBtn

      public org.controlsfx.control.SegmentedButton getSearchTypeBtn()

    • getTableFindSupport

      public AbstractTableFindSupport getTableFindSupport()

    • findSuggestionsIdProperty

      public final javafx.beans.property.StringProperty findSuggestionsIdProperty()
      See Also:

    • getFindSuggestionsId

      public final String getFindSuggestionsId()
      Gets the value of the property findSuggestionsId.
      Property description:

    • setFindSuggestionsId

      public final void setFindSuggestionsId(String pId)
      Sets the value of the property findSuggestionsId.
      Property description:

    • findSuggestionsFactoryProperty

      public final javafx.beans.property.ObjectProperty<BiFunction<String,String,javafx.collections.ObservableList<String>>> findSuggestionsFactoryProperty()
      See Also:

    • getFindSuggestionsFactory

      public final BiFunction<String,String,javafx.collections.ObservableList<String>> getFindSuggestionsFactory()
      Gets the value of the property findSuggestionsFactory.
      Property description:

    • setFindSuggestionsFactory

      public final void setFindSuggestionsFactory(BiFunction<String,String,javafx.collections.ObservableList<String>> pFactory)
      Sets the value of the property findSuggestionsFactory.
      Property description:

    • displaySearchResultInfoProperty

      public javafx.beans.property.BooleanProperty displaySearchResultInfoProperty()
      See Also:

    • getDisplaySearchResultInfo

      public boolean getDisplaySearchResultInfo()
      Gets the value of the property displaySearchResultInfo.
      Property description:

    • setDisplaySearchResultInfo

      public void setDisplaySearchResultInfo(boolean pDisplaySearchResultInfo)
      Sets the value of the property displaySearchResultInfo.
      Property description:

    • createPrevBtn

      protected javafx.scene.control.Button createPrevBtn()

    • createNextBtn

      protected javafx.scene.control.Button createNextBtn()

    • createMatchCaseBtn

      protected javafx.scene.control.ToggleButton createMatchCaseBtn()

    • createRegexBtn

      protected javafx.scene.control.ToggleButton createRegexBtn()

    • createPlainTextBtn

      protected javafx.scene.control.ToggleButton createPlainTextBtn()

    • createXPathBtn

      protected javafx.scene.control.ToggleButton createXPathBtn()

    • requestFind

      public void requestFind(javafx.beans.property.BooleanProperty pToolBarVisible)
      Sets the tool bar to be visible (if it is not) and requests the focus for the find text field.
      Parameters:
      pToolBarVisible - visibility

    • createFindAction

      public org.controlsfx.control.action.Action createFindAction(javafx.beans.property.BooleanProperty pToolBarVisible)

    • firePrevBtn

      public void firePrevBtn()

    • fireNextBtn

      public void fireNextBtn()

    • setTableFindSupport

      public void setTableFindSupport(AbstractTableFindSupport pTableFindSupport)