|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides support for managing the filters defined for a Common Navigator viewer.
An INavigatorFilterService manages the available common filters and their
current activation state for a particular INavigatorContentService. An
INavigatorFilterService cannot be acquired without an
INavigatorContentService (through
INavigatorContentService.getFilterService()
). Each instance will
provide information specific to the content service associated with it.
The visibility of commonFilters is controlled through matching viewerContentBindings. That is, like content extensions, the id of a commonFilter must match an includes expression for at least one viewerContentBinding element for the corresponding INavigatorContentService.
The activation of each filter should be persisted from session to session.
Clients of this interface have control over when the persistence occurs. In
particular, clients should call persistFilterActivationState()
after each call to setActiveFilterIds(String[])
.
This interface is not intended to be implemented by clients.
INavigatorContentService.getFilterService()
,
ViewerFilter
Method Summary | |
---|---|
ICommonFilterDescriptor[] |
getVisibleFilterDescriptors()
Visible filters are filters whose ids match a viewerContentBinding for the corresponding viewer. |
ViewerFilter[] |
getVisibleFilters(boolean toReturnOnlyActiveFilters)
Determine the set of filters which are visible to the content service associated with this filter service. |
boolean |
isActive(String aFilterId)
|
void |
persistFilterActivationState()
Persist the current activation state for visible filters. |
void |
setActiveFilterIds(String[] theFilterIds)
Activate the set of given filters. |
Method Detail |
public ViewerFilter[] getVisibleFilters(boolean toReturnOnlyActiveFilters)
toReturnOnlyActiveFilters
- True indicates that only active filters should be returned.
public ICommonFilterDescriptor[] getVisibleFilterDescriptors()
public boolean isActive(String aFilterId)
aFilterId
- Check the activation of aFilterId for the content service
corresponding to this filter service.
public void setActiveFilterIds(String[] theFilterIds)
getVisibleFilters(boolean)
. An inactive filter will
only be returned from getVisibleFilters(boolean)
when it is
called with false.
theFilterIds
- An array of filter ids to activate.public void persistFilterActivationState()
|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.