Module org.icepdf.ri.viewer

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

Class MarkupAnnotationPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

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

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, DocumentListener, MutableDocument

public class MarkupAnnotationPanel
extends JPanel
implements ActionListener, PropertyChangeListener, MutableDocument, DocumentListener

MarkupAnnotationPanel allows users to easily search, sort, filter and view markup annotations and their popup annotation children. The view main purpose to make working with a large number of markup annotations as easy as possible. The view shows all markup annotation in an open document.

Since:

6.3

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarkupAnnotationPanel.FilterAuthorColumn
class	MarkupAnnotationPanel.FilterColorAction
static class	MarkupAnnotationPanel.FilterSubTypeColumn
static class	MarkupAnnotationPanel.FilterVisibilityColumn
static class	MarkupAnnotationPanel.SortColumn

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	COLUMN_PROPERTY
protected GridBagConstraints	constraints
protected ResourceBundle	messageBundle

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
MarkupAnnotationPanel(SwingController controller)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
protected void	addGB(JPanel layout, Component component, int x, int y, int rowSpan, int colSpan)
protected void	applyAnnotationStatusLabel(Annotation annotation)	Apply <Public | Private> | <Color label name, if exists> message format for any named colours
protected void	buildMarkupAnnotationCommentView()
protected void	buildSearchBar()
protected void	buildSortFilterToolBar()
void	changedUpdate(DocumentEvent e)
void	disposeDocument()	Swing controller is calling dispose and any post document clean up should be made.
QuickPaintAnnotationButton	getQuickPaintAnnotationButton()
void	insertUpdate(DocumentEvent e)
void	propertyChange(PropertyChangeEvent evt)
void	refreshColorPanel()
void	refreshDocumentInstance()	Swing controller should be checked to retrieve a new document instance.
void	removeUpdate(DocumentEvent e)
void	setAnnotationUtilityToolbar(JToolBar annotationUtilityToolbar)
void	setParentPanel(AnnotationPanel parentPanel)
protected void	sortAndFilterAnnotationData()

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

Field Detail

COLUMN_PROPERTY

public static final String COLUMN_PROPERTY

See Also:

Constant Field Values

constraints

protected GridBagConstraints constraints

messageBundle

protected final ResourceBundle messageBundle

Constructor Detail

MarkupAnnotationPanel

public MarkupAnnotationPanel(SwingController controller)

Method Detail

setParentPanel

public void setParentPanel(AnnotationPanel parentPanel)

setAnnotationUtilityToolbar

public void setAnnotationUtilityToolbar(JToolBar annotationUtilityToolbar)

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

applyAnnotationStatusLabel

protected void applyAnnotationStatusLabel(Annotation annotation)

Apply <Public | Private> | <Color label name, if exists> message format for any named colours

Parameters:

annotation - annotation to generate status lable from.

getQuickPaintAnnotationButton

public QuickPaintAnnotationButton getQuickPaintAnnotationButton()

buildSearchBar

protected void buildSearchBar()

buildSortFilterToolBar

protected void buildSortFilterToolBar()

refreshColorPanel

public void refreshColorPanel()

buildMarkupAnnotationCommentView

protected void buildMarkupAnnotationCommentView()

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

sortAndFilterAnnotationData

protected void sortAndFilterAnnotationData()

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

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

addGB

protected void addGB(JPanel layout,
                     Component component,
                     int x,
                     int y,
                     int rowSpan,
                     int colSpan)