Modelers

org.topcased.modeler.extensions
Class OutlineManager

java.lang.Object
  extended by AbstractExtensionManager
      extended by org.topcased.modeler.extensions.OutlineManager

public final class OutlineManager
extends AbstractExtensionManager

An outline provider.
Provides all registered extensions for org.topcased.modeler.outline extension point.
Creation : 24 nov. 2005


Nested Class Summary
 class OutlineManager.CreateChildMenuConfiguration
          Represents a 'Create child' menu configuration for the org.topcased.modeler.outline extension point.
 class OutlineManager.FilterConfiguration
          Represents an outline filter configuration for the org.topcased.modeler.outline extension point.
 class OutlineManager.SorterConfiguration
          Represents an outline sorter configuration for the org.topcased.modeler.outline extension point.
 
Method Summary
protected  void addExtension(org.eclipse.core.runtime.IExtension extension)
           
 OutlineManager.CreateChildMenuConfiguration getCreateChildMenuConfiguration(java.lang.String configId)
          Gets a OutlineManager.CreateChildMenuConfiguration by its id.
 java.util.Collection getCreateChildMenus(java.lang.String editorId)
          Gets the collection of OutlineManager.FilterConfiguration for the given Topcased editor id.
 OutlineManager.FilterConfiguration getFilterConfiguration(java.lang.String configId)
          Gets a OutlineManager.FilterConfiguration by its id.
 java.util.Collection getFilters(java.lang.String editorId)
          Gets the collection of OutlineManager.FilterConfiguration for the given Topcased editor id.
static OutlineManager getInstance()
          Get this outline manager unique instance.
 OutlineManager.SorterConfiguration getSorterConfiguration(java.lang.String configId)
          Gets a OutlineManager.SorterConfiguration by its id.
 java.util.Collection getSorters(java.lang.String editorId)
          Gets the collection of OutlineManager.SorterConfiguration for the given Topcased editor id.
protected  void initialize()
          Initialize this outline manager reading the extension registry.
protected  void removeExtension(org.eclipse.core.runtime.IExtension extension)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static OutlineManager getInstance()
Get this outline manager unique instance.

Returns:
this outline manager

initialize

protected void initialize()
Initialize this outline manager reading the extension registry.


addExtension

protected void addExtension(org.eclipse.core.runtime.IExtension extension)
See Also:
org.topcased.facilities.extensions.AbstractExtensionManager#addExtension(org.eclipse.core.runtime.IExtension)

removeExtension

protected void removeExtension(org.eclipse.core.runtime.IExtension extension)
See Also:
org.topcased.facilities.extensions.AbstractExtensionManager#removeExtension(org.eclipse.core.runtime.IExtension)

getCreateChildMenus

public java.util.Collection getCreateChildMenus(java.lang.String editorId)
Gets the collection of OutlineManager.FilterConfiguration for the given Topcased editor id.

Parameters:
editorId - a Topcased editor id or null to get all the configurations
Returns:
a collection of CreateChildMenuConfiguration. Never returns null.

getCreateChildMenuConfiguration

public OutlineManager.CreateChildMenuConfiguration getCreateChildMenuConfiguration(java.lang.String configId)
Gets a OutlineManager.CreateChildMenuConfiguration by its id.

Parameters:
configId - a configuration id
Returns:
a CreateChildMenuConfiguration or null if it does not exist.

getFilters

public java.util.Collection getFilters(java.lang.String editorId)
Gets the collection of OutlineManager.FilterConfiguration for the given Topcased editor id.

Parameters:
editorId - a Topcased editor id or null to get all the configurations
Returns:
a collection of FilterConfiguration. Never returns null.

getFilterConfiguration

public OutlineManager.FilterConfiguration getFilterConfiguration(java.lang.String configId)
Gets a OutlineManager.FilterConfiguration by its id.

Parameters:
configId - a configuration id
Returns:
a FilterConfiguration or null if it does not exist.

getSorters

public java.util.Collection getSorters(java.lang.String editorId)
Gets the collection of OutlineManager.SorterConfiguration for the given Topcased editor id.

Parameters:
editorId - a Topcased editor id or null to get all the configurations
Returns:
a collection of SorterConfiguration. Never returns null.

getSorterConfiguration

public OutlineManager.SorterConfiguration getSorterConfiguration(java.lang.String configId)
Gets a OutlineManager.SorterConfiguration by its id.

Parameters:
configId - a configuration id
Returns:
a SorterConfiguration or null if it does not exist.

Modelers

Copyright (c) 2005 TOPCASED Contributors 2005 - 2007. All rights reserved.