|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.kiml.layout.AbstractLayoutProvider
public abstract class AbstractLayoutProvider
A layout provider executes a layout algorithm to layout the child elements of a node.
When used in Eclipse, layout providers must register through the layoutProviders
extension point. All layout providers published to Eclipse
this way are collected in the LayoutServices
singleton, provided the
UI plugin is loaded.
Constructor Summary | |
---|---|
AbstractLayoutProvider()
|
Method Summary | |
---|---|
abstract void |
doLayout(KNode layoutNode,
IKielerProgressMonitor progressMonitor)
Performs the actual layout process, that is attaches layout information to the given node object. |
Object |
getDefault(String optionId)
Returns the default value for the given layout option. |
void |
initialize(String parameter)
Initialize the layout provider with the given parameter. |
boolean |
supportsHierarchy(KNode layoutNode)
Determines whether this layout provider supports hierarchy. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractLayoutProvider()
Method Detail |
---|
public void initialize(String parameter)
parameter
- a string used to parameterize the layout provider
instancepublic abstract void doLayout(KNode layoutNode, IKielerProgressMonitor progressMonitor) throws KielerException
layoutNode
- the parent node which should be laid outprogressMonitor
- progress monitor used to keep track of progress
KielerException
- if the method fails to perform layoutpublic Object getDefault(String optionId)
null
.
optionId
- identifier of a layout option
null
if this
layout provider does not know that optionpublic boolean supportsHierarchy(KNode layoutNode)
false
.
layoutNode
- the parent node for which layout is requested
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |