com.smartgwt.client.util.workflow

Class SetLabelTextTask

java.lang.Object

com.smartgwt.client.core.BaseClass

com.smartgwt.client.util.workflow.ProcessElement

com.smartgwt.client.util.workflow.ComponentTask

com.smartgwt.client.util.workflow.SetLabelTextTask

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

public class SetLabelTextTask
extends ComponentTask

Sets the text of a label.

See Also:

Label.setContents(java.lang.String)

Field Summary

Fields inherited from class com.smartgwt.client.core.BaseClass

config, configOnly, factoryCreated, factoryProperties, id, scClassName

Constructor Summary

Constructors

Constructor and Description
SetLabelTextTask()
SetLabelTextTask(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.core.client.JavaScriptObject	create()
static SetLabelTextTask	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
UserSummary	getTextFormula() Formula to be used to calculate the label text contents.
java.lang.String	getValue() Value to assign to label text contents.
SetLabelTextTask	setTextFormula(UserSummary textFormula) Formula to be used to calculate the label text contents.
SetLabelTextTask	setValue(java.lang.String value) Value to assign to label text contents.

Methods inherited from class com.smartgwt.client.util.workflow.ComponentTask

getComponentBaseClass, getComponentBaseClassAsStringArray, getComponentId, getComponentRequiresDataSource, setComponentBaseClass, setComponentBaseClass, setComponentId, setComponentRequiresDataSource

Methods inherited from class com.smartgwt.client.util.workflow.ProcessElement

convertToJavaScriptArray, getClassDescription, getDescription, getEditorType, getElementDescription, getID, getJsObj, getNextElement, getOrCreateJsObj, getPassThruOutput, getProcessElements, getTitle, isCreated, onInit, setAttribute, setClassDescription, setDescription, setEditorType, setID, setJavaScriptObject, setNextElement, setPassThruOutput, setTitle

Methods inherited from class com.smartgwt.client.core.BaseClass

addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, asSGWTComponent, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassName

Methods inherited from class java.lang.Object

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

Constructor Detail

SetLabelTextTask

public SetLabelTextTask()

SetLabelTextTask

public SetLabelTextTask(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static SetLabelTextTask getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

create

public com.google.gwt.core.client.JavaScriptObject create()

Overrides:

create in class ComponentTask

setTextFormula

public SetLabelTextTask setTextFormula(UserSummary textFormula)
                                throws java.lang.IllegalStateException

Formula to be used to calculate the label text contents. Use value property to assign a static value instead.

Available fields for use in the formula are the current rule context.

Parameters:

textFormula - New textFormula value. Default value is null

Returns:

SetLabelTextTask instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created

getTextFormula

public UserSummary getTextFormula()

Formula to be used to calculate the label text contents. Use value property to assign a static value instead.

Available fields for use in the formula are the current rule context.

Returns:

Current textFormula value. Default value is null

setValue

public SetLabelTextTask setValue(java.lang.String value)
                          throws java.lang.IllegalStateException

Value to assign to label text contents. To assign a dynamic value see textFormula.

Parameters:

value - New value value. Default value is null

Returns:

SetLabelTextTask instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created

See Also:

HTMLString

getValue

public java.lang.String getValue()

Value to assign to label text contents. To assign a dynamic value see textFormula.

Returns:

Current value value. Default value is null

See Also:

HTMLString