com.openpcl.viewer
Class OpenPCLViewer

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.openpcl.viewer.OpenPCLViewer

All Implemented Interfaces:

IOpenPCL, IPluginHooksOpenPCL, ImageObserver, MenuContainer, Serializable, Accessible

public class OpenPCLViewer
extends JPanel
implements IOpenPCL, IPluginHooksOpenPCL

OpenPCLViewer is an open source PCL Viewer.
The command line options (or OpenPCLViewer constructor String array) are at the JavaDoc for PosStartupOptions at PosStartupOptions. OpenPCLViewer can be used in 3 ways:
1. As a PCL viewer. This is the normal user mode.

or
2. As a JPanel embedded in your Java app's layout anywhere you wish. Your app can call the methods shown in the Interface IOpenPCL to control how the OpenPCLViewer JPanel looks on screen and to control its behavior. OpenPCLViewer's own toolbar buttons and events call these same Interface methods to control it that and external app can call. You can hide the toolbar and/or JTree of PCL page nodes and call all the public api methods from your app's toolbar and/or menu items.

or
3. Don't do #1 or #2 above. This will allow you to not need the openpcl.jar file at run time. This one is the bare bones way. Your app will use the classes in the pclrenderimage.jar file directly by you app will call the public api interface IPclRenderImage methods. See the JavaDoc text on the PclRenderImage class and for the IPclRenderImage interface.

More details about it:
For (1), when OpenPCLViewer is run as the main app, its main() method runs which calls it's constructor. In this case, it will instantiate and show the JFrame PosSimpleJFrame, then embed itself as a JPanel into PosSimpleJFrame's layout. This requires no user programming and it does this as the ready to run PCL viewer.

For (2), if you've written a Java app already and you want to put a JPanel in your app that is a PCL viewer, then your app's code will instantiate OpenPCLViewer by doing a
"new OpenPCLViewer(JFrame pParentJFrame, String pArgs[])"
and pass your app's JFrame in the constructor. Doing it this way, the OpenPCLViewer main() is never run because your app's main() is the main(). Since OpenPCLViewer is a subclass of JPanel, it needs a reference to the JFrame where this JPanel will be contained so that JDialogs and JOptionPanes can be modal on the passed in JFrame as the parent frame. For the 2nd parameter which is the "String pArgs[]" you can pass null if you don't want to specify any command line options or the name of a PCL file to open and view at program startup time. Then you would add the OpenPCLViewer panel into your app's layout in any place you wish. If you don't want the JTree or toolbar or status bar, you can turn those off independently by calling public api interface methods that are in IOpenPCL. If you have your own menu items or toolbar buttons that you have in your app that you want to control the PCL Viewer JPanel with, then hide OpenPCLViewer's toolbar and make your event listener code call the OpenPCLViewer's public api interface methods that are in IOpenPCL.

For (3), If you want to *not* embed the OpenPCLViewer JPanel in your app, and instead the only thing you want is the BufferedImage bitmap that PclRenderImage draws from the PCL bytes, then you can use the classed in the pclrenderimage.jar file directly and not have the openpcl.jar file there at run time. In this case, your app needs to have all the UI code since you're going the bare bones route and not using any classes in the openpcl.jar file. Your direct method calling to the pclrenderimage.jar file will be:
3a. Call the different "renderImage...()" public api interface methods for it to draw/render the PCL bytes to the BufferedImage bitmap that you passed to it in a. above, and optionally at what zoom factor or to say zoom width at the passed in width.
3b. Write some code that gets the PCL bytes from a local file open, or from a URL or from XML, because this bare bones way means your app in in charge of getting the PCL bytes to pass to PclRenderImage.
3c. Put the java.awt.image.BufferedImage (that is returned from the renderImage...() methods) on the screen, or pass it along to a client who is in charge of putting it on the client's screen.

Author:

DocMagic, Document Systems Inc, Howard Hoagland.
The major viewing and printing functionality written 5/13/06 to 9/20/06.
Added more printing variations and more features and command line options after that.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected String	mAppDescription
protected String	mAppName
protected String	mAppVersion
int	mLastWindowState
static double	sDefaultZoomFactor
static int	sFileTypeNotSupported
static int	sFileTypePCL
static boolean	sIsRunningOnMacintosh
static int	sLastWindowStateCascade
static int	sLastWindowStateTileHorizontal
static int	sLastWindowStateTileVertical
static int	sMaxNumImages
static String	sMaxViewsAlreadyOpenString
static int	sMinIndexImages
static String	sNotSupportedAtThisTime
static String	sOsNameString

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

OpenPCLViewer()
Constructor with no parameters calls a chained constructor passing null as the JFrame, null as the JApplet, and null as the args, and null for PosStartupOptions.

OpenPCLViewer(JApplet pJApplet, String[] pArgs)
Constructor with null for the external app JFrame reference but passing in the JApplet and the String[] args, and null for the PosStartupOptions object.

OpenPCLViewer(JFrame pParentJFrame, JApplet pJApplet, String[] pArgs, PosStartupOptions pPosStartupOptions)
All constructors chain to this constructor.

OpenPCLViewer(JFrame pJFrame, PosStartupOptions pPosStartupOptions)
Constructor with the external app JFrame reference and null as the JApplet, and null as the String[] args, but passing in the PosStartupOptions object.

OpenPCLViewer(JFrame pJFrame, String[] pArgs)
Constructor with the external app JFrame reference and null as the JApplet, and passing in the String[] args, and passing null for PosStartupOptions.

OpenPCLViewer(String[] pArgs)
Constructor passing null as the external app JFrame reference and null as the JApplet, and passing in the String[] args, and passing null for PosStartupOptions.

Method Summary

