SearchHighlightOptions
Contents
[
Hide
]
Inheritance: java.lang.Object
public final class SearchHighlightOptions
Provides options for searching and highlighting text in the documents, loaded to the Viewer class.
Constructors
| Constructor | Description |
|---|---|
| SearchHighlightOptions() | |
| SearchHighlightOptions(String searchTerm, boolean searchTermRegEx, Argb32Color backgroundColor, Argb32Color foregroundColor) |
Methods
SearchHighlightOptions()
public SearchHighlightOptions()
SearchHighlightOptions(String searchTerm, boolean searchTermRegEx, Argb32Color backgroundColor, Argb32Color foregroundColor)
public SearchHighlightOptions(String searchTerm, boolean searchTermRegEx, Argb32Color backgroundColor, Argb32Color foregroundColor)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| searchTerm | java.lang.String | |
| searchTermRegEx | boolean | |
| backgroundColor | Argb32Color | |
| foregroundColor | Argb32Color |
isSearchTermRegEx()
public boolean isSearchTermRegEx()
Returns: boolean
setSearchTermRegEx(boolean searchTermRegEx)
public void setSearchTermRegEx(boolean searchTermRegEx)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| searchTermRegEx | boolean |
getSearchTerm()
public String getSearchTerm()
Returns: java.lang.String
setSearchTerm(String searchTerm)
public void setSearchTerm(String searchTerm)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| searchTerm | java.lang.String |
getBackgroundColor()
public Argb32Color getBackgroundColor()
Returns: Argb32Color
setBackgroundColor(Argb32Color backgroundColor)
public void setBackgroundColor(Argb32Color backgroundColor)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| backgroundColor | Argb32Color |
getForegroundColor()
public Argb32Color getForegroundColor()
Returns: Argb32Color
setForegroundColor(Argb32Color foregroundColor)
public void setForegroundColor(Argb32Color foregroundColor)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| foregroundColor | Argb32Color |