Class GridSelectRecordsTask
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.GridSelectRecordsTask
- All Implemented Interfaces:
HasHandlers
Select or deselect one or more records as specified by criteria. Target records will also be scrolled into view or, for
a tree, parent folders will be opened to reveal the node.
Task Output:
- On a select, the set of newly selected records is the output, even if other records are also selected.
- On a deselect, the entire set of de-selected records is the output.
-
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()Criteria defining the records that should be selected or deselected.For grids that allow multiple selection, should any existing selection be retained? Only applies when selecting records.static GridSelectRecordsTaskgetOrCreateRef(JavaScriptObject jsObj) Set tofalseto prevent the first affected record from being scrolled into view.Set tofalseto clear selection.Should multiple records matchingCriteriabe affected? If set tofalseonly the first matching record is affected.setCriteria(Criteria criteria) Criteria defining the records that should be selected or deselected.setKeepExistingSelection(Boolean keepExistingSelection) For grids that allow multiple selection, should any existing selection be retained? Only applies when selecting records.setScrollIntoView(Boolean scrollIntoView) Set tofalseto prevent the first affected record from being scrolled into view.Set tofalseto clear selection.setSelectMultiple(Boolean selectMultiple) Should multiple records matchingCriteriabe affected? If set tofalseonly the first matching record is affected.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
-
GridSelectRecordsTask
public GridSelectRecordsTask() -
GridSelectRecordsTask
-
-
Method Details
-
getOrCreateRef
-
create
- Overrides:
createin classComponentTask
-
setCriteria
Criteria defining the records that should be selected or deselected. All records are selected or deselected if not specified.To target a single record just specify criteria for its primary key.
- Parameters:
criteria- New criteria value. Default value is null- Returns:
GridSelectRecordsTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getCriteria
Criteria defining the records that should be selected or deselected. All records are selected or deselected if not specified.To target a single record just specify criteria for its primary key.
- Returns:
- Current criteria value. Default value is null
-
setKeepExistingSelection
public GridSelectRecordsTask setKeepExistingSelection(Boolean keepExistingSelection) throws IllegalStateException For grids that allow multiple selection, should any existing selection be retained? Only applies when selecting records.- Parameters:
keepExistingSelection- New keepExistingSelection value. Default value is null- Returns:
GridSelectRecordsTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getKeepExistingSelection
For grids that allow multiple selection, should any existing selection be retained? Only applies when selecting records.- Returns:
- Current keepExistingSelection value. Default value is null
-
setScrollIntoView
Set tofalseto prevent the first affected record from being scrolled into view.- Parameters:
scrollIntoView- New scrollIntoView value. Default value is null- Returns:
GridSelectRecordsTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getScrollIntoView
Set tofalseto prevent the first affected record from being scrolled into view.- Returns:
- Current scrollIntoView value. Default value is null
-
setSelect
Set tofalseto clear selection.- Parameters:
select- New select value. Default value is null- Returns:
GridSelectRecordsTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getSelect
Set tofalseto clear selection.- Returns:
- Current select value. Default value is null
-
setSelectMultiple
Should multiple records matchingCriteriabe affected? If set tofalseonly the first matching record is affected.- Parameters:
selectMultiple- New selectMultiple value. Default value is null- Returns:
GridSelectRecordsTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getSelectMultiple
Should multiple records matchingCriteriabe affected? If set tofalseonly the first matching record is affected.- Returns:
- Current selectMultiple value. Default value is null
-