void	actionAppIsExiting() Action "App is Exiting".
void	actionCascadeWindows() Cascade Windows
void	actionCloseAllFiles() Close All Files
void	actionCloseFile() Close File
void	actionGetWebDoc() Get Web Doc
void	actionHelpAbout() Show the "Help About" dialog
void	actionHideChangeTheLookPopup() Hide the "Change the Look" popup
void	actionHideHelpChoicesPopup() Hide the help choices popup
void	actionHidePrintChoicesPopup() Hide the print choices popup
void	actionHideToolbar() Hide the toolbar
void	actionHideTree() Hide the pages tree
void	actionHideWindowControlPopup() Hide the window control popup
void	actionHideZoomSliderPopup() Hide the zoom slider popup
void	actionNextPage() Next Page
void	actionOpenLocalFileDialog() Show the Open File modal dialog
void	actionOpenLocalFileSpecified(String pFilePathAndFileName) Open the file that is passed in the method call
void	actionPreviousPage() Previous Page
void	actionPrintAll() Print All
void	actionPrintChanged() Print Changed
void	actionPrintRemaining() Print Remaining
void	actionPrintSelected() Print Selected
void	actionSaveAs() This gets executed when the user clicks the Save As icon on the toolbar. Subclass plugins override this method so do not delete or rename this method.
void	actionSaveOnePageToPclFile() Save one page only as PCL file
void	actionShowChangeTheLookPopup() Show the "Change the Look" popup
void	actionShowHelpChoicesPopup() Show the help choices popup
void	actionShowHideChangeTheLookPopup() Toggle show/hide the "Change the Look" popup
void	actionShowHideHelpChoicesPopup() Toggle show/hide the help choices popup
void	actionShowHidePrintChoicesPopup() Toggle show/hide the print choices popup
void	actionShowHideToolbar() Toggle show/hide the toolbar
void	actionShowHideTree(boolean pControlKeyPressed) Toggle show/hide the pages tree
void	actionShowHideWindowControlPopup() Toggle show/hide the window control popup
void	actionShowHideZoomSliderPopup() Toggle show/hide the zoom slider popup
void	actionShowLicenseInfo() Show the "License info" dialog
void	actionShowOptionsDialog(boolean pControlKeyPressed) Show the Options dialog
void	actionShowPrintChoicesPopup() Show the print choices popup
void	actionShowToolbar() Show the toobar
void	actionShowTree() Show the pages tree
void	actionShowWindowControlPopup() Show the window control popup
void	actionShowZoomSliderPopup() Show the zoom slider popup
void	actionTileWindowsHorizontal() Tile Windows Horizontal
void	actionTileWindowsVertical() Tile Windows Horizontal
double	actionZoomInOneNotch() Zoom In
double	actionZoomOutOneNotch() Zoom Out
void	actionZoomTo(double pZoomFactor) Zoom to passed in zoom factor
void	actionZoomToWidth(int pWidthToFit) Zoom to passed in width
void	actionZoomWidth() Zoom Width
void	actionZoomWidth(PosView pPosView) Non api interface for internal use only to Zoom Width during a tile or cascade when the windows that resized aren't the window that the user clicked on last.
void	addToolbarButtonsFromSubclass(PosToolBar pPosToolBar) Add any additional toolbar buttons.
void	applySelectedLookAndFeel() Apply the selected LookAndFeel to the screen.
void	blankOutBufferedImage() Convenience method that calls PclRenderImage.blankOutBufferedImage().
protected void	buildLayout()
protected void	buildPopupDialogs()
protected PosMdiDesktopPane	buildPosMdiDesktopPane()
protected void	buildPrintingSupport()
protected void	buildUI()
protected void	changeLookListSelection(ListSelectionEvent pE)
protected ListSelectionListener	createChangeLookListSelectionListener() The Change Look toolbar button pops up a floating window with a JList of LookAndFeels
protected ActionListener	createDirectAccessZoomActionListener() Direct access zoom (the zoom buttons on the toolbar 10, 20, 30, ...)
protected ComponentListener	createFrameComponentListener()
protected ListSelectionListener	createHelpChoicesListSelectionListener() The Help choices toolbar button pops up a floating window with a JList of: "Show License Info", "About"
protected String	createNewMdiView(String pShortName, String pLongName) This method creates a new MDI JInternalFrame view.
PosView	createNewViewPanel(String pShortName) Create a new view panel.
protected ListSelectionListener	createPrintChoicesListSelectionListener() The Print Choices toolbar button pops up a floating window with a JList of: "Print All", "Print Selected", "Print Remaining", "Print Changed"
protected ListSelectionListener	createWindowControlListSelectionListener() The Window Control toolbar button pops up a floating window with a JList of: "Tile Horizontal", "Tile Vertical", "Cascade", "View #n thru #n on each line"
protected WindowFocusListener	createWindowFocusListener()
protected ChangeListener	createZoomSliderChangeListener()
static boolean	detectIfMacintosh(String pOsNameString) Detect if running on Macintosh.
int	determineFileTypeByFileExtension(String pExtensionOfFileName) Determine the file type by the file extension.
protected void	directAccessZoomActionPerformed(ActionEvent e)
void	executeAfterUiIsShowing() Code that needs to execute after the UI is showing on the screen upon app startup.
protected Frame	findBrowserFrame(JApplet pJApplet)
protected int	findLowestIndexAvailableView()
protected int	findOutFileType(String pShortName)
protected int	findOutImageHeight() Find out the image height
boolean	forceFrontSideWhenDuplexing(PosTreeNode pPosTreeNode) Returns true if this tree node page must print on the front side (not on the back of a page) when duplexing.
String	getAppDescription() Get the app description.
Frame	getAppFrame() Get the app's Frame
String	getAppName() Get the app name.
String	getAppVersion() Get the app version.
BufferedImage	getBufferedImageToDrawOn() Convenience method that calls PclRenderImage.getBufferedImageToDrawOn().
int	getCurrentViewWindowWidth() Get the current view window width
double	getCurrentZoomFactor() Get the PclRenderImage's current zoom factor
String	getFilePathAndFileName()
String	getFormNameForTreeNode(PosTreeNode pPosTreeNode) Get the Form Name for a tree node page.
String	getHiddenTagBaseString(int pTagIndex) Get the hidden tag base String.
BufferedImage	getImageForPage(int pPageNumber, byte[] pPrintTimePclBytes, boolean pIsForPrinting, String pPaperSize, double pZoomFactor) Convenience method that calls PclRenderImage.getImageForPage().
boolean	getIsDrawingForPrinting()
Icon	getJInternalFrameIcon() Allow subclases to set their own icon.
String	getJInternalFrameTitleBar(String defaultTitle) Allow subclases to set their own title.
String	getLastRenderErrorString() Convenience method that calls PclRenderImage.getLastRenderErrorString().
static String	getOsNamePropertyString() Get the os.name property String.
String	getPackageHelpAboutInfo() Get the package path to the help about .html file.
String	getPackagePathLicenseInfo() Get the package path to the license info .html file.
JTree	getPagesJTree() Get the JTree of the PCL pages for purposes of an external app can call methods on the JTree object which can change how it looks on the screen.
String	getPaperSizeForPage(int pPageNumber) Convenience method that calls PclRenderImage.getPaperSizeIntFromPclForPage().
byte[]	getPclBytesForPage(int pPageNumber) Get the Pcl bytes for page N
byte[]	getPclBytesForTreeNode(PosTreeNode pPosTreeNode) Get the PCL bytes for a tree node page.
int	getPclPageCount() Convenience method that calls PclRenderImage.getPageCount(byte[]).
PCLPrintJob	getPCLPrintJob()
PosChangeTheLookPopupDialog	getPosChangeTheLookPopupDialog()
PosManageToolBar	getPosManageToolBar()
PosPrintSetupDialogChoices	getPosPrintSetupDialogChoices()
PosStartupOptions	getPosStartupOptions()
PosStatusBar	getPosStatusBar()
PosView	getPosViewSelected()
PosZoomPopupDialog	getPosZoomPopupDialog()
PrintRequestAttributeSet	getPrintRequestAttributeSet()
protected void	helpChoicesListSelection(ListSelectionEvent pE)
protected void	hidePopupDialogs()
boolean	isTreeNodePageLetterSize(PosTreeNode pPosTreeNode) See if the selected tree node is a Letter Size PCL page.
String	loadFromFileSplitIntoSeparatePclPages(String pFilePathAndFileName) Convenience method that calls PclRenderImage.loadFromFileSplitIntoSeparatePclPages().
String	loadFromUrlSplitIntoSeparatePclPages(String pUrl) Convenience method that calls PclRenderImage.loadFromUrlSplitIntoSeparatePclPages().
static void	main(String[] pArgs) OpenPCLViewer's main() method calls the OpenPCLViewer constructor passing the command line args that were passed to main().
PosFileFilter	makeFileFilterForOpenFileDialog() Make the file filter for the File Open dialog to specify which file extensions to include.
protected String	makePclPageTreeNodes()
void	parseFileBytesIntoTreeNodes(String pFileNameOnly, String pFilePathAndFileName) Open the file on disk.
protected void	printChoicesListSelection(ListSelectionEvent pE)
protected void	readPersistedViewValues(Preferences pPrefs) Read the locally persisted view frame's (x,y) location and (width,height), and window state (maximized/iconified) and full path and filename of last file opened
protected void	readPrintOptionsValues(Preferences pPrefs, PosPrintSetupDialogChoices pPosPrintSetupDialogChoices) Read the locally persisted print setup dialog options
String	renderImageAtZoomFactor(double pAtZoomFactor) Render the image from current PosView and current Pcl page selected but now at this zoom factor.
String	renderImageCurrentPageAndZoom() Render the image from current PosView and current Pcl page selected and current previously set zoom.
String	renderImageForceZoomWidth(int pWidthToFit) Render the image from current PosView and current Pcl page selected but now make it zoom width.
BufferedImage	renderImageForPrintingFromPageNumber(int pPageNumber, byte[] pPrintTimePclBytes) Render the BufferedImage from the page number and the print time only additional PCL bytes to draw
BufferedImage	renderImageForPrintingFromTreeNode(PosTreeNode pPosTreeNode) Render the BufferedImage from the tree node.
protected void	savePersistedPrintOptionsValues(Preferences pPrefs, PosPersistPrintOptionsValues pPosPersistPrintOptionsValues, PosPrintSetupDialogChoices pPosPrintSetupDialogChoices) Save to local persisted storate the print setup dialog options
protected void	savePersistedViewValues(JInternalFrame pJInternalFrame, Preferences pPrefs, PosPersistViewValues pPosPersistViewValues) Save to local persisted storage the view frame's (x,y) location and (width,height), and window state (maximized/iconified) and full path and filename of last file opened
void	setAsTheActiveView(PosView pPosView) Set the current view selected.
void	setFilePathAndFileName(String pFilePathAndFileName)
void	setIsDrawingForPrinting(boolean pIsDrawingForPrinting)
void	setThisViewClosed(PosView pPosView) Set this view closed.
void	showClippedImage() Show Clipped Image
void	showImageForPage(int pPageNumber) Call this method to show the image for the passed in page number as if the user clicked on the tree node for that page.
protected void	showStatusBar()
protected void	showToolbar()
void	showZoomFactorOnToolbarButton(double pZoomFactor) Show the zoom factor in the toolbar button JLabel.setText()
String	splitIntoSeparatePclPages(byte[] pPclBytes) Convenience method that calls PclRenderImage.splitIntoSeparatePclPages(byte[]).
void	viewIsClosing(PosView pPosView) The JInternalFrame is still showing on the screen, but the user clicked the close X.
protected void	windowControlListSelection(ListSelectionEvent pE)
protected void	zoomSliderStateChanged(ChangeEvent e)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mAppName

