com.ibm.xtools.common.ui.reduction.viewpoints

Interface IViewpointManager

public interface IViewpointManager

The IViewpointManager is responsible for managing the viewpoint preferences.

Field Summary

Fields

Modifier and Type	Field and Description
static IViewpointManager	INSTANCE Return the singleton instance of the viewpoint manager.

Method Summary

Modifier and Type	Method and Description
void	addViewpointListener(IViewpointListener viewpointListener) Adds an instance of IViewpointListener to listen for changes.
java.util.Collection<ICategory>	getAllCategories() Return all categories.
ICategory	getCategory(java.lang.String categoryId) Get the category with given ID.
Viewpoint	getEnabledViewpoint() Gets the enabled Viewpoint.
java.util.List<com.ibm.xtools.common.ui.reduction.internal.viewpoints.ViewpointElement>	getPreDefinedViewpointElements() Returns a list of pre-defined Viewpoint Elements.
java.util.List<Viewpoint>	getPreDefinedViewpoints(boolean reduced) Gets the list of pre-defined Viewpoints.
java.util.List<com.ibm.xtools.common.ui.reduction.internal.viewpoints.ViewpointElement>	getUserDefinedViewpointElements() Returns a list of user-defined viewpoint elements.
java.util.List<Viewpoint>	getUserDefinedViewpoints() Return a list of all user-defined viewpoints.
Viewpoint	getViewpoint(java.lang.String id) Return the Viewpoint for the given ID.
IViewpointElement	getViewpointElement(Viewpoint viewpoint, java.lang.String type) Return the viewpoint element for the given Viewpoint and type.
java.util.List<java.lang.String>	getViewpointElementTypes() Return the List of registered ViewpointElement types.
java.util.Collection<Viewpoint>	getViewpoints(java.lang.String categoryId, boolean reduced) Return the Viewpoints within the given category.
void	register(Viewpoint viewpoint) Registers a new user-defined viewpoint.
void	registerViewpointElement(com.ibm.xtools.common.ui.reduction.internal.viewpoints.ViewpointElement viewpointElement) Registers a new user-defined viewpoint element.
void	removeViewpointListener(IViewpointListener viewpointListener) Removes an instance of IViewpointListener listening for changes.
void	setEnabledViewpoint(Viewpoint viewpoint) Sets the enabled Viewpoint.
void	unregister(Viewpoint viewpoint) Unregister a user-defined viewpoint.
void	unregisterViewpointElement(com.ibm.xtools.common.ui.reduction.internal.viewpoints.ViewpointElement viewpointElement) Unregister a user-defined viewpoint element.

Field Detail

INSTANCE

static final IViewpointManager INSTANCE

Return the singleton instance of the viewpoint manager.

Method Detail

getCategory

ICategory getCategory(java.lang.String categoryId)

Get the category with given ID.

Parameters:

categoryId - the ID of the category

Returns:

the category with given ID

getViewpoints

java.util.Collection<Viewpoint> getViewpoints(java.lang.String categoryId,
                                              boolean reduced)

Return the Viewpoints within the given category.

Parameters:

categoryId - the ID of the category to get Viewpoints for

reduced - use true Viewpoints should be reduced by capabilities, false otherwise

Returns:

the Viewpoints within the given category

getAllCategories

java.util.Collection<ICategory> getAllCategories()

Return all categories.

Returns:

all categories

getPreDefinedViewpoints

java.util.List<Viewpoint> getPreDefinedViewpoints(boolean reduced)

Gets the list of pre-defined Viewpoints.

Parameters:

reduced - use true Viewpoints should be reduced by capabilities, false otherwise

Returns:

the list of pre-defined Viewpoints

getPreDefinedViewpointElements

java.util.List<com.ibm.xtools.common.ui.reduction.internal.viewpoints.ViewpointElement> getPreDefinedViewpointElements()

Returns a list of pre-defined Viewpoint Elements. Those elements are contributed thought the registry. The pre-defiend viewpoint element must have predefined viewpoint associate with it.

getUserDefinedViewpointElements

java.util.List<com.ibm.xtools.common.ui.reduction.internal.viewpoints.ViewpointElement> getUserDefinedViewpointElements()

Returns a list of user-defined viewpoint elements.

getUserDefinedViewpoints

java.util.List<Viewpoint> getUserDefinedViewpoints()

Return a list of all user-defined viewpoints.

Returns:

a list of all user-defined viewpoints

getEnabledViewpoint

Viewpoint getEnabledViewpoint()

Gets the enabled Viewpoint.

Returns:

the enabled Viewpoint

setEnabledViewpoint

void setEnabledViewpoint(Viewpoint viewpoint)

Sets the enabled Viewpoint.

Parameters:

viewpoint - the Viewpoint to enable

getViewpoint

Viewpoint getViewpoint(java.lang.String id)

Return the Viewpoint for the given ID.

Parameters:

id - the Viewpoint ID

Returns:

the Viewpoint for the given ID

register

void register(Viewpoint viewpoint)

Registers a new user-defined viewpoint.

Parameters:

viewpoint - the new user-defined viewpoint.

registerViewpointElement

void registerViewpointElement(com.ibm.xtools.common.ui.reduction.internal.viewpoints.ViewpointElement viewpointElement)

Registers a new user-defined viewpoint element.

Parameters:

viewpointElement - element the new user-defined viewpoint element.

unregister

void unregister(Viewpoint viewpoint)

Unregister a user-defined viewpoint.

Parameters:

viewpoint - the user-defined viewpoint

unregisterViewpointElement

void unregisterViewpointElement(com.ibm.xtools.common.ui.reduction.internal.viewpoints.ViewpointElement viewpointElement)

Unregister a user-defined viewpoint element.

Parameters:

viewpointElement - element the user-defined viewpoint element

addViewpointListener

void addViewpointListener(IViewpointListener viewpointListener)

Adds an instance of IViewpointListener to listen for changes.

Parameters:

viewpointListener - the listener to add

removeViewpointListener

void removeViewpointListener(IViewpointListener viewpointListener)

Removes an instance of IViewpointListener listening for changes.

Parameters:

viewpointListener - the listener to remove

getViewpointElementTypes

java.util.List<java.lang.String> getViewpointElementTypes()

Return the List of registered ViewpointElement types.

Returns:

the List of ViewpointElement types

getViewpointElement

IViewpointElement getViewpointElement(Viewpoint viewpoint,
                                      java.lang.String type)

Return the viewpoint element for the given Viewpoint and type.

If no viewpoint element currently exists for the given Viewpoint and type then a user defined viewpoint element is created and registered with this IViewpointManager.

If the given Viewpoint is not registered, or the type does not correspond to a viewpoint element type, then this method returns null.

Parameters:

viewpoint - the viewpoint

type - the viewpoint element type

Returns:

the corresponding viewpoint element