Package adams.flow.core

Interface InteractiveActorWithCustomParentComponent

All Superinterfaces:

Actor, AdditionalInformationHandler, CleanUpHandler, Comparable, Destroyable, ErrorHandler, InteractiveActor, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, Serializable, ShallowCopySupporter<Actor>, StopModeSupporter, Stoppable, StoppableWithFeedback, VariableChangeListener, VariablesInspectionHandler

All Known Implementing Classes:

AbstractInteractiveArrayProvider, AbstractInteractiveSource, AbstractInteractiveTransformer, AbstractSelectObjects, ConfirmationDialog, EnterManyValues, EnterValue, PasteFromClipboard, SelectCharset, SelectDateTime, SelectDirectory, SelectFile, SelectObjects, WekaChooseAttributes, WekaSelectDataset, WekaSelectObjects

public interface InteractiveActorWithCustomParentComponent
extends InteractiveActor

Interface for interactive actors that allow the selection of a custom parent component using a callable actor; instead of just using the outer dialog/frame.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Fields inherited from interface adams.flow.core.InteractiveActor

INTERACTION_CANCELED

Method Summary

Modifier and Type	Method	Description
Component	getActualParentComponent()	Returns the parent component to use.
CallableActorReference	getParentComponentActor()	Returns the (optional) callable actor to use as parent component instead of the flow panel.
boolean	getUseOuterWindow()	Returns whether to use the outer window as parent.
String	parentComponentActorTipText()	Returns the tip text for this property.
void	setParentComponentActor(CallableActorReference value)	Sets the (optional) callable actor to use as parent component instead of the flow panel.
void	setUseOuterWindow(boolean value)	Sets whether to use the outer window as parent.
String	useOuterWindowTipText()	Returns the tip text for this property.

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

customStopMessageTipText, doInteract, doInteractHeadless, getCustomStopMessage, getStopFlowIfCanceled, setCustomStopMessage, setStopFlowIfCanceled, stopFlowIfCanceledTipText, supportsHeadlessInteraction

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, defineOptions, getOptionManager

Methods inherited from interface adams.flow.core.StopModeSupporter

getStopMode, setStopMode, stopModeTipText

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Method Detail

getActualParentComponent

Component getActualParentComponent()

Returns the parent component to use.

Returns:

the parent

setParentComponentActor

void setParentComponentActor(CallableActorReference value)

Sets the (optional) callable actor to use as parent component instead of the flow panel.

Parameters:

value - the callable actor

getParentComponentActor

CallableActorReference getParentComponentActor()

Returns the (optional) callable actor to use as parent component instead of the flow panel.

Returns:

the callable actor

parentComponentActorTipText

String parentComponentActorTipText()

Returns the tip text for this property.

Returns:

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

setUseOuterWindow

void setUseOuterWindow(boolean value)

Sets whether to use the outer window as parent.

Parameters:

value - true if to use outer window

getUseOuterWindow

boolean getUseOuterWindow()

Returns whether to use the outer window as parent.

Returns:

true if to use outer window

useOuterWindowTipText

String useOuterWindowTipText()

Returns the tip text for this property.

Returns:

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