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

Class DateFilter<M>

java.lang.Object

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

com.sencha.gxt.widget.core.client.grid.filters.DateFilter<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

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

public class DateFilter<M>
extends Filter<M,Date>

A date filter. See Filter for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DateFilter.DateFilterMessages The locale-sensitive messages used by this class.
class	DateFilter.DefaultDateFilterMessages The default locale-sensitive messages used by this class.
protected class	DateFilter.Handler

Field Summary

Fields

Modifier and Type	Field and Description
protected CheckMenuItem	afterItem
protected DateMenu	afterMenu
protected CheckMenuItem	beforeItem
protected DateMenu	beforeMenu
protected DateFilter.Handler	handler
protected Date	maxDate
protected DateFilter.DateFilterMessages	messages
protected Date	minDate
protected CheckMenuItem	onItem
protected DateMenu	onMenu
protected List<RangeMenu.RangeItem>	rangeItems

Fields inherited from class com.sencha.gxt.widget.core.client.grid.filters.Filter

active, eventBus, menu, updateBuffer, valueProvider

Constructor Summary

Constructors

Constructor and Description
DateFilter(ValueProvider<? super M,Date> valueProvider) Creates a date filter for the specified value provider.

Method Summary

Modifier and Type	Method and Description
DateMenu	getAfterMenu()
DateMenu	getBeforeMenu()
List<FilterConfig>	getFilterConfig() Returns a list of filter configurations.
Date	getMaxDate() Returns the max date.
DateFilter.DateFilterMessages	getMessages() Returns the locale-sensitive messages used by this class.
Date	getMinDate() Returns the minimum date.
DateMenu	getOnMenu()
protected Class<Date>	getType()
Object	getValue() Template method to be implemented by all subclasses that is to get and return the value of the filter.
protected void	handleCheckChange(CheckChangeEvent<CheckMenuItem> event)
void	handleMenuSelect(<any> event) Handles the menu select event generated by the filter menu.
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.
void	setAfterDate(Date date) Sets the after date.
void	setBeforeDate(Date date) Sets the before date.
void	setFilterConfig(List<FilterConfig> configs) Sets the filters values using the given filter configs.
void	setMaxDate(Date maxDate) Sets the max date as passed to the date picker.
void	setMessages(DateFilter.DateFilterMessages messages) Sets the local-sensitive messages used by this class.
void	setMinDate(Date minDate) Set's the minimum date as passed to the date picker.
void	setOnDate(Date date) Sets the on date.
void	setValue(List<FilterConfig> values) Sets the filter's values.
protected void	updateMenuState(CheckMenuItem item, boolean checked)
protected boolean	validateModel(M 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.sencha.gxt.widget.core.client.grid.filters.Filter

addActivateHandler, addDeactivateHandler, addUpdateHandler, createNewFilterConfig, fireUpdate, getHandler, getMenu, getUpdateBuffer, getValueProvider, isActive, setActive, setActive, setHandler, setUpdateBuffer

Methods inherited from class java.lang.Object

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

Field Detail

beforeItem

protected CheckMenuItem beforeItem

afterItem

protected CheckMenuItem afterItem

onItem

protected CheckMenuItem onItem

beforeMenu

protected DateMenu beforeMenu

afterMenu

protected DateMenu afterMenu

onMenu

protected DateMenu onMenu

messages

protected DateFilter.DateFilterMessages messages

minDate

protected Date minDate

maxDate

protected Date maxDate

rangeItems

protected List<RangeMenu.RangeItem> rangeItems

handler

protected DateFilter.Handler handler

Constructor Detail

DateFilter

public DateFilter(ValueProvider<? super M,Date> valueProvider)

Creates a date filter for the specified value provider. See Filter.Filter(ValueProvider) for more information.

Parameters:

valueProvider - the value provider

Method Detail

getAfterMenu

public DateMenu getAfterMenu()

getBeforeMenu

public DateMenu getBeforeMenu()

getFilterConfig

public List<FilterConfig> getFilterConfig()

Description copied from class: Filter

Returns a list of filter configurations. Note that a filter may consist of multiple criteria (e.g. "date after" and "date before"). There is a filter configuration for each of these criteria.

Specified by:

getFilterConfig in class Filter<M,Date>

Returns:

a list of filter configurations

getMaxDate

public Date getMaxDate()

Returns the max date.

Returns:

the max date

getMessages

public DateFilter.DateFilterMessages getMessages()

Returns the locale-sensitive messages used by this class.

Returns:

the local-sensitive messages used by this class.

getMinDate

public Date getMinDate()

Returns the minimum date.

Returns:

the minimum date

getOnMenu

public DateMenu getOnMenu()

getValue

public Object getValue()

Description copied from class: Filter

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

Specified by:

getValue in class Filter<M,Date>

Returns:

the filter value

handleMenuSelect

public void handleMenuSelect(<any> event)

Handles the menu select event generated by the filter menu.

Parameters:

event - the menu select event

isActivatable

public boolean isActivatable()

Description copied from class: Filter

Template method to be implemented by all subclasses that is to return true if the filter has enough configuration information to be activated.

Overrides:

isActivatable in class Filter<M,Date>

Returns:

true if if the filter has enough configuration information to be activated

setAfterDate

public void setAfterDate(Date date)

Sets the after date. In order for the filter to be applied, Filter.setActive(boolean, boolean) must be called when setting filter value programmatically.

Parameters:

date - the after date

setBeforeDate

public void setBeforeDate(Date date)

Sets the before date. In order for the filter to be applied, Filter.setActive(boolean, boolean) must be called when setting filter value programmatically.

Parameters:

date - the before date

setMaxDate

public void setMaxDate(Date maxDate)

Sets the max date as passed to the date picker.

Parameters:

maxDate - the max date

setMessages

public void setMessages(DateFilter.DateFilterMessages messages)

Sets the local-sensitive messages used by this class.

Parameters:

messages - the locale sensitive messages used by this class.

setMinDate

public void setMinDate(Date minDate)

Set's the minimum date as passed to the date picker.

Parameters:

minDate - the minimum date

setOnDate

public void setOnDate(Date date)

Sets the on date. In order for the filter to be applied, Filter.setActive(boolean, boolean) must be called when setting filter value programmatically.

Parameters:

date - the on date

setValue

public void setValue(List<FilterConfig> values)

Sets the filter's values.

Parameters:

values - the values

getType

protected Class<Date> getType()

Specified by:

getType in class Filter<M,Date>

handleCheckChange

protected void handleCheckChange(CheckChangeEvent<CheckMenuItem> event)

updateMenuState

protected void updateMenuState(CheckMenuItem item,
                               boolean checked)

validateModel

protected boolean validateModel(M model)

Description copied from class: Filter

Template method to be implemented by all subclasses that is to validates the provided Model against the filters configuration. Defaults to return true.

Overrides:

validateModel in class Filter<M,Date>

Parameters:

model - the model

Returns:

true if valid

setFilterConfig

public void setFilterConfig(List<FilterConfig> configs)

Description copied from class: Filter

Sets the filters values using the given filter configs. The values of the filter can be changed programatically using this method.

Overrides:

setFilterConfig in class Filter<M,Date>

Parameters:

configs - the list of filter configurations