com.ptc.core.ca.co.client.simple
Class CoDefaultSimpleActionHandlerData

java.lang.Object
  com.ptc.core.ca.co.client.simple.CoDefaultSimpleActionHandlerData

All Implemented Interfaces:

CoActionHandlerData, CoHandlerData, CoSimpleActionHandlerData, CoSimpleHandlerData

Direct Known Subclasses:

CoClipboardActionHandlerData, CoDefaultWizardHandlerData, CoPropertyRetrieverOkActionHandlerData

Deprecated.

@Deprecated
public class CoDefaultSimpleActionHandlerData
extends Object
implements CoSimpleActionHandlerData

Supported API: true

Extendable: false

Field Summary

Fields inherited from interface com.ptc.core.ca.co.client.simple.CoSimpleActionHandlerData

ACTION_HOLDER, ACTION_HOLDER_RELATED_INSTANCE, ACTION_HOLDER_RELATED_TYPE_ID, ACTION_HOLDER_RELATED_UFID, INSTANCE_HOLDERS

Fields inherited from interface com.ptc.core.ca.co.client.action.CoActionHandlerData

ACTION, ACTION_TRIGGERED

Fields inherited from interface com.ptc.core.ca.co.client.element.CoHandlerData

ENV_DATA

Fields inherited from interface com.ptc.core.ca.co.client.simple.CoSimpleHandlerData

OPENER_ACTION_ADDRESS

Method Summary

CoAction	getAction() Deprecated. Gets the value of the attribute: action; the reference to an action element.
CoElement	getActionHolder() Deprecated. Gets the value of the attribute: actionHolder; the logical "holder" of the action.
CoInstance	getActionHolderRelatedInstance() Deprecated. Gets the value of the attribute: actionHolderRelatedInstance; the Info*Engine element related to a logical "holder" of an action wrapped into CoInstance Supported API: true
String	getActionHolderRelatedTypeId() Deprecated. Gets the value of the attribute: actionHolderRelatedTypeId; the type of the Info*Engine element related to a logical "holder" of an action.
String	getActionHolderRelatedUfid() Deprecated. Gets the value of the attribute: actionHolderRelatedUfid; the UFID of the Info*Engine element related to a logical "holder" of an action.
CoEnvData	getEnvData() Deprecated. Gets the value of the attribute: envData; the reference to the conceptual environment Supported API: true
ArrayList	getInstanceHolders() Deprecated. Gets the value of the attribute: instanceHolders; the list of conceptual elements the action was triggered on behalf of.
String	getOpenerActionAddress() Deprecated. Gets the value of the attribute: openerActionAddress; the stringified address of the action triggering of which resulted in the creation of this frame.
boolean	isActionTriggered() Deprecated. Gets the value of the attribute: actionTriggered; the action trigger status indicating whether an action was triggered.
protected void	setAction(CoAction a_Action) Deprecated. Sets the value of the attribute: action; the reference to an action element.
protected void	setActionHolder(CoElement a_ActionHolder) Deprecated. Sets the value of the attribute: actionHolder; the logical "holder" of the action.
protected void	setActionHolderRelatedInstance(CoInstance a_ActionHolderRelatedInstance) Deprecated. Sets the value of the attribute: actionHolderRelatedInstance; the Info*Engine element related to a logical "holder" of an action wrapped into CoInstance Supported API: true
protected void	setActionHolderRelatedTypeId(String a_ActionHolderRelatedTypeId) Deprecated. Sets the value of the attribute: actionHolderRelatedTypeId; the type of the Info*Engine element related to a logical "holder" of an action.
protected void	setActionHolderRelatedUfid(String a_ActionHolderRelatedUfid) Deprecated. Sets the value of the attribute: actionHolderRelatedUfid; the UFID of the Info*Engine element related to a logical "holder" of an action.
void	setActionTriggered(boolean a_ActionTriggered) Deprecated. Sets the value of the attribute: actionTriggered; the action trigger status indicating whether an action was triggered.
protected void	setEnvData(CoEnvData a_EnvData) Deprecated. Sets the value of the attribute: envData; the reference to the conceptual environment Supported API: true
protected void	setInstanceHolders(ArrayList a_InstanceHolders) Deprecated. Sets the value of the attribute: instanceHolders; the list of conceptual elements the action was triggered on behalf of.
protected void	setOpenerActionAddress(String a_OpenerActionAddress) Deprecated. Sets the value of the attribute: openerActionAddress; the stringified address of the action triggering of which resulted in the creation of this frame.

Methods inherited from class java.lang.Object

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

Method Detail

getActionHolder

public CoElement getActionHolder()

Deprecated.

Gets the value of the attribute: actionHolder; the logical "holder" of the action. This is not necessarily an action parent but rather an element an action logically belongs to. For instance, an action in the list of actions in a table's toolbar will have the table as the action holder and not the action list.

Supported API: true

Specified by:

getActionHolder in interface CoSimpleActionHandlerData

Returns:

CoElement

setActionHolder

protected void setActionHolder(CoElement a_ActionHolder)

Deprecated.

Sets the value of the attribute: actionHolder; the logical "holder" of the action. This is not necessarily an action parent but rather an element an action logically belongs to. For instance, an action in the list of actions in a table's toolbar will have the table as the action holder and not the action list.

Supported API: true

Parameters:

a_ActionHolder -

getActionHolderRelatedTypeId

public String getActionHolderRelatedTypeId()
                                    throws WTException

