TPTP 4.4.0 Platform Project
Public API Specification

org.eclipse.hyades.ui.filters
Interface IFilterViewer

All Known Implementing Classes:
FilterTraceViewer, FilterTypeSampleView, TraceInteractions

public interface IFilterViewer

The viewer associated with the view filters to be shown.


Method Summary
 void filterUpdated()
          When a filter is selected or changed, this method is called to signal to the viewer that one of its filters have changed or updated.
 java.lang.String[] getFilterScope()
          Returns the filter scope associated with the IFilterViewer implementor.
 void setFilterQueryProvider(IFilterQueryProvider filterQueryProvider)
          When the action is created, this method is called providing the IFilterQueryProvider to the viewer.
 

Method Detail

filterUpdated

public void filterUpdated()
When a filter is selected or changed, this method is called to signal to the viewer that one of its filters have changed or updated. The implementor can handle this in its choosing (examples: lazy refreshing, immediate refreshing).


setFilterQueryProvider

public void setFilterQueryProvider(IFilterQueryProvider filterQueryProvider)
When the action is created, this method is called providing the IFilterQueryProvider to the viewer. The viewer could then use this method to get the filter, or update filter queries in some programmatic way. The IFilterQueryProvider must also be used to call #IFilterQueryProvider.viewerDisposed() when this viewer is disposed.


getFilterScope

public java.lang.String[] getFilterScope()
Returns the filter scope associated with the IFilterViewer implementor. The filter scope is used to determine what filter types associated with this viewer. If a filter type is associated with any scope returned here its filters are displayed and can be edited/created from the action of this IFilterViewer.


TPTP 4.4.0 Platform Project
Public API Specification