DocumentViewModel (ICEpdf Viewer RI)

All Known Implementing Classes:

AbstractDocumentViewModel, DocumentViewModelImpl
```
public interface DocumentViewModel
```
The DocumentViewModel interface contains common accessors and modifiers needed to represent a document view state.

Since:

2.5

See Also:

AbstractDocumentViewModel

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DISPLAY_TOOL_CIRCLE_ANNOTATION` Display tool constant for creating new line annotation.
`static int`	`DISPLAY_TOOL_FREE_TEXT_ANNOTATION` Display tool constant for creating new line annotation.
`static int`	`DISPLAY_TOOL_HIGHLIGHT_ANNOTATION` Display tool constant for creating new highlight annotation.
`static int`	`DISPLAY_TOOL_INK_ANNOTATION` Display tool constant for creating new line annotation.
`static int`	`DISPLAY_TOOL_LINE_ANNOTATION` Display tool constant for creating new line annotation.
`static int`	`DISPLAY_TOOL_LINE_ARROW_ANNOTATION` Display tool constant for creating new line annotation.
`static int`	`DISPLAY_TOOL_LINK_ANNOTATION` Display tool constant for creating new link annotation.
`static int`	`DISPLAY_TOOL_NONE` Display tool constant for setting no tools
`static int`	`DISPLAY_TOOL_PAN` Display tool constant for adding a pan tool.
`static int`	`DISPLAY_TOOL_SELECTION` Display tool constant for adding a text selection tool.
`static int`	`DISPLAY_TOOL_SQUARE_ANNOTATION` Display tool constant for creating new line annotation.
`static int`	`DISPLAY_TOOL_SQUIGGLY_ANNOTATION` Display tool constant for creating new squiggly annotation.
`static int`	`DISPLAY_TOOL_STRIKEOUT_ANNOTATION` Display tool constant for creating new strikeout annotation.
`static int`	`DISPLAY_TOOL_TEXT_ANNOTATION` Display tool constant for creating new line annotation.
`static int`	`DISPLAY_TOOL_TEXT_SELECTION` Display tool constant for adding a text selection tool.
`static int`	`DISPLAY_TOOL_UNDERLINE_ANNOTATION` Display tool constant for creating new underline annotation.
`static int`	`DISPLAY_TOOL_WAIT` Display tool constant for showing user that gui is busy
`static int`	`DISPLAY_TOOL_ZOOM_DYNAMIC` Display tool constant for adding a zoom out tool.
`static int`	`DISPLAY_TOOL_ZOOM_IN` Display tool constant for adding a zoom in tool.
`static int`	`DISPLAY_TOOL_ZOOM_OUT` Display tool constant for adding a zoom out tool.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addMemento(org.icepdf.core.Memento oldMementoState, org.icepdf.core.Memento newMementoState)` Adds memento state to the care taker.
`void`	`addSelectedPageText(AbstractPageViewComponent pageViewComponent)` Adds the specified page to the list of selected pages.
`void`	`clearSelectedPageText()` Clears all pages in a selected state.
`void`	`dispose()` Free resources associated with this model.
`AnnotationComponent`	`getCurrentAnnotation()` Gets the currently selected annotation
`javax.swing.Timer`	`getDirtyTimer()` Get an instance of the dirty Timer use by all child PageComponents.
`org.icepdf.core.pobjects.Document`	`getDocument()` Gets the PDF document object associated with this views.
`int`	`getPageBoundary()` Gets the page boundry used to paint document pages.
`java.awt.Rectangle`	`getPageBounds(int pageIndex)` Gets the page bound of the specified page Index.
`java.util.List<AbstractPageViewComponent>`	`getPageComponents()` Gets the page components associated with this view model.
`java.util.ArrayList<java.lang.ref.WeakReference<AbstractPageViewComponent>>`	`getSelectedPageText()` Gets a list of doucment pages that have selected text elements.
`int`	`getViewCurrentPageIndex()` Gets the current page index represented in this model.
`float`	`getViewRotation()` Gets the view rotation of the model.
`int`	`getViewToolMode()` Gets the tool mode.
`float`	`getViewZoom()` Gets the view model zoom level.
`void`	`invalidate()` Invalidate the underlying Document Page models.
`boolean`	`isSelectAll()` Returns true if all text in the document should be in a selected state.
`boolean`	`isViewToolModeSelected(int viewToolMode)` Checks if the specified tool mode is set in the view model.
`void`	`setCurrentAnnotation(AnnotationComponent currentAnnotation)` Sets teh current annotation
`void`	`setPageBoundary(int pageBoundary)` Sets the page boundtry used to paint a page.
`void`	`setSelectAll(boolean selectAll)` Sets the selected all text state.
`boolean`	`setViewCurrentPageIndex(int pageIndex)` Sets the view model current page index.
`boolean`	`setViewRotation(float viewRotation)` Sets the view rotaiton of this model.
`boolean`	`setViewToolMode(int viewToolMode)` Sets the view tool mode.
`boolean`	`setViewZoom(float viewZoom)` Sets the models zoom level.

- Field Detail
  - DISPLAY_TOOL_PAN
```
static final int DISPLAY_TOOL_PAN
```
    Display tool constant for adding a pan tool.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_ZOOM_IN
```
static final int DISPLAY_TOOL_ZOOM_IN
```
    Display tool constant for adding a zoom in tool.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_ZOOM_OUT
```
static final int DISPLAY_TOOL_ZOOM_OUT
```
    Display tool constant for adding a zoom out tool.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_ZOOM_DYNAMIC
```
static final int DISPLAY_TOOL_ZOOM_DYNAMIC
```
    Display tool constant for adding a zoom out tool.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_TEXT_SELECTION
```
static final int DISPLAY_TOOL_TEXT_SELECTION
```
    Display tool constant for adding a text selection tool.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_SELECTION
```
static final int DISPLAY_TOOL_SELECTION
```
    Display tool constant for adding a text selection tool.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_LINK_ANNOTATION
```
static final int DISPLAY_TOOL_LINK_ANNOTATION
```
    Display tool constant for creating new link annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_HIGHLIGHT_ANNOTATION
```
static final int DISPLAY_TOOL_HIGHLIGHT_ANNOTATION
```
    Display tool constant for creating new highlight annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_UNDERLINE_ANNOTATION
```
static final int DISPLAY_TOOL_UNDERLINE_ANNOTATION
```
    Display tool constant for creating new underline annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_SQUIGGLY_ANNOTATION
```
static final int DISPLAY_TOOL_SQUIGGLY_ANNOTATION
```
    Display tool constant for creating new squiggly annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_STRIKEOUT_ANNOTATION
```
static final int DISPLAY_TOOL_STRIKEOUT_ANNOTATION
```
    Display tool constant for creating new strikeout annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_LINE_ANNOTATION
```
static final int DISPLAY_TOOL_LINE_ANNOTATION
```
    Display tool constant for creating new line annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_LINE_ARROW_ANNOTATION
```
static final int DISPLAY_TOOL_LINE_ARROW_ANNOTATION
```
    Display tool constant for creating new line annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_SQUARE_ANNOTATION
```
static final int DISPLAY_TOOL_SQUARE_ANNOTATION
```
    Display tool constant for creating new line annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_CIRCLE_ANNOTATION
```
static final int DISPLAY_TOOL_CIRCLE_ANNOTATION
```
    Display tool constant for creating new line annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_INK_ANNOTATION
```
static final int DISPLAY_TOOL_INK_ANNOTATION
```
    Display tool constant for creating new line annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_FREE_TEXT_ANNOTATION
```
static final int DISPLAY_TOOL_FREE_TEXT_ANNOTATION
```
    Display tool constant for creating new line annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_TEXT_ANNOTATION
```
static final int DISPLAY_TOOL_TEXT_ANNOTATION
```
    Display tool constant for creating new line annotation.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_NONE
```
static final int DISPLAY_TOOL_NONE
```
    Display tool constant for setting no tools
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TOOL_WAIT
```
static final int DISPLAY_TOOL_WAIT
```
    Display tool constant for showing user that gui is busy
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDocument
```
org.icepdf.core.pobjects.Document getDocument()
```
    Gets the PDF document object associated with this views.
    
    Returns:
    
    PDF document which is associated with this view.
  - getSelectedPageText
```
java.util.ArrayList<java.lang.ref.WeakReference<AbstractPageViewComponent>> getSelectedPageText()
```
    Gets a list of doucment pages that have selected text elements. The pages are referenced so that they will be removed automatically if the memory manage needs to dispose of a page.
    
    Returns:
    
    list Weakly referenced pages
  - addSelectedPageText
```
void addSelectedPageText(AbstractPageViewComponent pageViewComponent)
```
    Adds the specified page to the list of selected pages.
    
    Parameters:
    
    pageViewComponent - pageview component to add to list.
  - isSelectAll
```
boolean isSelectAll()
```
    Returns true if all text in the document should be in a selected state.
    
    Returns:
    
    true if document is in select all text text state, false otherwise.
  - setSelectAll
```
void setSelectAll(boolean selectAll)
```
    Sets the selected all text state.
    
    Parameters:
    
    selectAll - true to select all text, false otherwise.
  - clearSelectedPageText
```
void clearSelectedPageText()
```
    Clears all pages in a selected state.
  - getPageComponents
```
java.util.List<AbstractPageViewComponent> getPageComponents()
```
    Gets the page components associated with this view model.
    
    Returns:
    
    vector of page components.
  - setViewCurrentPageIndex
```
boolean setViewCurrentPageIndex(int pageIndex)
```
    Sets the view model current page index.
    
    Parameters:
    
    pageIndex - zero based current pages page index of the document.
    
    Returns:
    
    true if the page index could be set, false otherwise.
  - getViewCurrentPageIndex
```
int getViewCurrentPageIndex()
```
    Gets the current page index represented in this model.
    
    Returns:
    
    zero based page page index.
  - setViewZoom
