com.icesoft.pdf.views
Interface DocumentView

All Superinterfaces:

AdjustmentListener, EventListener, FocusListener, MouseInputListener, MouseListener, MouseMotionListener

All Known Implementing Classes:

AbstractDocumentView

public interface DocumentView

extends MouseInputListener, AdjustmentListener, FocusListener

The DocumentView interface should be used when create a new multipage view.

Since:

2.5

See Also:

AbstractDocumentView

Field Summary

static int	LEFT_VIEW Indicates that a two column view will have odd-numbered pages on the left.
static int	RIGHT_VIEW Indicates that a two column view will have odd-numbered pages on the right.

Method Summary

void	dispose() Dispose all resources associated with this views.
Dimension	getDocumentSize() Gets the total size of the document view.
int	getNextPageIncrement() Get the next page index.
DocumentViewController	getParentViewController() Parent document view controller
int	getPreviousPageIncrement() Get the previous page index.
DocumentViewModel	getViewModel() Gets the view model associated with this document view.
void	updateDocumentView() Update the child components which make up this view.

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.AdjustmentListener

adjustmentValueChanged

Methods inherited from interface java.awt.event.FocusListener

focusGained, focusLost

Field Detail

LEFT_VIEW

public static final int LEFT_VIEW

Indicates that a two column view will have odd-numbered pages on the left.

See Also:

Constant Field Values

RIGHT_VIEW

public static final int RIGHT_VIEW

Indicates that a two column view will have odd-numbered pages on the right.

See Also:

Constant Field Values

Method Detail

getNextPageIncrement

public int getNextPageIncrement()

Get the next page index. This will number will very depending on the page view type. Two column page views usually increment page counts by 2 and single page views by 1 page.

Returns:

number of pages to increment page count on a page increment command.

getPreviousPageIncrement

public int getPreviousPageIncrement()

Get the previous page index. This will number will very depending on the page view type. Two column page views usually increment page counts by 2 and single page views by 1 page.

Returns:

number of pages to increment page count on a page increment command.

getDocumentSize

public Dimension getDocumentSize()

Gets the total size of the document view. This size will very depending on the view type.

Returns:

size of document in pixels for all pages represented in the view.

getParentViewController

public DocumentViewController getParentViewController()

Parent document view controller

Returns:

document view controller

getViewModel

public DocumentViewModel getViewModel()

Gets the view model associated with this document view.

Returns:

document view model used by this view.

dispose

public void dispose()

Dispose all resources associated with this views.

updateDocumentView

public void updateDocumentView()

Update the child components which make up this view.