com.ptc.netmarkets.util.misc
Class NmAction

java.lang.Object
  com.ptc.netmarkets.util.misc.NmAction

All Implemented Interfaces:

com.ptc.netmarkets.util.misc.NmFormatable, Serializable, Cloneable

public class NmAction
extends Object
implements Cloneable, com.ptc.netmarkets.util.misc.NmFormatable, Serializable

Supported API: true

Extendable: true

See Also:

Serialized Form

Nested Class Summary

static class	com.ptc.netmarkets.util.misc.NmAction.AjaxType
static class	com.ptc.netmarkets.util.misc.NmAction.Command
static class	com.ptc.netmarkets.util.misc.NmAction.Comp_Command
static class	com.ptc.netmarkets.util.misc.NmAction.ExecuteLocation
static class	com.ptc.netmarkets.util.misc.NmAction.ExecutionStatus
static class	com.ptc.netmarkets.util.misc.NmAction.NmWindowType
static class	com.ptc.netmarkets.util.misc.NmAction.Type

Method Summary

NmAction	copy() Supported API: true
boolean	disableForCAD() Supported API: true
boolean	enableForCAD() Supported API: true
String	getAction() Gets the value of the attribute: action; Action name Supported API: true
String	getActionClass() Gets the value of the attribute: actionClass; Class that implements a method to execute Supported API: true
String	getActionMethod() Gets the value of the attribute: actionMethod; A method to execute Supported API: true
String	getAfterJS() Gets the value of the attribute: afterJS; js method to execute after action is clicked.
String	getAfterServerVK() Gets the value of the attribute: afterServerVK; Verification key to validate after a page is loaded.
String	getAjaxClass() Gets the value of the attribute: ajaxClass; Class that implements a method to execute for server side validation.
String	getAjaxMethod() Gets the value of the attribute: ajaxMethod; A method to execute Supported API: true
String	getAjaxType() Gets the value of the attribute: ajaxType; This tells us whether an action has been ajax enabled.
String	getBeforeJS() Gets the value of the attribute: beforeJS; String js method to call Supported API: true
String	getBeforeServerVK() Gets the value of the attribute: beforeServerVK; Verification key to validate before a page is loaded.
int	getCADProperty() Gets the value of the attribute: CADProperty; Determines whether or not an action should be enable/disabled if a CAD client is detected to be the user-agent Supported API: true
NmOid	getContextObject() Gets the value of the attribute: contextObject; Action name Supported API: true
String	getDesc() Gets the value of the attribute: desc; Action description Supported API: true
String	getDisabledIcon() Gets the value of the attribute: disabledIcon; Action icon Supported API: true
String	getDivClass() Gets the value of the attribute: divClass.
String	getHotKey() Gets the value of the attribute: hotKey; Defines the hotkey to be used to automatically trigger the action to occur Supported API: true
String	getIcon() Gets the value of the attribute: icon; Action icon Supported API: true
String	getIdName() Gets the value of the attribute: idName; The id of the link to use.
String	getInstallType() Gets the value of the attribute: installType; Specifies which solution must be installed for this action to be valid Supported API: true
String	getMoreURLInfo() Gets the value of the attribute: moreURLInfo; Action name Supported API: true
String	getOnClick() Gets the value of the attribute: onClick; Optional onlcick javascript code to run on actions.
String	getPageId() Gets the value of the attribute: pageId; ID of the step, to be used by javascript functions to manipulate step attributes.
String	getPageURL() Gets the value of the attribute: pageURL; Action name Supported API: true
HashMap	getParams() Gets the value of the attribute: params.
String	getPostloadJS() Gets the value of the attribute: postloadJS; js method to execute after wizard page is loaded.
String	getPreloadJS() Gets the value of the attribute: preloadJS; String js method to call Supported API: true
String	getRenderer() Gets the value of the attribute: renderer; The class that will handle rendering this action to the UI.
String	getRenderType() Gets the value of the attribute: renderType; Specifies which actions should be rendered by PDMLink or ProjectLink or xLink Supported API: true
String	getStyleClass() Gets the value of the attribute: styleClass.
String	getTitle() Gets the value of the attribute: title; Localized title of the action used for pages.
String	getToolTip() Gets the value of the attribute: toolTip; Action description Supported API: true
String	getType() Gets the value of the attribute: type; Action type Supported API: true
String	getUiComponent() Gets the value of the attribute: uiComponent; Speficies the related Role-Based UI Component constant.
String	getUrl() Gets the value of the attribute: url; The url to the page the action will go to.
String	getWindowType() Gets the value of the attribute: windowType; Specifies whether the action is enabled Supported API: true
static void	helpjspOrientationLink(String helpfile, Locale locale, Writer out) Generates a html to open accessibility orientation page.
static void	helpjspOrientationLink(String helpfile, NmURLFactoryBean urlFactoryBean, com.ptc.netmarkets.util.beans.NmLocaleBean localeBean, com.ptc.netmarkets.util.beans.NmContextBean nmcontext, com.ptc.netmarkets.util.beans.NmLinkBean linkBean, Writer out, Object request, Object response) Generates a html to open accessibility orientation page.
boolean	isButton() Gets the value of the attribute: button.
boolean	isConnector() Gets the value of the attribute: connector; Specifies whether the action is enabled Supported API: true
boolean	isDynamicWizardPage() Gets the value of the attribute: dynamicWizardPage; Specifies whether the page can be pre-loaded into the wizard.
boolean	isEnabled() Gets the value of the attribute: enabled; Specifies whether the action is enabled Supported API: true
boolean	isEnabledWhenSuspended() Gets the value of the attribute: enabledWhenSuspended; Specifies whether the action is enabled Supported API: true
boolean	isHidden() Gets the value of the attribute: hidden; Specifies whether the page should be hidden by default in the wizard.
boolean	isMultiselect() Gets the value of the attribute: multiselect; Specifies whether the action is enabled Supported API: true
boolean	isRenderWhileHidden() Gets the value of the attribute: renderWhileHidden.
boolean	isRequired() Gets the value of the attribute: required; This tells us whether the wizard if the page has required information.
boolean	isSelected() Gets the value of the attribute: selected; Specifies whether the action is enabled Supported API: true
boolean	isSelectRequired() Gets the value of the attribute: selectRequired; True or false.
void	setAction(String a_Action) Sets the value of the attribute: action; Action name Supported API: true
void	setActionClass(String a_ActionClass) Sets the value of the attribute: actionClass; Class that implements a method to execute Supported API: true
void	setActionMethod(String a_ActionMethod) Sets the value of the attribute: actionMethod; A method to execute Supported API: true
void	setAfterJS(String a_AfterJS) Sets the value of the attribute: afterJS; js method to execute after action is clicked.
void	setAfterServerVK(String a_AfterServerVK) Sets the value of the attribute: afterServerVK; Verification key to validate after a page is loaded.
void	setAjaxClass(String a_AjaxClass) Sets the value of the attribute: ajaxClass; Class that implements a method to execute for server side validation.
void	setAjaxMethod(String a_AjaxMethod) Sets the value of the attribute: ajaxMethod; A method to execute Supported API: true
void	setAjaxType(String a_AjaxType) Sets the value of the attribute: ajaxType; This tells us whether an action has been ajax enabled.
void	setBeforeJS(String a_BeforeJS) Sets the value of the attribute: beforeJS; String js method to call Supported API: true
void	setBeforeServerVK(String a_BeforeServerVK) Sets the value of the attribute: beforeServerVK; Verification key to validate before a page is loaded.
void	setButton(boolean a_Button) Sets the value of the attribute: button.
void	setCADProperty(int a_CADProperty) Sets the value of the attribute: CADProperty; Determines whether or not an action should be enable/disabled if a CAD client is detected to be the user-agent Supported API: true
void	setConnector(boolean a_Connector) Sets the value of the attribute: connector; Specifies whether the action is enabled Supported API: true
void	setContextObject(NmOid a_ContextObject) Sets the value of the attribute: contextObject; Action name Supported API: true
void	setDesc(String a_Desc) Sets the value of the attribute: desc; Action description Supported API: true
void	setDisabledIcon(String a_DisabledIcon) Sets the value of the attribute: disabledIcon; Action icon Supported API: true
void	setDivClass(String a_DivClass) Sets the value of the attribute: divClass.
void	setDynamicWizardPage(boolean a_DynamicWizardPage) Sets the value of the attribute: dynamicWizardPage; Specifies whether the page can be pre-loaded into the wizard.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: enabled; Specifies whether the action is enabled Supported API: true
void	setEnabledWhenSuspended(boolean a_EnabledWhenSuspended) Sets the value of the attribute: enabledWhenSuspended; Specifies whether the action is enabled Supported API: true
void	setHidden(boolean a_Hidden) Sets the value of the attribute: hidden; Specifies whether the page should be hidden by default in the wizard.
void	setHotKey(String a_HotKey) Sets the value of the attribute: hotKey; Defines the hotkey to be used to automatically trigger the action to occur Supported API: true
void	setIcon(String a_Icon) Sets the value of the attribute: icon; Action icon Supported API: true
void	setIdName(String a_IdName) Sets the value of the attribute: idName; The id of the link to use.
void	setInstallType(String a_InstallType) Sets the value of the attribute: installType; Specifies which solution must be installed for this action to be valid Supported API: true
void	setMoreURLInfo(String a_MoreURLInfo) Sets the value of the attribute: moreURLInfo; Action name Supported API: true
void	setMultiselect(boolean a_Multiselect) Sets the value of the attribute: multiselect; Specifies whether the action is enabled Supported API: true
void	setOnClick(String a_OnClick) Sets the value of the attribute: onClick; Optional onlcick javascript code to run on actions.
void	setPageId(String a_PageId) Sets the value of the attribute: pageId; ID of the step, to be used by javascript functions to manipulate step attributes.
void	setPageURL(String a_PageURL) Sets the value of the attribute: pageURL; Action name Supported API: true
void	setParams(HashMap a_Params) Sets the value of the attribute: params.
void	setPostloadJS(String a_PostloadJS) Sets the value of the attribute: postloadJS; js method to execute after wizard page is loaded.
void	setPreloadJS(String a_PreloadJS) Sets the value of the attribute: preloadJS; String js method to call Supported API: true
void	setRenderer(String a_Renderer) Sets the value of the attribute: renderer; The class that will handle rendering this action to the UI.
void	setRenderType(String a_RenderType) Sets the value of the attribute: renderType; Specifies which actions should be rendered by PDMLink or ProjectLink or xLink Supported API: true
void	setRenderWhileHidden(boolean a_RenderWhileHidden) Sets the value of the attribute: renderWhileHidden.
void	setRequired(boolean a_Required) Sets the value of the attribute: required; This tells us whether the wizard if the page has required information.
void	setSelected(boolean a_Selected) Sets the value of the attribute: selected; Specifies whether the action is enabled Supported API: true
void	setSelectRequired(boolean a_SelectRequired) Sets the value of the attribute: selectRequired; True or false.
void	setStyleClass(String a_StyleClass) Sets the value of the attribute: styleClass.
void	setTitle(String a_Title) Sets the value of the attribute: title; Localized title of the action used for pages.
void	setToolTip(String a_ToolTip) Sets the value of the attribute: toolTip; Action description Supported API: true
void	setType(String a_Type) Sets the value of the attribute: type; Action type Supported API: true
void	setUiComponent(String a_UiComponent) Sets the value of the attribute: uiComponent; Speficies the related Role-Based UI Component constant.
void	setUrl(String a_Url) Sets the value of the attribute: url; The url to the page the action will go to.
void	setWindowType(String a_WindowType) Sets the value of the attribute: windowType; Specifies whether the action is enabled Supported API: true

Methods inherited from class java.lang.Object

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

Method Detail

getActionClass

public String getActionClass()

Gets the value of the attribute: actionClass; Class that implements a method to execute

Supported API: true

Returns:

String

setActionClass

public void setActionClass(String a_ActionClass)

Sets the value of the attribute: actionClass; Class that implements a method to execute

Supported API: true

Parameters:

a_ActionClass -

getActionMethod

public String getActionMethod()

Gets the value of the attribute: actionMethod; A method to execute

Supported API: true

Returns:

String

setActionMethod

public void setActionMethod(String a_ActionMethod)

Sets the value of the attribute: actionMethod; A method to execute

Supported API: true

Parameters:

a_ActionMethod -

getType

public String getType()

Gets the value of the attribute: type; Action type

Supported API: true

Returns:

String

setType

public void setType(String a_Type)

Sets the value of the attribute: type; Action type

Supported API: true

Parameters:

a_Type -

getAction

public String getAction()

Gets the value of the attribute: action; Action name

Supported API: true

Returns:

String

setAction

public void setAction(String a_Action)

Sets the value of the attribute: action; Action name

Supported API: true

Parameters:

a_Action -

getDesc

public String getDesc()

Gets the value of the attribute: desc; Action description

Supported API: true

Returns:

String

setDesc

