FilterBuilder (Smart GWT EE API 5.1p (2022-05-28))

java.lang.Object
- com.google.gwt.user.client.ui.UIObject
- - com.google.gwt.user.client.ui.Widget
  - - com.smartgwt.client.widgets.BaseWidget
    - - com.smartgwt.client.widgets.Canvas
      - com.smartgwt.client.widgets.layout.Layout
        
        com.smartgwt.client.widgets.form.FilterBuilder

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, LogicalStructure, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasFilterChangedHandlers, HasSearchHandlers, HasMembersChangedHandlers
```
public class FilterBuilder
extends Layout
implements HasFilterChangedHandlers, HasSearchHandlers
```
A form that allows the user to input advanced search criteria, including operators on field values such as "less than", and sub-clauses using "AND" and "OR" operators.
A FilterBuilder produces an AdvancedCriteria object, which the DataSource subsystem can use to filter datasets, including the ability to perform such filtering within the browser for datasets that are completely loaded.
The operators available for each field can be customized at the DataSource level via DataSourceField.validOperators, DataSource.setTypeOperators() and related APIs.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
  com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary
- Fields inherited from class com.smartgwt.client.widgets.BaseWidget
  config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
- Fields inherited from class com.google.gwt.user.client.ui.UIObject
  DEBUG_ID_PREFIX

Constructor Summary

Constructors
Constructor and Description

FilterBuilder()

FilterBuilder(com.google.gwt.core.client.JavaScriptObject jsObj)

