com.icesoft.pdf.ri.common.views
Class AbstractDocumentView

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.icesoft.pdf.ri.common.views.AbstractDocumentView

All Implemented Interfaces:

AdjustmentListener, DocumentView, EventListener, FocusListener, ImageObserver, MenuContainer, MouseInputListener, MouseListener, MouseMotionListener, Serializable

Direct Known Subclasses:

OneColumnPageView, OnePageView, TwoColumnPageView, TwoPageView

public abstract class AbstractDocumentView

extends JComponent

implements DocumentView

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 inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected Document	currentDocument
protected JScrollPane	documentScrollpane
protected DocumentViewController	documentViewController
protected DocumentViewModelImpl	documentViewModel
protected static int	horizontalSpace
protected Point	lastMousePosition
protected static int	layoutInserts
protected static int	verticalSpace

Fields inherited from class javax.swing.JComponent

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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.icesoft.pdf.views.DocumentView

LEFT_VIEW, RIGHT_VIEW

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

AbstractDocumentView(DocumentViewController documentViewController, JScrollPane documentScrollpane, DocumentViewModelImpl documentViewModel)
Creates a new instance of AbstractDocumentView.

Method Summary

void	adjustmentValueChanged(AdjustmentEvent e)
void	dispose() Dispose all resources associated with this views.
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent e)
DocumentViewController	getParentViewController() Parent document view controller
DocumentViewModel	getViewModel() Gets the view model associated with this document view.
void	mouseClicked(MouseEvent e) Handler for mouse clicks.
void	mouseDragged(MouseEvent e) Mouse dragged, initiates page panning if the tool is selected.
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e) Mouse pressed, changes the mouse cursor depending on the tool selected.
void	mouseReleased(MouseEvent e) Mouse released, changes the mouse cursor depending on the tool selected.
abstract void	updateDocumentView() invalidates page components

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.icesoft.pdf.views.DocumentView

getDocumentSize, getNextPageIncrement, getPreviousPageIncrement

Field Detail

verticalSpace

protected static int verticalSpace

horizontalSpace

protected static int horizontalSpace

layoutInserts

protected static int layoutInserts

lastMousePosition

protected Point lastMousePosition

documentViewController

protected DocumentViewController documentViewController

documentScrollpane

protected JScrollPane documentScrollpane

currentDocument

protected Document currentDocument

documentViewModel

protected DocumentViewModelImpl documentViewModel

Constructor Detail

AbstractDocumentView

public AbstractDocumentView(DocumentViewController documentViewController,
                            JScrollPane documentScrollpane,
                            DocumentViewModelImpl 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

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.

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

mouseClicked

public void mouseClicked(MouseEvent e)

Handler for mouse clicks. Zoom-in and Zoom-out tools are handled here.

Specified by:

mouseClicked in interface MouseListener

Parameters:

e -

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Mouse pressed, changes the mouse cursor depending on the tool selected.

Specified by:

mousePressed in interface MouseListener

Parameters:

e -

mouseReleased

public void mouseReleased(MouseEvent e)

Mouse released, changes the mouse cursor depending on the tool selected.

Specified by:

mouseReleased in interface MouseListener

Parameters:

e -

mouseDragged

public void mouseDragged(MouseEvent e)

Mouse dragged, initiates page panning if the tool is selected.

Specified by:

mouseDragged in interface MouseMotionListener

Parameters:

e -

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

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