Class ShowHideTask
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.ShowHideTask
- All Implemented Interfaces:
HasHandlers
Show or hide a component. When showing, reveals any hidden parents as well.
-
Field Summary
Fields inherited from class com.smartgwt.client.core.BaseClass
config, configOnly, factoryCreated, factoryProperties, id, scClassName -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreate()getHide()Should the target form item be hidden?Should focus be moved to target component when showing?static ShowHideTaskgetOrCreateRef(JavaScriptObject jsObj) Set tofalseto prevent scrolling the component into view when showing.Set tofalseto not show a component's parents.IfcomponentIdtargets a DynamicForm, this property specifies the name of the target field to assign new title.IfcomponentIdtargets a SectionStack, this property specifies the name of the target section.IfcomponentIdtargets a SectionStack, this property specifies the title of the target section.IfcomponentIdtargets a TabSet, this property specifies the name or ID of the target tab to assign new title.Should the target form item be hidden?setMoveFocusToTarget(Boolean moveFocusToTarget) Should focus be moved to target component when showing?setScrollIntoView(Boolean scrollIntoView) Set tofalseto prevent scrolling the component into view when showing.setShowRecursively(Boolean showRecursively) Set tofalseto not show a component's parents.setTargetFieldName(String targetFieldName) IfcomponentIdtargets a DynamicForm, this property specifies the name of the target field to assign new title.setTargetSectionName(String targetSectionName) IfcomponentIdtargets a SectionStack, this property specifies the name of the target section.setTargetSectionTitle(String targetSectionTitle) IfcomponentIdtargets a SectionStack, this property specifies the title of the target section.setTargetTabName(String targetTabName) IfcomponentIdtargets a TabSet, this property specifies the name or ID of the target tab to assign new title.Methods inherited from class com.smartgwt.client.util.workflow.ComponentTask
getComponentBaseClass, getComponentBaseClassAsStringArray, getComponentId, getComponentRequiresDataSource, getTargetBaseClass, getTargetBaseClassAsStringArray, getTargetComponent, getTargetComponent, getUnsupportedComponentMessage, setComponentBaseClass, setComponentBaseClass, setComponentId, setComponentRequiresDataSource, setTargetBaseClass, setTargetBaseClass, setUnsupportedComponentMessageMethods inherited from class com.smartgwt.client.util.workflow.ProcessElement
completeElement, convertToJavaScriptArray, executeElement, getBindOutput, getClassDescription, getComponentReferences, getDescription, getDynamicValue, getEditorType, getElementDescription, getForceSingle, getID, getInvalidTaskMessage, getJsObj, getMockMode, getNextElement, getOrCreateJsObj, getPassThruOutput, getProcessElements, getSupportsMultipleInputRecords, getTextFormulaValue, getTypeTitle, getUndefinedComponentMessage, getUnresolvedComponentMessage, getWaitDuration, getWaitFor, getWaitLocator, isCreated, isValid, objectReferencesLastTaskOutput, onInit, reset, setAttribute, setBindOutput, setClassDescription, setDescription, setEditorType, setForceSingle, setID, setJavaScriptObject, setMockMode, setNextElement, setPassThruOutput, setSupportsMultipleInputRecords, setTypeTitle, setUndefinedComponentMessage, setUnresolvedComponentMessage, setWaitDuration, setWaitFor, setWaitLocator, updateGlobalIDInCriteria, updateGlobalIDInTextFormula, updateGlobalIDInValueProperty, updateGlobalIDInValues, updateGlobalIDReferences, updateLastElementBindingReferences, updateLastElementInCriteria, updateLastElementInValueProperty, updateLastElementInValuesMethods inherited from class com.smartgwt.client.core.BaseClass
addDynamicProperty, 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
-
Constructor Details
-
ShowHideTask
public ShowHideTask() -
ShowHideTask
-
-
Method Details
-
getOrCreateRef
-
create
- Overrides:
createin classComponentTask
-
setHide
Should the target form item be hidden?- Parameters:
hide- New hide value. Default value is null- Returns:
ShowHideTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getHide
Should the target form item be hidden?- Returns:
- Current hide value. Default value is null
-
setMoveFocusToTarget
Should focus be moved to target component when showing?- Parameters:
moveFocusToTarget- New moveFocusToTarget value. Default value is null- Returns:
ShowHideTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getMoveFocusToTarget
Should focus be moved to target component when showing?- Returns:
- Current moveFocusToTarget value. Default value is null
-
setScrollIntoView
Set tofalseto prevent scrolling the component into view when showing.- Parameters:
scrollIntoView- New scrollIntoView value. Default value is null- Returns:
ShowHideTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getScrollIntoView
Set tofalseto prevent scrolling the component into view when showing.- Returns:
- Current scrollIntoView value. Default value is null
-
setShowRecursively
Set tofalseto not show a component's parents.- Parameters:
showRecursively- New showRecursively value. Default value is null- Returns:
ShowHideTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getShowRecursively
Set tofalseto not show a component's parents.- Returns:
- Current showRecursively value. Default value is null
-
setTargetFieldName
IfcomponentIdtargets a DynamicForm, this property specifies the name of the target field to assign new title.- Parameters:
targetFieldName- New targetFieldName value. Default value is null- Returns:
ShowHideTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTargetFieldName
IfcomponentIdtargets a DynamicForm, this property specifies the name of the target field to assign new title.- Returns:
- Current targetFieldName value. Default value is null
- See Also:
-
setTargetSectionName
IfcomponentIdtargets a SectionStack, this property specifies the name of the target section. Alternately, the target section can be specified by usingtargetSectionTitle.- Parameters:
targetSectionName- New targetSectionName value. Default value is null- Returns:
ShowHideTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getTargetSectionName
IfcomponentIdtargets a SectionStack, this property specifies the name of the target section. Alternately, the target section can be specified by usingtargetSectionTitle.- Returns:
- Current targetSectionName value. Default value is null
-
setTargetSectionTitle
IfcomponentIdtargets a SectionStack, this property specifies the title of the target section. Alternately, the target section can be specified by usingtargetSectionName.- Parameters:
targetSectionTitle- New targetSectionTitle value. Default value is null- Returns:
ShowHideTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getTargetSectionTitle
IfcomponentIdtargets a SectionStack, this property specifies the title of the target section. Alternately, the target section can be specified by usingtargetSectionName.- Returns:
- Current targetSectionTitle value. Default value is null
-
setTargetTabName
IfcomponentIdtargets a TabSet, this property specifies the name or ID of the target tab to assign new title.- Parameters:
targetTabName- New targetTabName value. Default value is null- Returns:
ShowHideTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTargetTabName
IfcomponentIdtargets a TabSet, this property specifies the name or ID of the target tab to assign new title.- Returns:
- Current targetTabName value. Default value is null
- See Also:
-