Constructors
Constructor and Description
`FilterBuilder()`
`FilterBuilder(com.google.gwt.core.client.JavaScriptObject jsObj)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClause(FilterClause filterClause)` Add a new `FilterClause` to this FilterBuilder.
`void`	`addCriterion(Criterion criterion)` Add a new criterion, including recursively adding sub-criteria for a criterion that contains other criteria.
`com.google.gwt.event.shared.HandlerRegistration`	`addFilterChangedHandler(FilterChangedHandler handler)` Add a filterChanged handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addSearchHandler(SearchHandler handler)` Add a search handler.
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)` Changes the defaults for Canvas AutoChildren named `autoChildName`.
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)` Changes the defaults for FormItem AutoChildren named `autoChildName`.
`void`	`clearCriteria()` Clear all current criteria.
`protected com.google.gwt.core.client.JavaScriptObject`	`create()`
`ImgButton`	`getAddButton()` An ImgButton that allows new clauses to be added if `showAddButton` is set.
`java.lang.String`	`getAddButtonPrompt()` The hover prompt text for the add button.
`java.lang.Boolean`	`getAllowEmpty()` If set to false, the last clause cannot be removed.
`Canvas`	`getBracket()` Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
`VStack`	`getClauseStack()` VStack of all clauses that are part of this FilterBuilder
`AdvancedCriteria`	`getCriteria()` Get the edited criteria entered by the user.
`AdvancedCriteria`	`getCriteria(boolean includeEmptyValues)` Get the edited criteria entered by the user.
`DataSource`	`getDataSource()` The DataSource that this component should bind to for default fields and for performing `DSRequest`.
`java.lang.String`	`getEditorType(DataSourceField field, OperatorId operatorId)` Returns the type of editor to use for the field.
`DataSource`	`getFieldDataSource()` If specified, the FilterBuilder will dynamically fetch DataSourceField definitions from this DataSource rather than using `dataSource`.
`FormItem`	`getFieldPickerProperties()` Properties to combine with the `FieldPicker` autoChild FormItem.
`java.lang.String`	`getFieldPickerTitle()` The title for the `field-picker` select-item.
`java.lang.Integer`	`getFieldPickerWidth()` Width for the field picker formItem displayed in clauses within this FilterBuilder.
`java.lang.String`	`getFieldPickerWidthAsString()` Width for the field picker formItem displayed in clauses within this FilterBuilder.
`java.lang.String`	`getInlineAndNotTitle()` Title for the "And Not" operator (only applicable to the "inline" appearance)
`java.lang.String`	`getInlineAndTitle()` Title for the "And" operator (only applicable to the "inline" appearance)
`java.lang.String`	`getInlineOrTitle()` Title for the "Or" operator (only applicable to the "inline" appearance)
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`getLogicalStructure()` Getter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
`java.lang.String`	`getMatchAllTitle()` Title for the "Match All" (and) operator when using `topOperatorAppearance`:"radio".
`java.lang.String`	`getMatchAnyTitle()` Title for the "Match Any" (or) operator when using `topOperatorAppearance`:"radio".
`java.lang.String`	`getMatchNoneTitle()` Title for the "Match None" (not) operator when using `topOperatorAppearance`:"radio".
`Canvas[]`	`getMembers()` An array of canvases that will be contained within this layout.
`java.lang.String`	`getMissingFieldPrompt()` The message to display next to fieldNames that do not exist in the available dataSource.
`Label`	`getModeSwitcher()` Label to change between simple and advanced mode.
`java.lang.String`	`getModeSwitcherAdvancedMessage()` Title for the "Advanced.." mode switcher label (only applicable to the "radio" appearance).
`java.lang.String`	`getModeSwitcherFlattenWarningMessage()` Message displayed when switching to "radio" mode if the criteria will be logically changed.
`java.lang.String`	`getModeSwitcherSimpleMessage()` Title for the "Simple Mode.." mode switcher label (only applicable to the "bracket" appearance).
`SelectItem`	`getOperatorPicker()` Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
`FormItem`	`getOperatorPickerProperties()` Properties to combine with the `operatorPicker` autoChild FormItem.
`java.lang.String`	`getOperatorPickerTitle()` The title for the operator-picker select-item.
`java.lang.Integer`	`getOperatorPickerWidth()` Width for the operator picker formItem displayed in clauses within this FilterBuilder.
`java.lang.String`	`getOperatorPickerWidthAsString()` Width for the operator picker formItem displayed in clauses within this FilterBuilder.
`static FilterBuilder`	`getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
`DynamicForm`	`getRadioOperatorForm()` With `TopOperatorAppearance`:"radio", form that appears above the stack of clauses and allows picking the `LogicalOperator` for the overall FilterBuilder.
`HLayout`	`getRadioOperatorLayout()` HLayout of radioOperationForm and optional modeSwitcher.
`java.lang.String`	`getRadioOperatorTitle()` The title for the Operator RadioGroupItem displayed in the `radioOperatorForm`.
`java.lang.String`	`getRangeSeparator()` For operators that check that a value is within a range, text to show between the start and end input fields for specifying the limits of the range.
`ImgButton`	`getRemoveButton()` The removal ImgButton that appears before each clause if `showRemoveButton` is set.
`java.lang.String`	`getRemoveButtonPrompt()` The hover prompt text for the remove button.
`java.lang.Boolean`	`getRetainValuesAcrossFields()` Dictates whether values entered by a user should be retained in the value fields when a different field is selected.
`java.lang.Boolean`	`getSaveOnEnter()` If true, when the user hits the Enter key while focused in a text-item in this FilterBuilder, we automatically invoke the user-supplied `FilterBuilder.search()` method.
`FilterClause[]`	`getSelectedClauses()` Returns the list of this FilterBuilder's FilterClauses that are currently selected.
`java.lang.Boolean`	`getShowAddButton()` If set, a button will be shown underneath all current clauses allowing a new clause to be added.
`java.lang.Boolean`	`getShowFieldTitles()` If true (the default), show field titles in the drop-down box used to select a field for querying.
`java.lang.Boolean`	`getShowModeSwitcher()` When enabled allows FilterBuilder in `topOperatorAppearance:"radio"` or `topOperatorAppearance:"bracket"` mode to be switch to the other view by the user.
`java.lang.Boolean`	`getShowRemoveButton()` If set, a button will be shown for each clause allowing it to be removed.
`java.lang.Boolean`	`getShowSelectionCheckbox()` If true, causes a CheckboxItem to appear to the left of each clause in "inline" `appearance`.
`java.lang.Boolean`	`getShowSubClauseButton()` Whether to show a button that allows the user to add subclauses.
`java.lang.Boolean`	`getSortFields()` Should the `FieldPicker` items be sorted alphabetically in the drop down list.
`IButton`	`getSubClauseButton()` Button allowing the user to add subclauses grouped by a `LogicalOperator`.
`java.lang.String`	`getSubClauseButtonPrompt()` The hover prompt text for the subClauseButton.
`java.lang.String`	`getSubClauseButtonTitle()` The title of the subClauseButton
`LogicalOperator`	`getTopOperator()` Default logical operator for all top-level clauses in the FilterBuilder.
`TopOperatorAppearance`	`getTopOperatorAppearance()` How to display and edit the `top-level operator` for this FilterBuilder.
`DynamicForm`	`getTopOperatorForm()` With `TopOperatorAppearance` "bracket" and "inline", a form that appears to the left of the stack of clauses and allows picking the `LogicalOperator` for the overall FilterBuilder (or for that specific FilterClause, in the case of "inline")
`SelectItem`	`getTopOperatorItem()` Automatically generated SelectItem autoChild shown in the `topOperatorForm`.
`int`	`getTopOperatorItemWidth()` Width for the `topOperatorItem` autoChild.
`java.lang.String`	`getTopOperatorItemWidthAsString()` Width for the `topOperatorItem` autoChild.
`OperatorId[]`	`getTopOperatorOptions()` Logical operators to allow for `TopOperatorAppearance`s of "radio" and "bracket".
`java.lang.String`	`getTopOperatorTitle()` The title for the left-aligned Operator selectItem in the `topOperatorForm`.
`java.lang.Boolean`	`getValidateOnChange()` If true (the default), validates each entered value when it changes, to make sure it is a a valid value of its type (valid string, number, and so on).
`FormItem`	`getValueFieldProperties(FieldType type, java.lang.String fieldName, OperatorId operatorId, ValueItemType itemType, java.lang.String fieldType)` Override to return properties for the FormItem(s) used for the "value" field displayed within clauses within this filterBuilder.
`java.lang.Integer`	`getValueItemWidth()` Width for the value-chooser formItem displayed in clauses within this FilterBuilder.
`java.lang.String`	`getValueItemWidthAsString()` Width for the value-chooser formItem displayed in clauses within this FilterBuilder.
`protected void`	`onInit_FilterBuilder()`
`void`	`onInit()`
`void`	`removeClause(FilterClause clause)` Remove a clause this FilterBuilder is currently showing.
`void`	`setAddButtonPrompt(java.lang.String addButtonPrompt)` The hover prompt text for the add button.
`void`	`setAllowEmpty(java.lang.Boolean allowEmpty)` If set to false, the last clause cannot be removed.
`void`	`setCriteria(AdvancedCriteria criteria)` Initial criteria.
`void`	`setDataSource(DataSource dataSource)` DataSource this filter should use for field definitions and available ${isc.DocUtils.linkForRef('object:Operator')}s.
`static void`	`setDefaultProperties(FilterBuilder filterBuilderProperties)` Class level method to set the default properties of this class.
`void`	`setFieldDataSource(DataSource fieldDataSource)` If specified, the FilterBuilder will dynamically fetch DataSourceField definitions from this DataSource rather than using `dataSource`.
`void`	`setFieldOperatorCustomizer(FieldOperatorCustomizer customizer)` This method installs a customizer that returns the set of OperatorIds applicable to the passed fieldName
`void`	`setFieldPickerProperties(FormItem fieldPickerProperties)` Properties to combine with the `FieldPicker` autoChild FormItem.
`void`	`setFieldPickerTitle(java.lang.String fieldPickerTitle)` The title for the `field-picker` select-item.
`void`	`setFieldPickerWidth(java.lang.Integer fieldPickerWidth)` Width for the field picker formItem displayed in clauses within this FilterBuilder.
`void`	`setFieldPickerWidth(java.lang.String fieldPickerWidth)` Width for the field picker formItem displayed in clauses within this FilterBuilder.
`void`	`setInlineAndNotTitle(java.lang.String inlineAndNotTitle)` Title for the "And Not" operator (only applicable to the "inline" appearance)
`void`	`setInlineAndTitle(java.lang.String inlineAndTitle)` Title for the "And" operator (only applicable to the "inline" appearance)
`void`	`setInlineOrTitle(java.lang.String inlineOrTitle)` Title for the "Or" operator (only applicable to the "inline" appearance)
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`setLogicalStructure(com.smartgwt.logicalstructure.widgets.form.FilterBuilderLogicalStructure s)` Setter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
`void`	`setMatchAllTitle(java.lang.String matchAllTitle)` Title for the "Match All" (and) operator when using `topOperatorAppearance`:"radio".
`void`	`setMatchAnyTitle(java.lang.String matchAnyTitle)` Title for the "Match Any" (or) operator when using `topOperatorAppearance`:"radio".
`void`	`setMatchNoneTitle(java.lang.String matchNoneTitle)` Title for the "Match None" (not) operator when using `topOperatorAppearance`:"radio".
`void`	`setMissingFieldPrompt(java.lang.String missingFieldPrompt)` The message to display next to fieldNames that do not exist in the available dataSource.
`void`	`setModeSwitcherAdvancedMessage(java.lang.String modeSwitcherAdvancedMessage)` Title for the "Advanced.." mode switcher label (only applicable to the "radio" appearance).
`void`	`setModeSwitcherFlattenWarningMessage(java.lang.String modeSwitcherFlattenWarningMessage)` Message displayed when switching to "radio" mode if the criteria will be logically changed.
`void`	`setModeSwitcherSimpleMessage(java.lang.String modeSwitcherSimpleMessage)` Title for the "Simple Mode.." mode switcher label (only applicable to the "bracket" appearance).
`void`	`setOperatorPickerProperties(FormItem operatorPickerProperties)` Properties to combine with the `operatorPicker` autoChild FormItem.
`void`	`setOperatorPickerTitle(java.lang.String operatorPickerTitle)` The title for the operator-picker select-item.
`void`	`setOperatorPickerWidth(java.lang.Integer operatorPickerWidth)` Width for the operator picker formItem displayed in clauses within this FilterBuilder.
`void`	`setOperatorPickerWidth(java.lang.String operatorPickerWidth)` Width for the operator picker formItem displayed in clauses within this FilterBuilder.
`void`	`setRadioOperatorTitle(java.lang.String radioOperatorTitle)` The title for the Operator RadioGroupItem displayed in the `radioOperatorForm`.
`void`	`setRangeSeparator(java.lang.String rangeSeparator)` For operators that check that a value is within a range, text to show between the start and end input fields for specifying the limits of the range.
`void`	`setRemoveButtonPrompt(java.lang.String removeButtonPrompt)` The hover prompt text for the remove button.
`void`	`setRetainValuesAcrossFields(java.lang.Boolean retainValuesAcrossFields)` Dictates whether values entered by a user should be retained in the value fields when a different field is selected.
`void`	`setSaveOnEnter(java.lang.Boolean saveOnEnter)` If true, when the user hits the Enter key while focused in a text-item in this FilterBuilder, we automatically invoke the user-supplied `FilterBuilder.search()` method.
`void`	`setShowAddButton(java.lang.Boolean showAddButton)` If set, a button will be shown underneath all current clauses allowing a new clause to be added.
`void`	`setShowFieldTitles(boolean showFieldTitles)` If true (the default), show field titles in the drop-down box used to select a field for querying.
`void`	`setShowFieldTitles(java.lang.Boolean showFieldTitles)` If true (the default), show field titles in the drop-down box used to select a field for querying.
`void`	`setShowModeSwitcher(java.lang.Boolean showModeSwitcher)` When enabled allows FilterBuilder in `topOperatorAppearance:"radio"` or `topOperatorAppearance:"bracket"` mode to be switch to the other view by the user.
`void`	`setShowRemoveButton(java.lang.Boolean showRemoveButton)` If set, a button will be shown for each clause allowing it to be removed.
`void`	`setShowSelectionCheckbox(java.lang.Boolean showSelectionCheckbox)` If true, causes a CheckboxItem to appear to the left of each clause in "inline" `appearance`.
`void`	`setShowSubClauseButton(java.lang.Boolean showSubClauseButton)` Whether to show a button that allows the user to add subclauses.
`void`	`setSortFields(java.lang.Boolean sortFields)` Should the `FieldPicker` items be sorted alphabetically in the drop down list.
`void`	`setSubClauseButtonPrompt(java.lang.String subClauseButtonPrompt)` The hover prompt text for the subClauseButton.
`void`	`setSubClauseButtonTitle(java.lang.String subClauseButtonTitle)` The title of the subClauseButton
`void`	`setTopOperator(LogicalOperator topOperator)` Default logical operator for all top-level clauses in the FilterBuilder.
`void`	`setTopOperatorAppearance(TopOperatorAppearance topOperatorAppearance)` How to display and edit the `top-level operator` for this FilterBuilder.
`void`	`setTopOperatorItemWidth(int topOperatorItemWidth)` Width for the `topOperatorItem` autoChild.
`void`	`setTopOperatorItemWidth(java.lang.String topOperatorItemWidth)` Width for the `topOperatorItem` autoChild.
`void`	`setTopOperatorOptions(OperatorId... topOperatorOptions)` Logical operators to allow for `TopOperatorAppearance`s of "radio" and "bracket".
`void`	`setTopOperatorTitle(java.lang.String topOperatorTitle)` The title for the left-aligned Operator selectItem in the `topOperatorForm`.
`void`	`setValidateOnChange(java.lang.Boolean validateOnChange)` If true (the default), validates each entered value when it changes, to make sure it is a a valid value of its type (valid string, number, and so on).
`void`	`setValueItemWidth(java.lang.Integer valueItemWidth)` Width for the value-chooser formItem displayed in clauses within this FilterBuilder.
`void`	`setValueItemWidth(java.lang.String valueItemWidth)` Width for the value-chooser formItem displayed in clauses within this FilterBuilder.
`java.lang.Boolean`	`validate()` Validate the clauses of this FilterBuilder.

