SearchTextTask (ICEpdf :: Viewer : Swing/AWT Viewer RI 7.3.1 API)

java.lang.Object
- javax.swing.SwingWorker<Void,SearchTextTask.SearchResult>
- - org.icepdf.ri.common.utility.search.SearchTextTask

All Implemented Interfaces:

Runnable, Future<Void>, RunnableFuture<Void>
```
public class SearchTextTask
extends SwingWorker<Void,SearchTextTask.SearchResult>
```
This class is a utility for searching text in a PDF document. This is only a reference implementation.

Since:

1.1

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SearchTextTask.Builder`
`static class`	`SearchTextTask.CommentsResult`
`static class`	`SearchTextTask.DestinationsResult`
`static class`	`SearchTextTask.FormsResult`
`static class`	`SearchTextTask.OutlineResult`
`static class`	`SearchTextTask.SearchResult`
`static class`	`SearchTextTask.TextResult`

Nested classes/interfaces inherited from class javax.swing.SwingWorker
SwingWorker.StateValue

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Void`	`doInBackground()`
`protected void`	`done()`
`int`	`getCurrent()`	Gets the page that is currently being searched by this task.
`String`	`getPattern()`
`Pattern`	`getSearchPattern()`
`boolean`	`isCaseSensitive()`
`boolean`	`isComments()`
`boolean`	`isCumulative()`
`boolean`	`isDestinations()`
`boolean`	`isForms()`
`boolean`	`isOutlines()`
`boolean`	`isRegex()`
`boolean`	`isShowPages()`
`boolean`	`isText()`
`boolean`	`isWholeWord()`
`protected void`	`process(List<SearchTextTask.SearchResult> chunks)`

Methods inherited from class javax.swing.SwingWorker
addPropertyChangeListener, cancel, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, publish, removePropertyChangeListener, run, setProgress

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

Method Detail

getCurrent
```
public int getCurrent()
```
Gets the page that is currently being searched by this task.

Returns:

current page being processed.

doInBackground
```
protected Void doInBackground()
```
Specified by:

doInBackground in class SwingWorker<Void,SearchTextTask.SearchResult>

process
```
protected void process(List<SearchTextTask.SearchResult> chunks)
```
Overrides:

process in class SwingWorker<Void,SearchTextTask.SearchResult>

done
```
protected void done()
```
Overrides:

done in class SwingWorker<Void,SearchTextTask.SearchResult>

getPattern
```
public String getPattern()
```

getSearchPattern
```
public Pattern getSearchPattern()
```

isWholeWord
```
public boolean isWholeWord()
```

isCaseSensitive
```
public boolean isCaseSensitive()
```

isCumulative
```
public boolean isCumulative()
```

isShowPages
```
public boolean isShowPages()
```

isRegex
```
public boolean isRegex()
```

isText
```
public boolean isText()
```

isForms
```
public boolean isForms()
```

isComments
```
public boolean isComments()
```

isOutlines
```
public boolean isOutlines()
```

isDestinations
```
public boolean isDestinations()
```