com.sencha.gxt.widget.core.client.grid.filters

Class Filter<M,V>

java.lang.Object

com.sencha.gxt.widget.core.client.grid.filters.Filter<M,V>

All Implemented Interfaces:

ActivateEvent.HasActivateHandlers<Filter<M,?>>, DeactivateEvent.HasDeactivateHandlers<Filter<M,?>>, UpdateEvent.HasUpdateHandlers

Direct Known Subclasses:

BooleanFilter, DateFilter, ListFilter, NumericFilter, StringFilter

public abstract class Filter<M,V>
extends Object
implements UpdateEvent.HasUpdateHandlers, ActivateEvent.HasActivateHandlers<Filter<M,?>>, DeactivateEvent.HasDeactivateHandlers<Filter<M,?>>

Constructor Summary

Constructors

Constructor and Description
Filter(ValueProvider<M,V> valueProvider)

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addActivateHandler(ActivateEvent.ActivateHandler<Filter<M,?>> handler) Adds a ActivateEvent handler.
HandlerRegistration	addDeactivateHandler(DeactivateEvent.DeactivateHandler<Filter<M,?>> handler) Adds a DeactivateEvent handler.
HandlerRegistration	addUpdateHandler(UpdateEvent.UpdateHandler handler) Adds a UpdateEvent.UpdateHandler handler for UpdateEvent events.
abstract List<FilterConfig>	getFilterConfig()
FilterHandler<V>	getHandler()
Menu	getMenu() Returns the filter's menu.
int	getUpdateBuffer() Returns the update buffer.
abstract Object	getValue() Template method to be implemented by all subclasses that is to get and return the value of the filter.
ValueProvider<M,V>	getValueProvider()
boolean	isActive() Returns true if the filter is active.
void	setActive(boolean active, boolean supressEvent) Sets the status of the filter and fires the appropriate events.
void	setHandler(FilterHandler<V> handler)
void	setUpdateBuffer(int updateBuffer) Number of milliseconds to wait after user interaction to fire an update (defaults to 500).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Filter

public Filter(ValueProvider<M,V> valueProvider)

Method Detail

addActivateHandler

public HandlerRegistration addActivateHandler(ActivateEvent.ActivateHandler<Filter<M,?>> handler)

Description copied from interface: ActivateEvent.HasActivateHandlers

Adds a ActivateEvent handler.

Specified by:

addActivateHandler in interface ActivateEvent.HasActivateHandlers<Filter<M,?>>

Parameters:

handler - the handler

Returns:

the registration for the event

addDeactivateHandler

public HandlerRegistration addDeactivateHandler(DeactivateEvent.DeactivateHandler<Filter<M,?>> handler)

Description copied from interface: DeactivateEvent.HasDeactivateHandlers

Adds a DeactivateEvent handler.

Specified by:

addDeactivateHandler in interface DeactivateEvent.HasDeactivateHandlers<Filter<M,?>>

Parameters:

handler - the handler

Returns:

the registration for the event

addUpdateHandler

public HandlerRegistration addUpdateHandler(UpdateEvent.UpdateHandler handler)

Description copied from interface: UpdateEvent.HasUpdateHandlers

Adds a UpdateEvent.UpdateHandler handler for UpdateEvent events.

Specified by:

addUpdateHandler in interface UpdateEvent.HasUpdateHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

getFilterConfig

public abstract List<FilterConfig> getFilterConfig()

getHandler

public FilterHandler<V> getHandler()

getMenu

public Menu getMenu()

Returns the filter's menu.

Returns:

the menu

getUpdateBuffer

public int getUpdateBuffer()

Returns the update buffer.

Returns:

the update buffer in milliseconds

getValue

public abstract Object getValue()

Template method to be implemented by all subclasses that is to get and return the value of the filter.

getValueProvider

public ValueProvider<M,V> getValueProvider()

isActive

public boolean isActive()

Returns true if the filter is active.

Returns:

the active state

setActive

public void setActive(boolean active,
             boolean supressEvent)

Sets the status of the filter and fires the appropriate events. You can only set it to active if the filter is activatable.

Parameters:

active - the new filter state

supressEvent - true to prevent events from being fired

setHandler

public void setHandler(FilterHandler<V> handler)

setUpdateBuffer

public void setUpdateBuffer(int updateBuffer)

Number of milliseconds to wait after user interaction to fire an update (defaults to 500).

Parameters:

updateBuffer - the update buffer in milliseconds