Commands (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- org.jpedal.examples.viewer.Commands

Direct Known Subclasses:

JavaFXCommands
```
public class Commands
extends Object
```
This class contains code to execute the actual commands. http://www.idrsolutions.com/access-pdf-viewer-features-from-your-code/

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABOUT`
`static int`	`ACCELERATIONOFF`
`static int`	`ACCELERATIONON`
`static int`	`ADD`
`static int`	`ADDHEADERFOOTER`
`static int`	`ADDVIEW`
`static int`	`ALWAYSSHOWMOUSE`
`static int`	`AUTOSCROLL`
`static int`	`BACK`
`static int`	`BACKPAGE`
`static int`	`BITMAP`
`static int`	`BOOKMARK`
`static int`	`BUY`
`static int`	`CASCADE`
`static int`	`CHANGELINEART`
`protected Values`	`commonValues`
`static int`	`CONTENTMENU`
`static int`	`CONTINUOUS`
`static int`	`CONTINUOUS_FACING`
`static int`	`COPY`
`static int`	`CROP`
`protected GUIFactory`	`currentGUI`
`static int`	`CURRENTMENU`
`static int`	`CURRENTPAGE`
`protected PrinterInt`	`currentPrinter`
`protected PdfDecoderInt`	`decode_pdf`
`static int`	`DELETE`
`static int`	`DELETEPROPERTIESONEXIT`
`static int`	`DESELECTALL`
`static int`	`DOCINFO`
`static int`	`EDITMENU`
`static int`	`EXIT`
`static int`	`EXPORTMENU`
`static int`	`EXTRACTASIMAGE`
`boolean`	`extractingAsImage`
`static int`	`EXTRACTTEXT`
`static int`	`FACING`
`static int`	`FBACKPAGE`
`static int`	`FFORWARDPAGE`
`static int`	`FILEMENU`
`static int`	`FIND`
`static Integer`	`FIRST_DOCUMENT_SEARCH_RESULT_NOW_SHOWN`
`static int`	`FIRSTPAGE`
`static int`	`FORWARD`
`static int`	`FORWARDPAGE`
`static int`	`FULLSCREEN`
`static int`	`GETOUTLINEPANEL`
`static int`	`GETPAGECOUNTER`
`static int`	`GETPDFNAME`
`static int`	`GETTHUMBNAILPANEL`
`static int`	`GOTO`
`static int`	`GOTOMENU`
`static int`	`HANDOUTS`
`static int`	`HELP`
`static int`	`HELPFORUM`
`static int`	`HIGHLIGHT`
`static int`	`IMAGES`
`static int`	`LASTPAGE`
`protected MouseMode`	`mouseMode` tracks mouse operation mode currently selected
`static int`	`MOUSEMODE`
`static int`	`NEXTDOCUMENT`
`static int`	`NEXTRESULT`
`static int`	`NUP`
`static int`	`ONEPERPAGE`
`static int`	`OPENFILE`
`static int`	`OPENINSYSTEMDEFAULT`
`static int`	`OPENMENU`
`static int`	`OPENURL`
`static int`	`PAGECOUNT`
`static int`	`PAGEFLOW`
`static int`	`PAGEGROUPING`
`static int`	`PAGELAYOUTMENU`
`static int`	`PAGETOOLSMENU`
`static int`	`PANMODE`
`static int`	`PDF`
`static int`	`PDFMENU`
`static int`	`PORTFOLIO_DETAIL`
`static int`	`PORTFOLIO_TILES`
`static int`	`PORTFOLIOMENU`
`static int`	`PREFERENCES`
`static int`	`PREVIOUSDOCUMENT`
`static int`	`PREVIOUSRESULT`
`static int`	`PRINT`
`protected PropertiesFile`	`properties`
`static int`	`REPLACETEXTCOLOR`
`static int`	`RESAVEASFORM`
`static int`	`RESET`
`static int`	`ROTATE`
`static int`	`ROTATELEFT`
`static int`	`ROTATERIGHT`
`static int`	`ROTATION`
`static int`	`SAVE`
`static int`	`SAVEFORM`
`static int`	`SCALING`
`static int`	`SCROLL`
`static Integer`	`SEARCH_NOT_FOUND`
`static Integer`	`SEARCH_RETURNED_TO_START`
`protected GUISearchWindow`	`searchFrame`
`static int`	`SECURITY`
`static int`	`SELECTALL`
`static int`	`SEPARATECOVER`
`static int`	`SETCROP`
`static int`	`SETDISPLAYBACKGROUND`
`static int`	`SETENHANCEFRACTIONALLINES`
`static int`	`SETPAGECOLOR`
`static int`	`SETREPLACEMENTCOLORTHRESHOLD`
`static int`	`SETTEXTCOLOR`
`static int`	`SETUNDRAWNPAGECOLOR`
`static int`	`SHOWFORMNAMES`
`static int`	`SIGN`
`static int`	`SINGLE`
`static int`	`SNAPSHOT`
`static int`	`STAMPIMAGE`
`static int`	`STAMPTEXT`
`static int`	`TEXT`
`static int`	`TEXTSELECT`
`protected GUIThumbnailPanel`	`thumbnails`
`static int`	`TILE`
`static int`	`TIP`
`static int`	`TOGGLE`
`static int`	`UPDATEGUILAYOUT`
`static int`	`VIEWMENU`
`protected ViewStack`	`viewStack` used to store the IE views so we can go back to previous views and store changes
`static int`	`VISITWEBSITE`
`static int`	`WINDOWMENU`
`static int`	`ZOOMIN`
`static int`	`ZOOMOUT`

Constructor Summary

Constructors
Constructor and Description
`Commands(Values commonValues, GUIFactory currentGUI, PdfDecoderInt decode_pdf, GUIThumbnailPanel thumbnails, PropertiesFile properties, GUISearchWindow searchFrame, PrinterInt currentPrinter)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`executeCommand(int ID, Object[] args)` main routine which executes code for current command
`MouseMode`	`getMouseMode()`
`GUISearchList`	`getSearchList()` Returns the searchList of the last search preformed.
`ViewStack`	`getViewStack()`
`void`	`handleTransferedFile(String file)`
`static boolean`	`isPDFLinearized(String pdfUrl)` examine first few bytes to see if linearized and return true linearized file
`protected void`	`openTransferedFile()`
`void`	`recentDocumentsOption()`
`void`	`setPdfDecoder(PdfDecoderInt decode_pdf)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - viewStack
```
protected final ViewStack viewStack
```
    used to store the IE views so we can go back to previous views and store changes
  - extractingAsImage
```
public boolean extractingAsImage
```
  - ABOUT
```
public static final int ABOUT
```
    See Also:
    
    Constant Field Values
  - BITMAP
```
public static final int BITMAP
```
    See Also:
    
    Constant Field Values
  - IMAGES
```
public static final int IMAGES
```
    See Also:
    
    Constant Field Values
  - TEXT
```
public static final int TEXT
```
    See Also:
    
    Constant Field Values
  - SAVE
```
public static final int SAVE
```
    See Also:
    
    Constant Field Values
  - PRINT
```
public static final int PRINT
```
    See Also:
    
    Constant Field Values
  - EXIT
```
public static final int EXIT
```
    See Also:
    
    Constant Field Values
  - AUTOSCROLL
```
public static final int AUTOSCROLL
```
    See Also:
    
    Constant Field Values
  - DOCINFO
```
public static final int DOCINFO
```
    See Also:
    
    Constant Field Values
  - OPENFILE
```
public static final int OPENFILE
```
    See Also:
    
    Constant Field Values
  - BOOKMARK
```
public static final int BOOKMARK
```
    See Also:
    
    Constant Field Values
  - FIND
```
public static final int FIND
```
    See Also:
    
    Constant Field Values
  - SNAPSHOT
```
public static final int SNAPSHOT
```
    See Also:
    
    Constant Field Values
  - OPENURL
```
public static final int OPENURL
```
    See Also:
    
    Constant Field Values
  - VISITWEBSITE
```
public static final int VISITWEBSITE
```
    See Also:
    
    Constant Field Values
  - PREVIOUSDOCUMENT
```
public static final int PREVIOUSDOCUMENT
```
    See Also:
    
    Constant Field Values
  - NEXTDOCUMENT
```
public static final int NEXTDOCUMENT
```
    See Also:
    
    Constant Field Values
  - PREVIOUSRESULT
```
public static final int PREVIOUSRESULT
```
    See Also:
    
    Constant Field Values
  - NEXTRESULT
```
public static final int NEXTRESULT
```
    See Also:
    
    Constant Field Values
  - TIP
```
public static final int TIP
```
    See Also:
    
    Constant Field Values
  - CASCADE
```
public static final int CASCADE
```
    See Also:
    
    Constant Field Values
  - TILE
```
public static final int TILE
```
    See Also:
    
    Constant Field Values
  - PREFERENCES
```
public static final int PREFERENCES
```
    See Also:
    
    Constant Field Values
  - COPY
```
public static final int COPY
```
    See Also:
    
    Constant Field Values
  - SELECTALL
```
public static final int SELECTALL
```
    See Also:
    
    Constant Field Values
  - DESELECTALL
```
public static final int DESELECTALL
```
    See Also:
    
    Constant Field Values
  - UPDATEGUILAYOUT
```
public static final int UPDATEGUILAYOUT
```
    See Also:
    
    Constant Field Values
  - MOUSEMODE
```
public static final int MOUSEMODE
```
    See Also:
    
    Constant Field Values
  - PANMODE
```
public static final int PANMODE
```
    See Also:
    
    Constant Field Values
  - TEXTSELECT
```
public static final int TEXTSELECT
```
    See Also:
    
    Constant Field Values
  - SEPARATECOVER
```
public static final int SEPARATECOVER
```
    See Also:
    
    Constant Field Values
  - EXTRACTTEXT
```
public static final int EXTRACTTEXT
```
    See Also:
    
    Constant Field Values
  - EXTRACTASIMAGE
```
public static final int EXTRACTASIMAGE
```
    See Also:
    
    Constant Field Values
  - ROTATELEFT
```
public static final int ROTATELEFT
```
    See Also:
    
    Constant Field Values
  - ROTATERIGHT
```
public static final int ROTATERIGHT
```
    See Also:
    
    Constant Field Values
  - OPENINSYSTEMDEFAULT
```
public static final int OPENINSYSTEMDEFAULT
```
    See Also:
    
    Constant Field Values
  - FIRSTPAGE
```
public static final int FIRSTPAGE
```
    See Also:
    
    Constant Field Values
  - FBACKPAGE
```
public static final int FBACKPAGE
```
    See Also:
    
    Constant Field Values
  - BACKPAGE
```
public static final int BACKPAGE
```
    See Also:
    
    Constant Field Values
  - FORWARDPAGE
```
public static final int FORWARDPAGE
```
    See Also:
    
    Constant Field Values
  - FFORWARDPAGE
```
public static final int FFORWARDPAGE
```
    See Also:
    
    Constant Field Values
  - LASTPAGE
```
public static final int LASTPAGE
```
    See Also:
    
    Constant Field Values
  - GOTO
```
public static final int GOTO
```
    See Also:
    
    Constant Field Values
  - SINGLE
```
public static final int SINGLE
```
    See Also:
    
    Constant Field Values
  - CONTINUOUS
```
public static final int CONTINUOUS
```
    See Also:
    
    Constant Field Values
  - CONTINUOUS_FACING
```
public static final int CONTINUOUS_FACING
```
    See Also:
    
    Constant Field Values
  - FACING
```
public static final int FACING
```
    See Also:
    
    Constant Field Values
  - PAGEFLOW
```
public static final int PAGEFLOW
```
    See Also:
    
    Constant Field Values
  - FULLSCREEN
```
public static final int FULLSCREEN
```
    See Also:
    
    Constant Field Values
  - ZOOMIN
```
public static final int ZOOMIN
```
    See Also:
    
    Constant Field Values
  - ZOOMOUT
```
public static final int ZOOMOUT
```
    See Also:
    
    Constant Field Values
  - PORTFOLIO_DETAIL
```
public static final int PORTFOLIO_DETAIL
```
    See Also:
    
    Constant Field Values
  - PORTFOLIO_TILES
```
public static final int PORTFOLIO_TILES
```
    See Also:
    
    Constant Field Values
  - ROTATION
```
public static final int ROTATION
```
    See Also:
    
    Constant Field Values
  - SCALING
```
public static final int SCALING
```
    See Also:
    
    Constant Field Values
  - CURRENTMENU
```
public static final int CURRENTMENU
```
    See Also:
    
    Constant Field Values
  - CROP
```
public static final int CROP
```
    See Also:
    
    Constant Field Values
  - PAGETOOLSMENU
```
public static final int PAGETOOLSMENU
```
    See Also:
    
    Constant Field Values
  - CONTENTMENU
```
public static final int CONTENTMENU
```
    See Also:
    
    Constant Field Values
  - ONEPERPAGE
```
public static final int ONEPERPAGE
```
    See Also:
    
    Constant Field Values
  - PDFMENU
```
public static final int PDFMENU
```
    See Also:
    
    Constant Field Values
  - EXPORTMENU
```
public static final int EXPORTMENU
```
    See Also:
    
    Constant Field Values
  - WINDOWMENU
```
public static final int WINDOWMENU
```
    See Also:
    
    Constant Field Values
  - PAGELAYOUTMENU
```
public static final int PAGELAYOUTMENU
```
    See Also:
    
    Constant Field Values
  - EDITMENU
```
public static final int EDITMENU
```
    See Also:
    
    Constant Field Values
  - GOTOMENU
```
public static final int GOTOMENU
```
    See Also:
    
    Constant Field Values
  - VIEWMENU
```
public static final int VIEWMENU
```
    See Also:
    
    Constant Field Values
  - RESAVEASFORM
```
public static final int RESAVEASFORM
```
    See Also:
    
    Constant Field Values
  - OPENMENU
```
public static final int OPENMENU
```
    See Also:
    
    Constant Field Values
  - FILEMENU
```
public static final int FILEMENU
```
    See Also:
    
    Constant Field Values
  - HELPFORUM
```
public static final int HELPFORUM
```
    See Also:
    
    Constant Field Values
  - PORTFOLIOMENU
```
public static final int PORTFOLIOMENU
```
    See Also:
    
    Constant Field Values
  - SAVEFORM
```
public static final int SAVEFORM
```
    See Also:
    
    Constant Field Values
  - PDF
```
public static final int PDF
```
    See Also:
    
    Constant Field Values
  - ROTATE
```
public static final int ROTATE
```
    See Also:
    
    Constant Field Values
  - DELETE
```
public static final int DELETE
```
    See Also:
    
    Constant Field Values
  - ADD
```
public static final int ADD
```
    See Also:
    
    Constant Field Values
  - SECURITY
```
public static final int SECURITY
```
    See Also:
    
    Constant Field Values
  - ADDHEADERFOOTER
```
public static final int ADDHEADERFOOTER
```
    See Also:
    
    Constant Field Values
  - STAMPTEXT
```
public static final int STAMPTEXT
```
    See Also:
    
    Constant Field Values
  - STAMPIMAGE
```
public static final int STAMPIMAGE
```
    See Also:
    
    Constant Field Values
  - SETCROP
```
public static final int SETCROP
```
    See Also:
    
    Constant Field Values
  - NUP
```
public static final int NUP
```
    See Also:
    
    Constant Field Values
  - HANDOUTS
```
public static final int HANDOUTS
```
    See Also:
    
    Constant Field Values
  - SIGN
```
public static final int SIGN
```
    See Also:
    
    Constant Field Values
  - HIGHLIGHT
```
public static final int HIGHLIGHT
```
    See Also:
    
    Constant Field Values
  - SCROLL
```
public static final int SCROLL
```
    See Also:
    
    Constant Field Values
  - ADDVIEW
```
public static final int ADDVIEW
```
    See Also:
    
    Constant Field Values
  - FORWARD
```
public static final int FORWARD
```
    See Also:
    
    Constant Field Values
  - BACK
```
public static final int BACK
```
    See Also:
    
    Constant Field Values
  - PAGECOUNT
```
public static final int PAGECOUNT
```
    See Also:
    
    Constant Field Values
  - CURRENTPAGE
```
public static final int CURRENTPAGE
```
    See Also:
    
    Constant Field Values
  - GETOUTLINEPANEL
```
public static final int GETOUTLINEPANEL
```
    See Also:
    
    Constant Field Values
  - GETTHUMBNAILPANEL
```
public static final int GETTHUMBNAILPANEL
```
    See Also:
    
    Constant Field Values
  - GETPAGECOUNTER
```
public static final int GETPAGECOUNTER
```
    See Also:
    
    Constant Field Values
  - PAGEGROUPING
```
public static final int PAGEGROUPING
```
    See Also:
    
    Constant Field Values
  - SETPAGECOLOR
```
public static final int SETPAGECOLOR
```
    See Also:
    
    Constant Field Values
  - SETUNDRAWNPAGECOLOR
```
public static final int SETUNDRAWNPAGECOLOR
```
    See Also:
    
    Constant Field Values
  - REPLACETEXTCOLOR
```
public static final int REPLACETEXTCOLOR
```
    See Also:
    
    Constant Field Values
  - SETTEXTCOLOR
```
public static final int SETTEXTCOLOR
```
    See Also:
    
    Constant Field Values
  - CHANGELINEART
```
public static final int CHANGELINEART
```
    See Also:
    
    Constant Field Values
  - SETDISPLAYBACKGROUND
```
public static final int SETDISPLAYBACKGROUND
```
    See Also:
    
    Constant Field Values
  - SETREPLACEMENTCOLORTHRESHOLD
```
public static final int SETREPLACEMENTCOLORTHRESHOLD
```
    See Also:
    
    Constant Field Values
  - GETPDFNAME
```
public static final int GETPDFNAME
```
    See Also:
    
    Constant Field Values
  - SETENHANCEFRACTIONALLINES
```
public static final int SETENHANCEFRACTIONALLINES
```
    See Also:
    
    Constant Field Values
  - HELP
```
public static final int HELP
```
    See Also:
    
    Constant Field Values
  - BUY
```
public static final int BUY
```
    See Also:
    
    Constant Field Values
  - TOGGLE
```
public static final int TOGGLE
```
    See Also:
    
    Constant Field Values
  - RESET
```
public static final int RESET
```
    See Also:
    
    Constant Field Values
  - ACCELERATIONON
```
public static final int ACCELERATIONON
```
    See Also:
    
    Constant Field Values
  - ACCELERATIONOFF
```
public static final int ACCELERATIONOFF
```
    See Also:
    
    Constant Field Values
  - SHOWFORMNAMES
```
public static final int SHOWFORMNAMES
```
    See Also:
    
    Constant Field Values
  - DELETEPROPERTIESONEXIT
```
public static final int DELETEPROPERTIESONEXIT
```
    See Also:
    
    Constant Field Values
  - ALWAYSSHOWMOUSE
```
public static final int ALWAYSSHOWMOUSE
```
    See Also:
    
    Constant Field Values
  - FIRST_DOCUMENT_SEARCH_RESULT_NOW_SHOWN
```
public static final Integer FIRST_DOCUMENT_SEARCH_RESULT_NOW_SHOWN
```
  - SEARCH_RETURNED_TO_START
```
public static final Integer SEARCH_RETURNED_TO_START
```
  - SEARCH_NOT_FOUND
```
public static final Integer SEARCH_NOT_FOUND
```
  - commonValues
```
protected final Values commonValues
```
  - currentGUI
```
protected final GUIFactory currentGUI
```
  - decode_pdf
```
protected PdfDecoderInt decode_pdf
```
  - thumbnails
```
protected final GUIThumbnailPanel thumbnails
```
  - properties
```
protected final PropertiesFile properties
```
  - searchFrame
```
protected final GUISearchWindow searchFrame
```
  - currentPrinter
```
protected final PrinterInt currentPrinter
```
  - mouseMode
```
protected final MouseMode mouseMode
```
    tracks mouse operation mode currently selected
- Constructor Detail
  - Commands
```
public Commands(Values commonValues,
                GUIFactory currentGUI,
                PdfDecoderInt decode_pdf,
                GUIThumbnailPanel thumbnails,
                PropertiesFile properties,
                GUISearchWindow searchFrame,
                PrinterInt currentPrinter)
```
- Method Detail
  - executeCommand
```
public Object executeCommand(int ID,
                             Object[] args)
```
    main routine which executes code for current command
    Values can also be passed in so it can be called from your own code
    some commands return a status Object otherwise null
    
    Parameters:
    
    ID - is of type Int
    
    args - Program arguments passed into the Viewer.
    
    Returns:
    
    the status object
  - handleTransferedFile
```
public void handleTransferedFile(String file)
                          throws PdfException
```
    Throws:
    
    PdfException
  - openTransferedFile
```
protected void openTransferedFile()
                           throws PdfException
```
    Throws:
    
    PdfException
  - recentDocumentsOption
```
public void recentDocumentsOption()
```
  - setPdfDecoder
```
public void setPdfDecoder(PdfDecoderInt decode_pdf)
```
  - getSearchList
```
public GUISearchList getSearchList()
```
    Returns the searchList of the last search preformed. If currently searching this method will return the results for last completed search
    
    Returns:
    
    SearchList of all results, all data but the actual highlgiht areas
  - getMouseMode
```
public MouseMode getMouseMode()
```
  - getViewStack
```
public ViewStack getViewStack()
```
  - isPDFLinearized
```
public static final boolean isPDFLinearized(String pdfUrl)
```
    examine first few bytes to see if linearized and return true linearized file
    
    Parameters:
    
    pdfUrl - is of type String
    
    Returns:
    
    the isLinear

Class Commands

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

viewStack

extractingAsImage

ABOUT

BITMAP

IMAGES

TEXT

SAVE

PRINT

EXIT

AUTOSCROLL

DOCINFO

OPENFILE

BOOKMARK

FIND

SNAPSHOT

OPENURL

VISITWEBSITE

PREVIOUSDOCUMENT

NEXTDOCUMENT

PREVIOUSRESULT

NEXTRESULT

TIP

CASCADE

TILE

PREFERENCES

COPY

SELECTALL

DESELECTALL

UPDATEGUILAYOUT

MOUSEMODE

PANMODE

TEXTSELECT

SEPARATECOVER

EXTRACTTEXT

EXTRACTASIMAGE

ROTATELEFT

ROTATERIGHT

OPENINSYSTEMDEFAULT

FIRSTPAGE

FBACKPAGE

BACKPAGE

FORWARDPAGE

FFORWARDPAGE

LASTPAGE

GOTO

SINGLE

CONTINUOUS

CONTINUOUS_FACING

FACING

PAGEFLOW

FULLSCREEN

ZOOMIN

ZOOMOUT

PORTFOLIO_DETAIL

PORTFOLIO_TILES

ROTATION

SCALING

CURRENTMENU

CROP

PAGETOOLSMENU

CONTENTMENU

ONEPERPAGE

PDFMENU

EXPORTMENU

WINDOWMENU

PAGELAYOUTMENU

EDITMENU

GOTOMENU

VIEWMENU

RESAVEASFORM

OPENMENU

FILEMENU

HELPFORUM

PORTFOLIOMENU