public class SearchForm extends DynamicForm implements HasCriteriaChangedHandlers, HasOnSearchHandlers
All DynamicForm properties and
methods work on SearchForm. SearchForm extends and specializes DynamicForm for searching; for example, SearchForm sets
hiliteRequiredFields false by default because fields are typically not required in a search.
A
SearchForm may be bound directly to a ListGrid by applying it to ListGrid.searchForm. Doing this ensures that when search() is invoked (from a submit button click or Enter keypress), the grid will be filtered by the values
from the search form.
Alternatively, developers may implement their own search handling logic.
DynamicFormconfig, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description |
|---|
SearchForm() |
SearchForm(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.event.shared.HandlerRegistration |
addCriteriaChangedHandler(CriteriaChangedHandler handler)
Add a criteriaChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addOnSearchHandler(OnSearchHandler handler)
Add a onSearch handler.
|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.String |
getCanEditFieldAttribute()
This property is overridden in SearchForm to allow editing of dataSource fields marked as
canFilter:true by
default. |
java.lang.Integer |
getCriteriaChangedDelay()
Delay in milliseconds between user changing the criteria in the form and the
SearchForm.criteriaChanged() notification method
being fired. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
static SearchForm |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.Boolean |
getSearchOnEnter()
Causes the
search() event to be triggered when the user
presses the Enter key in any field of this form. |
java.lang.Boolean |
getShowFilterFieldsOnly()
If this attribute is true any
canFilter:false fields
specified on the dataSource will not be shown unless explicitly included in this component's fields array |
java.lang.Boolean |
getStoreDisplayValues()
For editable fields with a specified
FormItem.displayField and FormItem.optionDataSource, if the user selects a new value (typically from PickList based item such as a SelectItem),
should the selected displayValue be updated on the record being edited in addition to the value for the actual item.Note that this only applies for fields using local display field values. |
boolean |
getUseMultiSelectForValueMaps()
When creating a SelectItem within a Search Form for editing criteria for a field with a ValueMap, should the SelectItem
default to
multiple:true? |
void |
search() |
SearchForm |
setCanEditFieldAttribute(java.lang.String canEditFieldAttribute)
This property is overridden in SearchForm to allow editing of dataSource fields marked as
canFilter:true by
default. |
SearchForm |
setCriteriaChangedDelay(java.lang.Integer criteriaChangedDelay)
Delay in milliseconds between user changing the criteria in the form and the
SearchForm.criteriaChanged() notification method
being fired. |
static void |
setDefaultProperties(SearchForm searchFormProperties)
Class level method to set the default properties of this class.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.form.SearchFormLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
SearchForm |
setSearchOnEnter(java.lang.Boolean searchOnEnter)
Causes the
search() event to be triggered when the user
presses the Enter key in any field of this form. |
SearchForm |
setShowFilterFieldsOnly(java.lang.Boolean showFilterFieldsOnly)
If this attribute is true any
canFilter:false fields
specified on the dataSource will not be shown unless explicitly included in this component's fields array |
SearchForm |
setStoreDisplayValues(java.lang.Boolean storeDisplayValues)
For editable fields with a specified
FormItem.displayField and FormItem.optionDataSource, if the user selects a new value (typically from PickList based item such as a SelectItem),
should the selected displayValue be updated on the record being edited in addition to the value for the actual item.Note that this only applies for fields using local display field values. |
SearchForm |
setUseMultiSelectForValueMaps(boolean useMultiSelectForValueMaps)
When creating a SelectItem within a Search Form for editing criteria for a field with a ValueMap, should the SelectItem
default to
multiple:true? |
addAsyncValidationReplyHandler, addDragCompleteHandler, addDropCompleteHandler, addFetchDataHandler, addFormSubmitFailedHandler, addFormulaField, addHiddenValidationErrorsHandler, addItemChangedHandler, addItemChangeHandler, addItemKeyPressHandler, addSubmitValuesHandler, addSummaryField, addValuesChangedHandler, anySelected, assignItemsTabPositions, cancel, cancelEditing, checkForValidationErrors, checkForValidationErrors, checkForValidationErrors, clearErrors, clearFieldErrors, clearValue, clearValues, completeEditing, deselectAllRecords, deselectRecord, deselectRecord, deselectRecords, deselectRecords, disableHilite, disableHiliting, editFields, editHilites, editNewRecord, editNewRecord, editNewRecord, editRecord, editSelectedData, editSelectedData, enableHilite, enableHilite, enableHiliting, enableHiliting, exportData, exportData, exportData, fetchData, fetchData, fetchData, fetchData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fieldIsEditable, fieldIsEditable, fieldIsEditable, filterData, filterData, filterData, filterData, find, findAll, findIndex, findNextIndex, findNextIndex, focus, focusInItem, focusInItem, focusInItem, getAction, getAddDropValues, getAddFormulaFieldText, getAddOperation, getAddSummaryFieldText, getAllowExpressions, getAutoComplete, getAutoFetchAsFilter, getAutoFetchData, getAutoFetchTextMatchStyle, getAutoFocus, getAutoFocusOnError, getBrowserSpellCheck, getCanAddFormulaFields, getCanAddSummaryFields, getCanEdit, getCanFocus, getCanSubmit, getCanTabToIcons, getCanTabToSectionHeaders, getCellBorder, getCellPadding, getCellSpacing, getChangedValues, getCheckFileAccessOnSubmit, getClipItemTitles, getClipStaticValue, getDataArity, getDataAsJSList, getDataFetchMode, getDataPageSize, getDataSource, getDateFormatter, getDatetimeFormatter, getDeepCloneOnEdit, getDefaultSearchOperator, getDisableValidation, getDragData, getDragDataAction, getDragTrackerStyle, getDropValues, getDuplicateDragMessage, getEditFormulaFieldText, getEditProxyConstructor, getEditSummaryFieldText, getEncoding, getErrorItemCellStyle, getErrors, getErrorsPreamble, getEventItem, getEventItemInfo, getExportAll, getExportFields, getExportIncludeSummaries, getFetchOperation, getFetchRequestProperties, getField, getField, getFieldAlignments, getFieldCount, getFieldErrors, getFields, getFields, getFieldsAsJavaScriptObjects, getFileAccessFailedWarning, getFixedColWidths, getFocusItem, getFormSubmitFailedWarning, getHiliteProperty, getHiliteRequiredFields, getHilites, getHiliteState, getImplicitCriteria, getImplicitSave, getImplicitSaveDelay, getImplicitSaveOnBlur, getInitialCriteria, getInitialSort, getItem, getItemHoverAlign, getItemHoverDelay, getItemHoverHeight, getItemHoverHeightAsString, getItemHoverOpacity, getItemHoverStyle, getItemHoverVAlign, getItemHoverVAlignAsString, getItemHoverWidth, getItemHoverWidthAsString, getItemLayout, getLinearAutoSpanItems, getLinearHintWidth, getLinearHintWidthAsString, getLinearMode, getLinearNumCols, getLinearOnMobile, getLongTextEditorThreshold, getLongTextEditorType, getMethod, getMinColWidth, getMinHintWidth, getNoErrorDetailsMessage, getNumCols, getOldValues, getOperator, getOriginalValueMessage, getPreventDuplicates, getProgressiveLoading, getReadOnlyDisplay, getReadOnlyTextBoxStyle, getRecordIndex, getRecordList, getRejectInvalidValueOnChange, getRemoveOperation, getRequiredMessage, getRequiredRightTitlePrefix, getRequiredRightTitleSuffix, getRequiredTitlePrefix, getRequiredTitleSuffix, getResultSet, getRevertValueKey, getRightTitlePrefix, getRightTitleSuffix, getSavedSearchId, getSaveOnEnter, getSaveOperationType, getSaveOperationType, getSectionVisibilityMode, getSelectOnClick, getSelectOnFocus, getShowComplexFields, getShowComplexFieldsRecursively, getShowDeletions, getShowDetailFields, getShowErrorIcons, getShowErrorStyle, getShowErrorText, getShowHiddenFields, getShowImageAsURL, getShowInlineErrors, getShowOldValueInHover, getShowPending, getShowSavedSearchesByDS, getShowTitlesWithErrorMessages, getSkipConversionOnMapping, getSort, getSparseFieldState, getStopOnError, getSuppressBrowserClearIcons, getSuppressValidationErrorCallback, getSynchronousValidation, getTarget, getTimeFormatter, getTitleAlign, getTitleField, getTitleFieldValue, getTitleOrientation, getTitlePrefix, getTitleSuffix, getUnknownErrorMessage, getUpdateOperation, getUseAllDataSourceFields, getUseFlatFields, getUserTask, getValidateOnChange, getValidateOnExit, getValidationURL, getValue, getValueAsString, getValues, getValuesAsAdvancedCriteria, getValuesAsAdvancedCriteria, getValuesAsCriteria, getValuesAsRecord, getValuesManager, getWrapHintText, getWrapItemTitles, hasErrors, hasFieldErrors, hideItem, invalidateCache, isFocused, isNewRecord, isPendingAsyncValidation, onInit_DynamicForm, onInit, rememberValues, reset, resetValues, saveData, saveData, saveData, selectAllRecords, selectRecord, selectRecord, selectRecord, selectRecord, selectRecords, selectRecords, selectRecords, selectRecords, setAction, setAddDropValues, setAddFormulaFieldText, setAddOperation, setAddSummaryFieldText, setAllowExpressions, setAutoComplete, setAutoFetchAsFilter, setAutoFetchData, setAutoFetchTextMatchStyle, setAutoFocus, setAutoFocusOnError, setBrowserSpellCheck, setCanAddFormulaFields, setCanAddSummaryFields, setCanEdit, setCanFocus, setCanSubmit, setCanTabToIcons, setCanTabToSectionHeaders, setCellBorder, setCellPadding, setCellSpacing, setCheckFileAccessOnSubmit, setClipItemTitles, setClipStaticValue, setColWidths, setDataArity, setDataFetchMode, setDataPageSize, setDataSource, setDataSource, setDataSource, setDateFormatter, setDatetimeFormatter, setDeepCloneOnEdit, setDefaultProperties, setDefaultSearchOperator, setDisableValidation, setDragDataAction, setDragDataCustomizer, setDragTrackerStyle, setDropValues, setDuplicateDragMessage, setEditFormulaFieldText, setEditProxyConstructor, setEditSummaryFieldText, setEncoding, setErrorItemCellStyle, setErrorOrientation, setErrors, setErrorsPreamble, setExportAll, setExportFields, setExportIncludeSummaries, setFetchOperation, setFetchRequestProperties, setFieldErrors, setFieldErrors, setFields, setFields, setFileAccessFailedWarning, setFixedColWidths, setFormSubmitFailedWarning, setHiliteProperty, setHiliteRequiredFields, setHilites, setHiliteState, setImplicitCriteria, setImplicitCriteria, setImplicitCriteria, setImplicitSave, setImplicitSaveDelay, setImplicitSaveOnBlur, setInitialCriteria, setInitialSort, setItemHoverAlign, setItemHoverDelay, setItemHoverFormatter, setItemHoverHeight, setItemHoverHeight, setItemHoverOpacity, setItemHoverStyle, setItemHoverVAlign, setItemHoverVAlign, setItemHoverWidth, setItemHoverWidth, setItemLayout, setItems, setItemTitleHoverFormatter, setItemValueHoverFormatter, setLinearAutoSpanItems, setLinearHintWidth, setLinearHintWidth, setLinearMode, setLinearNumCols, setLinearOnMobile, setLogicalStructure, setLongTextEditorThreshold, setLongTextEditorType, setMethod, setMinColWidth, setMinHintWidth, setNoErrorDetailsMessage, setNumCols, setOperator, setOriginalValueMessage, setPreventDuplicates, setProgressiveLoading, setReadOnlyDisplay, setReadOnlyTextBoxStyle, setRejectInvalidValueOnChange, setRemoveOperation, setRequiredMessage, setRequiredRightTitlePrefix, setRequiredRightTitleSuffix, setRequiredTitlePrefix, setRequiredTitleSuffix, setRevertValueKey, setRightTitlePrefix, setRightTitleSuffix, setSavedSearchId, setSaveOnEnter, setSaveOperationType, setSectionVisibilityMode, setSelectOnClick, setSelectOnFocus, setShowComplexFields, setShowComplexFieldsRecursively, setShowDeletions, setShowDetailFields, setShowErrorIcons, setShowErrorStyle, setShowErrorText, setShowHiddenFields, setShowImageAsURL, setShowInlineErrors, setShowOldValueInHover, setShowPending, setShowSavedSearchesByDS, setShowTitlesWithErrorMessages, setSkipConversionOnMapping, setSort, setSparseFieldState, setStopOnError, setSuppressBrowserClearIcons, setSuppressValidationErrorCallback, setSynchronousValidation, setTarget, setTimeFormatter, setTitleAlign, setTitleField, setTitleOrientation, setTitlePrefix, setTitleSuffix, setTitleWidth, setTitleWidth, setUnknownErrorMessage, setUpdateOperation, setUseAllDataSourceFields, setUseAllDataSourceFields, setUseFlatFields, setUserTask, setValidateOnChange, setValidateOnExit, setValidationURL, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValues, setValuesAsCriteria, setValuesManager, setWrapHintText, setWrapItemTitles, showErrors, showFieldErrors, showItem, showItemContextMenu, sortItemsIntoTabOrder, submit, submit, submit, submitForm, titleClipped, transferRecords, transferSelectedData, transferSelectedData, validate, validate, validateData, validateData, valuesAreValid, valuesHaveChanged, viewSelectedData, viewSelectedData, viewSelectedDataaddChild, 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, enable, encloses, 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, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, 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, getOverflow, 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, 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, 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, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, 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, 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, setOverflow, 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, 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, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropaddDrawHandler, 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, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetOrCreateJsObjpublic SearchForm()
public SearchForm(com.google.gwt.core.client.JavaScriptObject jsObj)
public static SearchForm getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
create in class DynamicFormpublic SearchForm setCanEditFieldAttribute(java.lang.String canEditFieldAttribute) throws java.lang.IllegalStateException
canFilter:true by
default.
Note : This is an advanced setting
setCanEditFieldAttribute in class DynamicFormcanEditFieldAttribute - New canEditFieldAttribute value. Default value is "canFilter"SearchForm instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdIdentifierpublic java.lang.String getCanEditFieldAttribute()
canFilter:true by
default.getCanEditFieldAttribute in class DynamicFormIdentifierpublic SearchForm setCriteriaChangedDelay(java.lang.Integer criteriaChangedDelay)
SearchForm.criteriaChanged() notification method
being fired. Set to zero to respond to criteria changes synchronously after DynamicForm.itemChanged().criteriaChangedDelay - New criteriaChangedDelay value. Default value is 200SearchForm instance, for chaining setter callspublic java.lang.Integer getCriteriaChangedDelay()
SearchForm.criteriaChanged() notification method
being fired. Set to zero to respond to criteria changes synchronously after DynamicForm.itemChanged().public SearchForm setSearchOnEnter(java.lang.Boolean searchOnEnter)
search() event to be triggered when the user
presses the Enter key in any field of this form. This is the same as the saveOnEnter property of DynamicForm - setting either property to true will cause the search() event to fire on Enter keypress.
searchOnEnter - New searchOnEnter value. Default value is trueSearchForm instance, for chaining setter callspublic java.lang.Boolean getSearchOnEnter()
search() event to be triggered when the user
presses the Enter key in any field of this form. This is the same as the saveOnEnter property of DynamicForm - setting either property to true will cause the search() event to fire on Enter keypress.
public SearchForm setShowFilterFieldsOnly(java.lang.Boolean showFilterFieldsOnly)
canFilter:false fields
specified on the dataSource will not be shown unless explicitly included in this component's fields array
Note : This is an advanced setting
showFilterFieldsOnly - New showFilterFieldsOnly value. Default value is trueSearchForm instance, for chaining setter callspublic java.lang.Boolean getShowFilterFieldsOnly()
canFilter:false fields
specified on the dataSource will not be shown unless explicitly included in this component's fields arraypublic SearchForm setStoreDisplayValues(java.lang.Boolean storeDisplayValues)
FormItem.displayField and FormItem.optionDataSource, if the user selects a new value (typically from PickList based item such as a SelectItem),
should the selected displayValue be updated on the record being edited in addition to the value for the actual item.local display field values. Overriden
to be false for searchForms. It is typically not necessary to have the display value as well as the data
value be included in generated criteria when a user selects a new value from a field with a specified FormItem.displayField.
See DynamicForm.storeDisplayValues for more information
on this property.
Note : This is an advanced setting
setStoreDisplayValues in class DynamicFormstoreDisplayValues - New storeDisplayValues value. Default value is falseSearchForm instance, for chaining setter callspublic java.lang.Boolean getStoreDisplayValues()
FormItem.displayField and FormItem.optionDataSource, if the user selects a new value (typically from PickList based item such as a SelectItem),
should the selected displayValue be updated on the record being edited in addition to the value for the actual item.local display field values. Overriden
to be false for searchForms. It is typically not necessary to have the display value as well as the data
value be included in generated criteria when a user selects a new value from a field with a specified FormItem.displayField.
See DynamicForm.storeDisplayValues for more information
on this property.
getStoreDisplayValues in class DynamicFormpublic SearchForm setUseMultiSelectForValueMaps(boolean useMultiSelectForValueMaps) throws java.lang.IllegalStateException
multiple:true? Note that for
ListGrids showing a filterEditor, this property
will be derived from ListGrid.useMultiSelectForFilterValueMaps
Note : This is an advanced setting
useMultiSelectForValueMaps - New useMultiSelectForValueMaps value. Default value is trueSearchForm instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getUseMultiSelectForValueMaps()
multiple:true? Note that for
ListGrids showing a filterEditor, this property
will be derived from ListGrid.useMultiSelectForFilterValueMaps
public com.google.gwt.event.shared.HandlerRegistration addCriteriaChangedHandler(CriteriaChangedHandler handler)
Notification method fired when the criteria are modified in this SearchForm. As the user edits values, this method will
be fired after a configurable delay.
addCriteriaChangedHandler in interface HasCriteriaChangedHandlershandler - the criteriaChanged handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addOnSearchHandler(OnSearchHandler handler)
Notification event fired indicating that a user is attempting to perform a search. This is fired when a SearchForm is
submitted either from a click on a SubmitItem in the form, or from an
Enter keypress if SearchForm.searchOnEnter or
DynamicForm.saveOnEnter is true.
addOnSearchHandler in interface HasOnSearchHandlershandler - the onSearch handlerHandlerRegistration used to remove this handlerpublic static void setDefaultProperties(SearchForm searchFormProperties)
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.
searchFormProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic void search()
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.form.SearchFormLogicalStructure s)
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure in interface LogicalStructuregetLogicalStructure in class DynamicForm