Class FilterClause
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,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,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers,HasMembersChangedHandlers
Note that FilterClauses must be used in conjunction with a FilterBuilder.
By default the FilterBuilder will auto-generate its clauses based on specified criteria, but for advanced usage a
FilterClause may be instantiated directly and passed to a filterBuilder via FilterBuilder.addClause().
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()AutoChild containing the UI for the filter-properties in this FilterClause.Initial criterion for this FilterClause.Properties to combine with theFieldPickerautoChild FormItem.The title for thefield-pickerselect-item.voidReturns thefilterBuildercontaining this clause, or null if this filterClause is not embedded in a filterBuilder.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.AutoChild for theFormItemthat allows a user to select the operator when creating filter clauses.Properties to combine with theoperatorPickerautoChild FormItem.The title for the operator-picker select-item.static FilterClausegetOrCreateRef(JavaScriptObject jsObj) The clause removal ImgButton that appears before this clause ifshowRemoveButtonis set.The hover prompt text for the remove button.If true (the default), show field titles in the drop-down box used to select a field for querying.If set, show a button for this clause allowing it to be removed.If true (the default), validates the entered value when it changes, to make sure it is a a valid value of its type (valid string, number, and so on).A hint to show in the value-item when using an operator that allows users to select field-names from a list.A hint to show in the value-item when using an operator that allows users to select values from a list.A hint to show in the value-item when using an operator that takes user-entered values.The title for the value-item.The ImgButton that appears after each clause ifFilterBuilder.allowAggregatesis set.The size of the buttons in each clause that allow Value-query functionality, such asrelated-fieldandaggregationfeatures, if they don't specify sizes.The size of the icons in the buttons in each clause that allow Value-query functionality, such asrelated-fieldandaggregationfeatures, if they don't specify separate image-sizes.The ImgButton that appears after each clause ifFilterBuilder.allowAggregatesis set.A hint to show in the value-item when using an operator that takes an array of values.voidremove()Remove this clause by destroy()ing it.setCriterion(Criteria criterion) Initial criterion for this FilterClause.static voidsetDefaultProperties(FilterClause filterClauseProperties) Class level method to set the default properties of this class.setFieldPickerProperties(FormItem fieldPickerProperties) Properties to combine with theFieldPickerautoChild FormItem.setFieldPickerTitle(String fieldPickerTitle) The title for thefield-pickerselect-item.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setOperatorPickerProperties(FormItem operatorPickerProperties) Properties to combine with theoperatorPickerautoChild FormItem.setOperatorPickerTitle(String operatorPickerTitle) The title for the operator-picker select-item.setRemoveButtonPrompt(String removeButtonPrompt) The hover prompt text for the remove button.setShowFieldTitles(Boolean showFieldTitles) If true (the default), show field titles in the drop-down box used to select a field for querying.setShowRemoveButton(Boolean showRemoveButton) If set, show a button for this clause allowing it to be removed.setValidateOnChange(Boolean validateOnChange) If true (the default), validates the entered value when it changes, to make sure it is a a valid value of its type (valid string, number, and so on).setValueItemFieldHint(String valueItemFieldHint) A hint to show in the value-item when using an operator that allows users to select field-names from a list.setValueItemListHint(String valueItemListHint) A hint to show in the value-item when using an operator that allows users to select values from a list.setValueItemTextHint(String valueItemTextHint) A hint to show in the value-item when using an operator that takes user-entered values.setValueItemTitle(String valueItemTitle) The title for the value-item.setValueQueryButtonSize(Integer valueQueryButtonSize) The size of the buttons in each clause that allow Value-query functionality, such asrelated-fieldandaggregationfeatures, if they don't specify sizes.setValueQueryIconSize(Integer valueQueryIconSize) The size of the icons in the buttons in each clause that allow Value-query functionality, such asrelated-fieldandaggregationfeatures, if they don't specify separate image-sizes.setValueSetHint(String valueSetHint) A hint to show in the value-item when using an operator that takes an array of values.validate()Validate this clause.Methods inherited from class com.smartgwt.client.widgets.layout.HStack
setDefaultProperties, setLogicalStructureMethods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEditProxyConstructor, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, revealChild, revealChild, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEditProxyConstructor, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMemberMethods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, 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, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, 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, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, doValueDictation, doVoiceCommand, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, 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, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, supportsValueDictation, supportsVoiceCommands, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, 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, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods 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, unsinkEventsMethods 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, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
FilterClause
public FilterClause() -
FilterClause
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- 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, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- 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, seeSGWTProperties.- See Also:
-
create
-
getClause
AutoChild containing the UI for the filter-properties in this FilterClause.This component is an AutoChild named "clause". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current clause value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setCriterion
Initial criterion for this FilterClause.When initialized with a criterion, the clause will be automatically set up for editing the supplied criterion.
Note that an empty or partial criterion is allowed, for example, it may specify
Criterion.fieldNameonly and will generate an expression with the operator not chosen.- Parameters:
criterion- New criterion value. Default value is null- Returns:
FilterClauseinstance, for chaining setter calls
-
getCriterion
Initial criterion for this FilterClause.When initialized with a criterion, the clause will be automatically set up for editing the supplied criterion.
Note that an empty or partial criterion is allowed, for example, it may specify
Criterion.fieldNameonly and will generate an expression with the operator not chosen.- Returns:
- Return the criterion specified by this FilterClause. Default value is null
-
setFieldPickerProperties
public FilterClause setFieldPickerProperties(FormItem fieldPickerProperties) throws IllegalStateException Properties to combine with theFieldPickerautoChild FormItem.- Parameters:
fieldPickerProperties- New fieldPickerProperties value. Default value is null- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getFieldPickerProperties
Properties to combine with theFieldPickerautoChild FormItem.- Returns:
- Current fieldPickerProperties value. Default value is null
-
setFieldPickerTitle
The title for thefield-pickerselect-item.- Parameters:
fieldPickerTitle- New fieldPickerTitle value. Default value is "Field Name"- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getFieldPickerTitle
The title for thefield-pickerselect-item.- Returns:
- Current fieldPickerTitle value. Default value is "Field Name"
-
getOperatorPicker
AutoChild for theFormItemthat allows a user to select the operator when creating filter clauses. Each clause will create an operatorPicker automatically. To customize this item, useoperatorPickerPropertiesThis component is an AutoChild named "operatorPicker". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current operatorPicker value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setOperatorPickerProperties
public FilterClause setOperatorPickerProperties(FormItem operatorPickerProperties) throws IllegalStateException Properties to combine with theoperatorPickerautoChild FormItem.- Parameters:
operatorPickerProperties- New operatorPickerProperties value. Default value is null- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getOperatorPickerProperties
Properties to combine with theoperatorPickerautoChild FormItem.- Returns:
- Current operatorPickerProperties value. Default value is null
-
setOperatorPickerTitle
The title for the operator-picker select-item.- Parameters:
operatorPickerTitle- New operatorPickerTitle value. Default value is "Operator"- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getOperatorPickerTitle
The title for the operator-picker select-item.- Returns:
- Current operatorPickerTitle value. Default value is "Operator"
-
getRemoveButton
The clause removal ImgButton that appears before this clause ifshowRemoveButtonis set.This component is an AutoChild named "removeButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current removeButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setRemoveButtonPrompt
The hover prompt text for the remove button.- Parameters:
removeButtonPrompt- New removeButtonPrompt value. Default value is "Remove"- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getRemoveButtonPrompt
The hover prompt text for the remove button.- Returns:
- Current removeButtonPrompt value. Default value is "Remove"
-
setShowFieldTitles
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- New showFieldTitles value. Default value is true- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
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:
- Current showFieldTitles value. Default value is true
-
setShowRemoveButton
If set, show a button for this clause allowing it to be removed.- Parameters:
showRemoveButton- New showRemoveButton value. Default value is true- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowRemoveButton
If set, show a button for this clause allowing it to be removed.- Returns:
- Current showRemoveButton value. Default value is true
-
setValidateOnChange
If true (the default), validates the 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 theFilterClauseby callingvalidate()from your own code.- Parameters:
validateOnChange- New validateOnChange value. Default value is true- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getValidateOnChange
If true (the default), validates the 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 theFilterClauseby callingvalidate()from your own code.- Returns:
- Current validateOnChange value. Default value is true
-
setValueItemFieldHint
A hint to show in the value-item when using an operator that allows users to select field-names from a list.- Parameters:
valueItemFieldHint- New valueItemFieldHint value. Default value is "Select a field"- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getValueItemFieldHint
A hint to show in the value-item when using an operator that allows users to select field-names from a list.- Returns:
- Current valueItemFieldHint value. Default value is "Select a field"
-
setValueItemListHint
A hint to show in the value-item when using an operator that allows users to select values from a list.- Parameters:
valueItemListHint- New valueItemListHint value. Default value is "Select a value"- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getValueItemListHint
A hint to show in the value-item when using an operator that allows users to select values from a list.- Returns:
- Current valueItemListHint value. Default value is "Select a value"
-
setValueItemTextHint
A hint to show in the value-item when using an operator that takes user-entered values.- Parameters:
valueItemTextHint- New valueItemTextHint value. Default value is "Enter a value"- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getValueItemTextHint
A hint to show in the value-item when using an operator that takes user-entered values.- Returns:
- Current valueItemTextHint value. Default value is "Enter a value"
-
setValueItemTitle
The title for the value-item.- Parameters:
valueItemTitle- New valueItemTitle value. Default value is "Value"- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getValueItemTitle
The title for the value-item.- Returns:
- Current valueItemTitle value. Default value is "Value"
-
getValueQueryAggregateButton
The ImgButton that appears after each clause ifFilterBuilder.allowAggregatesis set.This component is an AutoChild named "valueQueryAggregateButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current valueQueryAggregateButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setValueQueryButtonSize
public FilterClause setValueQueryButtonSize(Integer valueQueryButtonSize) throws IllegalStateException The size of the buttons in each clause that allow Value-query functionality, such asrelated-fieldandaggregationfeatures, if they don't specify sizes.- Parameters:
valueQueryButtonSize- New valueQueryButtonSize value. Default value is 18- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getValueQueryButtonSize
The size of the buttons in each clause that allow Value-query functionality, such asrelated-fieldandaggregationfeatures, if they don't specify sizes.- Returns:
- Current valueQueryButtonSize value. Default value is 18
-
setValueQueryIconSize
The size of the icons in the buttons in each clause that allow Value-query functionality, such asrelated-fieldandaggregationfeatures, if they don't specify separate image-sizes.- Parameters:
valueQueryIconSize- New valueQueryIconSize value. Default value is 18- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getValueQueryIconSize
The size of the icons in the buttons in each clause that allow Value-query functionality, such asrelated-fieldandaggregationfeatures, if they don't specify separate image-sizes.- Returns:
- Current valueQueryIconSize value. Default value is 18
-
getValueQueryRelatedFieldButton
The ImgButton that appears after each clause ifFilterBuilder.allowAggregatesis set.This component is an AutoChild named "valueQueryRelatedFieldButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current valueQueryRelatedFieldButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setValueSetHint
A hint to show in the value-item when using an operator that takes an array of values.- Parameters:
valueSetHint- New valueSetHint value. Default value is "Comma-separated values"- Returns:
FilterClauseinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getValueSetHint
A hint to show in the value-item when using an operator that takes an array of values.- Returns:
- Current valueSetHint value. Default value is "Comma-separated values"
-
getFilterBuilder
public void getFilterBuilder()Returns thefilterBuildercontaining this clause, or null if this filterClause is not embedded in a filterBuilder. -
remove
public void remove()Remove this clause by destroy()ing it. -
validate
Validate this clause.- Returns:
- true if if the clause is valid, false otherwise
-
setDefaultProperties
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:
filterClauseProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classHStack
-