protected String mAppName

mAppDescription

protected String mAppDescription

mAppVersion

protected String mAppVersion

sMinIndexImages

public static final int sMinIndexImages

See Also:

Constant Field Values

sMaxNumImages

public static final int sMaxNumImages

See Also:

Constant Field Values

sDefaultZoomFactor

public static final double sDefaultZoomFactor

See Also:

Constant Field Values

sFileTypeNotSupported

public static final int sFileTypeNotSupported

See Also:

Constant Field Values

sFileTypePCL

public static final int sFileTypePCL

See Also:

Constant Field Values

sLastWindowStateTileVertical

public static final int sLastWindowStateTileVertical

See Also:

Constant Field Values

sLastWindowStateTileHorizontal

public static final int sLastWindowStateTileHorizontal

See Also:

Constant Field Values

sLastWindowStateCascade

public static final int sLastWindowStateCascade

See Also:

Constant Field Values

mLastWindowState

public int mLastWindowState

sMaxViewsAlreadyOpenString

public static final String sMaxViewsAlreadyOpenString

See Also:

Constant Field Values

sNotSupportedAtThisTime

public static final String sNotSupportedAtThisTime

See Also:

Constant Field Values

sOsNameString

public static String sOsNameString

sIsRunningOnMacintosh

public static boolean sIsRunningOnMacintosh

