com.smartgwt.client.widgets.form
Class FilterBuilder

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

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 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, id, isElementSet, nativeObject, scClassName

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

DEBUG_ID_PREFIX

Constructor Summary

FilterBuilder()

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

Method Summary

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.
void	clearCriteria() Clear all current criteria.
protected static FilterClause[]	convertToFilterClauseArray(com.google.gwt.core.client.JavaScriptObject nativeArray)
protected com.google.gwt.core.client.JavaScriptObject	create()
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.
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.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()
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() Return the members in the Layout.
java.lang.String	getMissingFieldPrompt() The message to display next to fieldNames that do not exist in the available dataSource.
java.lang.String	getOperatorPickerTitle() The title for the operator-picker select-item.
static FilterBuilder	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
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.
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	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.
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.
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.
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	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	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)
void	setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
com.smartgwt.logicalstructure.core.LogicalStructureObject	setLogicalStructure(com.smartgwt.logicalstructure.widgets.form.FilterBuilderLogicalStructure s)
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	setOperatorPickerTitle(java.lang.String operatorPickerTitle) The title for the operator-picker select-item.
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	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 topOperator for this FilterBuilder.
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).
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, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOffset, getMemberOverlap, getMembersMargin, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, membersChanged, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, 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, 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, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, deparent, depeer, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAttribute, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getParentElements, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setPadding, setPageLeft, setPageTop, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

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

addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, initNativeObject, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, 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, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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, unsinkEvents

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)

setJavaScriptObject

public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)

Overrides:

setJavaScriptObject in class Layout

create

protected com.google.gwt.core.client.JavaScriptObject create()

Overrides:

create in class Layout

setAddButtonPrompt

public void setAddButtonPrompt(java.lang.String addButtonPrompt)
                        throws java.lang.IllegalStateException

The hover prompt text for the add button.

Parameters:

addButtonPrompt - . See String. 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:

. See 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 - 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

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 - 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 - 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 - . See String. 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:

. See 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 - . See String. 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:

. See 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 - . See String. 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:

. See 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 - . See String. 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:

. See 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 - . See String. 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:

. See 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 - . See String. 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:

. See 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 - . See String. 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:

. See 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 - . See String. 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:

. See String

setOperatorPickerTitle

public void setOperatorPickerTitle(java.lang.String operatorPickerTitle)
                            throws java.lang.IllegalStateException

The title for the operator-picker select-item.

Parameters:

operatorPickerTitle - . See String. 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:

. See String

setRadioOperatorTitle

public void setRadioOperatorTitle(java.lang.String radioOperatorTitle)
                           throws java.lang.IllegalStateException

The title for the Operator RadioGroupItem displayed in the radioOperatorForm.

Parameters:

radioOperatorTitle - . See String. 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:

. See 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 - . See String. 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:

. See String

setRemoveButtonPrompt

public void setRemoveButtonPrompt(java.lang.String removeButtonPrompt)
                           throws java.lang.IllegalStateException

The hover prompt text for the remove button.

Parameters:

removeButtonPrompt - . See String. 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:

. See 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 - 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 - 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 - 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.

Parameters:

showFieldTitles - 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.

Returns:

Boolean

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 - 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 - 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 - 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 - 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

setSubClauseButtonPrompt

public void setSubClauseButtonPrompt(java.lang.String subClauseButtonPrompt)
                              throws java.lang.IllegalStateException

The hover prompt text for the subClauseButton.

Parameters:

subClauseButtonPrompt - . See String. 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:

. See String

setSubClauseButtonTitle

public void setSubClauseButtonTitle(java.lang.String subClauseButtonTitle)
                             throws java.lang.IllegalStateException

The title of the subClauseButton

Parameters:

subClauseButtonTitle - . See String. 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:

. See 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

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 - . See String. 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:

. See 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 FilterBuilder.validate from your own code.

Parameters:

validateOnChange - 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 FilterBuilder.validate from your own code.

Returns:

Boolean

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 FilterBuilder.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 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 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)

addSearchHandler

public com.google.gwt.event.shared.HandlerRegistration addSearchHandler(SearchHandler handler)

Add a search handler.

A StringMethod that is automatically invoked if 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 subsequent instances of this class will automatically have the default properties that were set when this method was called. 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 effect 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.

Parameters:

filterBuilderProperties - properties that should be used as new defaults when instances of this class are created

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

setTopOperatorAppearance

public void setTopOperatorAppearance(TopOperatorAppearance topOperatorAppearance)
                              throws java.lang.IllegalStateException

How to display and edit the topOperator for this FilterBuilder.

See TopOperatorAppearance for a list of options.

Parameters:

topOperatorAppearance - topOperatorAppearance Default value is "bracket"

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

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.

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

convertToFilterClauseArray

protected static FilterClause[] convertToFilterClauseArray(com.google.gwt.core.client.JavaScriptObject nativeArray)

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

Return the members in the Layout.

Overrides:

getMembers in class Layout

Returns:

the 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.

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

setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.form.FilterBuilderLogicalStructure s)

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()

Specified by:

getLogicalStructure in interface LogicalStructure

Overrides:

getLogicalStructure in class Layout