```
boolean setViewZoom(float viewZoom)
```
    Sets the models zoom level.
    
    Parameters:
    
    viewZoom - zoom value
    
    Returns:
    
    true if the view zoom was set correctly otherwise, false.
  - getViewZoom
```
float getViewZoom()
```
    Gets the view model zoom level.
    
    Returns:
    
    zoom level of this view model
  - setViewRotation
```
boolean setViewRotation(float viewRotation)
```
    Sets the view rotaiton of this model.
    
    Parameters:
    
    viewRotation - rotation in degrees
    
    Returns:
    
    true if the view rotation was set correctly, otherwise false.
  - getViewRotation
```
float getViewRotation()
```
    Gets the view rotation of the model.
    
    Returns:
    
    view rotation of the model
  - invalidate
```
void invalidate()
```
    Invalidate the underlying Document Page models.
  - setViewToolMode
```
boolean setViewToolMode(int viewToolMode)
```
    Sets the view tool mode.
    
    Parameters:
    
    viewToolMode - selected tool mode, pan, zoom and et.
    
    Returns:
    
    true if the view tool was set correctly, false otherwise.
  - getViewToolMode
```
int getViewToolMode()
```
    Gets the tool mode.
    
    Returns:
    
    tool mode.
  - isViewToolModeSelected
```
boolean isViewToolModeSelected(int viewToolMode)
```
    Checks if the specified tool mode is set in the view model.
    
    Parameters:
    
    viewToolMode - tool model to check if selected.
    
    Returns:
    
    true if specified tool mode is selected, otherwise false.
  - getPageBounds
```
java.awt.Rectangle getPageBounds(int pageIndex)
```
    Gets the page bound of the specified page Index.
    
    Parameters:
    
    pageIndex - zero based page index.
    
    Returns:
    
    bounds of specified page. If page index. is not valid, null is returned.
  - dispose
```
void dispose()
```
    Free resources associated with this model.
  - setPageBoundary
```
void setPageBoundary(int pageBoundary)
```
    Sets the page boundtry used to paint a page.
    
    Parameters:
    
    pageBoundary - page bounds
  - getPageBoundary
```
int getPageBoundary()
```
    Gets the page boundry used to paint document pages.
    
    Returns:
    
    page boundary type as defined in the class Page.
  - getCurrentAnnotation
```
AnnotationComponent getCurrentAnnotation()
```
    Gets the currently selected annotation
    
    Returns:
    
    currently selected annotaitons.
  - setCurrentAnnotation
```
void setCurrentAnnotation(AnnotationComponent currentAnnotation)
```
    Sets teh current annotation
    
    Parameters:
    
    currentAnnotation - annotation to set as current
  - addMemento
```
void addMemento(org.icepdf.core.Memento oldMementoState,
                org.icepdf.core.Memento newMementoState)
```
    Adds memento state to the care taker.
    
    Parameters:
    
    oldMementoState - origional state.
    
    newMementoState - new state.
  - getDirtyTimer
```
javax.swing.Timer getDirtyTimer()
```
    Get an instance of the dirty Timer use by all child PageComponents.
    
    Returns:
    
    instance of Swing Timer

Interface DocumentViewModel

Field Summary

Method Summary

Field Detail

DISPLAY_TOOL_PAN

DISPLAY_TOOL_ZOOM_IN

DISPLAY_TOOL_ZOOM_OUT

DISPLAY_TOOL_ZOOM_DYNAMIC

DISPLAY_TOOL_TEXT_SELECTION

DISPLAY_TOOL_SELECTION

DISPLAY_TOOL_LINK_ANNOTATION

DISPLAY_TOOL_HIGHLIGHT_ANNOTATION

DISPLAY_TOOL_UNDERLINE_ANNOTATION

DISPLAY_TOOL_SQUIGGLY_ANNOTATION

DISPLAY_TOOL_STRIKEOUT_ANNOTATION

DISPLAY_TOOL_LINE_ANNOTATION

DISPLAY_TOOL_LINE_ARROW_ANNOTATION

DISPLAY_TOOL_SQUARE_ANNOTATION

DISPLAY_TOOL_CIRCLE_ANNOTATION

DISPLAY_TOOL_INK_ANNOTATION

DISPLAY_TOOL_FREE_TEXT_ANNOTATION

DISPLAY_TOOL_TEXT_ANNOTATION

DISPLAY_TOOL_NONE

DISPLAY_TOOL_WAIT

Method Detail

getDocument

getSelectedPageText

addSelectedPageText

isSelectAll

setSelectAll

clearSelectedPageText

getPageComponents

setViewCurrentPageIndex

getViewCurrentPageIndex

setViewZoom

getViewZoom

setViewRotation

getViewRotation

invalidate

setViewToolMode

getViewToolMode

isViewToolModeSelected

getPageBounds

dispose

setPageBoundary

getPageBoundary

getCurrentAnnotation

setCurrentAnnotation

addMemento

getDirtyTimer