Constructor Detail

OpenPCLViewer

public OpenPCLViewer()

Constructor with no parameters calls a chained constructor passing null as the JFrame, null as the JApplet, and null as the args, and null for PosStartupOptions. Passing null for both the JFrame and null for JApplet will cause it to be the default PCL Viewer by instantiating PosSimpleJFrame. The "String[] pArgs" is for passing command line options. The PosStartupOptions object has the command line options set as instance values.

OpenPCLViewer

public OpenPCLViewer(String[] pArgs)

Constructor passing null as the external app JFrame reference and null as the JApplet, and passing in the String[] args, and passing null for PosStartupOptions. Passing null for both the JFrame and null for JApplet will cause it to be the default PCL Viewer by instantiating PosSimpleJFrame. The "String[] pArgs" is for passing command line options. The PosStartupOptions object has the command line options set as instance values.

Parameters:

pArgs -

OpenPCLViewer

public OpenPCLViewer(JFrame pJFrame,
                     String[] pArgs)

Constructor with the external app JFrame reference and null as the JApplet, and passing in the String[] args, and passing null for PosStartupOptions. Passing the external app JFrame and null for JApplet will cause it to not instante the PosSimpleJFrame. in the case when this JPanel is embedded into the layout of the external app. The "String[] pArgs" is for passing command line options. The PosStartupOptions object has the command line options set as instance values.

OpenPCLViewer

public OpenPCLViewer(JFrame pJFrame,
                     PosStartupOptions pPosStartupOptions)

Constructor with the external app JFrame reference and null as the JApplet, and null as the String[] args, but passing in the PosStartupOptions object. Passing the external app JFrame and null for JApplet will cause it to not instante the PosSimpleJFrame, in the case when this JPanel is embedded into the layout of the external app. The "String[] pArgs" is for passing command line options. The PosStartupOptions object has the command line options set as instance values.

OpenPCLViewer

public OpenPCLViewer(JApplet pJApplet,
                     String[] pArgs)

Constructor with null for the external app JFrame reference but passing in the JApplet and the String[] args, and null for the PosStartupOptions object. Passing null for the external app JFrame but passing in the JApplet will cause it to not instante the PosSimpleJFrame and causes it to find the Frame of the IE or Firefox or other browser. The "String[] pArgs" is for passing command line options. The PosStartupOptions object has the command line options set as instance values.

OpenPCLViewer

public OpenPCLViewer(JFrame pParentJFrame,
                     JApplet pJApplet,
                     String[] pArgs,
                     PosStartupOptions pPosStartupOptions)

All constructors chain to this constructor. Passing the external app JFrame will cause it to not instante the PosSimpleJFrame in the case when this JPanel is embedded into the layout of the external app. Passing in a JApplet causes it to find the Frame of the IE or Firefox or other browser. The "String[] pArgs" is for passing command line options. The PosStartupOptions object has the command line options set as instance values.

Method Detail

main

public static void main(String[] pArgs)

OpenPCLViewer's main() method calls the OpenPCLViewer constructor passing the command line args that were passed to main().

getOsNamePropertyString

public static String getOsNamePropertyString()

Get the os.name property String. Do not delete or rename this method because Subclass plugin main() methods and subclasses of JApplet init() methods call this method.

Returns:

String

detectIfMacintosh

public static boolean detectIfMacintosh(String pOsNameString)

Detect if running on Macintosh. This static method must be called from main() due to the need to set property values before the AWT is loaded. See the Apple website pages for Java Developers targeting Macintosh for more explanation of why. Do not delete or rename this method because Subclass plugin main() methods and subclasses of JApplet init() methods call this method.

Parameters:

pOsNameString -

Returns:

boolean

findBrowserFrame

protected Frame findBrowserFrame(JApplet pJApplet)

buildLayout

protected void buildLayout()

buildUI

protected void buildUI()

executeAfterUiIsShowing

public void executeAfterUiIsShowing()

Code that needs to execute after the UI is showing on the screen upon app startup.

showToolbar

protected void showToolbar()

addToolbarButtonsFromSubclass

public void addToolbarButtonsFromSubclass(PosToolBar pPosToolBar)

Add any additional toolbar buttons. Subclass plugins override this method so do not delete or rename this method.

Specified by:

addToolbarButtonsFromSubclass in interface IPluginHooksOpenPCL

showStatusBar

protected void showStatusBar()

buildPosMdiDesktopPane

protected PosMdiDesktopPane buildPosMdiDesktopPane()

buildPrintingSupport

protected void buildPrintingSupport()

buildPopupDialogs

protected void buildPopupDialogs()

makeFileFilterForOpenFileDialog

public PosFileFilter makeFileFilterForOpenFileDialog()

Make the file filter for the File Open dialog to specify which file extensions to include. Subclass plugins override this method so do not delete or rename this method.

Specified by:

makeFileFilterForOpenFileDialog in interface IPluginHooksOpenPCL

readPersistedViewValues

protected void readPersistedViewValues(Preferences pPrefs)

Read the locally persisted view frame's (x,y) location and (width,height), and window state (maximized/iconified) and full path and filename of last file opened

readPrintOptionsValues

protected void readPrintOptionsValues(Preferences pPrefs,
                                      PosPrintSetupDialogChoices pPosPrintSetupDialogChoices)

Read the locally persisted print setup dialog options

Parameters:

pPrefs -

pPosPrintSetupDialogChoices -

savePersistedViewValues

protected void savePersistedViewValues(JInternalFrame pJInternalFrame,
                                       Preferences pPrefs,
                                       PosPersistViewValues pPosPersistViewValues)

Save to local persisted storage the view frame's (x,y) location and (width,height), and window state (maximized/iconified) and full path and filename of last file opened

savePersistedPrintOptionsValues

protected void savePersistedPrintOptionsValues(Preferences pPrefs,
                                               PosPersistPrintOptionsValues pPosPersistPrintOptionsValues,
                                               PosPrintSetupDialogChoices pPosPrintSetupDialogChoices)

Save to local persisted storate the print setup dialog options

Parameters:

pPrefs -

pPosPersistPrintOptionsValues -

pPosPrintSetupDialogChoices -

getPosManageToolBar