public void setDesc(String a_Desc)

Sets the value of the attribute: desc; Action description

Supported API: true

Parameters:

a_Desc -

getIcon

public String getIcon()

Gets the value of the attribute: icon; Action icon

Supported API: true

Returns:

String

setIcon

public void setIcon(String a_Icon)

Sets the value of the attribute: icon; Action icon

Supported API: true

Parameters:

a_Icon -

getDisabledIcon

public String getDisabledIcon()

Gets the value of the attribute: disabledIcon; Action icon

Supported API: true

Returns:

String

setDisabledIcon

public void setDisabledIcon(String a_DisabledIcon)

Sets the value of the attribute: disabledIcon; Action icon

Supported API: true

Parameters:

a_DisabledIcon -

isEnabled

public boolean isEnabled()

Gets the value of the attribute: enabled; Specifies whether the action is enabled

Supported API: true

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)

Sets the value of the attribute: enabled; Specifies whether the action is enabled

Supported API: true

Parameters:

a_Enabled -

getWindowType

public String getWindowType()

Gets the value of the attribute: windowType; Specifies whether the action is enabled

Supported API: true

Returns:

String

setWindowType

public void setWindowType(String a_WindowType)

Sets the value of the attribute: windowType; Specifies whether the action is enabled

Supported API: true

