com.canto.cumulus.prefs

Class AssetActionProcessor

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.AssetActionProcessor

Direct Known Subclasses:

AssetActionPacker, AssetActionSaver

public class AssetActionProcessor
extends BaseManager

This class manages the settings for a single processor of an AssetAction.

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
JPack	getConfiguration(PackListener packListener) This returns the configuration pack for this module.
java.lang.String	getModuleName() Returns the module display name.
int	getPosition() Returns the position of this module in the entire module list.
int	getType() Returns the type of this module.
java.lang.String	getUID() Returns the UID of this module
boolean	isActive() Returns whether this module is active.
void	setConfiguration(JPack config, PackListener packListener) Sets the module configuration.
void	setIsActive(boolean value) Sets whether this module is active.
void	setModuleName(java.lang.String value) Sets the module display name.
void	setShowUI(boolean value) Sets whether this module should show configuration UI when being executed
void	setUID(java.lang.String uid) Sets the module UID.
boolean	showUI() Specifies whether this module should show configuration UI when being executed

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getType

public int getType()

Returns the type of this module.

Returns:

type

getPosition

public int getPosition()

Returns the position of this module in the entire module list.

Returns:

position of this module or -1

showUI

public boolean showUI()

Specifies whether this module should show configuration UI when being executed

Returns:

true if this module should show configuration UI when being executed

setShowUI

public void setShowUI(boolean value)

Sets whether this module should show configuration UI when being executed

Parameters:

value - true if this module should show configuration UI when being executed

isActive

public boolean isActive()

Returns whether this module is active.

Returns:

true if this module is active

setIsActive

public void setIsActive(boolean value)

Sets whether this module is active.

Parameters:

value - true if active

getConfiguration

public JPack getConfiguration(PackListener packListener)

This returns the configuration pack for this module.

Parameters:

packListener - the listener being notified if the module should store its settings back

Returns:

the configuration pack

setConfiguration

public void setConfiguration(JPack config,
                    PackListener packListener)

Sets the module configuration.

Parameters:

config - the module configuration to set

packListener - the listener previously registered with calling getConfiguration(PackListener)

getUID

public java.lang.String getUID()

Returns the UID of this module

Returns:

module UID

setUID

public void setUID(java.lang.String uid)

Sets the module UID.

Parameters:

uid - module UID

getModuleName

public java.lang.String getModuleName()

Returns the module display name.

Returns:

module display name or null

setModuleName

public void setModuleName(java.lang.String value)

Sets the module display name.

Parameters:

value - module display name