public PosManageToolBar getPosManageToolBar()

getPosStatusBar

public PosStatusBar getPosStatusBar()

getPosZoomPopupDialog

public PosZoomPopupDialog getPosZoomPopupDialog()

getPosChangeTheLookPopupDialog

public PosChangeTheLookPopupDialog getPosChangeTheLookPopupDialog()

getIsDrawingForPrinting

public boolean getIsDrawingForPrinting()

getPosViewSelected

public PosView getPosViewSelected()

getFilePathAndFileName

public String getFilePathAndFileName()

getPosStartupOptions

public PosStartupOptions getPosStartupOptions()

getPosPrintSetupDialogChoices

public PosPrintSetupDialogChoices getPosPrintSetupDialogChoices()

getPCLPrintJob

public PCLPrintJob getPCLPrintJob()

getPrintRequestAttributeSet

public PrintRequestAttributeSet getPrintRequestAttributeSet()

setIsDrawingForPrinting

public void setIsDrawingForPrinting(boolean pIsDrawingForPrinting)

setFilePathAndFileName

public void setFilePathAndFileName(String pFilePathAndFileName)

createPrintChoicesListSelectionListener

protected ListSelectionListener createPrintChoicesListSelectionListener()

The Print Choices toolbar button pops up a floating window with a JList of: "Print All", "Print Selected", "Print Remaining", "Print Changed"

printChoicesListSelection

protected void printChoicesListSelection(ListSelectionEvent pE)

createDirectAccessZoomActionListener

protected ActionListener createDirectAccessZoomActionListener()

Direct access zoom (the zoom buttons on the toolbar 10, 20, 30, ...)

Returns:

directAccessZoomActionPerformed

protected void directAccessZoomActionPerformed(ActionEvent e)

createZoomSliderChangeListener

protected ChangeListener createZoomSliderChangeListener()

zoomSliderStateChanged

protected void zoomSliderStateChanged(ChangeEvent e)

createChangeLookListSelectionListener

protected ListSelectionListener createChangeLookListSelectionListener()

The Change Look toolbar button pops up a floating window with a JList of LookAndFeels

changeLookListSelection

protected void changeLookListSelection(ListSelectionEvent pE)

applySelectedLookAndFeel

public void applySelectedLookAndFeel()

Apply the selected LookAndFeel to the screen. Subclass plugins override this method so do not delete or rename this method.

Specified by:

applySelectedLookAndFeel in interface IPluginHooksOpenPCL

createWindowControlListSelectionListener

protected ListSelectionListener createWindowControlListSelectionListener()

The Window Control toolbar button pops up a floating window with a JList of: "Tile Horizontal", "Tile Vertical", "Cascade", "View #n thru #n on each line"

windowControlListSelection

protected void windowControlListSelection(ListSelectionEvent pE)

createHelpChoicesListSelectionListener

protected ListSelectionListener createHelpChoicesListSelectionListener()

The Help choices toolbar button pops up a floating window with a JList of: "Show License Info", "About"

helpChoicesListSelection

protected void helpChoicesListSelection(ListSelectionEvent pE)

createFrameComponentListener

protected ComponentListener createFrameComponentListener()

createWindowFocusListener

protected WindowFocusListener createWindowFocusListener()

hidePopupDialogs

protected void hidePopupDialogs()

setAsTheActiveView

public void setAsTheActiveView(PosView pPosView)

Set the current view selected. This method is called from PosInternalFrameListener.internalFrameActivated() whenever a view JInternalFrame is first shown, or when the user clicks on a view JInternalFrame, or types ctrl-F6 to cycle thru them This method is very important because the code in OpenPCLViewer uses this mPosViewSelected to call the methods of the currently selected view, and the code in PclRenderImage renders/draws ons the BufferedImage.

Parameters:

pPosView -

viewIsClosing

public void viewIsClosing(PosView pPosView)

The JInternalFrame is still showing on the screen, but the user clicked the close X. This is called from PosInternalFrameListener.internalFrameClosing() which will call OpenPCLViewer.viewIsClosing() which will save the JInternalFrame's (x,y) and (width,height) and last opened filename, but only if this is the last open view and now there will be no view open.

Parameters:

pPosView -

setThisViewClosed

public void setThisViewClosed(PosView pPosView)

Set this view closed. This method is called from PosInternalFrameListener.internalFrameClosing() whenever the user clicks the Close X on the view JInternalFrame or clicks the Close File icon, or the actionCloseFile() method is called by an external app

Parameters:

pPosView -

findLowestIndexAvailableView

protected int findLowestIndexAvailableView()

findOutFileType

protected int findOutFileType(String pShortName)

determineFileTypeByFileExtension

public int determineFileTypeByFileExtension(String pExtensionOfFileName)

Determine the file type by the file extension. Subclass plugins override this method so do not delete or rename this method.

Specified by:

determineFileTypeByFileExtension in interface IPluginHooksOpenPCL

showZoomFactorOnToolbarButton

public void showZoomFactorOnToolbarButton(double pZoomFactor)

Show the zoom factor in the toolbar button JLabel.setText()

getCurrentViewWindowWidth

public int getCurrentViewWindowWidth()

Get the current view window width

showClippedImage

public void showClippedImage()

Show Clipped Image

findOutImageHeight

protected int findOutImageHeight()

Find out the image height

isTreeNodePageLetterSize

public boolean isTreeNodePageLetterSize(PosTreeNode pPosTreeNode)

See if the selected tree node is a Letter Size PCL page. If not, then it's Legal Size. Subclass plugins override this method so do not delete or rename this method.

Specified by:

isTreeNodePageLetterSize in interface IPluginHooksOpenPCL

getPclBytesForTreeNode

public byte[] getPclBytesForTreeNode(PosTreeNode pPosTreeNode)

Get the PCL bytes for a tree node page. This is used for "Print PCL Direct" to send the actual PCL bytes to the printer. Subclass plugins override this method so do not delete or rename this method.

Specified by:

getPclBytesForTreeNode in interface IPluginHooksOpenPCL

getFormNameForTreeNode

public String getFormNameForTreeNode(PosTreeNode pPosTreeNode)

Get the Form Name for a tree node page. Used for both print "PCL Direct" and for "Windows Print". Subclass plugins override this method so do not delete or rename this method.

Specified by:

