SearchField (Big Faceless PDF Library 2.28.2)

java.lang.Object
- org.faceless.pdf2.viewer2.ViewerFeature
- - org.faceless.pdf2.viewer2.ViewerWidget
  - - org.faceless.pdf2.viewer2.feature.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.

regex true 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

Field Summary
- Fields inherited from class org.faceless.pdf2.viewer2.ViewerWidget
  propertyChangeSupport

Constructor Summary

Constructors
Constructor Description

SearchField()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`documentUpdated(DocumentPanelEvent event)`	Called when an `DocumentPanelEvent` is raised
`void`	`initialize(PDFViewer viewer)`	Called when the feature is first added to a viewer
`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.
`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.

Methods inherited from class org.faceless.pdf2.viewer2.ViewerWidget
action, addPropertyChangeListener, createActionListener, firePropertyChange, getComponent, getIcon, getViewer, isButtonEnabledByDefault, isDocumentRequired, isMenuEnabledByDefault, removePropertyChangeListener, setButton, setComponent, setDocumentRequired, setMenu, setMenu, setToolBarEnabled, setToolBarEnabledAlways, setToolBarFloatable, setToolBarFloating, toString

Methods inherited from class org.faceless.pdf2.viewer2.ViewerFeature
getAllEnabledFeatures, getAllFeatures, getCustomJavaScript, getFeatureProperty, getFeatureURLProperty, getName, isEnabledByDefault, setFeatureName, teardown

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SearchField
```
public SearchField()
```
- Method Detail
  - initialize
```
public void initialize(PDFViewer viewer)
```
    Description copied from class: ViewerFeature
    
    Called when the feature is first added to a viewer
    
    Overrides:
    
    initialize in class ViewerWidget
  - 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
  - documentUpdated
```
public void documentUpdated(DocumentPanelEvent event)
```
    Description copied from interface: DocumentPanelListener
    
    Called when an DocumentPanelEvent is raised
    
    Specified by:
    
    documentUpdated in interface DocumentPanelListener