com.ptc.core.foundation.content.client
Class CoAttachmentsListPickerOkActionHandlerData

java.lang.Object
  extended by com.ptc.core.foundation.content.client.CoAttachmentsListPickerOkActionHandlerData
All Implemented Interfaces:
CoActionHandlerData, CoHandlerData, CoObjectListPickerOkActionHandlerData, CoSimpleHandlerData

public class CoAttachmentsListPickerOkActionHandlerData
extends Object
implements CoObjectListPickerOkActionHandlerData

The class implementing CoObjectListPickerOkActionHandlerData interface using "simple" approach.

Supported API: true

Extendable: false


Field Summary
 
Fields inherited from interface com.ptc.core.ca.co.client.picker.CoObjectListPickerOkActionHandlerData
PICKED_ELEMENT_LIST, TARGET_IE_ELEMENT_LIST, TARGET_INSTANCE_LIST_HOLDER
 
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()
          Gets the value of the attribute: action; the reference to an action element.
 CoEnvData getEnvData()
          Gets the value of the attribute: envData; the reference to the conceptual environment

Supported API: true
 String getOpenerActionAddress()
          Gets the value of the attribute: openerActionAddress; the stringified address of the action triggering of which resulted in the creation of this frame.
 ArrayList getPickedElementList()
          Gets the value of the attribute: pickedElementList; the list of picked elements in the picker frame.
 ArrayList getTargetIeElementList()
          Gets the value of the attribute: targetIeElementList; the list of Info*Engine elements of the target instance list holder in the frame from where the picker frame was lauched.
 CoElement getTargetInstanceListHolder()
          Gets the value of the attribute: targetInstanceListHolder; the target instance list holder in the frame from where the picker frame was lauched.
 boolean isActionTriggered()
          Gets the value of the attribute: actionTriggered; the action trigger status indicating whether an action was triggered.
protected  void setAction(CoAction a_Action)
          Sets the value of the attribute: action; the reference to an action element.
 void setActionTriggered(boolean a_ActionTriggered)
          Sets the value of the attribute: actionTriggered; the action trigger status indicating whether an action was triggered.
protected  void setEnvData(CoEnvData a_EnvData)
          Sets the value of the attribute: envData; the reference to the conceptual environment

Supported API: true
protected  void setOpenerActionAddress(String a_OpenerActionAddress)
          Sets the value of the attribute: openerActionAddress; the stringified address of the action triggering of which resulted in the creation of this frame.
 void setPickedElementList(ArrayList a_PickedElementList)
          Sets the value of the attribute: pickedElementList; the list of picked elements in the picker frame.
 void setTargetIeElementList(ArrayList a_TargetIeElementList)
          Sets the value of the attribute: targetIeElementList; the list of Info*Engine elements of the target instance list holder in the frame from where the picker frame was lauched.
 void setTargetInstanceListHolder(CoElement a_TargetInstanceListHolder)
          Sets the value of the attribute: targetInstanceListHolder; the target instance list holder in the frame from where the picker frame was lauched.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getPickedElementList

public ArrayList getPickedElementList()
Gets the value of the attribute: pickedElementList; the list of picked elements in the picker frame.

Supported API: true

Specified by:
getPickedElementList in interface CoObjectListPickerOkActionHandlerData
Returns:
ArrayList

setPickedElementList

public void setPickedElementList(ArrayList a_PickedElementList)
Sets the value of the attribute: pickedElementList; the list of picked elements in the picker frame.

Supported API: true

Specified by:
setPickedElementList in interface CoObjectListPickerOkActionHandlerData
Parameters:
a_PickedElementList -

getTargetInstanceListHolder

public CoElement getTargetInstanceListHolder()
Gets the value of the attribute: targetInstanceListHolder; the target instance list holder in the frame from where the picker frame was lauched.

Supported API: true

Specified by:
getTargetInstanceListHolder in interface CoObjectListPickerOkActionHandlerData
Returns:
CoElement

setTargetInstanceListHolder

public void setTargetInstanceListHolder(CoElement a_TargetInstanceListHolder)
Sets the value of the attribute: targetInstanceListHolder; the target instance list holder in the frame from where the picker frame was lauched.

Supported API: true

Specified by:
setTargetInstanceListHolder in interface CoObjectListPickerOkActionHandlerData
Parameters:
a_TargetInstanceListHolder -

getTargetIeElementList

public ArrayList getTargetIeElementList()
Gets the value of the attribute: targetIeElementList; the list of Info*Engine elements of the target instance list holder in the frame from where the picker frame was lauched.

Supported API: true

Specified by:
getTargetIeElementList in interface CoObjectListPickerOkActionHandlerData
Returns:
ArrayList

setTargetIeElementList

public void setTargetIeElementList(ArrayList a_TargetIeElementList)
Sets the value of the attribute: targetIeElementList; the list of Info*Engine elements of the target instance list holder in the frame from where the picker frame was lauched.

Supported API: true

Specified by:
setTargetIeElementList in interface CoObjectListPickerOkActionHandlerData
Parameters:
a_TargetIeElementList -

getAction

public CoAction getAction()
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)
Sets the value of the attribute: action; the reference to an action element.

Supported API: true

Parameters:
a_Action -

isActionTriggered

public boolean isActionTriggered()
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)
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()
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)
Sets the value of the attribute: envData; the reference to the conceptual environment

Supported API: true

Parameters:
a_EnvData -

getOpenerActionAddress

public String getOpenerActionAddress()
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)
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 -