All Known Implementing Classes:

DocumentViewControllerImpl
```
public interface DocumentViewController
```
The DocumentViewControllerImpl is the controller 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

Fields
Modifier and Type	Field	Description
`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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addNewAnnotation(AnnotationComponent annotationComponent)`
`void`	`addNewDestination(Destination destination)`
`void`	`assignSelectedAnnotation(AnnotationComponent annotationComponent)`
`void`	`clearHighlightedText()`
`void`	`clearSelectedAnnotations()`
`void`	`clearSelectedText()`
`void`	`closeDocument()`
`void`	`deleteAnnotation(AnnotationComponent annotationComponent)`
`void`	`deleteAnnotations(Collection<AnnotationComponent> annotations)`
`void`	`deleteCurrentAnnotation()`
`void`	`deleteDestination(Destination destination)`
`void`	`dispose()`
`void`	`firePropertyChange(String event, int oldValue, int newValue)`
`void`	`firePropertyChange(String event, Object oldValue, Object newValue)`
`AnnotationCallback`	`getAnnotationCallback()`
`int`	`getCurrentPageDisplayValue()`
`int`	`getCurrentPageIndex()`
`Document`	`getDocument()`
`DocumentView`	`getDocumentView()`
`DocumentViewModel`	`getDocumentViewModel()`
`int`	`getFitMode()`
`Adjustable`	`getHorizontalScrollBar()`
`Controller`	`getParentController()`
`float`	`getRotation()`	Each Page may have its own rotation, but on top of that, the user may select to have the Page further rotated by 90, 180 or 270 degrees.
`SecurityCallback`	`getSecurityCallback()`
`String`	`getSelectedText()`
`SignatureAppearanceCallback`	`getSignatureAppearanceCallback()`
`int`	`getToolMode()`
`Adjustable`	`getVerticalScrollBar()`
`Container`	`getViewContainer()`
`int`	`getViewCursor()`
`Cursor`	`getViewCursor(int cursorType)`
`int`	`getViewMode()`
`JViewport`	`getViewPort()`
`float`	`getZoom()`	The Page being shown may be zoomed in or out, to show more detail, or provide an overview.
`float[]`	`getZoomLevels()`
`boolean`	`isToolModeSelected(int viewToolMode)`
`void`	`redo()`
`void`	`requestViewFocusInWindow()`
`void`	`revertViewType()`
`void`	`selectAllText()`
`void`	`setAnnotationCallback(AnnotationCallback annotationCallback)`
`void`	`setComponentTarget(PageViewComponent pageComponent, Component component)`
`boolean`	`setCurrentPageIndex(int pageNumber)`
`int`	`setCurrentPageNext()`
`int`	`setCurrentPagePrevious()`
`void`	`setDestinationTarget(Destination destination)`
`void`	`setDocument(Document document)`
`void`	`setDocumentViewType(int documentView, int fitMode)`
`boolean`	`setFitMode(int fitMode)`
`float`	`setRotateLeft()`
`float`	`setRotateRight()`
`boolean`	`setRotation(float userRotation)`
`void`	`setSecurityCallback(SecurityCallback securityCallback)`
`void`	`setSignatureAppearanceCallback(SignatureAppearanceCallback signatureAppearanceCallback)`
`boolean`	`setToolMode(int viewToolMode)`
`void`	`setViewCursor(int cursorType)`
`void`	`setViewKeyListener(KeyListener l)`
`void`	`setViewType(int documentView)`
`boolean`	`setZoom(float userZoom)`
`boolean`	`setZoomCentered(float zoom, Point centeringPoint, boolean becauseOfValidFitMode)`
`boolean`	`setZoomIn()`
`boolean`	`setZoomIn(Point point)`
`void`	`setZoomLevels(float[] zoomLevels)`
`boolean`	`setZoomOut()`
`boolean`	`setZoomOut(Point point)`
`boolean`	`setZoomToViewPort(float zoom, Point viewPortPosition, int pageIndex, boolean becauseOfValidFitMode)`
`void`	`undo()`
`void`	`updateAnnotation(AnnotationComponent annotationComponent)`
`void`	`updateDestination(Destination oldDestination, Destination destination)`
`void`	`updatedSummaryAnnotation(AnnotationComponent annotationComponent)`

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(Document document)

getDocument
```
Document getDocument()
```

closeDocument
```
void closeDocument()
```

dispose
```
void dispose()
```

getViewContainer
```
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()
```

setComponentTarget

void setComponentTarget(PageViewComponent pageComponent,
                        Component component)

setDestinationTarget

