Module org.icepdf.ri.viewer

Package org.icepdf.ri.common.utility.annotation.markup

Class MarkupAnnotationHandlerPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.icepdf.ri.common.AbstractWorkerPanel

org.icepdf.ri.common.utility.annotation.markup.MarkupAnnotationHandlerPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, TreeSelectionListener, MutableDocument

public class MarkupAnnotationHandlerPanel
extends AbstractWorkerPanel
implements PropertyChangeListener, TreeSelectionListener

The MarkupAnnotationHandlerPanel lists all the markup annotations in a document. A worker thread is used scan the documents for annotations and any found annotations are stored for display. The MarkupAnnotationHandlerPanel has several control to sort and filter the data returned by this task.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.icepdf.ri.common.AbstractWorkerPanel

AbstractWorkerPanel.NodeSelectionListener

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 inherited from class org.icepdf.ri.common.AbstractWorkerPanel

cellRenderer, constraints, controller, messageBundle, nodeSelectionListener, progressBar, progressLabel, rootNodeLabel, rootTreeNode, tree, treeModel, workerTask

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

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(Annotation annotation, Pattern searchPattern)
void	buildUI()	Build the tree based on the current implementation of cellRenderer and the given worker task found by the calling implementation of AbstractWorkerPanel.buildWorkerTaskUI().
protected void	buildWorkerTaskUI()	Builds the tree nodes for the given implementation of the worker
void	endProgressControls()
void	propertyChange(PropertyChangeEvent evt)
void	refreshDocumentInstance()	Set the current document instance.
void	refreshMarkupTree()
void	selectTreeNodeUserObject(Object userObject)	Travers tree model and try and select a node that has a matching user object.
void	sortAndFilterAnnotationData(Pattern searchPattern, MarkupAnnotationPanel.SortColumn sortType, MarkupAnnotationPanel.FilterSubTypeColumn filterType, MarkupAnnotationPanel.FilterAuthorColumn filterAuthor, MarkupAnnotationPanel.FilterVisibilityColumn filterVisibility, Color filterColor, boolean isRegex, boolean isCaseSensitive)
void	startProgressControls(int lengthOfTask)
void	updateProgressControls(int progress)
void	updateProgressControls(int progress, String label)
void	updateProgressControls(String label)
void	valueChanged(TreeSelectionEvent e)

Methods inherited from class org.icepdf.ri.common.AbstractWorkerPanel

addGB, buildProgressBar, disposeDocument, expandAllNodes, getDocumentTitle, getProgressBar, resetTree, stopWorkerTask

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, 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, setVisible, 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

Method Detail

refreshDocumentInstance

public void refreshDocumentInstance()

Description copied from class: AbstractWorkerPanel

Set the current document instance. The method executed is the abstract AbstractWorkerPanel.buildWorkerTaskUI() method which kicks off the tree creation process. Check AbstractWorkerPanel.buildWorkerTaskUI() documentation for the implementing class to see what thread this work is done on.

Specified by:

refreshDocumentInstance in interface MutableDocument

Overrides:

refreshDocumentInstance in class AbstractWorkerPanel

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

sortAndFilterAnnotationData

public void sortAndFilterAnnotationData(Pattern searchPattern,
                                        MarkupAnnotationPanel.SortColumn sortType,
                                        MarkupAnnotationPanel.FilterSubTypeColumn filterType,
                                        MarkupAnnotationPanel.FilterAuthorColumn filterAuthor,
                                        MarkupAnnotationPanel.FilterVisibilityColumn filterVisibility,
                                        Color filterColor,
                                        boolean isRegex,
                                        boolean isCaseSensitive)

refreshMarkupTree

public void refreshMarkupTree()

buildUI

public void buildUI()

Description copied from class: AbstractWorkerPanel

Build the tree based on the current implementation of cellRenderer and the given worker task found by the calling implementation of AbstractWorkerPanel.buildWorkerTaskUI(). Before this method is call the following instance variables should be set:

• nodeSelectionListener - event handler for node clicks
• cellRenderer - cell render, implements DefaultTreeCellRenderer
• rootNodeLabel - label for root node

Overrides:

buildUI in class AbstractWorkerPanel

addAnnotation

public void addAnnotation(Annotation annotation,
                          Pattern searchPattern)

startProgressControls

public void startProgressControls(int lengthOfTask)

Specified by:

startProgressControls in class AbstractWorkerPanel

updateProgressControls

public void updateProgressControls(int progress)

Specified by:

updateProgressControls in class AbstractWorkerPanel

updateProgressControls

public void updateProgressControls(int progress,
                                   String label)

Specified by:

updateProgressControls in class AbstractWorkerPanel

updateProgressControls

public void updateProgressControls(String label)

Specified by:

updateProgressControls in class AbstractWorkerPanel

endProgressControls

public void endProgressControls()

Specified by:

endProgressControls in class AbstractWorkerPanel

buildWorkerTaskUI

protected void buildWorkerTaskUI()

Description copied from class: AbstractWorkerPanel

Builds the tree nodes for the given implementation of the worker

Specified by:

buildWorkerTaskUI in class AbstractWorkerPanel

selectTreeNodeUserObject

public void selectTreeNodeUserObject(Object userObject)

Description copied from class: AbstractWorkerPanel

Travers tree model and try and select a node that has a matching user object.

Specified by:

selectTreeNodeUserObject in class AbstractWorkerPanel

Parameters:

userObject - user object to try and find in the tree

valueChanged

public void valueChanged(TreeSelectionEvent e)

Specified by:

valueChanged in interface TreeSelectionListener