org.icepdf.ri.common.views
Interface DocumentViewController

All Known Implementing Classes:

DocumentViewControllerImpl

public interface DocumentViewController

The DocumentViewControllerImpl is the controler in the MVC for multipage view management. This controller is used to manipulate the one column, one page, two column and two page views.

The Swing implementation of multiple view usesa the folowing MVC base classes:

Since:

2.5

See Also:

AbstractDocumentView, AbstractDocumentViewModel, DocumentViewControllerImpl

Field Summary

static int	CURSOR_CROSSHAIR
static int	CURSOR_DEFAULT
static int	CURSOR_HAND_ANNOTATION
static int	CURSOR_HAND_CLOSE
static int	CURSOR_HAND_OPEN
static int	CURSOR_MAGNIFY
static int	CURSOR_SELECT
static int	CURSOR_TEXT_SELECTION
static int	CURSOR_WAIT
static int	CURSOR_ZOOM_IN
static int	CURSOR_ZOOM_OUT
static int	PAGE_FIT_ACTUAL_SIZE Set the view to show the page at actual size
static int	PAGE_FIT_NONE Set the view to show the page at the specified zoom level.
static int	PAGE_FIT_WINDOW_HEIGHT Set the view to show the page at actual size
static int	PAGE_FIT_WINDOW_WIDTH Set the view to show the page at actual size

Method Summary

void	assignSelectedAnnotation(AnnotationComponent annotationComponent)
void	clearHighlightedText()
void	clearSelectedAnnotations()
void	clearSelectedText()
void	closeDocument()
void	deleteAnnotation(AnnotationComponent annotationComponent)
void	deleteCurrentAnnotation()
void	dispose()
void	firePropertyChange(java.lang.String event, int oldValue, int newValue)
void	firePropertyChange(java.lang.String event, java.lang.Object oldValue, java.lang.Object newValue)
AnnotationCallback	getAnnotationCallback()
int	getCurrentPageDisplayValue()
int	getCurrentPageIndex()
org.icepdf.core.pobjects.Document	getDocument()
DocumentViewModel	getDocumentViewModel()
int	getFitMode()
java.awt.Adjustable	getHorizontalScrollBar()
Controller	getParentController()
float	getRotation()
org.icepdf.core.SecurityCallback	getSecurityCallback()
java.lang.String	getSelectedText()
int	getToolMode()
java.awt.Adjustable	getVerticalScrollBar()
java.awt.Container	getViewContainer()
int	getViewCursor()
java.awt.Cursor	getViewCursor(int cursorType)
int	getViewMode()
javax.swing.JViewport	getViewPort()
float	getZoom()
float[]	getZoomLevels()
boolean	isToolModeSelected(int viewToolMode)
void	redo()
void	requestViewFocusInWindow()
void	selectAllText()
void	setAnnotationCallback(AnnotationCallback annotationCallback)
boolean	setCurrentPageIndex(int pageNumber)
int	setCurrentPageNext()
int	setCurrentPagePrevious()
void	setDestinationTarget(org.icepdf.core.pobjects.Destination destination)
void	setDocument(org.icepdf.core.pobjects.Document document)
void	setDocumentViewType(int documentView, int fitMode)
boolean	setFitMode(int fitMode)
float	setRotateLeft()
float	setRotateRight()
boolean	setRotation(float userRotation)
void	setSecurityCallback(org.icepdf.core.SecurityCallback securityCallback)
boolean	setToolMode(int viewToolMode)
void	setViewCursor(int cursorType)
void	setViewKeyListener(java.awt.event.KeyListener l)
void	setViewType(int documentView)
boolean	setZoom(float userZoom)
boolean	setZoomCentered(float zoom, java.awt.Point centeringPoint, boolean becauseOfValidFitMode)
boolean	setZoomIn()
boolean	setZoomIn(java.awt.Point point)
void	setZoomLevels(float[] zoomLevels)
boolean	setZoomOut()
boolean	setZoomOut(java.awt.Point point)
boolean	setZoomToViewPort(float zoom, java.awt.Point viewPortPosition, int pageIndex, boolean becauseOfValidFitMode)
void	undo()

Field Detail

PAGE_FIT_NONE

static final int PAGE_FIT_NONE

Set the view to show the page at the specified zoom level.

See Also:

Constant Field Values

PAGE_FIT_ACTUAL_SIZE

static final int PAGE_FIT_ACTUAL_SIZE

Set the view to show the page at actual size

See Also:

Constant Field Values

PAGE_FIT_WINDOW_HEIGHT

static final int PAGE_FIT_WINDOW_HEIGHT

Set the view to show the page at actual size

See Also:

Constant Field Values

PAGE_FIT_WINDOW_WIDTH

static final int PAGE_FIT_WINDOW_WIDTH

Set the view to show the page at actual size

See Also:

Constant Field Values

CURSOR_HAND_OPEN

static final int CURSOR_HAND_OPEN

See Also:

Constant Field Values

CURSOR_HAND_CLOSE