void setDestinationTarget(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(Point point)
```

setZoomCentered

boolean setZoomCentered(float zoom,
                        Point centeringPoint,
                        boolean becauseOfValidFitMode)

setZoomToViewPort

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

setZoomOut
```
boolean setZoomOut()
```

setZoomOut
```
boolean setZoomOut(Point point)
```

getZoom
```
float getZoom()
```
The Page being shown may be zoomed in or out, to show more detail, or provide an overview.

Returns:

The user's requested zoom

setRotation

boolean setRotation(float userRotation)

getRotation
```
float getRotation()
```
Each Page may have its own rotation, but on top of that, the user may select to have the Page further rotated by 90, 180 or 270 degrees.

Returns:

The user's requested rotation

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

Cursor getViewCursor(int cursorType)

getViewCursor
```
int getViewCursor()
```

setViewKeyListener

void setViewKeyListener(KeyListener l)

getHorizontalScrollBar
```
Adjustable getHorizontalScrollBar()
```

getVerticalScrollBar
```
Adjustable getVerticalScrollBar()
```

getViewPort
```
JViewport getViewPort()
```

setAnnotationCallback

void setAnnotationCallback(AnnotationCallback annotationCallback)

setSignatureAppearanceCallback

void setSignatureAppearanceCallback(SignatureAppearanceCallback signatureAppearanceCallback)

setSecurityCallback

void setSecurityCallback(SecurityCallback securityCallback)

addNewAnnotation

void addNewAnnotation(AnnotationComponent annotationComponent)

updateAnnotation

void updateAnnotation(AnnotationComponent annotationComponent)

updatedSummaryAnnotation

void updatedSummaryAnnotation(AnnotationComponent annotationComponent)

deleteCurrentAnnotation
```
void deleteCurrentAnnotation()
```

deleteAnnotation

void deleteAnnotation(AnnotationComponent annotationComponent)

addNewDestination

void addNewDestination(Destination destination)

updateDestination

void updateDestination(Destination oldDestination,
                       Destination destination)

deleteDestination

void deleteDestination(Destination destination)

undo
```
void undo()
```

redo
```
void redo()
```

getAnnotationCallback

AnnotationCallback getAnnotationCallback()

getSignatureAppearanceCallback

SignatureAppearanceCallback getSignatureAppearanceCallback()

getSecurityCallback
```
SecurityCallback getSecurityCallback()
```

getDocumentViewModel

DocumentViewModel getDocumentViewModel()

getDocumentView
```
DocumentView getDocumentView()
```

clearSelectedText
```
void clearSelectedText()
```

clearHighlightedText
```
void clearHighlightedText()
```

clearSelectedAnnotations
```
void clearSelectedAnnotations()
```

assignSelectedAnnotation

void assignSelectedAnnotation(AnnotationComponent annotationComponent)

selectAllText
```
void selectAllText()
```

getSelectedText
```
String getSelectedText()
```

revertViewType
```
void revertViewType()
```

firePropertyChange

void firePropertyChange(String event,
                        int oldValue,
                        int newValue)

firePropertyChange

void firePropertyChange(String event,
                        Object oldValue,
                        Object newValue)

deleteAnnotations

void deleteAnnotations(Collection<AnnotationComponent> annotations)

Interface DocumentViewController

Field Summary

Method Summary

Field Detail

PAGE_FIT_NONE

PAGE_FIT_ACTUAL_SIZE

PAGE_FIT_WINDOW_HEIGHT

PAGE_FIT_WINDOW_WIDTH

CURSOR_HAND_OPEN

CURSOR_HAND_CLOSE

CURSOR_ZOOM_IN

CURSOR_ZOOM_OUT

CURSOR_WAIT

CURSOR_SELECT

CURSOR_DEFAULT

CURSOR_HAND_ANNOTATION

CURSOR_TEXT_SELECTION

CURSOR_CROSSHAIR

CURSOR_MAGNIFY

Method Detail

setDocument

getDocument

closeDocument

dispose

getViewContainer

getParentController

setViewType

getViewMode

setFitMode

getFitMode

setDocumentViewType

setCurrentPageIndex

setCurrentPageNext

setCurrentPagePrevious

setComponentTarget

setDestinationTarget

getCurrentPageIndex

getCurrentPageDisplayValue

setZoomLevels

getZoomLevels

setZoom

setZoomIn

setZoomIn

setZoomCentered

setZoomToViewPort

setZoomOut

setZoomOut

getZoom

setRotation

getRotation

setRotateRight

setRotateLeft

setToolMode

getToolMode

isToolModeSelected

requestViewFocusInWindow

setViewCursor

getViewCursor

getViewCursor

setViewKeyListener

getHorizontalScrollBar

getVerticalScrollBar

getViewPort

setAnnotationCallback

setSignatureAppearanceCallback

setSecurityCallback

addNewAnnotation

updateAnnotation

updatedSummaryAnnotation

deleteCurrentAnnotation

deleteAnnotation

addNewDestination

updateDestination

deleteDestination

undo

redo

getAnnotationCallback

getSignatureAppearanceCallback

getSecurityCallback

getDocumentViewModel