Package adams.flow.sink

Class PDFViewer

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.core.AbstractDisplay

adams.flow.sink.AbstractDisplay

adams.flow.sink.AbstractGraphicalDisplay

adams.flow.sink.PDFViewer

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, FlowControlSubMenuSupporter, HeadlessExecutionSupporter, InputConsumer, ComponentSupplier, DisplayPanelProvider, MenuBarProvider, SendToActionSupporter, Serializable, Comparable

public class PDFViewer
extends AbstractGraphicalDisplay
implements DisplayPanelProvider, SendToActionSupporter

Actor for displaying PDF files.

Input/output:
- accepts:
java.lang.String
java.io.File


Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: PDFViewer
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-width <int> (property: width)
    The width of the dialog.
    default: 800
    minimum: 1
 

-height <int> (property: height)
    The height of the dialog.
    default: 600
    minimum: 1
 

-x <int> (property: x)
    The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
    ).
    default: -1
    minimum: -3
 

-y <int> (property: y)
    The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
    ).
    default: -1
    minimum: -3
 

-writer <adams.gui.print.JComponentWriter> (property: writer)
    The writer to use for generating the graphics output.
    default: adams.gui.print.NullWriter
 

-zoom <double> (property: zoom)
    The zoom level in percent.
    default: 100.0
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseFileChooser	m_PDFFileChooser	the filedialog for saving the PDF file.
protected PDFPanel	m_PDFPanel	the panel with the PDF.
protected double	m_Zoom	the zoom level.

Fields inherited from class adams.flow.sink.AbstractGraphicalDisplay

m_GraphicFileChooser, m_MenuBar, m_MenuItemFileClear, m_MenuItemFileClose, m_MenuItemFileSaveAs, m_MenuItemFileSaveTextAs, m_MenuItemFlowPauseResume, m_MenuItemFlowStop, m_ShowFlowControlSubMenu, m_TextFileChooser, m_Writer

Fields inherited from class adams.flow.core.AbstractDisplay

BACKUP_INPUT, m_CreateFrame, m_DisplayType, m_Frame, m_Height, m_InputToken, m_KeepOpen, m_Panel, m_ResetGUIWaiting, m_ShortTitle, m_Updating, m_Width, m_X, m_Y

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors

Constructor	Description
PDFViewer()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
protected void	cleanUpGUI()	Removes all graphical components.
void	clearPanel()	Clears the content of the panel.
AbstractDisplayPanel	createDisplayPanel(Token token)	Creates a new panel for the token.
void	defineOptions()	Adds options to the internal list of options.
protected void	display(Token token)	Displays the token (the panel and dialog have already been created at this stage).
boolean	displayPanelRequiresScrollPane()	Returns whether the created display panel requires a scroll pane or not.
protected int	getDefaultHeight()	Returns the default height for the dialog.
protected int	getDefaultWidth()	Returns the default width for the dialog.
protected BaseFileChooser	getPDFFileChooser()	Returns (and initializes if necessary) the file chooser for the text.
Class[]	getSendToClasses()	Returns the class that the supporter generates.
Object	getSendToItem(Class[] cls)	Returns the object to send.
double	getZoom()	Returns the zoom level in percent.
String	globalInfo()	Returns a string describing the object.
boolean	hasSendToItem(Class[] cls)	Checks whether something to send is available.
protected BasePanel	newPanel()	Creates the panel to display in the dialog.
protected void	saveAs()	Saves the panel as picture.
void	setZoom(double value)	Sets the zoom level in percent.
boolean	supportsClear()	Whether "clear" is supported and shows up in the menu.
String	zoomTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.sink.AbstractGraphicalDisplay

canPauseOrResume, clear, close, createMenuBar, getGraphicFileChooser, getMenuBar, getShowFlowControlSubMenu, getTextFileChooser, getWriter, hasPanel, isPaused, pauseResumeFlow, saveTextAs, setShowFlowControlSubMenu, setWriter, showFlowControlSubMenuTipText, stopFlow, supplyComponent, updateMenu, wrapUp, writerTipText

Methods inherited from class adams.flow.sink.AbstractDisplay

newDisplayRunnable, postDisplay, preDisplay

Methods inherited from class adams.flow.core.AbstractDisplay

