|
|||||||||
| 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.layout.Layout
com.smartgwt.client.widgets.layout.HStack
com.smartgwt.client.widgets.form.FilterClause
public class FilterClause
An HStack-based widget that allows a user to input a single criterion based on one field and one operator.
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, id, isElementSet, nativeObject, scClassName |
| Fields inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
DEBUG_ID_PREFIX |
| Constructor Summary | |
|---|---|
FilterClause()
|
|
FilterClause(JavaScriptObject jsObj)
|
|
| Method Summary | |
|---|---|
protected JavaScriptObject |
create()
|
Criteria |
getCriterion()
Initial criterion for this FilterClause. |
String |
getFieldPickerTitle()
The title for the field-picker select-item. |
void |
getFilterBuilder()
Returns the filterBuilder containing this clause, or null if this
filterClause is not embedded in a filterBuilder. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
|
static FilterClause |
getOrCreateRef(JavaScriptObject jsObj)
|
String |
getRemoveButtonPrompt()
The hover prompt text for the remove button. |
Boolean |
getShowFieldTitles()
If true (the default), show field titles in the drop-down box used to select a field for querying. |
Boolean |
getShowRemoveButton()
If set, show a button for this clause allowing it to be removed. |
Boolean |
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). |
String |
getValueItemTitle()
The title for the value-item. |
void |
remove()
Remove this clause by destroy()ing it. |
void |
setCriterion(Criteria criterion)
Initial criterion for this FilterClause. |
static void |
setDefaultProperties(FilterClause filterClauseProperties)
Class level method to set the default properties of this class. |
void |
setFieldPickerTitle(String fieldPickerTitle)
The title for the field-picker select-item. |
void |
setJavaScriptObject(JavaScriptObject jsObj)
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.form.FilterClauseLogicalStructure s)
|
void |
setRemoveButtonPrompt(String removeButtonPrompt)
The hover prompt text for the remove button. |
void |
setShowFieldTitles(Boolean showFieldTitles)
If true (the default), show field titles in the drop-down box used to select a field for querying. |
void |
setShowRemoveButton(Boolean showRemoveButton)
If set, show a button for this clause allowing it to be removed. |
void |
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). |
void |
setValueItemTitle(String valueItemTitle)
The title for the value-item. |
Boolean |
validate()
Validate this clause. |
| Methods inherited from class com.smartgwt.client.widgets.layout.HStack |
|---|
setDefaultProperties, setLogicalStructure |
| Methods inherited from class com.google.gwt.user.client.ui.Widget |
|---|
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents |
| Methods inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
|---|
fireEvent |
| Constructor Detail |
|---|
public FilterClause()
public FilterClause(JavaScriptObject jsObj)
| Method Detail |
|---|
public static FilterClause getOrCreateRef(JavaScriptObject jsObj)
public void setJavaScriptObject(JavaScriptObject jsObj)
setJavaScriptObject in class HStackprotected JavaScriptObject create()
create in class HStackpublic void setCriterion(Criteria criterion)
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
fieldName only and will generate an expression with the operator
not chosen.
criterion - criterion Default value is nullpublic Criteria getCriterion()
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
fieldName only and will generate an expression with the operator
not chosen.
public void setFieldPickerTitle(String fieldPickerTitle)
throws IllegalStateException
field-picker select-item.
fieldPickerTitle - . See String. Default value is "Field Name"
IllegalStateException - this property cannot be changed after the component has been createdpublic String getFieldPickerTitle()
field-picker select-item.
String
public void setRemoveButtonPrompt(String removeButtonPrompt)
throws IllegalStateException
removeButtonPrompt - . See String. Default value is "Remove"
IllegalStateException - this property cannot be changed after the component has been createdpublic String getRemoveButtonPrompt()
String
public void setShowFieldTitles(Boolean showFieldTitles)
throws IllegalStateException
showFieldTitles - showFieldTitles Default value is true
IllegalStateException - this property cannot be changed after the component has been createdpublic Boolean getShowFieldTitles()
public void setShowRemoveButton(Boolean showRemoveButton)
throws IllegalStateException
showRemoveButton - showRemoveButton Default value is true
IllegalStateException - this property cannot be changed after the component has been createdpublic Boolean getShowRemoveButton()
public void setValidateOnChange(Boolean validateOnChange)
throws IllegalStateException
FilterClause by calling FilterClause.validate from your own code.
validateOnChange - validateOnChange Default value is true
IllegalStateException - this property cannot be changed after the component has been createdpublic Boolean getValidateOnChange()
FilterClause by calling FilterClause.validate from your own code.
public void setValueItemTitle(String valueItemTitle)
throws IllegalStateException
valueItemTitle - . See String. Default value is "Value"
IllegalStateException - this property cannot be changed after the component has been createdpublic String getValueItemTitle()
Stringpublic void getFilterBuilder()
filterBuilder containing this clause, or null if this
filterClause is not embedded in a filterBuilder.
public void remove()
public Boolean validate()
public static void setDefaultProperties(FilterClause filterClauseProperties)
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.
filterClauseProperties - 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.FilterClauseLogicalStructure s)
public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
getLogicalStructure in interface LogicalStructuregetLogicalStructure in class HStack
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||