Class Operator
This class is not meant to be created and used, it is actually documentation of settings
allowed in a DataSource descriptor (.ds.xml file), for use with Smart GWT Pro Edition and
above.
See com.smartgwt.client.docs.serverds for how to use this documentation.
Use with DataSource.addSearchOperator() to define custom filtering behaviors for client-side filtering.
-
Field Summary
FieldsModifier and TypeFieldDescriptionList of types that this Operator is valid for.booleanWhether this operator should be offered to users by default in interfaces such as theFilterBuilder.Unique id for an operator, which appears withinAdvancedCriteriaas theOperatorproperty.booleanWhether this operator needs to be executed on the server side.The text use when using this operator as anexpressionin a FormItem.User-visible title for this operator when used with text-based fields - eg, "equals (match case)" rather than just "equals".Name of a property on the Operators class that provides the title for this operator when used with text-based fields.User-visible title for this operator, such as "doesn't contain".Name of a property on the Operators class that provides the title for this operator.Usage hint text specific to this Operator and shown, for example, in the hover-text ofListGridfilterEditorfields.Indicates the kind of value expected in aCriterionthat uses this operator. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
fieldTypes
List of types that this Operator is valid for.If omitted, the operator is assumed to be valid for all FieldTypes unless a list of FieldTypes is passed to
DataSource.addSearchOperator().Default value is null
- See Also:
-
titleProperty
Name of a property on the Operators class that provides the title for this operator.Default value is null
- See Also:
-
ID
Unique id for an operator, which appears withinAdvancedCriteriaas theOperatorproperty.A list of built-in identifiers is
here.Default value is null
- See Also:
-
textTitle
User-visible title for this operator when used with text-based fields - eg, "equals (match case)" rather than just "equals".To simplify internationalization by separating titles from operator code, you can use specify
textTitlePropertyinstead of this property.Default value is null
- See Also:
-
title
User-visible title for this operator, such as "doesn't contain".To simplify internationalization by separating titles from operator code, you can use specify
titlePropertyinstead of this property.Default value is null
- See Also:
-
editorType
For an operator withvalueType:"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.Default value is null
- See Also:
-
symbol
The text use when using this operator as anexpressionin a FormItem.Default value is null
- See Also:
-
requiresServer
public boolean requiresServerWhether this operator needs to be executed on the server side.This implies that if a
Criterionusing this operator is either introduced intocriteriaor is changed, the server will need to be contacted to perform filtering.Default value is false
- See Also:
-
valueType
Indicates the kind of value expected in aCriterionthat uses this operator.OperatorValueTypelists possibilities.The default of
nullis equivalent to "fieldType", indicating thatCriterion.valueis expected to contain a value of the same type as the field indicated byCriterion.fieldName.Default value is null
- See Also:
-
usageHint
Usage hint text specific to this Operator and shown, for example, in the hover-text ofListGridfilterEditorfields.If unset, the default for all operators, this value is derived from an attribute on the Operators class, in the format [operator.valueType]UsageHint - for example, the "between" operator uses valueRangeUsageHint.
Default value is null
- See Also:
-
textTitleProperty
Name of a property on the Operators class that provides the title for this operator when used with text-based fields.Default value is null
- See Also:
-
Constructor Details
-
Operator
public Operator()
-