Methods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEditProxyConstructor, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembersLength, getMembersMargin, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEditProxyConstructor, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember

Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, printComponents, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeBy, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, applyFactoryProperties, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent

- Constructor Detail
  - FilterBuilder
```
public FilterBuilder()
```
  - FilterBuilder
```
public FilterBuilder(com.google.gwt.core.client.JavaScriptObject jsObj)
```
- Method Detail
  - getOrCreateRef
```
public static FilterBuilder getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)
```
    Changes the defaults for Canvas AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)
```
    Changes the defaults for FormItem AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - create
```
protected com.google.gwt.core.client.JavaScriptObject create()
```
    Overrides:
    
    create in class Layout
  - getAddButton
```
public ImgButton getAddButton()
                       throws java.lang.IllegalStateException
```
    An ImgButton that allows new clauses to be added if showAddButton is set.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    ImgButton
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - setAddButtonPrompt
```
public void setAddButtonPrompt(java.lang.String addButtonPrompt)
                        throws java.lang.IllegalStateException
```
    The hover prompt text for the add button.
    
    Parameters:
    
    addButtonPrompt - Default value is "Add"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getAddButtonPrompt
```
public java.lang.String getAddButtonPrompt()
```
    The hover prompt text for the add button.
    
    Returns:
    
    String
  - setAllowEmpty
```
public void setAllowEmpty(java.lang.Boolean allowEmpty)
                   throws java.lang.IllegalStateException
```
    If set to false, the last clause cannot be removed.
    
    Parameters:
    
    allowEmpty - Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getAllowEmpty
```
public java.lang.Boolean getAllowEmpty()
```
    If set to false, the last clause cannot be removed.
    
    Returns:
    
    Boolean
  - getBracket
```
public Canvas getBracket()
```
    Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.
    Widget used as a "bracket" to hint to the user that a subclause groups several field-by-field filter criteria under one logical operator.
    By default, a simple CSS-style Canvas with borders on three sides. A vertical StretchImg could provide a more elaborate appearance.
    
    Returns:
    
    null
  - getClauseStack
```
public VStack getClauseStack()
                      throws java.lang.IllegalStateException
```
    VStack of all clauses that are part of this FilterBuilder
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    VStack
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - setFieldDataSource
```
public void setFieldDataSource(DataSource fieldDataSource)
                        throws java.lang.IllegalStateException
```
    If specified, the FilterBuilder will dynamically fetch DataSourceField definitions from this DataSource rather than using dataSource. The FieldPicker will default to being a ComboBoxItem rather than a SelectItem so that the user will have type-ahead auto-completion.
    The records returned from the fieldDataSource must have properties corresponding to a DataSourceField definition, at a minimum, "name" and "type". Any property legal on a DataSourceField is legal on the returned records, including valueMap.
    Even when a fieldDataSource is specified, dataSource may still be specified in order to control the list of valid operators for each field.
    
    Parameters:
    
    fieldDataSource - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getFieldDataSource
```
public DataSource getFieldDataSource()
```
    If specified, the FilterBuilder will dynamically fetch DataSourceField definitions from this DataSource rather than using dataSource. The FieldPicker will default to being a ComboBoxItem rather than a SelectItem so that the user will have type-ahead auto-completion.
    The records returned from the fieldDataSource must have properties corresponding to a DataSourceField definition, at a minimum, "name" and "type". Any property legal on a DataSourceField is legal on the returned records, including valueMap.
    Even when a fieldDataSource is specified, dataSource may still be specified in order to control the list of valid operators for each field.
    
    Returns:
    
    DataSource
  - setFieldPickerProperties
```
public void setFieldPickerProperties(FormItem fieldPickerProperties)
                              throws java.lang.IllegalStateException
```
    Properties to combine with the FieldPicker autoChild FormItem.
    
    Parameters:
    
    fieldPickerProperties - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getFieldPickerProperties
```
public FormItem getFieldPickerProperties()
```
    Properties to combine with the FieldPicker autoChild FormItem.
    
    Returns:
    
    FormItem
  - setFieldPickerTitle
```
public void setFieldPickerTitle(java.lang.String fieldPickerTitle)
                         throws java.lang.IllegalStateException
