Package com.smartgwt.client.data
Class Operator
java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.data.Operator
- All Implemented Interfaces:
HasHandlers
Specification of an operator for use in filtering, for example "equals".
Use with
DataSource.addSearchOperator()
to define custom filtering behaviors for client-side filtering.-
Field Summary
Fields inherited from class com.smartgwt.client.core.RefDataClass
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidsetEditorType(String editorType) For an operator withOperatorValueType.CUSTOM, indicates what kind of FormItem to use to provide a user interface for creating a validCriterion.voidWhether this operator is hidden by default.voidUnique id for an operator, which appears withinAdvancedCriteriaas theOperatorproperty.voidUser-visible title for this operator, such as "doesn't contain".voidsetValueType(OperatorValueType valueType) Indicates the kind of value expected in aCriterionthat uses this operator.Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
-
Constructor Details
-
Operator
public Operator()
-
-
Method Details
-
setID
Unique id for an operator, which appears withinAdvancedCriteriaas theOperatorproperty.A list of built-in identifiers is
here.- Parameters:
id-
-
setTitle
User-visible title for this operator, such as "doesn't contain".- Parameters:
title-
-
setValueType
Indicates the kind of value expected in aCriterionthat uses this operator.OperatorValueTypelists possibilities.The default of
nullis equivalent to "fieldType", indicating thatCriterion.getValue()is expected to contain a value of the same type as the field indicated byCriterion.getFieldName().- Parameters:
valueType-
-
setEditorType
For an operator withOperatorValueType.CUSTOM, indicates what kind of FormItem to use to provide a user interface for creating a validCriterion. The default ofnullmeans an ordinary TextItem is fine.- Parameters:
editorType-
-
setHidden
Whether this operator is hidden by default. Hidden operators are not made available by default in widgets like FilterBuilders.- Parameters:
hidden-
-