|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
com.smartgwt.client.widgets.form.DynamicForm
com.smartgwt.client.widgets.form.SearchForm
public class SearchForm
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 not required in a search.
DynamicForm| 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, id, isElementSet, nativeObject, scClassName |
| Fields inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
DEBUG_ID_PREFIX |
| Constructor Summary | |
|---|---|
SearchForm()
|
|
SearchForm(JavaScriptObject jsObj)
|
|
| Method Summary | |
|---|---|
protected JavaScriptObject |
create()
|
String |
getCanEditFieldAttribute()
If this component is bound to a dataSource, this attribute may be specified to customize what fields from the dataSource may be edited by default. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
|
static SearchForm |
getOrCreateRef(JavaScriptObject jsObj)
|
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 |
void |
setCanEditFieldAttribute(String canEditFieldAttribute)
If this component is bound to a dataSource, this attribute may be specified to customize what fields from the dataSource may be edited by default. |
static void |
setDefaultProperties(SearchForm searchFormProperties)
Class level method to set the default properties of this class. |
void |
setJavaScriptObject(JavaScriptObject jsObj)
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.form.SearchFormLogicalStructure s)
|
void |
setShowFilterFieldsOnly(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 |
| Methods inherited from class com.google.gwt.user.client.ui.Widget |
|---|
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents |
| Methods inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent |
|---|
getOrCreateJsObj |
| Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
|---|
fireEvent |
| Constructor Detail |
|---|
public SearchForm()
public SearchForm(JavaScriptObject jsObj)
| Method Detail |
|---|
public static SearchForm getOrCreateRef(JavaScriptObject jsObj)
public void setJavaScriptObject(JavaScriptObject jsObj)
setJavaScriptObject in class DynamicFormprotected JavaScriptObject create()
create in class DynamicForm
public void setCanEditFieldAttribute(String canEditFieldAttribute)
throws IllegalStateException
SearchForm class has this attribute
set to "canFilter" which allows search forms to edit dataSource fields marked as canEdit:false
(but not those marked as canFilter:false). Note that if canEdit is explicitly specified on
a field in the fields array, that property will be
respected in preference to the canEditAttribute value. (See canEdit, canEdit). Also note that individual dataBoundComponents may
have additional logic around whether a field can be edited - for example ListGrid.canEditCell may be overridden.
Note : This is an advanced setting
setCanEditFieldAttribute in class DynamicFormcanEditFieldAttribute - . See String. Default value is "canFilter"
IllegalStateException - this property cannot be changed after the component has been createdpublic String getCanEditFieldAttribute()
SearchForm class has this attribute
set to "canFilter" which allows search forms to edit dataSource fields marked as canEdit:false
(but not those marked as canFilter:false). Note that if canEdit is explicitly specified on
a field in the fields array, that property will be
respected in preference to the canEditAttribute value. (See canEdit, canEdit). Also note that individual dataBoundComponents may
have additional logic around whether a field can be edited - for example ListGrid.canEditCell may be overridden.
getCanEditFieldAttribute in class DynamicFormStringpublic void setShowFilterFieldsOnly(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 - showFilterFieldsOnly Default value is truepublic Boolean getShowFilterFieldsOnly()
canFilter:false fields
specified on the dataSource will not be shown unless explicitly included in this component's fields array
public static void setDefaultProperties(SearchForm searchFormProperties)
Note: This method is intended for setting default attributes only and will effect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead.
searchFormProperties - properties that should be used as new defaults when instances of this class are createdpublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.form.SearchFormLogicalStructure s)
public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
getLogicalStructure in interface LogicalStructuregetLogicalStructure in class DynamicForm
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||