getFormNameForTreeNode in interface IPluginHooksOpenPCL

forceFrontSideWhenDuplexing

public boolean forceFrontSideWhenDuplexing(PosTreeNode pPosTreeNode)

Returns true if this tree node page must print on the front side (not on the back of a page) when duplexing. Subclass plugins override this method so do not delete or rename this method.

Specified by:

forceFrontSideWhenDuplexing in interface IPluginHooksOpenPCL

createNewViewPanel

public PosView createNewViewPanel(String pShortName)

Create a new view panel. Subclass plugins override this method so do not delete or rename this method.

Specified by:

createNewViewPanel in interface IPluginHooksOpenPCL

createNewMdiView

protected String createNewMdiView(String pShortName,
                                  String pLongName)

This method creates a new MDI JInternalFrame view. UI side only and doesn't call into PclRenderImage to get the image yet.

Parameters:

pShortName. - Used as the JTree root node name.

pLongName -

Returns:

If error returns error String. If no error then returns null

getJInternalFrameIcon

public Icon getJInternalFrameIcon()

Allow subclases to set their own icon. Subclass plugins override this method so do not delete or rename this method.

Specified by:

getJInternalFrameIcon in interface IPluginHooksOpenPCL

getJInternalFrameTitleBar

public String getJInternalFrameTitleBar(String defaultTitle)

Allow subclases to set their own title. Subclass plugins override this method so do not delete or rename this method.

Specified by:

getJInternalFrameTitleBar in interface IPluginHooksOpenPCL

makePclPageTreeNodes

protected String makePclPageTreeNodes()

renderImageForceZoomWidth

public String renderImageForceZoomWidth(int pWidthToFit)

Render the image from current PosView and current Pcl page selected but now make it zoom width.

Parameters:

pWidthToFit -

Returns:

If error returns error String. If no error then returns null

renderImageAtZoomFactor

public String renderImageAtZoomFactor(double pAtZoomFactor)

Render the image from current PosView and current Pcl page selected but now at this zoom factor.

Parameters:

pAtZoomFactor -

Returns:

If error returns error String. If no error then returns null

renderImageCurrentPageAndZoom

public String renderImageCurrentPageAndZoom()

Render the image from current PosView and current Pcl page selected and current previously set zoom.

Returns:

If error returns error String. If no error then returns null

renderImageForPrintingFromTreeNode

public BufferedImage renderImageForPrintingFromTreeNode(PosTreeNode pPosTreeNode)

Render the BufferedImage from the tree node. Subclass plugins override this method so do not delete or rename this method.

Specified by:

renderImageForPrintingFromTreeNode in interface IPluginHooksOpenPCL

renderImageForPrintingFromPageNumber

public BufferedImage renderImageForPrintingFromPageNumber(int pPageNumber,
                                                          byte[] pPrintTimePclBytes)

Render the BufferedImage from the page number and the print time only additional PCL bytes to draw

splitIntoSeparatePclPages

public String splitIntoSeparatePclPages(byte[] pPclBytes)

Convenience method that calls PclRenderImage.splitIntoSeparatePclPages(byte[]). Split the passed in Pcl bytes into separate pages and internally store each page's Pcl bytes.

Specified by:

splitIntoSeparatePclPages in interface IOpenPCL

Parameters:

pPclBytes -

Returns:

If error returns error String. If no error then returns null

getPclPageCount

public int getPclPageCount()

Convenience method that calls PclRenderImage.getPageCount(byte[]). Returns the number of separate pages found by parsing the passed in Pcl bytes in splitIntoSeparatePclPages().

Specified by:

getPclPageCount in interface IOpenPCL

Returns:

int

getImageForPage

public BufferedImage getImageForPage(int pPageNumber,
                                     byte[] pPrintTimePclBytes,
                                     boolean pIsForPrinting,
                                     String pPaperSize,
                                     double pZoomFactor)

Convenience method that calls PclRenderImage.getImageForPage(). The PCL for the passed in page number will be rendered to a BufferedImage. Note that the UI side version of this method getImageForPage() puts the BufferedImage on the screen that was returned from PclRenderImage.getImageForPage(). If there was an error in the rendering, then null is returned instead of the BufferedImage, in which case, call getLastRenderErrorString() to get the String error message. Passing in the zoom factor is mandatory because the rendering code draws everything (text, rectanges, raster dot areas, etc) pre-scaled to exactly how small or big is needed and clips the overall image width and height to make the whole image look zoomed smaller or bigger. The UI code can then put this image on the screen without scaling the image on the UI side. Doing it this way is needed so the image looks sharp because scaling using the AffineTransform scale leaves the image too blurry for both zoom in or out. In DocMaster, this is getImage().

Specified by:

getImageForPage in interface IOpenPCL

Parameters:

pPageNumber. - The Pcl page number to render to the image.

pPrintTimePclBytes. - Draw these additional PCL bytes on the print image.

pIsForPrinting. - If true non printing items like signature blocks won't be rendered.

pPaperSize. - If a paper size is not specified in the PCL, this paper size will be used. "LTR" or "LGL".

pZoomFactor. - This is mandatory (see note for why).

Returns:

BufferedImage. If null, then get the return String from PclRenderImage.getLastErrorString()

getLastRenderErrorString

public String getLastRenderErrorString()

Convenience method that calls PclRenderImage.getLastRenderErrorString(). Get the last error string. Call this if getImageForPage() returned null instead of returning the BufferedImage.

Specified by:

getLastRenderErrorString in interface IOpenPCL

Returns:

String of the last error

loadFromFileSplitIntoSeparatePclPages

public String loadFromFileSplitIntoSeparatePclPages(String pFilePathAndFileName)

Convenience method that calls PclRenderImage.loadFromFileSplitIntoSeparatePclPages(). Read the PCL bytes the passed in String full path and filename. Then this calls splitIntoSeparatePclPages to split the Pcl into its separate pages. No image is rendered yet. To get the image for a page number, call getImageForPage().

Specified by:

loadFromFileSplitIntoSeparatePclPages in interface IOpenPCL

Parameters:

pFullPathAndFilename -

Returns:

If error returns error String. If no error then returns null

loadFromUrlSplitIntoSeparatePclPages

public String loadFromUrlSplitIntoSeparatePclPages(String pUrl)