```
    The title for the field-picker select-item.
    
    Parameters:
    
    fieldPickerTitle - Default value is "Field Name"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getFieldPickerTitle
```
public java.lang.String getFieldPickerTitle()
```
    The title for the field-picker select-item.
    
    Returns:
    
    String
  - setFieldPickerWidth
```
public void setFieldPickerWidth(java.lang.Integer fieldPickerWidth)
                         throws java.lang.IllegalStateException
```
    Width for the field picker formItem displayed in clauses within this FilterBuilder.
    
    Parameters:
    
    fieldPickerWidth - Default value is "*"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getFieldPickerWidth
```
public java.lang.Integer getFieldPickerWidth()
```
    Width for the field picker formItem displayed in clauses within this FilterBuilder.
    
    Returns:
    
    Integer
  - setFieldPickerWidth
```
public void setFieldPickerWidth(java.lang.String fieldPickerWidth)
                         throws java.lang.IllegalStateException
```
    Width for the field picker formItem displayed in clauses within this FilterBuilder.
    
    Parameters:
    
    fieldPickerWidth - Default value is "*"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getFieldPickerWidthAsString
```
public java.lang.String getFieldPickerWidthAsString()
```
    Width for the field picker formItem displayed in clauses within this FilterBuilder.
    
    Returns:
    
    String
  - setInlineAndNotTitle
```
public void setInlineAndNotTitle(java.lang.String inlineAndNotTitle)
                          throws java.lang.IllegalStateException
```
    Title for the "And Not" operator (only applicable to the "inline" appearance)
    
    Parameters:
    
    inlineAndNotTitle - Default value is "and not"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getInlineAndNotTitle
```
public java.lang.String getInlineAndNotTitle()
```
    Title for the "And Not" operator (only applicable to the "inline" appearance)
    
    Returns:
    
    String
  - setInlineAndTitle
```
public void setInlineAndTitle(java.lang.String inlineAndTitle)
                       throws java.lang.IllegalStateException
```
    Title for the "And" operator (only applicable to the "inline" appearance)
    
    Parameters:
    
    inlineAndTitle - Default value is "and"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getInlineAndTitle
```
public java.lang.String getInlineAndTitle()
```
    Title for the "And" operator (only applicable to the "inline" appearance)
    
    Returns:
    
    String
  - setInlineOrTitle
```
public void setInlineOrTitle(java.lang.String inlineOrTitle)
                      throws java.lang.IllegalStateException
```
    Title for the "Or" operator (only applicable to the "inline" appearance)
    
    Parameters:
    
    inlineOrTitle - Default value is "or"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getInlineOrTitle
```
public java.lang.String getInlineOrTitle()
```
    Title for the "Or" operator (only applicable to the "inline" appearance)
    
    Returns:
    
    String
  - setMatchAllTitle
```
public void setMatchAllTitle(java.lang.String matchAllTitle)
                      throws java.lang.IllegalStateException
```
    Title for the "Match All" (and) operator when using topOperatorAppearance:"radio".
    
    Parameters:
    
    matchAllTitle - Default value is "Match All"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getMatchAllTitle
```
public java.lang.String getMatchAllTitle()
```
    Title for the "Match All" (and) operator when using topOperatorAppearance:"radio".
    
    Returns:
    
    String
  - setMatchAnyTitle
```
public void setMatchAnyTitle(java.lang.String matchAnyTitle)
                      throws java.lang.IllegalStateException
```
    Title for the "Match Any" (or) operator when using topOperatorAppearance:"radio".
    
    Parameters:
    
    matchAnyTitle - Default value is "Match Any"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getMatchAnyTitle
```
public java.lang.String getMatchAnyTitle()
```
    Title for the "Match Any" (or) operator when using topOperatorAppearance:"radio".
    
    Returns:
    
    String
  - setMatchNoneTitle
```
public void setMatchNoneTitle(java.lang.String matchNoneTitle)
                       throws java.lang.IllegalStateException
```
    Title for the "Match None" (not) operator when using topOperatorAppearance:"radio".
    
    Parameters:
    
    matchNoneTitle - Default value is "Match None"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getMatchNoneTitle
```
public java.lang.String getMatchNoneTitle()
```
    Title for the "Match None" (not) operator when using topOperatorAppearance:"radio".
    
    Returns:
    
    String
  - setMissingFieldPrompt
```
public void setMissingFieldPrompt(java.lang.String missingFieldPrompt)
                           throws java.lang.IllegalStateException
```
    The message to display next to fieldNames that do not exist in the available dataSource.
    
    Parameters:
    
    missingFieldPrompt - Default value is "[missing field definition]"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getMissingFieldPrompt
```
public java.lang.String getMissingFieldPrompt()
```
    The message to display next to fieldNames that do not exist in the available dataSource.
    
    Returns:
    
    String
  - getModeSwitcher
```
public Label getModeSwitcher()
                      throws java.lang.IllegalStateException
```
    Label to change between simple and advanced mode. When clicked the filter mode is switched to the other mode. This label is only shown if showModeSwitcher is true.
    Shows either modeSwitcherSimpleMessage or modeSwitcherAdvancedMessage depending on the current state of the filter.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    Label
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - setModeSwitcherAdvancedMessage
```
public void setModeSwitcherAdvancedMessage(java.lang.String modeSwitcherAdvancedMessage)
                                    throws java.lang.IllegalStateException
```
    Title for the "Advanced.." mode switcher label (only applicable to the "radio" appearance).
    
    Parameters:
    
    modeSwitcherAdvancedMessage - Default value is "Advanced.."
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getModeSwitcherAdvancedMessage
```
public java.lang.String getModeSwitcherAdvancedMessage()
```
    Title for the "Advanced.." mode switcher label (only applicable to the "radio" appearance).
    
    Returns:
    
    String
  - setModeSwitcherFlattenWarningMessage
```
public void setModeSwitcherFlattenWarningMessage(java.lang.String modeSwitcherFlattenWarningMessage)
                                          throws java.lang.IllegalStateException
```
    Message displayed when switching to "radio" mode if the criteria will be logically changed.
    
    Parameters:
    
    modeSwitcherFlattenWarningMessage - Default value is "Criteria will be modified to fit in simpler editing interface"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getModeSwitcherFlattenWarningMessage
```
public java.lang.String getModeSwitcherFlattenWarningMessage()
```
    Message displayed when switching to "radio" mode if the criteria will be logically changed.
    
    Returns:
    
    String
  - setModeSwitcherSimpleMessage
```
public void setModeSwitcherSimpleMessage(java.lang.String modeSwitcherSimpleMessage)
                                  throws java.lang.IllegalStateException
```
    Title for the "Simple Mode.." mode switcher label (only applicable to the "bracket" appearance).
    
    Parameters:
    
    modeSwitcherSimpleMessage - Default value is "Simple Mode.."
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getModeSwitcherSimpleMessage
```
public java.lang.String getModeSwitcherSimpleMessage()
```
    Title for the "Simple Mode.." mode switcher label (only applicable to the "bracket" appearance).
    
    Returns:
    
    String
  - getOperatorPicker
```
public SelectItem getOperatorPicker()
```
    Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.
    AutoChild for the FormItem that allows a user to select the operator when creating filter clauses. Each clause will create an operatorPicker automatically. To customize this item, use operatorPickerProperties
    
    Returns:
    
    null
  - setOperatorPickerProperties
```
public void setOperatorPickerProperties(FormItem operatorPickerProperties)
                                 throws java.lang.IllegalStateException
