Module org.icepdf.ri.viewer

Package org.icepdf.ri.common.views

Class AbstractDocumentView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLayeredPane

org.icepdf.ri.common.views.AbstractDocumentView

All Implemented Interfaces:

ActionListener, AdjustmentListener, FocusListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, DocumentView

Direct Known Subclasses:

CollectionDocumentView, OneColumnPageView, OnePageView, TwoColumnPageView, TwoPageView

public abstract class AbstractDocumentView
extends JLayeredPane
implements DocumentView, PropertyChangeListener, MouseListener, MouseMotionListener, ActionListener

The AbstractDocumentView class is implemented by the four predefined page views; OneColumnPageView, OnePageView, TwoColumnPageView and TwoPageView. Most of common work is implemented in this class which aid developers in defining their own custom page views.

Since:

2.5

See Also:

Serialized Form

Nested Class Summary

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

JLayeredPane.AccessibleJLayeredPane

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 Color	backgroundColour
protected ToolHandler	currentTool
protected DocumentViewController	documentViewController
protected DocumentViewModel	documentViewModel
static int	horizontalSpace
static int	layoutInserts
protected MouseWheelZoom	mouseWheelZoom
static int	verticalSpace

Fields inherited from class javax.swing.JLayeredPane

DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

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 org.icepdf.ri.common.views.DocumentView

LEFT_VIEW, RIGHT_VIEW

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
AbstractDocumentView(DocumentViewController documentViewController, JScrollPane documentScrollpane, DocumentViewModel documentViewModel)	Creates a new instance of AbstractDocumentView.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)	Auto scroll timer action event, calls method that determine if mouse has left the main viewport on a mouse drag event.
protected void	addPopupAnnotationAndGlue(AbstractPageViewComponent pageViewComponent)
void	adjustmentValueChanged(AdjustmentEvent e)
void	dispose()	Dispose all resources associated with this views.
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent e)
ToolHandler	getCurrentToolHandler()
DocumentViewController	getParentViewController()	Parent document view controller
DocumentViewModel	getViewModel()	Gets the view model associated with this document view.
void	installCurrentTool(ToolHandler currentTool)	Installs the current tool handler.
protected boolean	isTextSelectionTool()
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	paintComponent(Graphics g)	Paints the selection box for this page view.
void	propertyChange(PropertyChangeEvent evt)
void	setToolMode(int viewToolMode)	Sets the tool type/mode that is to be enabled for the particular view.
ToolHandler	uninstallCurrentTool()	Uninstalls the current tool Handler.
abstract void	updateDocumentView()	invalidates page components

Methods inherited from class javax.swing.JLayeredPane

addImpl, getAccessibleContext, getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, paramString, putLayer, remove, removeAll, setLayer, setLayer, setPosition

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, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, 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, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, 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

Methods inherited from interface org.icepdf.ri.common.views.DocumentView

add, add, getDocumentSize, getNextPageIncrement, getPreviousPageIncrement, remove, repaint

Field Detail

backgroundColour

public static Color backgroundColour

verticalSpace

public static final int verticalSpace

See Also:

Constant Field Values

horizontalSpace

public static final int horizontalSpace

See Also:

Constant Field Values

layoutInserts

public static final int layoutInserts

See Also:

Constant Field Values

documentViewController

protected DocumentViewController documentViewController

documentViewModel

protected DocumentViewModel documentViewModel

currentTool

protected ToolHandler currentTool

mouseWheelZoom

protected MouseWheelZoom mouseWheelZoom

Constructor Detail

AbstractDocumentView

public AbstractDocumentView(DocumentViewController documentViewController,
                            JScrollPane documentScrollpane,
                            DocumentViewModel documentViewModel)

Creates a new instance of AbstractDocumentView.

Parameters:

documentViewController - controller for MVC

documentScrollpane - scrollpane used to view pages

documentViewModel - model to represent view

Method Detail

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

getParentViewController

public DocumentViewController getParentViewController()

Description copied from interface: DocumentView

Parent document view controller

Specified by:

getParentViewController in interface DocumentView

Returns:

document view controller

getViewModel

public DocumentViewModel getViewModel()

Description copied from interface: DocumentView

Gets the view model associated with this document view.

Specified by:

getViewModel in interface DocumentView

Returns:

document view model used by this view.

addPopupAnnotationAndGlue

protected void addPopupAnnotationAndGlue(AbstractPageViewComponent pageViewComponent)

dispose

public void dispose()

Description copied from interface: DocumentView

Dispose all resources associated with this views.

Specified by:

dispose in interface DocumentView

updateDocumentView

public abstract void updateDocumentView()

invalidates page components

Specified by:

updateDocumentView in interface DocumentView

uninstallCurrentTool

public ToolHandler uninstallCurrentTool()

Description copied from interface: DocumentView

Uninstalls the current tool Handler.

Specified by:

uninstallCurrentTool in interface DocumentView

Returns:

tool handler that was removed.

installCurrentTool

public void installCurrentTool(ToolHandler currentTool)

Description copied from interface: DocumentView

Installs the current tool handler.

Specified by:

installCurrentTool in interface DocumentView

Parameters:

currentTool - tool ot install.

getCurrentToolHandler

public ToolHandler getCurrentToolHandler()

setToolMode

public void setToolMode(int viewToolMode)

Description copied from interface: DocumentView

Sets the tool type/mode that is to be enabled for the particular view. Mouse and keyboard listeners are associated with this call. No actual state is stored in the view this is only for setup purposes. The tool state is stored in the DocumentViewModel.

Specified by:

setToolMode in interface DocumentView

Parameters:

viewToolMode - tool mode type.

paintComponent

public void paintComponent(Graphics g)

Paints the selection box for this page view.

Overrides:

paintComponent in class JComponent

Parameters:

g - Java graphics context to paint to.

adjustmentValueChanged

public void adjustmentValueChanged(AdjustmentEvent e)

Specified by:

adjustmentValueChanged in interface AdjustmentListener

focusGained

public void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Specified by:

focusLost in interface FocusListener

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

isTextSelectionTool

protected boolean isTextSelectionTool()

actionPerformed

public void actionPerformed(ActionEvent e)

Auto scroll timer action event, calls method that determine if mouse has left the main viewport on a mouse drag event.

Specified by:

actionPerformed in interface ActionListener

Parameters:

e - mouse event