backupState, cleanUp, cleanUpGUIKeepOpen, closeDisplay, createFrame, createTitle, currentInput, deregisterInWrapUp, deregisterWindow, deregisterWithEditor, displayTypeTipText, doCreateFrame, doExecute, doExecuteHeadless, getCreateFrame, getDefaultDisplayType, getDefaultShortTitle, getDefaultX, getDefaultY, getDisplayType, getFrame, getFrameDefaultCloseOperation, getHeight, getKeepOpen, getPanel, getQuickInfo, getShortTitle, getWidth, getX, getY, hasInput, heightTipText, initialize, input, postCreateFrame, preCreateFrame, registerWindow, registerWithEditor, reset, restoreState, setCreateFrame, setDisplayType, setHeight, setKeepOpen, setShortTitle, setWidth, setX, setY, shortTitleTipText, stopExecution, supportsHeadlessExecution, widthTipText, xTipText, yTipText

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.flow.core.InputConsumer

currentInput, hasInput, input

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_PDFPanel

protected PDFPanel m_PDFPanel

the panel with the PDF.

m_Zoom

protected double m_Zoom

the zoom level.

m_PDFFileChooser

protected transient BaseFileChooser m_PDFFileChooser

the filedialog for saving the PDF file.

Constructor Detail

PDFViewer

public PDFViewer()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractGraphicalDisplay

getDefaultWidth

protected int getDefaultWidth()

Returns the default width for the dialog.

Overrides:

getDefaultWidth in class AbstractDisplay

Returns:

the default width

getDefaultHeight

protected int getDefaultHeight()

Returns the default height for the dialog.

Overrides:

getDefaultHeight in class AbstractDisplay

Returns:

the default height

setZoom

public void setZoom(double value)

Sets the zoom level in percent.

Parameters:

value - the zoom

getZoom

public double getZoom()

Returns the zoom level in percent.

Returns:

the zoom

zoomTipText

public String zoomTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

supportsClear

public boolean supportsClear()

Whether "clear" is supported and shows up in the menu.

Specified by:

supportsClear in interface ClearableDisplay

Overrides:

supportsClear in class AbstractGraphicalDisplay

Returns:

true if supported

clearPanel

public void clearPanel()

Clears the content of the panel.

Specified by:

clearPanel in class AbstractDisplay

newPanel

protected BasePanel newPanel()

Creates the panel to display in the dialog.

Specified by:

newPanel in class AbstractDisplay

Returns:

the panel

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Returns:

java.lang.String.class, java.io.File.class

getPDFFileChooser

protected BaseFileChooser getPDFFileChooser()

Returns (and initializes if necessary) the file chooser for the text.

Returns:

the file chooser

saveAs

protected void saveAs()

Saves the panel as picture.

Overrides:

saveAs in class AbstractGraphicalDisplay

display

protected void display(Token token)

Displays the token (the panel and dialog have already been created at this stage).

Specified by:

display in class AbstractDisplay

Parameters:

token - the token to display

cleanUpGUI

protected void cleanUpGUI()

Removes all graphical components.

Overrides:

cleanUpGUI in class AbstractGraphicalDisplay

createDisplayPanel

public AbstractDisplayPanel createDisplayPanel(Token token)

Creates a new panel for the token.

Specified by:

createDisplayPanel in interface DisplayPanelProvider

Parameters:

token - the token to display in a new panel, can be null

Returns:

the generated panel

displayPanelRequiresScrollPane

public boolean displayPanelRequiresScrollPane()

Returns whether the created display panel requires a scroll pane or not.

Specified by:

displayPanelRequiresScrollPane in interface DisplayPanelProvider

Returns:

true if the display panel requires a scroll pane

getSendToClasses

public Class[] getSendToClasses()

Returns the class that the supporter generates.

Specified by:

getSendToClasses in interface SendToActionSupporter

Overrides:

getSendToClasses in class AbstractGraphicalDisplay

Returns:

the class

hasSendToItem

public boolean hasSendToItem(Class[] cls)

Checks whether something to send is available.

Specified by:

hasSendToItem in interface SendToActionSupporter

Overrides:

hasSendToItem in class AbstractGraphicalDisplay

Parameters:

cls - the requested classes

Returns:

true if an object is available for sending

getSendToItem

public Object getSendToItem(Class[] cls)

Returns the object to send.

Specified by:

getSendToItem in interface SendToActionSupporter

Overrides:

getSendToItem in class AbstractGraphicalDisplay

Parameters:

cls - the requested classes

Returns:

the item to send