```
    Properties to combine with the operatorPicker autoChild FormItem.
    
    Parameters:
    
    operatorPickerProperties - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getOperatorPickerProperties
```
public FormItem getOperatorPickerProperties()
```
    Properties to combine with the operatorPicker autoChild FormItem.
    
    Returns:
    
    FormItem
  - setOperatorPickerTitle
```
public void setOperatorPickerTitle(java.lang.String operatorPickerTitle)
                            throws java.lang.IllegalStateException
```
    The title for the operator-picker select-item.
    
    Parameters:
    
    operatorPickerTitle - Default value is "Operator"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getOperatorPickerTitle
```
public java.lang.String getOperatorPickerTitle()
```
    The title for the operator-picker select-item.
    
    Returns:
    
    String
  - setOperatorPickerWidth
```
public void setOperatorPickerWidth(java.lang.Integer operatorPickerWidth)
                            throws java.lang.IllegalStateException
```
    Width for the operator picker formItem displayed in clauses within this FilterBuilder.
    
    Parameters:
    
    operatorPickerWidth - Default value is 150
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getOperatorPickerWidth
```
public java.lang.Integer getOperatorPickerWidth()
```
    Width for the operator picker formItem displayed in clauses within this FilterBuilder.
    
    Returns:
    
    Integer
  - setOperatorPickerWidth
```
public void setOperatorPickerWidth(java.lang.String operatorPickerWidth)
                            throws java.lang.IllegalStateException
```
    Width for the operator picker formItem displayed in clauses within this FilterBuilder.
    
    Parameters:
    
    operatorPickerWidth - Default value is 150
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getOperatorPickerWidthAsString
```
public java.lang.String getOperatorPickerWidthAsString()
```
    Width for the operator picker formItem displayed in clauses within this FilterBuilder.
    
    Returns:
    
    String
  - getRadioOperatorForm
```
public DynamicForm getRadioOperatorForm()
                                 throws java.lang.IllegalStateException
```
    With TopOperatorAppearance:"radio", form that appears above the stack of clauses and allows picking the LogicalOperator for the overall FilterBuilder.
    By default, consists of a simple RadioGroupItem.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    DynamicForm
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - getRadioOperatorLayout
```
public HLayout getRadioOperatorLayout()
                               throws java.lang.IllegalStateException
```
    HLayout of radioOperationForm and optional modeSwitcher.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    HLayout
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - setRadioOperatorTitle
```
public void setRadioOperatorTitle(java.lang.String radioOperatorTitle)
                           throws java.lang.IllegalStateException
```
    The title for the Operator RadioGroupItem displayed in the radioOperatorForm.
    
    Parameters:
    
    radioOperatorTitle - Default value is "Overall Operator"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getRadioOperatorTitle
```
public java.lang.String getRadioOperatorTitle()
```
    The title for the Operator RadioGroupItem displayed in the radioOperatorForm.
    
    Returns:
    
    String
  - setRangeSeparator
```
public void setRangeSeparator(java.lang.String rangeSeparator)
                       throws java.lang.IllegalStateException
```
    For operators that check that a value is within a range, text to show between the start and end input fields for specifying the limits of the range.
    
    Parameters:
    
    rangeSeparator - Default value is "and"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getRangeSeparator
```
public java.lang.String getRangeSeparator()
```
    For operators that check that a value is within a range, text to show between the start and end input fields for specifying the limits of the range.
    
    Returns:
    
    String
  - getRemoveButton
```
public ImgButton getRemoveButton()
                          throws java.lang.IllegalStateException
```
    The removal ImgButton that appears before each clause if showRemoveButton is set.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    ImgButton
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - setRemoveButtonPrompt
```
public void setRemoveButtonPrompt(java.lang.String removeButtonPrompt)
                           throws java.lang.IllegalStateException
```
    The hover prompt text for the remove button.
    
    Parameters:
    
    removeButtonPrompt - Default value is "Remove"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getRemoveButtonPrompt
```
public java.lang.String getRemoveButtonPrompt()
```
    The hover prompt text for the remove button.
    
    Returns:
    
    String
  - setRetainValuesAcrossFields
```
public void setRetainValuesAcrossFields(java.lang.Boolean retainValuesAcrossFields)
```
    Dictates whether values entered by a user should be retained in the value fields when a different field is selected. Default value is true.
    Note that, when switching between fields that have an optionDataSource or valueMap, this property is ignored and the values are never retained.
    
    Parameters:
    
    retainValuesAcrossFields - Default value is true
  - getRetainValuesAcrossFields
```
public java.lang.Boolean getRetainValuesAcrossFields()
```
    Dictates whether values entered by a user should be retained in the value fields when a different field is selected. Default value is true.
    Note that, when switching between fields that have an optionDataSource or valueMap, this property is ignored and the values are never retained.
    
    Returns:
    
    Boolean
  - setSaveOnEnter
```
public void setSaveOnEnter(java.lang.Boolean saveOnEnter)
                    throws java.lang.IllegalStateException
```
    If true, when the user hits the Enter key while focused in a text-item in this FilterBuilder, we automatically invoke the user-supplied FilterBuilder.search() method.
    
    Parameters:
    
    saveOnEnter - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getSaveOnEnter
```
public java.lang.Boolean getSaveOnEnter()
```
    If true, when the user hits the Enter key while focused in a text-item in this FilterBuilder, we automatically invoke the user-supplied FilterBuilder.search() method.
    
    Returns:
    
    Boolean
  - setShowAddButton
```
public void setShowAddButton(java.lang.Boolean showAddButton)
                      throws java.lang.IllegalStateException
```
    If set, a button will be shown underneath all current clauses allowing a new clause to be added.
    
    Parameters:
    
    showAddButton - Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getShowAddButton
```
public java.lang.Boolean getShowAddButton()
```
    If set, a button will be shown underneath all current clauses allowing a new clause to be added.
    
    Returns:
    
    Boolean
  - setShowFieldTitles
```
public void setShowFieldTitles(java.lang.Boolean showFieldTitles)
                        throws java.lang.IllegalStateException
```
    If true (the default), show field titles in the drop-down box used to select a field for querying. If false, show actual field names instead. When multiple DataSources are configured, multiDSFieldFormat controls how field names appear in the field drop-down.
    
    Parameters:
    
    showFieldTitles - Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getShowFieldTitles
```
public java.lang.Boolean getShowFieldTitles()
```
    If true (the default), show field titles in the drop-down box used to select a field for querying. If false, show actual field names instead. When multiple DataSources are configured, multiDSFieldFormat controls how field names appear in the field drop-down.
    
    Returns:
    
    Boolean
  - setShowModeSwitcher
```
public void setShowModeSwitcher(java.lang.Boolean showModeSwitcher)
                         throws java.lang.IllegalStateException