Deprecated.

Gets the value of the attribute: actionHolderRelatedTypeId; the type of the Info*Engine element related to a logical "holder" of an action.

Supported API: true

Specified by:

getActionHolderRelatedTypeId in interface CoSimpleActionHandlerData

Returns:

String

Throws:

WTException

setActionHolderRelatedTypeId

protected void setActionHolderRelatedTypeId(String a_ActionHolderRelatedTypeId)
                                     throws WTException

Deprecated.

Sets the value of the attribute: actionHolderRelatedTypeId; the type of the Info*Engine element related to a logical "holder" of an action.

Supported API: true

Parameters:

a_ActionHolderRelatedTypeId -

Throws:

WTException

getActionHolderRelatedUfid

public String getActionHolderRelatedUfid()
                                  throws WTException

Deprecated.

Gets the value of the attribute: actionHolderRelatedUfid; the UFID of the Info*Engine element related to a logical "holder" of an action.

Supported API: true

Specified by:

getActionHolderRelatedUfid in interface CoSimpleActionHandlerData

Returns:

String

Throws:

WTException

setActionHolderRelatedUfid

protected void setActionHolderRelatedUfid(String a_ActionHolderRelatedUfid)
                                   throws WTException

Deprecated.

Sets the value of the attribute: actionHolderRelatedUfid; the UFID of the Info*Engine element related to a logical "holder" of an action.

Supported API: true

Parameters:

a_ActionHolderRelatedUfid -

Throws:

WTException

getActionHolderRelatedInstance

public CoInstance getActionHolderRelatedInstance()
                                          throws WTException

Deprecated.

Gets the value of the attribute: actionHolderRelatedInstance; the Info*Engine element related to a logical "holder" of an action wrapped into CoInstance

Supported API: true

Specified by:

getActionHolderRelatedInstance in interface CoSimpleActionHandlerData

Returns:

CoInstance

Throws:

WTException

setActionHolderRelatedInstance

protected void setActionHolderRelatedInstance(CoInstance a_ActionHolderRelatedInstance)
                                       throws WTException

Deprecated.

Sets the value of the attribute: actionHolderRelatedInstance; the Info*Engine element related to a logical "holder" of an action wrapped into CoInstance

Supported API: true

Parameters:

a_ActionHolderRelatedInstance -

Throws:

WTException

getInstanceHolders

public ArrayList getInstanceHolders()

Deprecated.

Gets the value of the attribute: instanceHolders; the list of conceptual elements the action was triggered on behalf of. For instance

• a list of selected rows in a table for an action in a toolbar.
• a row in a table for an action in a row
• a property panel for an action in a panel

Supported API: true

Specified by:

getInstanceHolders in interface CoSimpleActionHandlerData

Returns:

ArrayList

setInstanceHolders

protected void setInstanceHolders(ArrayList a_InstanceHolders)

Deprecated.

Sets the value of the attribute: instanceHolders; the list of conceptual elements the action was triggered on behalf of. For instance

• a list of selected rows in a table for an action in a toolbar.
• a row in a table for an action in a row
• a property panel for an action in a panel

Supported API: true

Parameters:

a_InstanceHolders -

getAction

public CoAction getAction()

Deprecated.

Gets the value of the attribute: action; the reference to an action element.

Supported API: true

Specified by:

getAction in interface CoActionHandlerData

Returns:

CoAction

setAction

protected void setAction(CoAction a_Action)

Deprecated.

Sets the value of the attribute: action; the reference to an action element.

Supported API: true

Parameters:

a_Action -

isActionTriggered

public boolean isActionTriggered()

Deprecated.

Gets the value of the attribute: actionTriggered; the action trigger status indicating whether an action was triggered.

During the update of the action model handler calls methods to determine visibility and accessability of the action. At that moment the trigger status will be set to false.

Supported API: true

Specified by:

isActionTriggered in interface CoActionHandlerData

Returns:

boolean

setActionTriggered

public void setActionTriggered(boolean a_ActionTriggered)

Deprecated.

Sets the value of the attribute: actionTriggered; the action trigger status indicating whether an action was triggered.

During the update of the action model handler calls methods to determine visibility and accessability of the action. At that moment the trigger status will be set to false.

Supported API: true

Specified by:

setActionTriggered in interface CoActionHandlerData

Parameters:

a_ActionTriggered -

getEnvData

public CoEnvData getEnvData()

Deprecated.

Gets the value of the attribute: envData; the reference to the conceptual environment

Supported API: true

Specified by:

getEnvData in interface CoHandlerData

Returns:

CoEnvData

setEnvData

protected void setEnvData(CoEnvData a_EnvData)

Deprecated.

Sets the value of the attribute: envData; the reference to the conceptual environment

Supported API: true

Parameters:

a_EnvData -

getOpenerActionAddress

public String getOpenerActionAddress()

Deprecated.

Gets the value of the attribute: openerActionAddress; the stringified address of the action triggering of which resulted in the creation of this frame. null for non-temporary frame.

Supported API: true

Specified by:

getOpenerActionAddress in interface CoSimpleHandlerData

Returns:

String

setOpenerActionAddress

protected void setOpenerActionAddress(String a_OpenerActionAddress)

Deprecated.

Sets the value of the attribute: openerActionAddress; the stringified address of the action triggering of which resulted in the creation of this frame. null for non-temporary frame.

Supported API: true

Parameters:

a_OpenerActionAddress -