public class GridFetchDataTask extends ComponentTask
ListGrid.fetchData()config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
GridFetchDataTask() |
GridFetchDataTask(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.Boolean |
getApplyToImplicitCriteria()
Should criteria be applied to the grid as
implicit
criteria? When criteria is applied this way, it is not shown to the user and cannot be changed by the user. |
Criteria |
getCriteria()
Criteria to use for fetch.
|
java.lang.String[] |
getGroupBy()
List of fields to group by in the fetch.
|
static GridFetchDataTask |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
DSRequest |
getRequestProperties()
Additional properties to set on the DSRequest that will be issued to perform the fetch or clear criteria.
|
java.util.Map<java.lang.String,SummaryFunctionType> |
getSummaryFunctions()
A mapping from field names to
summary functions to be applied to
each field in the fetch. |
GridFetchDataTask |
setApplyToImplicitCriteria(java.lang.Boolean applyToImplicitCriteria)
Should criteria be applied to the grid as
implicit
criteria? When criteria is applied this way, it is not shown to the user and cannot be changed by the user. |
GridFetchDataTask |
setCriteria(Criteria criteria)
Criteria to use for fetch.
|
GridFetchDataTask |
setGroupBy(java.lang.String... groupBy)
List of fields to group by in the fetch.
|
GridFetchDataTask |
setRequestProperties(DSRequest requestProperties)
Additional properties to set on the DSRequest that will be issued to perform the fetch or clear criteria.
|
GridFetchDataTask |
setSummaryFunctions(java.util.Map<java.lang.String,SummaryFunctionType> summaryFunctions)
A mapping from field names to
summary functions to be applied to
each field in the fetch. |
getComponentBaseClass, getComponentBaseClassAsStringArray, getComponentId, getComponentRequiresDataSource, getTargetBaseClass, getTargetBaseClassAsStringArray, getTargetComponent, getTargetComponent, getUnsupportedComponentMessage, setComponentBaseClass, setComponentBaseClass, setComponentId, setComponentRequiresDataSource, setTargetBaseClass, setTargetBaseClass, setUnsupportedComponentMessagecompleteElement, 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, updateLastElementInValuesaddDynamicProperty, 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, setScClassNamepublic GridFetchDataTask()
public GridFetchDataTask(com.google.gwt.core.client.JavaScriptObject jsObj)
public static GridFetchDataTask getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public com.google.gwt.core.client.JavaScriptObject create()
create in class ComponentTaskpublic GridFetchDataTask setApplyToImplicitCriteria(java.lang.Boolean applyToImplicitCriteria) throws java.lang.IllegalStateException
implicit
criteria? When criteria is applied this way, it is not shown to the user and cannot be changed by the user.applyToImplicitCriteria - New applyToImplicitCriteria value. Default value is nullGridFetchDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getApplyToImplicitCriteria()
implicit
criteria? When criteria is applied this way, it is not shown to the user and cannot be changed by the user.public GridFetchDataTask setCriteria(Criteria criteria) throws java.lang.IllegalStateException
null or empty, the filter criteria of the grid will be cleared.criteria - New criteria value. Default value is nullGridFetchDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic Criteria getCriteria()
null or empty, the filter criteria of the grid will be cleared.public GridFetchDataTask setGroupBy(java.lang.String... groupBy) throws java.lang.IllegalStateException
See the Server Summaries
overview for examples of usage.
groupBy - New groupBy value. Default value is nullGridFetchDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdsetSummaryFunctions(java.util.Map<java.lang.String, com.smartgwt.client.types.SummaryFunctionType>),
Server Summariespublic java.lang.String[] getGroupBy()
See the Server Summaries
overview for examples of usage.
getSummaryFunctions(),
Server Summariespublic GridFetchDataTask setRequestProperties(DSRequest requestProperties) throws java.lang.IllegalStateException
requestProperties - New requestProperties value. Default value is nullGridFetchDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic DSRequest getRequestProperties()
public GridFetchDataTask setSummaryFunctions(java.util.Map<java.lang.String,SummaryFunctionType> summaryFunctions) throws java.lang.IllegalStateException
summary functions to be applied to
each field in the fetch. See the Server Summaries overview for
examples of usage.
summaryFunctions - New summaryFunctions value. Default value is nullGridFetchDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdsetGroupBy(java.lang.String...),
Server Summariespublic java.util.Map<java.lang.String,SummaryFunctionType> getSummaryFunctions()
summary functions to be applied to
each field in the fetch. See the Server Summaries overview for
examples of usage.
getGroupBy(),
Server Summaries