```
    When enabled allows FilterBuilder in topOperatorAppearance:"radio" or topOperatorAppearance:"bracket" mode to be switch to the other view by the user. "radio" mode is considered simple where "bracket" mode is advanced mode.
    Note that when switching from "bracket" to "radio" mode any entered criteria will be flattened by calling DataSource.flattenCriteria(). If the criteria cannot be flattened without losing symantics (see DataSource.canFlattenCriteria()) the user is prompted to confirm.
    If showModeSwitcher is set and topOperatorAppearance is unset:
    - when first drawn, the filterBuilder will choose which mode to use based on the provided criteria if any: advanced mode ("bracket") will be used if AdvancedCriteria are provided which cannot be flattened without loss of data (see DataSource.canFlattenCriteria()), otherwise simple mode ("radio") will be used.
    - for any calls to setCriteria() after draw, the FilterBuilder will switch to advanced mode if the criteria cannot be shown in simple mode without losing information, but will never automatically switch to simple mode, but an explicit call setTopOperatorAppearance("radio") can be used to do so.
    Parameters:
    
    showModeSwitcher - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    setModeSwitcherSimpleMessage(java.lang.String), setModeSwitcherAdvancedMessage(java.lang.String), setModeSwitcherFlattenWarningMessage(java.lang.String)
  - getShowModeSwitcher
```
public java.lang.Boolean getShowModeSwitcher()
```
    When enabled allows FilterBuilder in topOperatorAppearance:"radio" or topOperatorAppearance:"bracket" mode to be switch to the other view by the user. "radio" mode is considered simple where "bracket" mode is advanced mode.
    Note that when switching from "bracket" to "radio" mode any entered criteria will be flattened by calling DataSource.flattenCriteria(). If the criteria cannot be flattened without losing symantics (see DataSource.canFlattenCriteria()) the user is prompted to confirm.
    If showModeSwitcher is set and topOperatorAppearance is unset:
    - when first drawn, the filterBuilder will choose which mode to use based on the provided criteria if any: advanced mode ("bracket") will be used if AdvancedCriteria are provided which cannot be flattened without loss of data (see DataSource.canFlattenCriteria()), otherwise simple mode ("radio") will be used.
    - for any calls to setCriteria() after draw, the FilterBuilder will switch to advanced mode if the criteria cannot be shown in simple mode without losing information, but will never automatically switch to simple mode, but an explicit call setTopOperatorAppearance("radio") can be used to do so.
    Returns:
    
    Boolean
    
    See Also:
    
    getModeSwitcherSimpleMessage(), getModeSwitcherAdvancedMessage(), getModeSwitcherFlattenWarningMessage()
  - setShowRemoveButton
```
public void setShowRemoveButton(java.lang.Boolean showRemoveButton)
                         throws java.lang.IllegalStateException
```
    If set, a button will be shown for each clause allowing it to be removed.
    
    Parameters:
    
    showRemoveButton - Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getShowRemoveButton
```
public java.lang.Boolean getShowRemoveButton()
```
    If set, a button will be shown for each clause allowing it to be removed.
    
    Returns:
    
    Boolean
  - setShowSelectionCheckbox
```
public void setShowSelectionCheckbox(java.lang.Boolean showSelectionCheckbox)
                              throws java.lang.IllegalStateException
```
    If true, causes a CheckboxItem to appear to the left of each clause in "inline" appearance. This checkbox allows the user to select individual clauses so that, for example, clauses can be removed from the filterBuilder by application code. This property is ignored for appearances other than "inline".
    
    Parameters:
    
    showSelectionCheckbox - Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getShowSelectionCheckbox
```
public java.lang.Boolean getShowSelectionCheckbox()
```
    If true, causes a CheckboxItem to appear to the left of each clause in "inline" appearance. This checkbox allows the user to select individual clauses so that, for example, clauses can be removed from the filterBuilder by application code. This property is ignored for appearances other than "inline".
    
    Returns:
    
    Boolean
  - setShowSubClauseButton
```
public void setShowSubClauseButton(java.lang.Boolean showSubClauseButton)
                            throws java.lang.IllegalStateException
```
    Whether to show a button that allows the user to add subclauses. Defaults to false if the TopOperatorAppearance is "radio" or "inline", true in all other cases.
    
    Parameters:
    
    showSubClauseButton - Default value is See Description
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getShowSubClauseButton
```
public java.lang.Boolean getShowSubClauseButton()
```
    Whether to show a button that allows the user to add subclauses. Defaults to false if the TopOperatorAppearance is "radio" or "inline", true in all other cases.
    
    Returns:
    
    Boolean
  - setSortFields
```
public void setSortFields(java.lang.Boolean sortFields)
                   throws java.lang.IllegalStateException
```
    Should the FieldPicker items be sorted alphabetically in the drop down list.
    
    Parameters:
    
    sortFields - Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getSortFields
```
public java.lang.Boolean getSortFields()
```
    Should the FieldPicker items be sorted alphabetically in the drop down list.
    
    Returns:
    
    Boolean
  - getSubClauseButton
```
public IButton getSubClauseButton()
                           throws java.lang.IllegalStateException
```
    Button allowing the user to add subclauses grouped by a LogicalOperator.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    IButton
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - setSubClauseButtonPrompt
```
public void setSubClauseButtonPrompt(java.lang.String subClauseButtonPrompt)
                              throws java.lang.IllegalStateException
```
    The hover prompt text for the subClauseButton.
    
    Parameters:
    
    subClauseButtonPrompt - Default value is "Add Subclause"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getSubClauseButtonPrompt
```
public java.lang.String getSubClauseButtonPrompt()
```
    The hover prompt text for the subClauseButton.
    
    Returns:
    
    String
  - setSubClauseButtonTitle
```
public void setSubClauseButtonTitle(java.lang.String subClauseButtonTitle)
                             throws java.lang.IllegalStateException
```
    The title of the subClauseButton
    
    Parameters:
    
    subClauseButtonTitle - Default value is "+()"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getSubClauseButtonTitle
```
public java.lang.String getSubClauseButtonTitle()
```
    The title of the subClauseButton
    
    Returns:
    
    String
  - setTopOperator
```
public void setTopOperator(LogicalOperator topOperator)
```
    Default logical operator for all top-level clauses in the FilterBuilder.
    May be able to be changed by the user via the UI, according to TopOperatorAppearance.
    
    If this method is called after the component has been drawn/initialized: Programmatically change the topOperator for this FilterBuilder.
    
    Parameters:
    
    topOperator - new top-level operator. Default value is "and"
  - getTopOperator
```
public LogicalOperator getTopOperator()
```
    Default logical operator for all top-level clauses in the FilterBuilder.
    May be able to be changed by the user via the UI, according to TopOperatorAppearance.
    
    Returns:
    
    LogicalOperator
  - setTopOperatorAppearance
```
public void setTopOperatorAppearance(TopOperatorAppearance topOperatorAppearance)
```
    How to display and edit the top-level operator for this FilterBuilder.
    See TopOperatorAppearance for a list of options.
    
    If this method is called after the component has been drawn/initialized: Modify TopOperatorAppearance at runtime.
    Note that when changing from "bracket" to "radio" mode the criteria will be flattened by calling DataSource.flattenCriteria() which could result in a logical change to the criteria.
    
    Parameters:
    
    topOperatorAppearance - new topOperatorAppearance. Default value is "bracket"
  - getTopOperatorAppearance
```
public TopOperatorAppearance getTopOperatorAppearance()
```
    How to display and edit the top-level operator for this FilterBuilder.
    See TopOperatorAppearance for a list of options.
    
    Returns:
    
    TopOperatorAppearance
  - getTopOperatorForm
```
public DynamicForm getTopOperatorForm()
                               throws java.lang.IllegalStateException
```
    With TopOperatorAppearance "bracket" and "inline", a form that appears to the left of the stack of clauses and allows picking the LogicalOperator for the overall FilterBuilder (or for that specific FilterClause, in the case of "inline")
    By default, consists of a CheckboxItem if showSelectionCheckbox is true, and a simple SelectItem containing the available logical operators.
    If this FilterBuilder shows nested sub-clauses, the same defaults will be applied to the top-operator item for each sub-clause.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    DynamicForm
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - getTopOperatorItem
```
public SelectItem getTopOperatorItem()
                              throws java.lang.IllegalStateException
