com.ptc.core.components.factory.dataUtilities
Class NmActionDataUtility

java.lang.Object
  com.ptc.core.components.factory.AbstractDataUtility
      com.ptc.core.components.factory.dataUtilities.NmActionDataUtility

All Implemented Interfaces:

com.ptc.core.components.descriptor.DataUtility

public class NmActionDataUtility
extends com.ptc.core.components.factory.AbstractDataUtility

Gets an NmHTMLActionModel or NmAction for a given column descriptor. By default this data utility will return the Actions hyperlink. And by default the Actions hyperlink will display the action model flagged with menufor="<someObjectType>" in an actionmodels.xml file, where someObjectType is the type of the row object (e.g. wt.part.WTPart) This is determined dynamically, you should not have to configure it, even if your table has multiple object types.

To have this data utility return an Actions hyperlink to some other action model use the "actionModel" property. In a jsp it would be like:
<jca:describeColumn id="nmActions">
<jca:setComponentProperty key="actionModel" value="<action_model_name>"/>
</jca:describeColumn>
from a data utility class it would be like:
descriptor.setProperty(DescriptorConstants.ActionProperties.ACTION_MODEL, "<action_model_name>");
Where <action_model_name> is the name of some action model in an actionmodels.xml.

To have this data utility return an NmAction, set the objectType and actionName properties on the descriptor. In a jsp it would be like:
<jca:describeColumn id="someIconAction" dataUtilityId="nmActions">
<jca:setComponentProperty key="actionName" value="<action_name>"/>
<jca:setComponentProperty key="objectType" value="<object_type>"/>
</jca:describeColumn>
from a data utility class it would be like:
descriptor.setProperty(DescriptorConstants.ActionProperties.ACTION_NAME, "<action_name>");
descriptor.setProperty(DescriptorConstants.ActionProperties.OBJECT_TYPE, "<object_type>");
Where <action_name> and <object_type> are the name and type of an action specified in an actions.xml file.

Supported API: true

Extendable: false

Method Summary

Methods inherited from class java.lang.Object

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