Parameters:

a_WindowType -

isMultiselect

public boolean isMultiselect()

Gets the value of the attribute: multiselect; Specifies whether the action is enabled

Supported API: true

Returns:

boolean

setMultiselect

public void setMultiselect(boolean a_Multiselect)

Sets the value of the attribute: multiselect; Specifies whether the action is enabled

Supported API: true

Parameters:

a_Multiselect -

getPageURL

public String getPageURL()

Gets the value of the attribute: pageURL; Action name

Supported API: true

Returns:

String

setPageURL

public void setPageURL(String a_PageURL)

Sets the value of the attribute: pageURL; Action name

Supported API: true

Parameters:

a_PageURL -

getParams

public HashMap getParams()

Gets the value of the attribute: params.

Supported API: true

Returns:

HashMap

setParams

public void setParams(HashMap a_Params)

Sets the value of the attribute: params.

Supported API: true

Parameters:

a_Params -

getMoreURLInfo

public String getMoreURLInfo()

Gets the value of the attribute: moreURLInfo; Action name

Supported API: true

Returns:

String

setMoreURLInfo

public void setMoreURLInfo(String a_MoreURLInfo)

Sets the value of the attribute: moreURLInfo; Action name

Supported API: true

Parameters:

a_MoreURLInfo -

isSelected

public boolean isSelected()

Gets the value of the attribute: selected; Specifies whether the action is enabled

Supported API: true

Returns:

boolean

setSelected

public void setSelected(boolean a_Selected)

Sets the value of the attribute: selected; Specifies whether the action is enabled

Supported API: true

Parameters:

a_Selected -

isConnector

public boolean isConnector()

Gets the value of the attribute: connector; Specifies whether the action is enabled

Supported API: true

Returns:

boolean

setConnector

public void setConnector(boolean a_Connector)

Sets the value of the attribute: connector; Specifies whether the action is enabled

Supported API: true

Parameters:

a_Connector -

getContextObject

public NmOid getContextObject()

Gets the value of the attribute: contextObject; Action name

Supported API: true

Returns:

NmOid

setContextObject

public void setContextObject(NmOid a_ContextObject)

Sets the value of the attribute: contextObject; Action name

Supported API: true

Parameters:

a_ContextObject -

getToolTip

public String getToolTip()

