com.smartgwt.client.util.workflow

Class SetButtonTitleTask

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.SetButtonTitleTask

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

public class SetButtonTitleTask
extends ComponentTask

Sets the title of a button or window.

See Also:

Button.setTitle(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
SetButtonTitleTask()
SetButtonTitleTask(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.core.client.JavaScriptObject	create()
static SetButtonTitleTask	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
UserSummary	getTextFormula() Formula to be used to calculate the button title contents.
java.lang.String	getTitle() Title to assign to button.
SetButtonTitleTask	setTextFormula(UserSummary textFormula) Formula to be used to calculate the button title contents.
SetButtonTitleTask	setTitle(java.lang.String title) Title to assign to button.

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, isCreated, onInit, setAttribute, setClassDescription, setDescription, setEditorType, setID, setJavaScriptObject, setNextElement, setPassThruOutput

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

SetButtonTitleTask

public SetButtonTitleTask()

SetButtonTitleTask

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

Method Detail

getOrCreateRef

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

create

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

Overrides:

create in class ComponentTask

setTextFormula

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

Formula to be used to calculate the button title contents. Use title 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:

SetButtonTitleTask 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 button title contents. Use title 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

setTitle

public SetButtonTitleTask setTitle(java.lang.String title)
                            throws java.lang.IllegalStateException

Title to assign to button. To assign a dynamic value see textFormula.

Overrides:

setTitle in class ProcessElement

Parameters:

title - New title value. Default value is null

Returns:

SetButtonTitleTask instance, for chaining setter calls

Throws:

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

See Also:

HTMLString

getTitle

public java.lang.String getTitle()

Title to assign to button. To assign a dynamic value see textFormula.

Overrides:

getTitle in class ProcessElement

Returns:

Current title value. Default value is null

See Also:

HTMLString