|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.extjs.gxt.ui.client.event.BaseObservable
com.extjs.gxt.ui.client.widget.grid.filters.Filter
public abstract class Filter
Abstract base class for filter implementations.
Nested Class Summary | |
---|---|
static class |
Filter.FilterMessages
|
Field Summary | |
---|---|
protected java.lang.String |
dataIndex
|
protected Menu |
menu
|
Constructor Summary | |
---|---|
Filter(java.lang.String dataIndex)
Creates a new filter instance. |
Method Summary | ||
---|---|---|
protected void |
fireUpdate()
|
|
java.lang.String |
getDataIndex()
Returns the filter's data index. |
|
Menu |
getMenu()
Returns the filter's menu. |
|
Filter.FilterMessages |
getMessages()
|
|
protected
|
getModelValue(ModelData model)
|
|
abstract java.util.List<FilterConfig> |
getSerialArgs()
Template method to be implemented by all subclasses that is to get and return serialized filter data for transmission to the server. |
|
int |
getUpdateBuffer()
Returns the update buffer. |
|
abstract java.lang.Object |
getValue()
Template method to be implemented by all subclasses that is to get and return the value of the filter. |
|
boolean |
isActivatable()
Template method to be implemented by all subclasses that is to return true if the filter has enough configuration information to be
activated. |
|
boolean |
isActive()
Returns true if the filter is active. |
|
java.util.List<FilterConfig> |
serialize()
Returns the serialized filter data for transmission to the server and fires the 'Serialize' event. |
|
void |
setActive(boolean active,
boolean supressEvent)
Sets the status of the filter and fires the appropriate events. |
|
void |
setMessages(Filter.FilterMessages messages)
|
|
void |
setUpdateBuffer(int updateBuffer)
Number of milliseconds to wait after user interaction to fire an update (defaults to 500). |
|
abstract void |
setValue(java.lang.Object value)
Template method to be implemented by all subclasses that is to set the value of the filter and fire the 'Update' event. |
|
boolean |
validateModel(ModelData model)
Template method to be implemented by all subclasses that is to validates the provided Model against the filters configuration. |
Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable |
---|
addListener, callListener, fireEvent, fireEvent, getFiresEvents, getListeners, hasActiveEvent, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String dataIndex
protected Menu menu
Constructor Detail |
---|
public Filter(java.lang.String dataIndex)
dataIndex
- the data index the filter is mapped toMethod Detail |
---|
public java.lang.String getDataIndex()
public Menu getMenu()
public Filter.FilterMessages getMessages()
public abstract java.util.List<FilterConfig> getSerialArgs()
public int getUpdateBuffer()
public abstract java.lang.Object getValue()
public boolean isActivatable()
true
if the filter has enough configuration information to be
activated.
public boolean isActive()
public java.util.List<FilterConfig> serialize()
public void setActive(boolean active, boolean supressEvent)
active
- the new filter statesupressEvent
- true to prevent events from being firedpublic void setMessages(Filter.FilterMessages messages)
public void setUpdateBuffer(int updateBuffer)
updateBuffer
- the update buffer in millisecondspublic abstract void setValue(java.lang.Object value)
value
- the filter valuepublic boolean validateModel(ModelData model)
model
- the model
protected void fireUpdate()
protected <X> X getModelValue(ModelData model)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |