eu.geclipse.ui.views.filters
Interface IGridFilter

All Known Implementing Classes:

AbstractGridViewerFilter, JobStatusFilter, JobSubmissionTimeFilter

public interface IGridFilter

Filter used in g-eclipse views

Method Summary

ViewerFilter	getFilter()
java.lang.String	getFilterId()
boolean	isEnabled() Useful when in given filter configuration user doesn't want to use all filters (e.g. user want to filter jobs using status, but he haven't specified submission date)
IGridFilter	makeClone() Cloning is used in ConfigureFiltersDialog, so it's important that every IGridFilter implement clone
void	readState(IMemento filterMemento) Read filter state from IMemento
void	saveState(IMemento filterMemento) Saves filter state into IMemento

Method Detail

isEnabled

boolean isEnabled()

Useful when in given filter configuration user doesn't want to use all filters (e.g. user want to filter jobs using status, but he haven't specified submission date)

Returns:

true if this filter should be applied to the view

saveState

void saveState(IMemento filterMemento)

Saves filter state into IMemento

Parameters:

filterMemento - memento, in which filter state should be stored

readState

void readState(IMemento filterMemento)

Read filter state from IMemento

Parameters:

filterMemento - memento, from which filter state will be restored

getFilter

ViewerFilter getFilter()

Returns:

ViewerFilter implementation used by eclipse StructuredViewer

makeClone

IGridFilter makeClone()
                      throws java.lang.CloneNotSupportedException

Cloning is used in ConfigureFiltersDialog, so it's important that every IGridFilter implement clone

Returns:

cloned filter

Throws:

java.lang.CloneNotSupportedException

getFilterId

java.lang.String getFilterId()

Returns:

filter id used to find filter in memento. Every IGridFilter class should has unique id. Objects of the same class should have the same id.