Package adams.flow.standalone

Class TabView

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

adams.flow.standalone.TabView

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, TextSupporter, VariablesInspectionHandler, SpreadSheetSupporter, VariableChangeListener, Actor, ActorHandler, ActorReferenceHandler, DataPlotUpdaterSupporter, DisplayTypeSupporter, ErrorHandler, Flushable, MutableActorHandler, ComponentSupplier, TextSupplier, MenuBarProvider, SendToActionSupporter, Serializable, Comparable

public class TabView
extends AbstractMultiView
implements ComponentSupplier, TextSupplier, SpreadSheetSupporter, DataPlotUpdaterSupporter

Displays multiple graphical actors in a tabbed pane. The actors can be referenced in the flow using adams.flow.sink.CallableSink actors.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

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

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

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

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

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

-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
 

-actor <adams.flow.core.Actor> [-actor ...] (property: actors)
    The panel-generating actors to display in the tabbed pane.
    default: 
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.flow.standalone.AbstractMultiView

AbstractMultiView.ViewWrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseTabbedPane	m_TabbedPane	the tabbed pane.

Fields inherited from class adams.flow.standalone.AbstractMultiView

m_Actors, m_MenuBar, m_MenuItemFileClear, m_MenuItemFileClose, m_MenuItemFlowPauseResume, m_MenuItemFlowStop, m_ShowFlowControlSubMenu, m_Wrappers, 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_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
TabView()

Method Summary

Modifier and Type	Method	Description
String	actorsTipText()	Returns the tip text for this property.
void	addPanel(Actor actor, BasePanel panel)	Replaces the current dummy panel with the actual panel.
String	getCustomSupplyTextMenuItemCaption()	Returns the text for the menu item.
ExtensionFileFilter	getCustomTextFileFilter()	Returns a custom file filter for the file chooser.
String	globalInfo()	Returns a string describing the object.
boolean	makeVisible(AbstractMultiView.ViewWrapper wrapper)	Ensures that the wrapper is visible.
protected BasePanel	newPanel()	Creates the panel to display in the dialog.
JComponent	supplyComponent()	Returns the current component.
String	supplyText()	Supplies the text.
SpreadSheet	toSpreadSheet()	Returns the content as spreadsheet.
void	updatePlot()	Updates the data container panel regardless, notifying the listeners.

Methods inherited from class adams.flow.standalone.AbstractMultiView

add, add, canPauseOrResume, check, check, checkActorReferenceHandlers, cleanUp, clear, clearPanel, close, createMenuBar, defineOptions, doExecute, firstActive, flushExecution, get, getActorHandlerInfo, getActors, getMenuBar, getProhibitedPrecedingActorReferenceHandlers, getSendToClasses, getSendToItem, getShowFlowControlSubMenu, hasSendToItem, indexOf, initialize, isPaused, isReferencingRequired, lastActive, newDisplayRunnable, pauseResumeFlow, remove, removeAll, set, setActors, setShowFlowControlSubMenu, setUp, setVariables, showFlowControlSubMenuTipText, size, stopExecution, stopFlow, supportsClear, updateMenu, updateParent, wrapUp

Methods inherited from class adams.flow.core.AbstractDisplay

backupState, cleanUpGUI, cleanUpGUIKeepOpen, closeFrame, createFrame, createTitle, currentInput, deregisterInWrapUp, deregisterWindow, deregisterWithEditor, displayTypeTipText, doCreateFrame, getCreateFrame, getDefaultDisplayType, getDefaultHeight, getDefaultShortTitle, getDefaultWidth, getDefaultX, getDefaultY, getDisplayType, getFrame, getFrameDefaultCloseOperation, getHeight, getKeepOpen, getPanel, getQuickInfo, getShortTitle, getWidth, getX, getY, hasInput, heightTipText, input, postCreateFrame, preCreateFrame, registerWindow, registerWithEditor, reset, restoreState, setCreateFrame, setDisplayType, setHeight, setKeepOpen, setShortTitle, setWidth, setX, setY, shortTitleTipText, 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, 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

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, shallowCopy, shallowCopy, sizeOf, stopExecution, toCommandLine, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

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_TabbedPane

protected BaseTabbedPane m_TabbedPane

the tabbed pane.

Constructor Detail

TabView

public TabView()

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

actorsTipText

public String actorsTipText()

Returns the tip text for this property.

Specified by:

actorsTipText in class AbstractMultiView

Returns:

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

makeVisible

public boolean makeVisible(AbstractMultiView.ViewWrapper wrapper)

Ensures that the wrapper is visible.

Specified by:

makeVisible in class AbstractMultiView

Parameters:

wrapper - the wrapper to make visible

Returns:

true if successful

newPanel

protected BasePanel newPanel()

Creates the panel to display in the dialog.

Specified by:

newPanel in class AbstractMultiView

Returns:

the panel

addPanel

public void addPanel(Actor actor,
                     BasePanel panel)

Replaces the current dummy panel with the actual panel.

Specified by:

addPanel in class AbstractMultiView

Parameters:

actor - the actor this panel is for

panel - the panel to replace the dummy one

supplyComponent

public JComponent supplyComponent()

Returns the current component.

Specified by:

supplyComponent in interface ComponentSupplier

Returns:

the current component, can be null

getCustomSupplyTextMenuItemCaption

public String getCustomSupplyTextMenuItemCaption()

Returns the text for the menu item.

Specified by:

getCustomSupplyTextMenuItemCaption in interface TextSupplier

Returns:

the menu item text, null for default

getCustomTextFileFilter

public ExtensionFileFilter getCustomTextFileFilter()

Returns a custom file filter for the file chooser.

Specified by:

getCustomTextFileFilter in interface TextSupplier

Returns:

the file filter, null if to use default one

supplyText

public String supplyText()

Supplies the text.

Specified by:

supplyText in interface TextSupplier

Specified by:

supplyText in interface TextSupporter

Returns:

the text, null if none available

toSpreadSheet

public SpreadSheet toSpreadSheet()

Returns the content as spreadsheet.

Specified by:

toSpreadSheet in interface SpreadSheetSupporter

Returns:

the content, null if not available

updatePlot

public void updatePlot()

Updates the data container panel regardless, notifying the listeners.

Specified by:

updatePlot in interface DataPlotUpdaterSupporter