```
    Automatically generated SelectItem autoChild shown in the topOperatorForm. Developers may customize this item using the standard autoChild pattern (by modifying topOperatorItemDefaults and topOperatorItemProperties).
    If this FilterBuilder shows nested sub-clauses, the same defaults will be applied to the top-operator item for each sub-clause.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    SelectItem
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - setTopOperatorItemWidth
```
public void setTopOperatorItemWidth(int topOperatorItemWidth)
                             throws java.lang.IllegalStateException
```
    Width for the topOperatorItem autoChild.
    
    Parameters:
    
    topOperatorItemWidth - Default value is "*"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getTopOperatorItemWidth
```
public int getTopOperatorItemWidth()
```
    Width for the topOperatorItem autoChild.
    
    Returns:
    
    int
  - setTopOperatorItemWidth
```
public void setTopOperatorItemWidth(java.lang.String topOperatorItemWidth)
                             throws java.lang.IllegalStateException
```
    Width for the topOperatorItem autoChild.
    
    Parameters:
    
    topOperatorItemWidth - Default value is "*"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getTopOperatorItemWidthAsString
```
public java.lang.String getTopOperatorItemWidthAsString()
```
    Width for the topOperatorItem autoChild.
    
    Returns:
    
    String
  - setTopOperatorOptions
```
public void setTopOperatorOptions(OperatorId... topOperatorOptions)
                           throws java.lang.IllegalStateException
```
    Logical operators to allow for TopOperatorAppearances of "radio" and "bracket".
    Note that this list may be further limited according to the available operators returned by the DataSource.
    
    Parameters:
    
    topOperatorOptions - Default value is ["and", "or", "not"]
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getTopOperatorOptions
```
public OperatorId[] getTopOperatorOptions()
```
    Logical operators to allow for TopOperatorAppearances of "radio" and "bracket".
    Note that this list may be further limited according to the available operators returned by the DataSource.
    
    Returns:
    
    OperatorId...
  - setTopOperatorTitle
```
public void setTopOperatorTitle(java.lang.String topOperatorTitle)
                         throws java.lang.IllegalStateException
```
    The title for the left-aligned Operator selectItem in the topOperatorForm.
    
    Parameters:
    
    topOperatorTitle - Default value is "Clause Operator"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getTopOperatorTitle
```
public java.lang.String getTopOperatorTitle()
```
    The title for the left-aligned Operator selectItem in the topOperatorForm.
    
    Returns:
    
    String
  - setValidateOnChange
```
public void setValidateOnChange(java.lang.Boolean validateOnChange)
                         throws java.lang.IllegalStateException
```
    If true (the default), validates each entered value when it changes, to make sure it is a a valid value of its type (valid string, number, and so on). No other validation is carried out. If you switch this property off, it is still possible to validate the FilterBuilder by calling validate() from your own code.
    
    Parameters:
    
    validateOnChange - Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getValidateOnChange
```
public java.lang.Boolean getValidateOnChange()
```
    If true (the default), validates each entered value when it changes, to make sure it is a a valid value of its type (valid string, number, and so on). No other validation is carried out. If you switch this property off, it is still possible to validate the FilterBuilder by calling validate() from your own code.
    
    Returns:
    
    Boolean
  - setValueItemWidth
```
public void setValueItemWidth(java.lang.Integer valueItemWidth)
                       throws java.lang.IllegalStateException
```
    Width for the value-chooser formItem displayed in clauses within this FilterBuilder. Note that depending on the selected operator type, this item may not be displayed, or may have different characteristics. See getValueFieldProperties() for information on customizing the value item.
    
    Parameters:
    
    valueItemWidth - Default value is 150
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getValueItemWidth
```
public java.lang.Integer getValueItemWidth()
```
    Width for the value-chooser formItem displayed in clauses within this FilterBuilder. Note that depending on the selected operator type, this item may not be displayed, or may have different characteristics. See getValueFieldProperties() for information on customizing the value item.
    
    Returns:
    
    Integer
  - setValueItemWidth
```
public void setValueItemWidth(java.lang.String valueItemWidth)
                       throws java.lang.IllegalStateException
```
    Width for the value-chooser formItem displayed in clauses within this FilterBuilder. Note that depending on the selected operator type, this item may not be displayed, or may have different characteristics. See getValueFieldProperties() for information on customizing the value item.
    
    Parameters:
    
    valueItemWidth - Default value is 150
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getValueItemWidthAsString
```
public java.lang.String getValueItemWidthAsString()
```
    Width for the value-chooser formItem displayed in clauses within this FilterBuilder. Note that depending on the selected operator type, this item may not be displayed, or may have different characteristics. See getValueFieldProperties() for information on customizing the value item.
    
    Returns:
    
    String
  - addClause
```
public void addClause(FilterClause filterClause)
```
    Add a new FilterClause to this FilterBuilder.
    This API is intended for the rare use case of adding a highly customized FilterClause component that does not include the standard field/operator/value picking interface, instead providing a custom interface and returning a criterion via FilterClause.getCriterion().
    If you just want to programmatically add a new FilterClause showing a specific Criterion use addCriterion().
    If you want to use the standard field/operator/value interface but provide a custom control for editing the value, see DataSource.addSearchOperator() and Operator.editorType.
    
    Parameters:
    
    filterClause - A FilterClause instance
  - addCriterion
```
public void addCriterion(Criterion criterion)
```
    Add a new criterion, including recursively adding sub-criteria for a criterion that contains other criteria.
    
    Parameters:
    
    criterion - new criterion to be added
  - clearCriteria
```
public void clearCriteria()
```
    Clear all current criteria.
  - addFilterChangedHandler
```
public com.google.gwt.event.shared.HandlerRegistration addFilterChangedHandler(FilterChangedHandler handler)
```
    Add a filterChanged handler.
    Handler fired when there is a change() event fired on any FormItem within the filterBuilder.
    
    Specified by:
    
    addFilterChangedHandler in interface HasFilterChangedHandlers
    
    Parameters:
    
    handler - the filterChanged handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - getEditorType
```
public java.lang.String getEditorType(DataSourceField field,
                                      OperatorId operatorId)
```
    Returns the type of editor to use for the field.
    Default behavior is to use the Operator.editorType for a custom operator, otherwise, use RelativeDateItem for before/after/between operators on date fields, otherwise, use the same editor as would be chosen by a SearchForm.
    
    Parameters:
    
    field - DataSourceField definition
    
    operatorId - OperatorId for the chosen operator
    
    Returns:
    
    Smart GWT class to use (must be subclass of FormItem)
  - getSelectedClauses
```
public FilterClause[] getSelectedClauses()
```
    Returns the list of this FilterBuilder's FilterClauses that are currently selected. A clause is "selected" if the user has checked the checkbox next to it; therefore, this method always returns an empty list unless the showSelectionCheckbox property is set. This method is only applicable where TopOperatorAppearance is "inline" (because that is the only appearance that supports showSelectionCheckbox)
    
    Returns:
    
    The list of selected clauses
  - addSearchHandler
```
public com.google.gwt.event.shared.HandlerRegistration addSearchHandler(SearchHandler handler)
```
    Add a search handler.
    A StringMethod that is automatically invoked if FilterBuilder.saveOnEnter is set and the user presses Enter whilst in a text-item in any clause or subclause.
    
    Specified by:
    
    addSearchHandler in interface HasSearchHandlers
    
    Parameters:
    
    handler - the search handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - validate
```
public java.lang.Boolean validate()
```
    Validate the clauses of this FilterBuilder.
    
    Returns:
    
    true if all clauses are valid, false otherwise
  - setDefaultProperties
```
public static void setDefaultProperties(FilterBuilder filterBuilderProperties)
```
    Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.
    Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
    
    Parameters:
    
    filterBuilderProperties - properties that should be used as new defaults when instances of this class are created
    
    See Also:
    
    SGWTProperties
  - onInit
```
public void onInit()
```
    Overrides:
    
    onInit in class Layout
  - onInit_FilterBuilder
```
protected void onInit_FilterBuilder()
```
  - setShowFieldTitles
```
public void setShowFieldTitles(boolean showFieldTitles)
                        throws java.lang.IllegalStateException