Convenience method that calls PclRenderImage.loadFromUrlSplitIntoSeparatePclPages(). Read the PCL bytes the passed in String URL. Then this calls splitIntoSeparatePclPages to split the Pcl into its separate pages. No image is rendered yet. To get the image for a page number, call getImageForPage().

Specified by:

loadFromUrlSplitIntoSeparatePclPages in interface IOpenPCL

Parameters:

pUrl -

Returns:

If error returns error String. If no error then returns null

getBufferedImageToDrawOn

public BufferedImage getBufferedImageToDrawOn()

Convenience method that calls PclRenderImage.getBufferedImageToDrawOn(). Get the BufferedImage to draw on for purposes of an external app can call methods on the BufferedImage object so the external app can directly draw on the image if wanted.

Specified by:

getBufferedImageToDrawOn in interface IOpenPCL

Returns:

BufferedImage. If null, then get the return String from PclRenderImage.getLastErrorString()

blankOutBufferedImage

public void blankOutBufferedImage()

Convenience method that calls PclRenderImage.blankOutBufferedImage(). Blank out the BufferedImage on the screen.

Specified by:

blankOutBufferedImage in interface IOpenPCL

getPclBytesForPage

public byte[] getPclBytesForPage(int pPageNumber)

Get the Pcl bytes for page N

Specified by:

getPclBytesForPage in interface IOpenPCL

getPaperSizeForPage

public String getPaperSizeForPage(int pPageNumber)

Convenience method that calls PclRenderImage.getPaperSizeIntFromPclForPage(). Get the Paper Size int that was in the original Pcl bytes for the passed in page. Each page has its own paper size setting, which was set in the PclRenderImage.commandFoundEvent() for the Pcl command "ESC & L # A". When a Paper Size Pcl command is found, it is set on the current page and also on the following pages until another Paper Size command is found. For those Pcl files that have been dieted/scrubbed, and the Paper Size is not there, then the default Paper Size is used from PriPageSettings.sDefaultPaperSize.

Specified by:

getPaperSizeForPage in interface IOpenPCL

Parameters:

pPageNumber -

Returns:

String

getPagesJTree

public JTree getPagesJTree()

Get the JTree of the PCL pages for purposes of an external app can call methods on the JTree object which can change how it looks on the screen.

Specified by:

getPagesJTree in interface IOpenPCL

Returns:

JTree

getCurrentZoomFactor

public double getCurrentZoomFactor()

Get the PclRenderImage's current zoom factor

Specified by:

getCurrentZoomFactor in interface IOpenPCL

Returns:

double

actionOpenLocalFileDialog

public void actionOpenLocalFileDialog()

Show the Open File modal dialog

Specified by:

actionOpenLocalFileDialog in interface IOpenPCL

actionOpenLocalFileSpecified

public void actionOpenLocalFileSpecified(String pFilePathAndFileName)

Open the file that is passed in the method call

parseFileBytesIntoTreeNodes

public void parseFileBytesIntoTreeNodes(String pFileNameOnly,
                                        String pFilePathAndFileName)

Open the file on disk. Read and parse all bytes in the file into tree nodes. Subclass plugins override this method so do not delete or rename this method.

Specified by:

parseFileBytesIntoTreeNodes in interface IPluginHooksOpenPCL

showImageForPage

public void showImageForPage(int pPageNumber)

Call this method to show the image for the passed in page number as if the user clicked on the tree node for that page.

Parameters:

pPageNumber -

actionShowHideToolbar

public void actionShowHideToolbar()

Toggle show/hide the toolbar

Specified by:

actionShowHideToolbar in interface IOpenPCL

actionShowToolbar

public void actionShowToolbar()

Show the toobar

Specified by:

actionShowToolbar in interface IOpenPCL

actionHideToolbar

public void actionHideToolbar()

Hide the toolbar

Specified by:

actionHideToolbar in interface IOpenPCL

actionGetWebDoc

public void actionGetWebDoc()

Get Web Doc

Specified by:

actionGetWebDoc in interface IOpenPCL

actionCloseFile

public void actionCloseFile()

Close File

Specified by:

actionCloseFile in interface IOpenPCL

actionCloseAllFiles

public void actionCloseAllFiles()

Close All Files

Specified by:

actionCloseAllFiles in interface IOpenPCL

actionShowHidePrintChoicesPopup

public void actionShowHidePrintChoicesPopup()

Toggle show/hide the print choices popup

Specified by:

actionShowHidePrintChoicesPopup in interface IOpenPCL

actionShowPrintChoicesPopup

public void actionShowPrintChoicesPopup()

Show the print choices popup

Specified by:

actionShowPrintChoicesPopup in interface IOpenPCL

actionHidePrintChoicesPopup

public void actionHidePrintChoicesPopup()

Hide the print choices popup

Specified by:

actionHidePrintChoicesPopup in interface IOpenPCL

actionPrintAll

public void actionPrintAll()

Print All

Specified by:

actionPrintAll in interface IOpenPCL

actionPrintSelected

public void actionPrintSelected()

Print Selected

Specified by:

actionPrintSelected in interface IOpenPCL

actionPrintRemaining

public void actionPrintRemaining()

Print Remaining

Specified by:

actionPrintRemaining in interface IOpenPCL

actionPrintChanged

public void actionPrintChanged()

Print Changed

Specified by:

actionPrintChanged in interface IOpenPCL

actionPreviousPage

public void actionPreviousPage()

Previous Page

Specified by:

actionPreviousPage in interface IOpenPCL

actionNextPage

public void actionNextPage()

Next Page

Specified by:

actionNextPage in interface IOpenPCL

actionShowHideTree

public void actionShowHideTree(boolean pControlKeyPressed)

Toggle show/hide the pages tree

Specified by:

actionShowHideTree in interface IOpenPCL

actionShowTree

public void actionShowTree()

Show the pages tree

Specified by:

actionShowTree in interface IOpenPCL

actionHideTree

public void actionHideTree()

Hide the pages tree

Specified by:

actionHideTree in interface IOpenPCL

actionZoomOutOneNotch

public double actionZoomOutOneNotch()

Zoom Out

Specified by:

actionZoomOutOneNotch in interface IOpenPCL

actionZoomInOneNotch

public double actionZoomInOneNotch()

Zoom In

Specified by:

actionZoomInOneNotch in interface IOpenPCL

actionShowHideZoomSliderPopup

public void actionShowHideZoomSliderPopup()

Toggle show/hide the zoom slider popup

Specified by:

actionShowHideZoomSliderPopup in interface IOpenPCL

actionShowZoomSliderPopup

public void actionShowZoomSliderPopup()

Show the zoom slider popup

Specified by:

actionShowZoomSliderPopup in interface IOpenPCL

actionHideZoomSliderPopup

public void actionHideZoomSliderPopup()

Hide the zoom slider popup

Specified by:

actionHideZoomSliderPopup in interface IOpenPCL

actionZoomWidth

public void actionZoomWidth()

Zoom Width

Specified by:

actionZoomWidth in interface IOpenPCL

actionZoomToWidth

public void actionZoomToWidth(int pWidthToFit)

Zoom to passed in width

Specified by:

actionZoomToWidth in interface IOpenPCL

actionZoomWidth

public void actionZoomWidth(PosView pPosView)

Non api interface for internal use only to Zoom Width during a tile or cascade when the windows that resized aren't the window that the user clicked on last. Called from PosView.mJInternalFrame.addComponentListener()

actionZoomTo

public void actionZoomTo(double pZoomFactor)

Zoom to passed in zoom factor

Specified by:

actionZoomTo in interface IOpenPCL

actionSaveAs

public void actionSaveAs()

This gets executed when the user clicks the Save As icon on the toolbar.
Subclass plugins override this method so do not delete or rename this method.

Specified by:

actionSaveAs in interface IOpenPCL

Specified by:

actionSaveAs in interface IPluginHooksOpenPCL

actionSaveOnePageToPclFile

public void actionSaveOnePageToPclFile()

Save one page only as PCL file

Specified by:

actionSaveOnePageToPclFile in interface IOpenPCL

actionShowHideChangeTheLookPopup

public void actionShowHideChangeTheLookPopup()

Toggle show/hide the "Change the Look" popup

Specified by:

actionShowHideChangeTheLookPopup in interface IOpenPCL

actionShowChangeTheLookPopup

public void actionShowChangeTheLookPopup()

Show the "Change the Look" popup

Specified by:

actionShowChangeTheLookPopup in interface IOpenPCL

actionHideChangeTheLookPopup

public void actionHideChangeTheLookPopup()

Hide the "Change the Look" popup

Specified by:

actionHideChangeTheLookPopup in interface IOpenPCL

actionShowHideWindowControlPopup

public void actionShowHideWindowControlPopup()

Toggle show/hide the window control popup

actionShowWindowControlPopup

public void actionShowWindowControlPopup()

Show the window control popup

actionHideWindowControlPopup

public void actionHideWindowControlPopup()

Hide the window control popup

actionTileWindowsHorizontal

public void actionTileWindowsHorizontal()

Tile Windows Horizontal

Specified by:

actionTileWindowsHorizontal in interface IOpenPCL

actionTileWindowsVertical

public void actionTileWindowsVertical()

Tile Windows Horizontal

Specified by:

actionTileWindowsVertical in interface IOpenPCL

actionCascadeWindows

public void actionCascadeWindows()

Cascade Windows

Specified by:

actionCascadeWindows in interface IOpenPCL

actionShowOptionsDialog

public void actionShowOptionsDialog(boolean pControlKeyPressed)

Show the Options dialog

Specified by:

actionShowOptionsDialog in interface IOpenPCL

actionShowHideHelpChoicesPopup

public void actionShowHideHelpChoicesPopup()

Toggle show/hide the help choices popup

Specified by:

actionShowHideHelpChoicesPopup in interface IOpenPCL

actionShowHelpChoicesPopup

public void actionShowHelpChoicesPopup()

Show the help choices popup

Specified by:

actionShowHelpChoicesPopup in interface IOpenPCL

actionHideHelpChoicesPopup

public void actionHideHelpChoicesPopup()

Hide the help choices popup

Specified by:

actionHideHelpChoicesPopup in interface IOpenPCL

actionShowLicenseInfo

public void actionShowLicenseInfo()

Show the "License info" dialog

Specified by:

actionShowLicenseInfo in interface IOpenPCL

actionHelpAbout

public void actionHelpAbout()

Show the "Help About" dialog

Specified by:

actionHelpAbout in interface IOpenPCL

actionAppIsExiting

public void actionAppIsExiting()

Action "App is Exiting". This will call the CloseAllFiles operation and remove the JFrame listeners

Specified by:

actionAppIsExiting in interface IOpenPCL

getAppFrame

public Frame getAppFrame()

Get the app's Frame

Specified by:

getAppFrame in interface IOpenPCL

getAppName

public String getAppName()

Get the app name. Subclass plugins override this method so do not delete or rename this method.

Specified by:

getAppName in interface IOpenPCL

Specified by:

getAppName in interface IPluginHooksOpenPCL

getAppDescription

public String getAppDescription()

Get the app description. Subclass plugins override this method so do not delete or rename this method.

Specified by:

getAppDescription in interface IOpenPCL

Specified by:

getAppDescription in interface IPluginHooksOpenPCL

getAppVersion

public String getAppVersion()

Get the app version. Subclass plugins override this method so do not delete or rename this method.

Specified by:

getAppVersion in interface IOpenPCL

Specified by:

getAppVersion in interface IPluginHooksOpenPCL

getPackagePathLicenseInfo

public String getPackagePathLicenseInfo()

Get the package path to the license info .html file. Subclass plugins override this method so do not delete or rename this method.

Specified by:

getPackagePathLicenseInfo in interface IOpenPCL

Specified by:

getPackagePathLicenseInfo in interface IPluginHooksOpenPCL

getPackageHelpAboutInfo

public String getPackageHelpAboutInfo()

Get the package path to the help about .html file. Subclass plugins override this method so do not delete or rename this method.

Specified by:

getPackageHelpAboutInfo in interface IOpenPCL

Specified by:

getPackageHelpAboutInfo in interface IPluginHooksOpenPCL

getHiddenTagBaseString

public String getHiddenTagBaseString(int pTagIndex)

Get the hidden tag base String. Subclass plugins override this method so do not delete or rename this method.

Specified by:

getHiddenTagBaseString in interface IPluginHooksOpenPCL