static final int CURSOR_HAND_CLOSE

See Also:

Constant Field Values

CURSOR_ZOOM_IN

static final int CURSOR_ZOOM_IN

See Also:

Constant Field Values

CURSOR_ZOOM_OUT

static final int CURSOR_ZOOM_OUT

See Also:

Constant Field Values

CURSOR_WAIT

static final int CURSOR_WAIT

See Also:

Constant Field Values

CURSOR_SELECT

static final int CURSOR_SELECT

See Also:

Constant Field Values

CURSOR_DEFAULT

static final int CURSOR_DEFAULT

See Also:

Constant Field Values

CURSOR_HAND_ANNOTATION

static final int CURSOR_HAND_ANNOTATION

See Also:

Constant Field Values

CURSOR_TEXT_SELECTION

static final int CURSOR_TEXT_SELECTION

See Also:

Constant Field Values

CURSOR_CROSSHAIR

static final int CURSOR_CROSSHAIR

See Also:

Constant Field Values

CURSOR_MAGNIFY

static final int CURSOR_MAGNIFY

See Also:

Constant Field Values

Method Detail

setDocument

void setDocument(org.icepdf.core.pobjects.Document document)

getDocument

org.icepdf.core.pobjects.Document getDocument()

closeDocument

void closeDocument()

dispose

void dispose()

getViewContainer

java.awt.Container getViewContainer()

getParentController

Controller getParentController()

setViewType

void setViewType(int documentView)

getViewMode

int getViewMode()

setFitMode

boolean setFitMode(int fitMode)

getFitMode

int getFitMode()

setDocumentViewType

void setDocumentViewType(int documentView,
                         int fitMode)

setCurrentPageIndex

boolean setCurrentPageIndex(int pageNumber)

setCurrentPageNext

int setCurrentPageNext()

setCurrentPagePrevious

int setCurrentPagePrevious()

setDestinationTarget

void setDestinationTarget(org.icepdf.core.pobjects.Destination destination)

getCurrentPageIndex

int getCurrentPageIndex()

getCurrentPageDisplayValue

int getCurrentPageDisplayValue()

setZoomLevels

void setZoomLevels(float[] zoomLevels)

getZoomLevels

float[] getZoomLevels()

setZoom

boolean setZoom(float userZoom)

setZoomIn

boolean setZoomIn()

setZoomIn

boolean setZoomIn(java.awt.Point point)

setZoomCentered

boolean setZoomCentered(float zoom,
                        java.awt.Point centeringPoint,
                        boolean becauseOfValidFitMode)

setZoomToViewPort

boolean setZoomToViewPort(float zoom,
                          java.awt.Point viewPortPosition,
                          int pageIndex,
                          boolean becauseOfValidFitMode)

setZoomOut

boolean setZoomOut()

setZoomOut

boolean setZoomOut(java.awt.Point point)

getZoom

float getZoom()

setRotation

boolean setRotation(float userRotation)

getRotation

float getRotation()

setRotateRight

float setRotateRight()

setRotateLeft

float setRotateLeft()

setToolMode

boolean setToolMode(int viewToolMode)

getToolMode

int getToolMode()

isToolModeSelected

boolean isToolModeSelected(int viewToolMode)

requestViewFocusInWindow

void requestViewFocusInWindow()

setViewCursor

void setViewCursor(int cursorType)

getViewCursor

java.awt.Cursor getViewCursor(int cursorType)

getViewCursor

int getViewCursor()

setViewKeyListener

void setViewKeyListener(java.awt.event.KeyListener l)

getHorizontalScrollBar

java.awt.Adjustable getHorizontalScrollBar()

getVerticalScrollBar

java.awt.Adjustable getVerticalScrollBar()

getViewPort

javax.swing.JViewport getViewPort()

setAnnotationCallback

void setAnnotationCallback(AnnotationCallback annotationCallback)

setSecurityCallback

void setSecurityCallback(org.icepdf.core.SecurityCallback securityCallback)

deleteCurrentAnnotation

void deleteCurrentAnnotation()

deleteAnnotation

void deleteAnnotation(AnnotationComponent annotationComponent)

undo

void undo()

redo

void redo()

getAnnotationCallback

AnnotationCallback getAnnotationCallback()

getSecurityCallback

org.icepdf.core.SecurityCallback getSecurityCallback()

getDocumentViewModel

DocumentViewModel getDocumentViewModel()

clearSelectedText

void clearSelectedText()

clearHighlightedText

void clearHighlightedText()

clearSelectedAnnotations

void clearSelectedAnnotations()

assignSelectedAnnotation

void assignSelectedAnnotation(AnnotationComponent annotationComponent)

selectAllText

void selectAllText()

getSelectedText

java.lang.String getSelectedText()

firePropertyChange

void firePropertyChange(java.lang.String event,
                        int oldValue,
                        int newValue)

firePropertyChange

void firePropertyChange(java.lang.String event,
                        java.lang.Object oldValue,
                        java.lang.Object newValue)