com.ptc.core.components.tags.components
Class PropagateComponentTag

java.lang.Object
  SimpleTagSupport
      com.ptc.core.components.tags.components.PropagateComponentTag

public class PropagateComponentTag
extends SimpleTagSupport

Tag class used to render the PropagateComponent.
Properties of the tag include:

Tag parameter	Description	Object Type
onChangeAction	Javascript code to call on an onChange event occurs.	java.lang.String
label	The label to render with the component. Default is "Propagate from object"	java.lang.String
tooltip	The tooltip to render with the component.	java.lang.String
renderContext	Used is the renderingContext requires to be overloaded.	com.ptc.core.components.rendering.RenderingContext
preferenceKey	The fully qualified preference key (CONTAINER scope) to use to verify is this component is enabled. The default for this tag is to not check preferences. The preference values supported are either true (the component is rendered), selected (the component is rendered and selected by default) or false (the component is not rendered) If any other preference value is returned the configuration of the component will not change (default to is true)	java.lang.String

Supported API: true

Extendable: false

See Also:

PropagationBean

Method Summary

String	getLabel() Will retrieve the label for the component.
String	getOnChangeAction() Will retrieve the onChange Javascript action for the tag.
String	getPreferenceKey() Will retrieve the preference key for the tag.
com.ptc.core.components.rendering.RenderingContext	getRenderContext() Will retrieve the currently set rendering context.
String	getTooltip() Will retrieve the tooltip for the component.
void	setLabel(String label) Will set the label for the component.
void	setOnChangeAction(String action) Will set the onChange Javascript action for the tag.
void	setPreferenceKey(String key) Will set the preference key for the tag.
void	setRenderContext(com.ptc.core.components.rendering.RenderingContext rc) Will set the current rendering context.
void	setTooltip(String label) Will set the tooltip for the component.

Methods inherited from class java.lang.Object

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

Method Detail

setPreferenceKey

public void setPreferenceKey(String key)

Will set the preference key for the tag.

Supported API: true

Parameters:

key - The fully qualified preference key to set.

getPreferenceKey

public String getPreferenceKey()

Will retrieve the preference key for the tag.

Supported API: true

Returns:

String The fully qualified preference key or null if not defined.

setOnChangeAction

public void setOnChangeAction(String action)

Will set the onChange Javascript action for the tag.

Supported API: true

Parameters:

action - The javascript to execute on an onChange event.

getOnChangeAction

public String getOnChangeAction()

Will retrieve the onChange Javascript action for the tag. Defaults to "javascript:markDownstreamWizStepsDirty();" if not defined.

Supported API: true

Returns:

String The javascript onChange logic.

setRenderContext

public void setRenderContext(com.ptc.core.components.rendering.RenderingContext rc)

Will set the current rendering context.

Supported API: true

Parameters:

rc - The rendering context to use.

getRenderContext

public com.ptc.core.components.rendering.RenderingContext getRenderContext()

Will retrieve the currently set rendering context.

Supported API: true

Returns:

String The render context.

getLabel

public String getLabel()

Will retrieve the label for the component.

Supported API: true

Returns:

String The component label.

setLabel

public void setLabel(String label)

Will set the label for the component.

Supported API: true

Parameters:

label - The label to set for the component display.

getTooltip

public String getTooltip()

Will retrieve the tooltip for the component.

Supported API: true

Returns:

String The component tooltip.

setTooltip

public void setTooltip(String label)

Will set the tooltip for the component.

Supported API: true

Parameters:

label - The tooltip to set for the component display.