Gets the value of the attribute: toolTip; Action description

Supported API: true

Returns:

String

setToolTip

public void setToolTip(String a_ToolTip)

Sets the value of the attribute: toolTip; Action description

Supported API: true

Parameters:

a_ToolTip -

isEnabledWhenSuspended

public boolean isEnabledWhenSuspended()

Gets the value of the attribute: enabledWhenSuspended; Specifies whether the action is enabled

Supported API: true

Returns:

boolean

setEnabledWhenSuspended

public void setEnabledWhenSuspended(boolean a_EnabledWhenSuspended)

Sets the value of the attribute: enabledWhenSuspended; Specifies whether the action is enabled

Supported API: true

Parameters:

a_EnabledWhenSuspended -

isButton

public boolean isButton()

Gets the value of the attribute: button.

Supported API: true

Returns:

boolean

setButton

public void setButton(boolean a_Button)

Sets the value of the attribute: button.

Supported API: true

Parameters:

a_Button -

getCADProperty

public int getCADProperty()

Gets the value of the attribute: CADProperty; Determines whether or not an action should be enable/disabled if a CAD client is detected to be the user-agent

Supported API: true

Returns:

int

setCADProperty

public void setCADProperty(int a_CADProperty)

Sets the value of the attribute: CADProperty; Determines whether or not an action should be enable/disabled if a CAD client is detected to be the user-agent

Supported API: true

Parameters:

a_CADProperty -

getRenderType

public String getRenderType()

Gets the value of the attribute: renderType; Specifies which actions should be rendered by PDMLink or ProjectLink or xLink

Supported API: true

Returns:

String

setRenderType

public void setRenderType(String a_RenderType)

Sets the value of the attribute: renderType; Specifies which actions should be rendered by PDMLink or ProjectLink or xLink

Supported API: true

Parameters:

a_RenderType -

getUrl

public String getUrl()

Gets the value of the attribute: url; The url to the page the action will go to.

Supported API: true

Returns:

String

setUrl

public void setUrl(String a_Url)

Sets the value of the attribute: url; The url to the page the action will go to.

Supported API: true

Parameters:

a_Url -

getIdName

public String getIdName()

Gets the value of the attribute: idName; The id of the link to use.

Supported API: true

Returns:

String

setIdName

public void setIdName(String a_IdName)

Sets the value of the attribute: idName; The id of the link to use.

Supported API: true

Parameters:

a_IdName -

getInstallType

public String getInstallType()

Gets the value of the attribute: installType; Specifies which solution must be installed for this action to be valid

Supported API: true

Returns:

String

setInstallType

public void setInstallType(String a_InstallType)

Sets the value of the attribute: installType; Specifies which solution must be installed for this action to be valid

Supported API: true

Parameters:

a_InstallType -

getUiComponent

public String getUiComponent()

Gets the value of the attribute: uiComponent; Speficies the related Role-Based UI Component constant. It may be null if no UI Component is related to this action.

Supported API: true

Returns:

String

setUiComponent

public void setUiComponent(String a_UiComponent)

Sets the value of the attribute: uiComponent; Speficies the related Role-Based UI Component constant. It may be null if no UI Component is related to this action.

Supported API: true

Parameters:

a_UiComponent -

getAjaxType

public String getAjaxType()

Gets the value of the attribute: ajaxType; This tells us whether an action has been ajax enabled. It is passed as a parameter to handleDynamicAction in main.js.

Supported API: true

Returns:

String

setAjaxType

public void setAjaxType(String a_AjaxType)

Sets the value of the attribute: ajaxType; This tells us whether an action has been ajax enabled. It is passed as a parameter to handleDynamicAction in main.js.

Supported API: true

Parameters:

a_AjaxType -

getAjaxClass

public String getAjaxClass()

Gets the value of the attribute: ajaxClass; Class that implements a method to execute for server side validation.

Supported API: true

Returns:

String

setAjaxClass

public void setAjaxClass(String a_AjaxClass)

Sets the value of the attribute: ajaxClass; Class that implements a method to execute for server side validation.

Supported API: true

Parameters:

a_AjaxClass -

getAjaxMethod

public String getAjaxMethod()

Gets the value of the attribute: ajaxMethod; A method to execute

