|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.core.properties.MapPropertyHolder
de.cau.cs.kieler.kiml.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.
Layout providers can hold properties, which represent the default layout option values of the layout provider. Subclasses can register their default layout option values in their constructor.
Constructor Summary | |
---|---|
AbstractLayoutProvider()
|
Method Summary | |
---|---|
abstract void |
doLayout(KNode parentNode,
IKielerProgressMonitor progressMonitor)
Performs the actual layout process, that is attaches layout information to the given node object. |
IDebugCanvas |
getDebugCanvas()
Returns the current debug canvas. |
void |
initialize(String parameter)
Initialize the layout provider with the given parameter. |
void |
setDebugCanvas(IDebugCanvas thedebugCanvas)
Sets the current debug canvas. |
boolean |
supportsHierarchy(KNode layoutNode)
Determines whether this layout provider would handle the complete hierarchy of the given layout node. |
Methods inherited from class de.cau.cs.kieler.core.properties.MapPropertyHolder |
---|
copyProperties, getAllProperties, getProperty, setProperty |
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) throws KielerException
parameter
- a string used to parameterize the layout provider instance
KielerException
- if the provider has received a wrong parameterpublic abstract void doLayout(KNode parentNode, IKielerProgressMonitor progressMonitor) throws KielerException
parentNode
- the parent node which should be laid outprogressMonitor
- progress monitor used to keep track of progress
KielerException
- if the method fails to perform layoutpublic boolean supportsHierarchy(KNode layoutNode)
layoutNode
- the parent node for which layout is requested
public final void setDebugCanvas(IDebugCanvas thedebugCanvas)
thedebugCanvas
- the debug canvaspublic final IDebugCanvas getDebugCanvas()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |