org.jpedal.examples.viewer.gui.javafx

Class JavaFXSearchWindow

java.lang.Object

javafx.stage.Window

javafx.stage.Stage

org.jpedal.examples.viewer.gui.javafx.JavaFXSearchWindow

All Implemented Interfaces:

javafx.event.EventTarget, GUISearchWindow

public class JavaFXSearchWindow
extends javafx.stage.Stage
implements GUISearchWindow

Provides interactive search Window and search capabilities.

We extend from Stage to add search into the left side-tab or to pop open a search window when either style==SEARCH_EXTERNAL_WINDOW || style==SEARCH_TABBED_PANE search style can be controlled from Viewer preferences.

Property Summary

Properties inherited from class javafx.stage.Stage

alwaysOnTopProperty, fullScreenExitHintProperty, fullScreenExitKeyProperty, fullScreenProperty, iconifiedProperty, maxHeightProperty, maximizedProperty, maxWidthProperty, minHeightProperty, minWidthProperty, resizableProperty, titleProperty

Properties inherited from class javafx.stage.Window

eventDispatcherProperty, focusedProperty, heightProperty, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, sceneProperty, showingProperty, widthProperty, xProperty, yProperty

Field Summary

Fields

Modifier and Type	Field and Description
boolean	hasSearched
boolean	isSearch
boolean	requestInterupt

Fields inherited from class javafx.stage.Window

impl_peer, peerListener

Fields inherited from interface org.jpedal.examples.viewer.gui.generic.GUISearchWindow

SEARCH_EXTERNAL_WINDOW, SEARCH_MENU_BAR, SEARCH_TABBED_PANE

Constructor Summary

Constructors

Constructor and Description
JavaFXSearchWindow(GUIFactory currentGUI)

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose of the search window
void	find(PdfDecoderInt dec, Values values) Find text in PDF using the search window.
void	findWithoutWindow(PdfDecoderInt dec, Values values, int searchType, boolean listOfTerms, boolean singlePageOnly, String searchValue) Find text in PDF without using the search window.
javafx.scene.layout.VBox	getContentVB() Get the Vertical box that holds the search window contents
int	getFirstPageWithResults() Get the first page with results
GUISearchList	getResults() Get the search result list
GUISearchList	getResults(int page) Perform a search on a single page and return the results
Map	getTextRectangles() Get the search result areas for the current results
int	getViewStyle() Get the view style being used by the search interface
void	grabFocusInInput() Have search text input grab focus
void	init(PdfDecoderInt dec, Values values) Not part of API - used internally
boolean	isSearchVisible() Gets the visibility of the search interface (external window style only)
void	removeSearchWindow(boolean justHide) Remove the search window from view and clear the results if required.
void	resetSearchWindow()
void	selectSearchOptions(int options) Set search options using bit flags from an int value.
void	setCaseSensitive(boolean caseSensitive) Set if search should use the case sensitive search rule
void	setMultiLine(boolean multiLine) Set if the search should use the find multi line results rule
void	setSearchText(String s) Set the value of the search input
void	setUpdateListDuringSearch(boolean updateListDuringSearch) Set if the search result list should be updated as the search continues
void	setViewStyle(int i) Set the view style for the search interface using a flag to control the style
void	setWholeWords(boolean wholeWords) Set if search should use the search whole words only rule

Methods inherited from class javafx.stage.Stage

alwaysOnTopProperty, close, fullScreenExitHintProperty, fullScreenExitKeyProperty, fullScreenProperty, getFullScreenExitHint, getFullScreenExitKeyCombination, getIcons, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getModality, getOwner, getStyle, getTitle, iconifiedProperty, impl_getMXWindowType, impl_setImportant, impl_setPrimary, impl_visibleChanged, impl_visibleChanging, initModality, initOwner, initStyle, isAlwaysOnTop, isFullScreen, isIconified, isMaximized, isResizable, maxHeightProperty, maximizedProperty, maxWidthProperty, minHeightProperty, minWidthProperty, resizableProperty, setAlwaysOnTop, setFullScreen, setFullScreenExitHint, setFullScreenExitKeyCombination, setIconified, setMaxHeight, setMaximized, setMaxWidth, setMinHeight, setMinWidth, setResizable, setScene, setTitle, show, showAndWait, titleProperty, toBack, toFront

Methods inherited from class javafx.stage.Window

addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getProperties, getScene, getUserData, getWidth, getX, getY, hasProperties, heightProperty, hide, impl_getPeer, impl_getWindows, isFocused, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, removeEventFilter, removeEventHandler, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setFocused, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setUserData, setWidth, setX, setY, showingProperty, sizeToScene, widthProperty, xProperty, yProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

hasSearched

public boolean hasSearched

isSearch

public boolean isSearch

requestInterupt

public boolean requestInterupt

Constructor Detail

JavaFXSearchWindow

public JavaFXSearchWindow(GUIFactory currentGUI)

Method Detail

find

public void find(PdfDecoderInt dec,
                 Values values)

Find text in PDF using the search window. If the search window has not been initialised it will be initialised here.

Specified by:

find in interface GUISearchWindow

Parameters:

dec - PdfDecoderInt object used for the PDF to be searched

values - Values object used by the user interface

findWithoutWindow

public void findWithoutWindow(PdfDecoderInt dec,
                              Values values,
                              int searchType,
                              boolean listOfTerms,
                              boolean singlePageOnly,
                              String searchValue)

Find text in PDF without using the search window. This will not initialise the user interface when performing searches.

Specified by:

findWithoutWindow in interface GUISearchWindow

Parameters:

dec - PdfDecoderInt object used for the PDF to be searched

values - Values object used by the user interface

searchType - int value using bit flags to control search options

listOfTerms - true to treat search value as a space separated list, false to treat as a single search term

singlePageOnly - true to search just the current page, false to search the entire document

searchValue - String value to be searched, this can be either a single search term or a space separated list of terms controlled by listOfTerms

grabFocusInInput

public void grabFocusInInput()

Have search text input grab focus

Specified by:

grabFocusInInput in interface GUISearchWindow

isSearchVisible

public boolean isSearchVisible()

Gets the visibility of the search interface (external window style only)

Specified by:

isSearchVisible in interface GUISearchWindow

Returns:

true is visible, otherwise false

init

public void init(PdfDecoderInt dec,
                 Values values)

Not part of API - used internally

Used to initialise the search interface ready for use.

Specified by:

init in interface GUISearchWindow

Parameters:

dec - PdfDecoderInt object used for the current PDF

values - Values object used by the user interface

getContentVB

public javafx.scene.layout.VBox getContentVB()

Get the Vertical box that holds the search window contents

Returns:

VBox from the search window

removeSearchWindow

public void removeSearchWindow(boolean justHide)

Remove the search window from view and clear the results if required.

Specified by:

removeSearchWindow in interface GUISearchWindow

Parameters:

justHide - true to keep the results, false to clear results

resetSearchWindow

public void resetSearchWindow()

Specified by:

resetSearchWindow in interface GUISearchWindow

getResults

public GUISearchList getResults()

Get the search result list

Specified by:

getResults in interface GUISearchWindow

Returns:

SearchList containing all search result data

getResults

public GUISearchList getResults(int page)

Perform a search on a single page and return the results

Specified by:

getResults in interface GUISearchWindow

Parameters:

page - int value for the page to be searched

Returns:

SearchList containing the results of the search

getTextRectangles

public Map getTextRectangles()

Get the search result areas for the current results

Specified by:

getTextRectangles in interface GUISearchWindow

Returns:

Map object containing result areas using result index as keys

getViewStyle

public int getViewStyle()

Get the view style being used by the search interface

Specified by:

getViewStyle in interface GUISearchWindow

Returns:

int value representing the search style

setViewStyle

public void setViewStyle(int i)

Set the view style for the search interface using a flag to control the style

For instance the search interface can be displayed as follows. setViewStyle(GUISearchWindow.SEARCH_EXTERNAL_WINDOW); // Show search interface as external window setViewStyle(GUISearchWindow.SEARCH_TABBED_PANE); // Show search interface on side tab bar setViewStyle(GUISearchWindow.SEARCH_MENU_BAR); // Show search interface on button tool bar

Specified by:

setViewStyle in interface GUISearchWindow

Parameters:

i - int value representing the search style

getFirstPageWithResults

public int getFirstPageWithResults()

Get the first page with results

Specified by:

getFirstPageWithResults in interface GUISearchWindow

Returns:

int value for the page of the first result

setWholeWords

public void setWholeWords(boolean wholeWords)

Set if search should use the search whole words only rule

Specified by:

setWholeWords in interface GUISearchWindow

Parameters:

wholeWords - true to enable whole words only rule, false to disable

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Set if search should use the case sensitive search rule

Specified by:

setCaseSensitive in interface GUISearchWindow

Parameters:

caseSensitive - true to enable case sensitive search rule, false to disable

setMultiLine

public void setMultiLine(boolean multiLine)

Set if the search should use the find multi line results rule

Specified by:

setMultiLine in interface GUISearchWindow

Parameters:

multiLine - true to enable find multi line results rule, false to disable

setSearchText

public void setSearchText(String s)

Set the value of the search input

Specified by:

setSearchText in interface GUISearchWindow

Parameters:

s - String value to be used as search input

setUpdateListDuringSearch

public void setUpdateListDuringSearch(boolean updateListDuringSearch)

Set if the search result list should be updated as the search continues

Specified by:

setUpdateListDuringSearch in interface GUISearchWindow

Parameters:

updateListDuringSearch - true to enable live list updating, false to disable

dispose

public void dispose()

Dispose of the search window

Specified by:

dispose in interface GUISearchWindow

selectSearchOptions

public void selectSearchOptions(int options)

Set search options using bit flags from an int value.

Specified by:

selectSearchOptions in interface GUISearchWindow

Parameters:

options - itn value presenting search options to be set