Supported API: true

Returns:

String

setAjaxMethod

public void setAjaxMethod(String a_AjaxMethod)

Sets the value of the attribute: ajaxMethod; A method to execute

Supported API: true

Parameters:

a_AjaxMethod -

getBeforeJS

public String getBeforeJS()

Gets the value of the attribute: beforeJS; String js method to call

Supported API: true

Returns:

String

setBeforeJS

public void setBeforeJS(String a_BeforeJS)

Sets the value of the attribute: beforeJS; String js method to call

Supported API: true

Parameters:

a_BeforeJS -

getAfterJS

public String getAfterJS()

Gets the value of the attribute: afterJS; js method to execute after action is clicked.

Supported API: true

Returns:

String

setAfterJS

public void setAfterJS(String a_AfterJS)

Sets the value of the attribute: afterJS; js method to execute after action is clicked.

Supported API: true

Parameters:

a_AfterJS -

isDynamicWizardPage

public boolean isDynamicWizardPage()

Gets the value of the attribute: dynamicWizardPage; Specifies whether the page can be pre-loaded into the wizard.

Supported API: true

Returns:

boolean

setDynamicWizardPage

public void setDynamicWizardPage(boolean a_DynamicWizardPage)

Sets the value of the attribute: dynamicWizardPage; Specifies whether the page can be pre-loaded into the wizard.

Supported API: true

Parameters:

a_DynamicWizardPage -

isHidden

public boolean isHidden()

Gets the value of the attribute: hidden; Specifies whether the page should be hidden by default in the wizard.

Supported API: true

Returns:

boolean

setHidden

public void setHidden(boolean a_Hidden)

Sets the value of the attribute: hidden; Specifies whether the page should be hidden by default in the wizard.

Supported API: true

Parameters:

a_Hidden -

getHotKey

public String getHotKey()

Gets the value of the attribute: hotKey; Defines the hotkey to be used to automatically trigger the action to occur

Supported API: true

Returns:

String

setHotKey

public void setHotKey(String a_HotKey)

Sets the value of the attribute: hotKey; Defines the hotkey to be used to automatically trigger the action to occur

Supported API: true

Parameters:

a_HotKey -

getBeforeServerVK

public String getBeforeServerVK()

Gets the value of the attribute: beforeServerVK; Verification key to validate before a page is loaded.

Supported API: true

Returns:

String

setBeforeServerVK

public void setBeforeServerVK(String a_BeforeServerVK)

Sets the value of the attribute: beforeServerVK; Verification key to validate before a page is loaded.

Supported API: true

Parameters:

a_BeforeServerVK -

getAfterServerVK

public String getAfterServerVK()

Gets the value of the attribute: afterServerVK; Verification key to validate after a page is loaded.

Supported API: true

Returns:

String

setAfterServerVK

public void setAfterServerVK(String a_AfterServerVK)

Sets the value of the attribute: afterServerVK; Verification key to validate after a page is loaded.

Supported API: true

Parameters:

a_AfterServerVK -

isRequired

public boolean isRequired()

Gets the value of the attribute: required; This tells us whether the wizard if the page has required information. The wizard cannot be closed until this step is visited.

Supported API: true

Returns:

boolean

setRequired

public void setRequired(boolean a_Required)

Sets the value of the attribute: required; This tells us whether the wizard if the page has required information. The wizard cannot be closed until this step is visited.

Supported API: true

Parameters:

a_Required -

getPageId

public String getPageId()

Gets the value of the attribute: pageId; ID of the step, to be used by javascript functions to manipulate step attributes.

Supported API: true

Returns:

String

setPageId

public void setPageId(String a_PageId)

Sets the value of the attribute: pageId; ID of the step, to be used by javascript functions to manipulate step attributes.

Supported API: true

Parameters:

a_PageId -

getPreloadJS

public String getPreloadJS()

Gets the value of the attribute: preloadJS; String js method to call

Supported API: true

Returns:

String

setPreloadJS

public void setPreloadJS(String a_PreloadJS)

Sets the value of the attribute: preloadJS; String js method to call

Supported API: true

Parameters:

a_PreloadJS -

getPostloadJS

public String getPostloadJS()

