Class SearchPanel

  • public class SearchPanel
    extends SidePanelFactory
    Creates a SidePanel that displays search results. This panel may be used instead of or as well as the SearchField - if no SearchField is found the panel will have a field placed at the top automatically (see setCreateSearchField(boolean)).
    The following initialization parameters can be specified to configure this feature.
    createSearchFieldtrue or false for setCreateSearchField(boolean)
    regextrue or false for setUseRegex(boolean)
    The name of this feature is SearchPanel

    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.

    • Constructor Detail

      • SearchPanel

        public SearchPanel()
        Create a new SearchPanel
    • Method Detail

      • setCreateSearchField

        public void setCreateSearchField​(boolean createfield)
        Set whether to create a SearchPanel.Field at the top of the SearchPanel.Results panel. By default this is the case, although if a SearchField is included in the feature list this is turned off.
        createfield - whether to create a Field object or not
      • 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.
        regex - whether to use a regular expression or not
      • setTextTool

        public void setTextTool​(TextTool selection)
        Set the TextTool object that will display the selection when an item in this panel is clicked on. A value of null (the default) will cause the panel to use the first TextTool object it finds in the viewer, or if none exists a new one will be created.
        selection - the selection object that will be used to display the selected results
      • setMerged

        public void setMerged​(boolean merge)
        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.
        merge - whether to merge the results as described