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
public class Operator extends RefDataClass
Specification of an operator for use in filtering, for example "equals". Use with DataSource.addSearchOperator() to define custom filtering behaviors for client-side filtering.

  • Constructor Details

    • Operator

      public Operator()

  • Method Details

    • setID

      public void setID(String id)
      Unique id for an operator, which appears within AdvancedCriteria as the Operator property.

      A list of built-in identifiers is here.

      Parameters:
      id -

    • setTitle

      public void setTitle(String title)
      User-visible title for this operator, such as "doesn't contain".
      Parameters:
      title -

    • setValueType

      public void setValueType(OperatorValueType valueType)
      Indicates the kind of value expected in a Criterion that uses this operator. OperatorValueType lists possibilities.

      The default of null is equivalent to "fieldType", indicating that Criterion.getValue() is expected to contain a value of the same type as the field indicated by Criterion.getFieldName().

      Parameters:
      valueType -

    • setEditorType

      public void setEditorType(String editorType)
      For an operator with OperatorValueType.CUSTOM, indicates what kind of FormItem to use to provide a user interface for creating a valid Criterion. The default of null means an ordinary TextItem is fine.
      Parameters:
      editorType -

    • setHidden

      public void setHidden(Boolean hidden)
      Whether this operator is hidden by default. Hidden operators are not made available by default in widgets like FilterBuilders.
      Parameters:
      hidden -