|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.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
LayoutDataService
singleton, provided the UI plugin is loaded.
Constructor Summary | |
---|---|
AbstractLayoutProvider()
|
Method Summary | |
---|---|
void |
dispose()
Dispose the layout provider by releasing any resources that are held. |
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 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 void dispose()
public abstract void doLayout(KNode parentNode, IKielerProgressMonitor progressMonitor)
parentNode
- the parent node which should be laid outprogressMonitor
- progress monitor used to keep track of progress
UnsupportedGraphException
- if the given KGraph is not supported by
this algorithmpublic 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 |