com.ptc.core.ca.co.client.tree
Class CoTreeNodeActionDoer

java.lang.Object
  extended by com.ptc.core.ca.co.client.simple.CoSimpleActionDoer
      extended by com.ptc.core.ca.co.client.tree.CoTreeNodeActionDoer
All Implemented Interfaces:
CoActionDoer, CoDoer
Direct Known Subclasses:
CoDefaultTreeNodeActionDoer

Deprecated.

@Deprecated
public abstract class CoTreeNodeActionDoer
extends CoSimpleActionDoer

The abstract class to be used a a base class for tree node doers. A tree node doer is intended to be used by a tree node action such as "contract node" or "expand node".

Supported API: true

Extendable: false


Method Summary
 boolean canExecute(CoSimpleActionHandlerData execData)
          Deprecated. Returns whether the action can be triggered.
 void contract(CoTreeNodeInstance node_instance, CoSimpleActionHandlerData execData)
          Deprecated. Contracts the node by modifying expanded status in the data tree.
 void execute(CoSimpleActionHandlerData execData)
          Deprecated. Contracts or expands the node based on its current status.
abstract  void expand(CoTreeNodeInstance node_instance, CoSimpleActionHandlerData execData)
          Deprecated. Expands the node in the data tree.
 CoTreeNodeInstance getNodeInstance(CoSimpleActionHandlerData execData)
          Deprecated. Returns a node in the data tree corresponding to the node element the action is a descendent of.
 boolean isRelevant(CoSimpleActionHandlerData execData)
          Deprecated. Returns whether the action is relevant to the current situation.
 
Methods inherited from class com.ptc.core.ca.co.client.simple.CoSimpleActionDoer
canExecute, execute, isRelevant
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isRelevant

public boolean isRelevant(CoSimpleActionHandlerData execData)
                   throws WTException
Deprecated. 
Returns whether the action is relevant to the current situation. The action may not be relevant when the licensing limitaions or the application logic prevent it from appearing in the GUI.

Supported API: true

Overrides:
isRelevant in class CoSimpleActionDoer
Parameters:
execData -
Returns:
boolean
Throws:
WTException

canExecute

public boolean canExecute(CoSimpleActionHandlerData execData)
                   throws WTException
Deprecated. 
Returns whether the action can be triggered. A contracted node can be expanded when the node is not populated or populated and has children. An expanded node can be contracted.

Supported API: true

Overrides:
canExecute in class CoSimpleActionDoer
Parameters:
execData -
Returns:
boolean
Throws:
WTException

execute

public void execute(CoSimpleActionHandlerData execData)
             throws WTException
Deprecated. 
Contracts or expands the node based on its current status.

Supported API: true

Specified by:
execute in class CoSimpleActionDoer
Parameters:
execData -
Throws:
WTException

getNodeInstance

public CoTreeNodeInstance getNodeInstance(CoSimpleActionHandlerData execData)
                                   throws WTException
Deprecated. 
Returns a node in the data tree corresponding to the node element the action is a descendent of.

Supported API: true

Parameters:
execData -
Returns:
CoTreeNodeInstance
Throws:
WTException

contract

public void contract(CoTreeNodeInstance node_instance,
                     CoSimpleActionHandlerData execData)
              throws WTException
Deprecated. 
Contracts the node by modifying expanded status in the data tree.

Supported API: true

Parameters:
node_instance -
execData -
Throws:
WTException

expand

public abstract void expand(CoTreeNodeInstance node_instance,
                            CoSimpleActionHandlerData execData)
                     throws WTException
Deprecated. 
Expands the node in the data tree.

Supported API: true

Parameters:
node_instance -
execData -
Throws:
WTException