com.smartgwt.client.widgets.form
Class SearchForm

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.form.DynamicForm
                      extended by com.smartgwt.client.widgets.form.SearchForm
All Implemented Interfaces:
HasHandlers, com.google.gwt.user.client.EventListener, DataBoundComponent, 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, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasItemChangedHandlers, HasItemChangeHandlers, HasItemKeyPressHandlers, HasSubmitValuesHandlers

public class SearchForm
extends DynamicForm

A SearchForm is a DynamicForm specialized for a user to enter search criteria.

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 required in a search.


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
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
SearchForm()
           
SearchForm(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 
Method Summary
protected  com.google.gwt.core.client.JavaScriptObject create()
           
static SearchForm getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 java.lang.Boolean getShowFilterFieldsOnly()
          If this attribute is true any canFilter fields specified on the dataSource will not be shown unless explicitly included in this component's fields
 void setShowFilterFieldsOnly(java.lang.Boolean showFilterFieldsOnly)
          If this attribute is true any canFilter fields specified on the dataSource will not be shown unless explicitly included in this component's fields
 
Methods inherited from class com.smartgwt.client.widgets.form.DynamicForm
addFormulaField, addItemChangedHandler, addItemChangeHandler, addItemKeyPressHandler, addSubmitValuesHandler, addSummaryField, anySelected, cancel, cancel, clearErrors, clearFieldErrors, clearValue, clearValues, deselectAllRecords, deselectRecord, deselectRecord, deselectRecords, deselectRecords, disableHilite, disableHiliting, editNewRecord, editNewRecord, editRecord, editSelectedData, editSelectedData, enableHilite, enableHilite, enableHiliting, enableHiliting, fetchData, fetchData, fetchData, fetchData, filterData, filterData, filterData, filterData, focusInItem, focusInItem, focusInItem, getAction, getAddDropValues, getAddFormulaFieldText, getAddOperation, getAddSummaryFieldText, getAutoFetchAsFilter, getAutoFetchData, getAutoFocus, getCanAddFormulaFields, getCanAddSummaryFields, getCancelParamName, getCancelParamValue, getCanFocus, getCanSubmit, getCellBorder, getCellPadding, getCellSpacing, getDataPageSize, getDataSource, getDisableValidation, getDragData, getDragDataAction, getDragTrackerStyle, getDropValues, getDuplicateDragMessage, getEditFormulaFieldText, getEditSummaryFieldText, getEncoding, getErrorItemCellStyle, getErrors, getErrorsPreamble, getExportAll, getExportFields, getFetchOperation, getField, getFieldErrors, getFields, getFixedColWidths, getHiliteProperty, getHiliteRequiredFields, getInitialCriteria, getItem, getItemHoverAlign, getItemHoverDelay, getItemHoverHeight, getItemHoverOpacity, getItemHoverStyle, getItemHoverVAlign, getItemHoverWidth, getItemLayout, getLongTextEditorThreshold, getLongTextEditorType, getMethod, getMinColWidth, getNumCols, getOperator, getPreventDuplicates, getRecordIndex, getRejectInvalidValueOnChange, getRemoveOperation, getRequiredRightTitlePrefix, getRequiredRightTitleSuffix, getRequiredTitlePrefix, getRequiredTitleSuffix, getRightTitlePrefix, getRightTitleSuffix, getSaveOnEnter, getSaveOperationType, getSectionVisibilityMode, getSelectOnFocus, getShowComplexFields, getShowComplexFieldsRecursively, getShowDetailFields, getShowErrorIcons, getShowErrorStyle, getShowErrorText, getShowHiddenFields, getShowInlineErrors, getShowTitlesWithErrorMessages, getTarget, getTitleField, getTitleFieldValue, getTitleOrientation, getTitlePrefix, getTitleSuffix, getUnknownErrorMessage, getUpdateOperation, getUseAllDataSourceFields, getUseFlatFields, getValidateOnChange, getValidationURL, getValue, getValueAsString, getValues, getValuesAsCriteria, getValuesManager, getWrapItemTitles, hasErrors, hasFieldErrors, hideItem, invalidateCache, isNewRecord, onInit, rememberValues, reset, resetValues, saveData, saveData, saveData, selectAllRecords, selectRecord, selectRecord, selectRecord, selectRecord, selectRecords, selectRecords, selectRecords, selectRecords, setAction, setAddDropValues, setAddFormulaFieldText, setAddOperation, setAddSummaryFieldText, setAutoFetchAsFilter, setAutoFetchData, setAutoFocus, setCanAddFormulaFields, setCanAddSummaryFields, setCancelParamName, setCancelParamValue, setCanFocus, setCanSubmit, setCellBorder, setCellPadding, setCellSpacing, setColWidths, setDataPageSize, setDataSource, setDisableValidation, setDragDataAction, setDragTrackerStyle, setDropValues, setDuplicateDragMessage, setEditFormulaFieldText, setEditSummaryFieldText, setEncoding, setErrorItemCellStyle, setErrorOrientation, setErrors, setErrorsPreamble, setExportAll, setExportFields, setFetchOperation, setFieldErrors, setFieldErrors, setFields, setFixedColWidths, setHiliteProperty, setHiliteRequiredFields, setInitialCriteria, setItemHoverAlign, setItemHoverDelay, setItemHoverFormatter, setItemHoverHeight, setItemHoverOpacity, setItemHoverStyle, setItemHoverVAlign, setItemHoverWidth, setItemLayout, setItems, setItemTitleHoverFormatter, setLongTextEditorThreshold, setLongTextEditorType, setMethod, setMinColWidth, setNumCols, setOperator, setPreventDuplicates, setRejectInvalidValueOnChange, setRemoveOperation, setRequiredRightTitlePrefix, setRequiredRightTitleSuffix, setRequiredTitlePrefix, setRequiredTitleSuffix, setResizeFrom, setRightTitlePrefix, setRightTitleSuffix, setSaveOnEnter, setSaveOperationType, setSectionVisibilityMode, setSelectOnFocus, setShowComplexFields, setShowComplexFieldsRecursively, setShowDetailFields, setShowErrorIcons, setShowErrorStyle, setShowErrorText, setShowHiddenFields, setShowInlineErrors, setShowTitlesWithErrorMessages, setTarget, setTitleField, setTitleOrientation, setTitlePrefix, setTitleSuffix, setTitleWidth, setTitleWidth, setUnknownErrorMessage, setUpdateOperation, setUseAllDataSourceFields, setUseAllDataSourceFields, setUseFlatFields, setValidateOnChange, setValidationURL, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValues, setValuesManager, setWrapItemTitles, showErrors, showFieldErrors, showItem, submit, submit, submit, submitForm, transferSelectedData, transferSelectedData, validate, validate, validateData, valuesHaveChanged
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
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, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, 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, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanHover, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTitle, getTooltip, getTop, 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, parentResized, redraw, redraw, removeChild, removeChild, resizeBy, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDefaultHeight, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showNextTo, showNextTo, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, visibleAtPoint, willAcceptDrop
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, 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, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
doAttachChildren, doDetachChildren, getParent, isAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent
getOrCreateJsObj
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

SearchForm

public SearchForm()

SearchForm

public SearchForm(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static SearchForm getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

create

protected com.google.gwt.core.client.JavaScriptObject create()
Overrides:
create in class DynamicForm

setShowFilterFieldsOnly

public void setShowFilterFieldsOnly(java.lang.Boolean showFilterFieldsOnly)
If this attribute is true any canFilter fields specified on the dataSource will not be shown unless explicitly included in this component's fields

Note : This is an advanced setting

Parameters:
showFilterFieldsOnly - showFilterFieldsOnly Default value is true

getShowFilterFieldsOnly

public java.lang.Boolean getShowFilterFieldsOnly()
If this attribute is true any canFilter fields specified on the dataSource will not be shown unless explicitly included in this component's fields

Returns:
Boolean