Package org.faceless.pdf2.viewer2.feature

Class SearchField

  • All Implemented Interfaces:
    DocumentPanelListener
    public class SearchField
extends ViewerWidget
implements DocumentPanelListener
    Create a widget that displays a Search field in the Toolbar. When activated, this widget will select or create a SearchPanel.Results and display the search results. The name of this feature is SearchField
    The following initialization parameters can be specified to configure this feature.
    regextrue or false for setUseRegex(boolean)

    This code is copyright the Big Faceless Organization. You're welcome to use, modify and distribute it in any form in your own projects, provided those projects continue to make use of the Big Faceless PDF library.

    Since:
    2.8

    • Constructor Detail

      • SearchField

        public SearchField()

    • Method Detail

      • setUseRegex

        public void setUseRegex​(boolean regex)
        Set whether searches run through the Search Field created by this class use a regular-expression instead of a text value. The default is false.
        Parameters:
        regex - whether to use a regular expression or not
        Since:
        2.18.3

      • setMerged

        public void setMerged​(boolean merged)
        Set whether to merge search results on a single page into one entry, which will highlight all results on that page when selected. By default this is set to false.
        Parameters:
        merge - whether to merge the results as described
        Since:
        2.28.2

      • getMinLength

        public int getMinLength()
        Return the minimum length a search term has to be before it's a valid term
        Since:
        2.29.1

      • setMinLength

        public void setMinLength​(int length)
        Set the minimum length a search term has to be before it's a valid term
        Parameters:
        length - the minimum length
        Since:
        2.29.1

      • isSearchValid

        public boolean isSearchValid​(String text)
        Return true if the specified value is a valid search term. Invalid terms will be rejected by the search fields, although they will still be accepted if you pass them directly to the #search method. The default implementation returns text.length() >= getMinLength()
        Parameters:
        text - the text value
        Returns:
        whether the term is valid
        Since:
        2.29.1