```
    If true (the default), show field titles in the drop-down box used to select a field for querying. If false, show actual field names instead.
    
    Parameters:
    
    showFieldTitles - showFieldTitles default is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - setDataSource
```
public void setDataSource(DataSource dataSource)
```
    DataSource this filter should use for field definitions and available ${isc.DocUtils.linkForRef('object:Operator')}s.
    
    Parameters:
    
    dataSource - dataSource Default value is null
  - getDataSource
```
public DataSource getDataSource()
```
    The DataSource that this component should bind to for default fields and for performing DSRequest.
    Can be specified as either a DataSource instance or the String ID of a DataSource.
    
    Returns:
    
    DataSource
  - setCriteria
```
public void setCriteria(AdvancedCriteria criteria)
```
    Initial criteria.
    When initialized with criteria, appropriate clauses for editing the provided criteria will be automatically generated.
    Note that empty or partial criteria are allowed, for example, criteria that specify fieldName only will generate an expression with the operator not chosen yet, and a ${isc.DocUtils.linkForRef('object:Criterion')} with a logical operator ("and" or "or") but not ${isc.DocUtils.linkForRef('criteria.criteria','subcriteria')} defined will generate an empty subclause. Set new criteria for editing.
    An interface for editing the provided criteria will be generated identically to what happens when initialized with Criteria.
    Any existing criteria entered by the user will be discarded.
    
    Parameters:
    
    criteria - new criteria. Pass null or {} to effectively reset the filterBuilder to it's initial state when no criteria are specified. Default value is null
  - getCriteria
```
public AdvancedCriteria getCriteria()
```
    Get the edited criteria entered by the user.
    
    Returns:
    
    Get the criteria entered by the user.
  - getCriteria
```
public AdvancedCriteria getCriteria(boolean includeEmptyValues)
```
    Get the edited criteria entered by the user.
    
    Parameters:
    
    By - default if a user has selected a field and operator type, but has failed to enter a value for the field it will be skipped. This optional parameter allows you to retrieve all criteria, including those with an empty value attribute.
    
    Returns:
    
    Get the criteria entered by the user.
  - removeClause
```
public void removeClause(FilterClause clause)
```
    Remove a clause this FilterBuilder is currently showing.
    
    Parameters:
    
    clause - clause as retrieved from filterBuilder.clauses
  - getMembers
```
public Canvas[] getMembers()
```
    Description copied from class: Layout
    An array of canvases that will be contained within this layout. You can set the following properties on these canvases (in addition to the standard component properties):
    - layoutAlign -- specifies the member's alignment along the breadth axis; valid values are "top", "center" and "bottom" for a horizontal layout and "left", "center" and "right" for a vertical layout (see defaultLayoutAlign for default implementation.)
    - showResizeBar -- set to true to show a resize bar (default is false)
    Height and width settings found on members are interpreted by the Layout according to the layout policy.
    Overrides:
    
    getMembers in class Layout
    
    Returns:
    
    Get the Array of members.
  - getValueFieldProperties
```
public FormItem getValueFieldProperties(FieldType type,
                                        java.lang.String fieldName,
                                        OperatorId operatorId,
                                        ValueItemType itemType,
                                        java.lang.String fieldType)
```
    Override to return properties for the FormItem(s) used for the "value" field displayed within clauses within this filterBuilder.
    Note that the valueType impacts when this method is called. For operators with valueType "fieldType" or "custom", a single value field is displayed. For operators with valueType "valueRange" two value-field items are displayed (one for the start and one for the end position). The valueItemType parameter may be used to determine which form item is being generated.
    Note : This is an override point
    
    Parameters:
    
    type - type of the DataSource field for this filter row. Note that for DataSourceSimpleTypeField SimpleType based DataSource fields this attribute will be null
    
    fieldName - name of the DataSource field for this filter row
    
    operatorId - OperatorId for the chosen operator
    
    itemType - What valueItem is being generated.
    
    fieldType - type of the DataSource field for this filter row. Typically one would use the parameter but this value is useful when the FieldType is a custom SimpleType in which case the type will be FieldType.CUSTOM and this parameter is the name of the SimpleType
    
    Returns:
    
    properties for the value field
  - setFieldOperatorCustomizer
```
public void setFieldOperatorCustomizer(FieldOperatorCustomizer customizer)
```
    This method installs a customizer that returns the set of OperatorIds applicable to the passed fieldName
    
    Parameters:
    
    customizer - the customizer to execute.
  - setLogicalStructure
```
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.form.FilterBuilderLogicalStructure s)
```
    Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
  - getLogicalStructure
```
public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
```
    Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
    
    Specified by:
    
    getLogicalStructure in interface LogicalStructure
    
    Overrides:
    
    getLogicalStructure in class Layout

Class FilterBuilder

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget

Fields inherited from class com.google.gwt.user.client.ui.UIObject

Constructor Summary

Method Summary

Methods inherited from class com.smartgwt.client.widgets.layout.Layout

Methods inherited from class com.smartgwt.client.widgets.Canvas

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

Methods inherited from class com.google.gwt.user.client.ui.UIObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

Constructor Detail

FilterBuilder

FilterBuilder

Method Detail

getOrCreateRef

changeAutoChildDefaults

changeAutoChildDefaults

create

getAddButton

setAddButtonPrompt

getAddButtonPrompt

setAllowEmpty

getAllowEmpty

getBracket

getClauseStack

setFieldDataSource

getFieldDataSource

setFieldPickerProperties

getFieldPickerProperties

setFieldPickerTitle

getFieldPickerTitle

setFieldPickerWidth

getFieldPickerWidth

setFieldPickerWidth

getFieldPickerWidthAsString

setInlineAndNotTitle

getInlineAndNotTitle

setInlineAndTitle

getInlineAndTitle

setInlineOrTitle

getInlineOrTitle

setMatchAllTitle

getMatchAllTitle

setMatchAnyTitle

getMatchAnyTitle

setMatchNoneTitle

getMatchNoneTitle

setMissingFieldPrompt

getMissingFieldPrompt

getModeSwitcher

setModeSwitcherAdvancedMessage

getModeSwitcherAdvancedMessage

setModeSwitcherFlattenWarningMessage

getModeSwitcherFlattenWarningMessage

setModeSwitcherSimpleMessage

getModeSwitcherSimpleMessage

getOperatorPicker

setOperatorPickerProperties

getOperatorPickerProperties

setOperatorPickerTitle

getOperatorPickerTitle

setOperatorPickerWidth

getOperatorPickerWidth

setOperatorPickerWidth

getOperatorPickerWidthAsString

getRadioOperatorForm

getRadioOperatorLayout

setRadioOperatorTitle

getRadioOperatorTitle

setRangeSeparator

getRangeSeparator

getRemoveButton

setRemoveButtonPrompt

getRemoveButtonPrompt

setRetainValuesAcrossFields