Class SearchBox

  • All Implemented Interfaces:
    javafx.css.Styleable, javafx.event.EventTarget
    Direct Known Subclasses:
    CodeAreaSearchBox

    public class SearchBox
    extends javafx.scene.layout.HBox
    'Search' field.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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()  
      javafx.beans.property.ObjectProperty<BiFunction<String,​String,​javafx.collections.ObservableList<String>>> findSuggestionsFactoryProperty()  
      javafx.beans.property.StringProperty findSuggestionsIdProperty()  
      void fireNextBtn()  
      void firePrevBtn()  
      boolean getDisplaySearchResultInfo()  
      BiFunction<String,​String,​javafx.collections.ObservableList<String>> getFindSuggestionsFactory()  
      String getFindSuggestionsId()  
      javafx.scene.control.TextField getFindTextField()  
      FindTextFieldSupport getFindTextFieldSupport()  
      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()  
      javafx.scene.control.ToggleButton getPlainTextBtn()  
      javafx.scene.control.Button getPrevBtn()  
      javafx.scene.control.ToggleButton getRegexBtn()  
      org.controlsfx.control.SegmentedButton getSearchTypeBtn()  
      AbstractTableFindSupport getTableFindSupport()  
      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)  
      void setFindSuggestionsFactory​(BiFunction<String,​String,​javafx.collections.ObservableList<String>> pFactory)  
      void setFindSuggestionsId​(String pId)  
      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, 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, 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 interface javafx.css.Styleable

        getStyleableNode
    • Field Detail

      • PREV_ICON

        protected static final javafx.scene.image.Image PREV_ICON
      • PREV_ACCELERATOR

        public static final javafx.scene.input.KeyCombination PREV_ACCELERATOR
      • NEXT_ICON

        protected static final javafx.scene.image.Image NEXT_ICON
      • NEXT_ACCELERATOR

        public static final javafx.scene.input.KeyCombination NEXT_ACCELERATOR
      • MATCH_CASE_ICON

        protected static final javafx.scene.image.Image MATCH_CASE_ICON
      • REGEX_ICON

        protected static final javafx.scene.image.Image REGEX_ICON
      • PLAIN_ICON

        protected static final javafx.scene.image.Image PLAIN_ICON
      • XPATH_ICON

        protected static final javafx.scene.image.Image XPATH_ICON
    • Method Detail

      • 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()
      • findSuggestionsIdProperty

        public final javafx.beans.property.StringProperty findSuggestionsIdProperty()
      • getFindSuggestionsId

        public final String getFindSuggestionsId()
      • setFindSuggestionsId

        public final void setFindSuggestionsId​(String pId)
      • findSuggestionsFactoryProperty

        public final javafx.beans.property.ObjectProperty<BiFunction<String,​String,​javafx.collections.ObservableList<String>>> findSuggestionsFactoryProperty()
      • getFindSuggestionsFactory

        public final BiFunction<String,​String,​javafx.collections.ObservableList<String>> getFindSuggestionsFactory()
      • setFindSuggestionsFactory

        public final void setFindSuggestionsFactory​(BiFunction<String,​String,​javafx.collections.ObservableList<String>> pFactory)
      • displaySearchResultInfoProperty

        public javafx.beans.property.BooleanProperty displaySearchResultInfoProperty()
      • getDisplaySearchResultInfo

        public boolean getDisplaySearchResultInfo()
      • setDisplaySearchResultInfo

        public void setDisplaySearchResultInfo​(boolean pDisplaySearchResultInfo)
      • 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()