adams.flow.sink
Class EmailViewer

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.core.AbstractDisplay
                  adams.flow.sink.AbstractDisplay
                      adams.flow.sink.AbstractTextualDisplay
                          adams.flow.sink.EmailViewer

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, InputConsumer, DisplayPanelProvider, TextSupplier, MenuBarProvider, SendToActionSupporter, Serializable, Comparable

public class EmailViewer
extends AbstractTextualDisplay
implements DisplayPanelProvider

Actor for displaying an email object.

Input/output:
- accepts:
adams.core.net.Email

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: EmailViewer
 

-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.
 

-short-title (property: shortTitle)
    If enabled uses just the name for the title instead of the actor's full 
    name.
 

-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
 

Version:

$Revision: 7123 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected DisplayEmailPanel

m_EmailPanel the panel with the image.

Fields inherited from class adams.flow.sink.AbstractTextualDisplay

m_AlwaysClear, m_FileChooser, m_Font, m_MenuBar, m_MenuItemFileClear, m_MenuItemFileClose, m_MenuItemFileSaveAs

Fields inherited from class adams.flow.core.AbstractDisplay

BACKUP_INPUT, m_CreateFrame, m_Frame, m_Height, m_InputToken, m_Panel, 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_Headless, m_Name, m_Parent, m_Root, m_ScopeHandler, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

EmailViewer()

Method Summary

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.
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.
ExtensionFileFilter	getCustomTextFileFilter() Returns a custom file filter for the file chooser.
protected int	getDefaultHeight() Returns the default height for the dialog.
protected int	getDefaultWidth() Returns the default width for the dialog.
String	globalInfo() Returns a string describing the object.
protected BasePanel	newPanel() Creates the panel to display in the dialog.
String	supplyText() Returns the text to save.

Methods inherited from class adams.flow.sink.AbstractTextualDisplay

alwaysClearTipText, cleanUp, clear, close, createFileMenu, createMenuBar, defineOptions, doExecute, fontTipText, getAlwaysClear, getDefaultFont, getFileChooser, getFont, getMenuBar, getQuickInfo, getSendToClasses, getSendToItem, hasSendToItem, indexOfMenuItem, preDisplay, saveAs, setAlwaysClear, setFont, supportsClear, updateMenu

Methods inherited from class adams.flow.sink.AbstractDisplay

newDisplayRunnable, postDisplay

Methods inherited from class adams.flow.core.AbstractDisplay

backupState, createFrame, createTitle, doCreateFrame, getCreateFrame, getDefaultX, getDefaultY, getFrame, getHeight, getPanel, getShortTitle, getWidth, getX, getY, heightTipText, initialize, input, postCreateFrame, preCreateFrame, reset, restoreState, setCreateFrame, setHeight, setShortTitle, setWidth, setX, setY, shortTitleTipText, stopExecution, widthTipText, wrapUp, xTipText, yTipText

Methods inherited from class adams.flow.core.AbstractActor

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

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, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager

Methods inherited from interface adams.flow.core.InputConsumer

input

Field Detail

m_EmailPanel

protected DisplayEmailPanel m_EmailPanel

the panel with the image.

Constructor Detail

EmailViewer

public EmailViewer()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

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

getCustomTextFileFilter

public ExtensionFileFilter getCustomTextFileFilter()

Returns a custom file filter for the file chooser.

Specified by:

getCustomTextFileFilter in interface TextSupplier

Overrides:

getCustomTextFileFilter in class AbstractTextualDisplay

Returns:

the file filter, null if to use default one

supplyText

public String supplyText()

Returns the text to save.

Specified by:

supplyText in interface TextSupplier

Specified by:

supplyText in class AbstractTextualDisplay

Returns:

the text, null if no text available

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:

adams.core.net.Email.class

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 AbstractTextualDisplay

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

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