|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.kiml.ui.diagram.DiagramLayoutEngine
public class DiagramLayoutEngine
The entry class for automatic layout of graphical diagrams.
Field Summary | |
---|---|
static DiagramLayoutEngine |
INSTANCE
the singleton instance that can be used whenever layout needs to be performed. |
static IProperty<IKielerProgressMonitor> |
PROGRESS_MONITOR
property for layout context: the progress monitor that was used for layout. |
Constructor Summary | |
---|---|
DiagramLayoutEngine()
|
Method Summary | ||
---|---|---|
static int |
calcAnimationTime(LayoutMapping<?> mapping,
boolean animate)
Calculates animation time for the given graph size. |
|
LayoutOptionManager |
getOptionManager()
Returns the currently used layout option manager. |
|
|
layout(IDiagramLayoutManager<T> layoutManager,
IWorkbenchPart workbenchPart,
Object diagramPart,
boolean animate,
boolean progressBar,
boolean layoutAncestors,
boolean zoom,
ILayoutConfig extraLayoutConfig)
Perform layout on the given workbench part using the given layout manager. |
|
LayoutMapping<?> |
layout(IWorkbenchPart workbenchPart,
Object diagramPart,
boolean animate,
boolean progressBar,
boolean layoutAncestors,
boolean zoom)
Perform layout on the given workbench part. |
|
LayoutMapping<?> |
layout(IWorkbenchPart workbenchPart,
Object diagramPart,
boolean animate,
boolean progressBar,
boolean layoutAncestors,
boolean zoom,
ILayoutConfig extraLayoutConfig)
Perform layout on the given workbench part. |
|
IStatus |
layout(LayoutMapping<?> mapping,
IKielerProgressMonitor progressMonitor,
ILayoutConfig extraLayoutConfig)
Perform layout on the given layout graph mapping. |
|
IStatus |
layout(LayoutMapping<?> mapping,
Object diagramPart,
IKielerProgressMonitor progressMonitor,
ILayoutConfig extraLayoutConfig,
boolean layoutAncestors)
Perform layout on the given layout graph mapping. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final DiagramLayoutEngine INSTANCE
public static final IProperty<IKielerProgressMonitor> PROGRESS_MONITOR
Constructor Detail |
---|
public DiagramLayoutEngine()
Method Detail |
---|
public LayoutMapping<?> layout(IWorkbenchPart workbenchPart, Object diagramPart, boolean animate, boolean progressBar, boolean layoutAncestors, boolean zoom)
workbenchPart
- the workbench part for which layout is performeddiagramPart
- the parent diagram part for which layout is performed, or null
if the whole
diagram shall be layoutedanimate
- if true, animation is activatedprogressBar
- if true, a progress bar is displayedlayoutAncestors
- if true, layout is not only performed for the selected diagram part, but also for
its ancestorszoom
- if true, automatic zoom-to-fit is activated
public LayoutMapping<?> layout(IWorkbenchPart workbenchPart, Object diagramPart, boolean animate, boolean progressBar, boolean layoutAncestors, boolean zoom, ILayoutConfig extraLayoutConfig)
workbenchPart
- the workbench part for which layout is performeddiagramPart
- the parent diagram part for which layout is performed, or null
if the whole
diagram shall be layoutedanimate
- if true, animation is activatedprogressBar
- if true, a progress bar is displayedlayoutAncestors
- if true, layout is not only performed for the selected diagram part, but also for
its ancestorszoom
- if true, automatic zoom-to-fit is activatedextraLayoutConfig
- an additional layout configuration to use, or null
public <T> LayoutMapping<T> layout(IDiagramLayoutManager<T> layoutManager, IWorkbenchPart workbenchPart, Object diagramPart, boolean animate, boolean progressBar, boolean layoutAncestors, boolean zoom, ILayoutConfig extraLayoutConfig)
T
- the type of diagram part that is handled by the given diagram layout managerlayoutManager
- a diagram layout managerworkbenchPart
- the workbench part for which layout is performeddiagramPart
- the parent diagram part for which layout is performed, or null
if the whole
diagram shall be layoutedanimate
- if true, animation is activatedprogressBar
- if true, a progress bar is displayedlayoutAncestors
- if true, layout is not only performed for the selected diagram part, but also for
its ancestorszoom
- if true, automatic zoom-to-fit is activatedextraLayoutConfig
- an additional layout configuration to use, or null
public static int calcAnimationTime(LayoutMapping<?> mapping, boolean animate)
mapping
- a mapping of the layout graphanimate
- whether animation should be performed
public LayoutOptionManager getOptionManager()
public IStatus layout(LayoutMapping<?> mapping, Object diagramPart, IKielerProgressMonitor progressMonitor, ILayoutConfig extraLayoutConfig, boolean layoutAncestors)
mapping
- a mapping for the layout graphdiagramPart
- the parent diagram part for which layout is performed, or null
if the whole
diagram shall be layoutedprogressMonitor
- a progress monitor to which progress of the layout algorithm is reportedextraLayoutConfig
- an additional layout configuration to use, or null
layoutAncestors
- if true, layout is not only performed for the selected diagram part, but also for
its ancestors
public IStatus layout(LayoutMapping<?> mapping, IKielerProgressMonitor progressMonitor, ILayoutConfig extraLayoutConfig)
mapping
- a mapping for the layout graphprogressMonitor
- a progress monitor to which progress of the layout algorithm is reportedextraLayoutConfig
- an additional layout configuration to use, or null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |