Module org.icepdf.ri.viewer

Package org.icepdf.ri.common.utility.search

Class SearchPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.icepdf.ri.common.utility.search.SearchPanel

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, DocumentListener, TreeSelectionListener, MutableDocument, BaseRedactModel, BaseSearchModel

public class SearchPanel
extends JPanel
implements ActionListener, MutableDocument, TreeSelectionListener, DocumentListener, BaseSearchModel, BaseRedactModel

This class is the GUI component for the SearchTextTask. This panel can be added to a utility panel. The GUI allows users to type in a search string and displays a JList of all the pages that have results. Each list item can be selected, and when selected, the viewer will show the corresponding page.

Since:

1.1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static String	BOLD_TAG_END
static String	BOLD_TAG_START
static String	HTML_TAG_END
static String	HTML_TAG_START

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
SearchPanel(SwingController controller)	Create a new instance of SearchPanel.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent event)	Two main actions are handle here, search and clear search.
void	addFoundCommentEntry(SearchTextTask.CommentsResult comment, SearchTextTask searchTextTask)
void	addFoundDestinationEntry(SearchTextTask.DestinationsResult destinationResult, SearchTextTask searchTextTask)
void	addFoundFormsEntry(SearchTextTask.FormsResult formsResult, SearchTextTask searchTextTask)
void	addFoundOutlineEntry(SearchTextTask.OutlineResult outlineResult, SearchTextTask searchTextTask)
void	addFoundTextEntry(SearchTextTask.TextResult textResult, SearchTextTask searchTextTask)	Adds a new node item to the treeModel.
void	changedUpdate(DocumentEvent e)
void	disposeDocument()	Swing controller is calling dispose and any post document clean up should be made.
String	getSearchPhrase()
void	insertUpdate(DocumentEvent e)
void	notifySearchFiltersChanged()
void	refreshDocumentInstance()	Swing controller should be checked to retrieve a new document instance.
void	removeUpdate(DocumentEvent e)
void	requestFocus()
void	setSearchPhrase(String searchPhrase)
MessageFormat	setupRedactCompletionMessageForm()
MessageFormat	setupRedactingMessageForm()
MessageFormat	setupSearchCompletionMessageForm()
MessageFormat	setupSearchingMessageForm()	Utility for creating the searching message format.
MessageFormat	setupSearchResultMessageForm()	Utility for creating the searchable dialog message format.
void	setVisible(boolean flag)
void	updateProgressControls(String message)
void	valueChanged(TreeSelectionEvent e)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

HTML_TAG_START

public static final String HTML_TAG_START

See Also:

Constant Field Values

HTML_TAG_END

public static final String HTML_TAG_END

See Also:

Constant Field Values

BOLD_TAG_START

public static final String BOLD_TAG_START

See Also:

Constant Field Values

BOLD_TAG_END

public static final String BOLD_TAG_END

See Also:

Constant Field Values

Constructor Detail

SearchPanel

public SearchPanel(SwingController controller)

Create a new instance of SearchPanel.

Parameters:

controller - root Controller

Method Detail

getSearchPhrase

public String getSearchPhrase()

setSearchPhrase

public void setSearchPhrase(String searchPhrase)

refreshDocumentInstance

public void refreshDocumentInstance()

Description copied from interface: MutableDocument

Swing controller should be checked to retrieve a new document instance.

Specified by:

refreshDocumentInstance in interface MutableDocument

disposeDocument

public void disposeDocument()

Description copied from interface: MutableDocument

Swing controller is calling dispose and any post document clean up should be made.

Specified by:

disposeDocument in interface MutableDocument

setVisible

public void setVisible(boolean flag)

Overrides:

setVisible in class JComponent

requestFocus

public void requestFocus()

Overrides:

requestFocus in class JComponent

valueChanged

public void valueChanged(TreeSelectionEvent e)

Specified by:

valueChanged in interface TreeSelectionListener

addFoundTextEntry

public void addFoundTextEntry(SearchTextTask.TextResult textResult,
                              SearchTextTask searchTextTask)

Adds a new node item to the treeModel.

Specified by:

addFoundTextEntry in interface BaseSearchModel

Parameters:

textResult - search result

searchTextTask - search task conducting the gui build.

addFoundFormsEntry

public void addFoundFormsEntry(SearchTextTask.FormsResult formsResult,
                               SearchTextTask searchTextTask)

Specified by:

addFoundFormsEntry in interface BaseSearchModel

addFoundCommentEntry

public void addFoundCommentEntry(SearchTextTask.CommentsResult comment,
                                 SearchTextTask searchTextTask)

Specified by:

addFoundCommentEntry in interface BaseSearchModel

addFoundOutlineEntry

public void addFoundOutlineEntry(SearchTextTask.OutlineResult outlineResult,
                                 SearchTextTask searchTextTask)

Specified by:

addFoundOutlineEntry in interface BaseSearchModel

addFoundDestinationEntry

public void addFoundDestinationEntry(SearchTextTask.DestinationsResult destinationResult,
                                     SearchTextTask searchTextTask)

Specified by:

addFoundDestinationEntry in interface BaseSearchModel

insertUpdate

public void insertUpdate(DocumentEvent e)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent e)

Specified by:

removeUpdate in interface DocumentListener

changedUpdate

public void changedUpdate(DocumentEvent e)

Specified by:

changedUpdate in interface DocumentListener

notifySearchFiltersChanged

public void notifySearchFiltersChanged()

Specified by:

notifySearchFiltersChanged in interface BaseSearchModel

actionPerformed

public void actionPerformed(ActionEvent event)

Two main actions are handle here, search and clear search.

Specified by:

actionPerformed in interface ActionListener

Parameters:

event - awt action event.

setupSearchResultMessageForm

public MessageFormat setupSearchResultMessageForm()

Utility for creating the searchable dialog message format.

Specified by:

setupSearchResultMessageForm in interface BaseSearchModel

Returns:

reusable message format.

setupSearchingMessageForm

public MessageFormat setupSearchingMessageForm()

Utility for creating the searching message format.

Specified by:

setupSearchingMessageForm in interface BaseSearchModel

Returns:

reusable message format.

setupSearchCompletionMessageForm

public MessageFormat setupSearchCompletionMessageForm()

Specified by:

setupSearchCompletionMessageForm in interface BaseSearchModel

setupRedactingMessageForm

public MessageFormat setupRedactingMessageForm()

Specified by:

setupRedactingMessageForm in interface BaseRedactModel

setupRedactCompletionMessageForm

public MessageFormat setupRedactCompletionMessageForm()

Specified by:

setupRedactCompletionMessageForm in interface BaseRedactModel

updateProgressControls

public void updateProgressControls(String message)

Specified by:

updateProgressControls in interface BaseRedactModel

Specified by:

updateProgressControls in interface BaseSearchModel