ides.api.plugin.layout
Class FSALayoutManager

java.lang.Object
  ides.api.plugin.layout.FSALayoutManager

public class FSALayoutManager
extends java.lang.Object

The manager of classes for the layout of FSAModels. Some layout classes are included with IDES.

Author:

Lenko Grigorov

See Also:

FSALayouter, registerLayouter(FSALayouter), getDefaultFSALayouter()

Field Summary

protected FSALayouter	defaultLayouter The default layouter to be used by IDES.
protected java.util.Map<java.lang.String,FSALayouter>	layouters The indexed set of all registered layouters.

Method Summary

java.lang.Object	clone()
FSALayouter	getDefaultFSALayouter() Retrieve the default FSA layouter which is used by IDES.
FSALayouter	getLayouter(java.lang.String name) Retrieve the layouter with the given name.
java.util.Set<java.lang.String>	getLayouterNames() Retrieve the names of all registered FSALayouters.
static FSALayoutManager	instance() Provides access to the instance of the manager.
void	registerLayouter(FSALayouter layouter) Register an FSALayouter with IDES.
void	setDefaultLayouter(FSALayouter layouter) Register the given layout and start using it as the default layouter for FSAModels.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

layouters

protected java.util.Map<java.lang.String,FSALayouter> layouters

The indexed set of all registered layouters. The key to the index is the name of the corresponding layouter.

defaultLayouter

protected FSALayouter defaultLayouter

The default layouter to be used by IDES.

See Also:

getDefaultFSALayouter(), setDefaultLayouter(FSALayouter)

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

instance

public static FSALayoutManager instance()

Provides access to the instance of the manager.

Returns:

the model manager

getDefaultFSALayouter

public FSALayouter getDefaultFSALayouter()

Retrieve the default FSA layouter which is used by IDES.

Returns:

the default FSA layouter which is used by IDES

registerLayouter

public void registerLayouter(FSALayouter layouter)

Register an FSALayouter with IDES. This class will become available for the layout of FSAModels.

If a layouter with the same name has already been registered, the new layouter will replace it.

Parameters:

layouter - the layouter to be registered

getLayouterNames

public java.util.Set<java.lang.String> getLayouterNames()

Retrieve the names of all registered FSALayouters.

Returns:

the names of all registered FSALayouters

getLayouter

public FSALayouter getLayouter(java.lang.String name)

Retrieve the layouter with the given name. If no layouter with the given name has been registered, returns null.

Parameters:

name - the name of the layouter

Returns:

the layouter with the given name; or null if no layouter with the given name has been registered

setDefaultLayouter

public void setDefaultLayouter(FSALayouter layouter)

Register the given layout and start using it as the default layouter for FSAModels.

Parameters:

layouter - the layouter to be registered and used as a default layouter