Gets the value of the attribute: postloadJS; js method to execute after wizard page is loaded.

Supported API: true

Returns:

String

setPostloadJS

public void setPostloadJS(String a_PostloadJS)

Sets the value of the attribute: postloadJS; js method to execute after wizard page is loaded.

Supported API: true

Parameters:

a_PostloadJS -

getTitle

public String getTitle()

Gets the value of the attribute: title; Localized title of the action used for pages.

Supported API: true

Returns:

String

setTitle

public void setTitle(String a_Title)

Sets the value of the attribute: title; Localized title of the action used for pages.

Supported API: true

Parameters:

a_Title -

isSelectRequired

public boolean isSelectRequired()

Gets the value of the attribute: selectRequired; True or false. This tells us whether an action requires at least one row be selected in a table.

Supported API: true

Returns:

boolean

setSelectRequired

public void setSelectRequired(boolean a_SelectRequired)

Sets the value of the attribute: selectRequired; True or false. This tells us whether an action requires at least one row be selected in a table.

Supported API: true

Parameters:

a_SelectRequired -

getOnClick

public String getOnClick()

Gets the value of the attribute: onClick; Optional onlcick javascript code to run on actions. This only effects the action when it's rendered as a button or Hyperlink, Not when it's in a menu.

Supported API: true

Returns:

String

setOnClick

public void setOnClick(String a_OnClick)

Sets the value of the attribute: onClick; Optional onlcick javascript code to run on actions. This only effects the action when it's rendered as a button or Hyperlink, Not when it's in a menu.

Supported API: true

Parameters:

a_OnClick -

getRenderer

public String getRenderer()

Gets the value of the attribute: renderer; The class that will handle rendering this action to the UI. The class must implement com.ptc.netmarkets.util.misc.ActionRenderer

Supported API: true

Returns:

String

setRenderer

public void setRenderer(String a_Renderer)

Sets the value of the attribute: renderer; The class that will handle rendering this action to the UI. The class must implement com.ptc.netmarkets.util.misc.ActionRenderer

Supported API: true

Parameters:

a_Renderer -

copy

public NmAction copy()

Supported API: true

Returns:

NmAction

enableForCAD

public boolean enableForCAD()
                     throws WTException

Supported API: true

Returns:

boolean

Throws:

WTException

disableForCAD

public boolean disableForCAD()
                      throws WTException

Supported API: true

Returns:

boolean

Throws:

WTException

getDivClass

public String getDivClass()

Gets the value of the attribute: divClass.

Supported API: true

Returns:

String

setDivClass

public void setDivClass(String a_DivClass)

Sets the value of the attribute: divClass.

Supported API: true

Parameters:

a_DivClass -

isRenderWhileHidden

public boolean isRenderWhileHidden()

Gets the value of the attribute: renderWhileHidden.

Supported API: true

Returns:

boolean

setRenderWhileHidden

public void setRenderWhileHidden(boolean a_RenderWhileHidden)

Sets the value of the attribute: renderWhileHidden.

Supported API: true

Parameters:

a_RenderWhileHidden -

getStyleClass

public String getStyleClass()

Gets the value of the attribute: styleClass.

Supported API: true

Returns:

String

setStyleClass

public void setStyleClass(String a_StyleClass)

Sets the value of the attribute: styleClass.

Supported API: true

Parameters:

a_StyleClass -

helpjspOrientationLink

public static void helpjspOrientationLink(String helpfile,
                                          NmURLFactoryBean urlFactoryBean,
                                          com.ptc.netmarkets.util.beans.NmLocaleBean localeBean,
                                          com.ptc.netmarkets.util.beans.NmContextBean nmcontext,
                                          com.ptc.netmarkets.util.beans.NmLinkBean linkBean,
                                          Writer out,
                                          Object request,
                                          Object response)
                                   throws Exception

Generates a html to open accessibility orientation page.

Supported API: true

Parameters:

String -

Throws:

Exception

helpjspOrientationLink

public static void helpjspOrientationLink(String helpfile,
                                          Locale locale,
                                          Writer out)
                                   throws Exception

Generates a html to open accessibility orientation page.

Supported API: true

Parameters:

String - helpFile

Writer - PrintWriter to include the help html

Throws:

Exception