|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.kiml.ui.layout.DiagramLayoutManager
public abstract class DiagramLayoutManager
Abstract superclass for managers of diagram layout.
Field Summary | |
---|---|
static int |
MAX_PROGRESS_LEVELS
maximal number of recursion levels for which progress is displayed. |
Constructor Summary | |
---|---|
DiagramLayoutManager()
|
Method Summary | |
---|---|
void |
applyAndZoom(boolean animate,
boolean cacheLayout,
int nodeCount)
Apply layout with zoom and animation. |
void |
applyAnimatedLayout(boolean animate,
boolean cacheLayout,
int nodeCount)
Apply layout with or without animation. |
protected abstract void |
applyLayout()
Applies the transferred layout to the original diagram. |
abstract KNode |
buildLayoutGraph(IWorkbenchPart workbenchPart,
EditPart editPart,
boolean layoutAncestors)
Builds a KGraph instance for the given editor or edit part. |
static int |
calcAnimationTime(int graphSize)
Calculates animation time for the given graph size. |
abstract IGraphicalFrameworkBridge |
getBridge()
Returns the graphical framework bridge for this layout manager. |
protected abstract ICachedLayout |
getCachedLayout()
Returns the cached layout for the last layout run. |
EditPart |
getEditPart(KNode knode)
Returns the edit part associated with the given layout node. |
protected ILayoutConfig |
getExternalConfig()
Returns the layout configuration that was set externally for this layout manager. |
abstract ILayoutConfig |
getLayoutConfig(EditPart editPart)
Returns a layout configuration for the given edit part. |
abstract KNode |
getLayoutGraph()
Returns the last built layout graph. |
KNode |
getLayoutNode(EditPart editPart)
Returns the layout node associated with the given edit part. |
int |
getPriority()
Return the manager priority. |
IKielerProgressMonitor |
getProgressMonitor()
Returns the last used progress monitor. |
IStatus |
layout(IKielerProgressMonitor progressMonitor)
Performs layout on the given editor or edit part using this layout manager and a specific progress monitor. |
void |
layout(IWorkbenchPart workbenchPart,
EditPart editPart,
boolean animate,
boolean progressBar,
boolean layoutAncestors,
boolean cacheLayout)
Performs layout on the given editor or edit part using this layout manager. |
void |
layout(IWorkbenchPart workbenchPart,
EditPart editPart,
boolean animate,
boolean progressBar,
boolean layoutAncestors,
boolean cacheLayout,
boolean zoom)
Performs layout on the given editor or edit part using this layout manager. |
void |
setLayoutConfig(ILayoutConfig layoutConfig)
Set an external layout configuration to use with this layout manager. |
void |
setPriority(int thepriority)
Set the manager priority. |
protected abstract boolean |
supports(EditPart editPart)
Determines whether this layout manager is able to perform layout for the given edit part. |
protected abstract boolean |
supports(IWorkbenchPart workbenchPart)
Determines whether this layout manager is able to perform layout for the given editor. |
protected abstract void |
transferLayout(boolean cacheLayout)
Transfers all layout data from the last created KGraph instance to the original diagram. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int MAX_PROGRESS_LEVELS
Constructor Detail |
---|
public DiagramLayoutManager()
Method Detail |
---|
public final int getPriority()
public final void setPriority(int thepriority)
thepriority
- the priority to setpublic final void setLayoutConfig(ILayoutConfig layoutConfig)
null
as parameter resets the configuration to the
standard.
layoutConfig
- a layout configuration, or null
protected final ILayoutConfig getExternalConfig()
null
public final void layout(IWorkbenchPart workbenchPart, EditPart editPart, boolean animate, boolean progressBar, boolean layoutAncestors, boolean cacheLayout)
workbenchPart
- the workbench part for which layout is performed, or null
if
the diagram is not part of an editoreditPart
- the parent edit part for which layout is performed, or
null
if the whole diagram shall be layoutedanimate
- if true, Draw2D animation is activatedprogressBar
- if true, a progress bar is displayedlayoutAncestors
- if true, layout is not only performed for the selected edit
part, but also for its ancestorscacheLayout
- if true, the layout result is cached for the underlying modelpublic final void layout(IWorkbenchPart workbenchPart, EditPart editPart, boolean animate, boolean progressBar, boolean layoutAncestors, boolean cacheLayout, boolean zoom)
workbenchPart
- the workbench part for which layout is performed, or null
if
the diagram is not part of an editoreditPart
- the parent edit part for which layout is performed, or
null
if the whole diagram shall be layoutedanimate
- if true, Draw2D animation is activatedprogressBar
- if true, a progress bar is displayedlayoutAncestors
- if true, layout is not only performed for the selected edit
part, but also for its ancestorscacheLayout
- if true, the layout result is cached for the underlying modelzoom
- if true, automatic zoom-to-fit is activatedpublic final void applyAndZoom(boolean animate, boolean cacheLayout, int nodeCount)
animate
- if true, activate Draw2D animationcacheLayout
- if true, the layout result is cached for the underlying modelnodeCount
- the number of nodes in the layouted diagrampublic final void applyAnimatedLayout(boolean animate, boolean cacheLayout, int nodeCount)
animate
- if true, activate Draw2D animationcacheLayout
- if true, the layout result is cached for the underlying modelnodeCount
- the number of nodes in the layouted diagrampublic IStatus layout(IKielerProgressMonitor progressMonitor)
progressMonitor
- a progress monitor to which progress of the layout algorithm
is reported
public IKielerProgressMonitor getProgressMonitor()
public static int calcAnimationTime(int graphSize)
graphSize
- total number of nodes in the graph
public EditPart getEditPart(KNode knode)
#buildLayoutGraph(IEditorPart, EditPart, boolean)
was
called.
knode
- a node from the layout graph
null
public KNode getLayoutNode(EditPart editPart)
#buildLayoutGraph(IEditorPart, EditPart, boolean)
was
called.
editPart
- an edit part of the currently layouted diagram
null
protected abstract boolean supports(IWorkbenchPart workbenchPart)
workbenchPart
- a workbench part
protected abstract boolean supports(EditPart editPart)
editPart
- an edit part
public abstract KNode buildLayoutGraph(IWorkbenchPart workbenchPart, EditPart editPart, boolean layoutAncestors)
workbenchPart
- the workbench part for which layout is performed, or null
editPart
- the parent edit part for which layout is performed, or
null
if the whole diagram shall be layoutedlayoutAncestors
- if true, layout is not only performed for the selected edit
part, but also for its ancestors
public abstract IGraphicalFrameworkBridge getBridge()
public abstract ILayoutConfig getLayoutConfig(EditPart editPart)
editPart
is null
, a generic layout configuration is
created.
editPart
- an edit part
protected abstract void transferLayout(boolean cacheLayout)
cacheLayout
- if true, the layout result is cached for the underlying modelprotected abstract void applyLayout()
public abstract KNode getLayoutGraph()
protected abstract ICachedLayout getCachedLayout()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |