y.layout
Class SelfLoopLayouter

java.lang.Object
  y.layout.AbstractLayoutStage
      y.layout.SelfLoopLayouter

All Implemented Interfaces:

Layouter, LayoutStage

public class SelfLoopLayouter
extends AbstractLayoutStage

A layout algorithm that routes the self-loops (reflexive edges) of a graph. By default this layouter routes self-loops in an orthogonal fashion. It places the self-loop in the least crowded quadrant around a node.

A core layout algorithm can be specified for this class. In that case the performed layout process of this class is subdivided into four stages:

1. Remove all self-loops of the input graph
2. Invoke the core layouter on the now self-loops free graph
3. Reinsert all formerly removed self-loops of the graph
4. Layout the self-loops of the input graph

Field Summary

static Object

KEEP_SELF_LOOP_LAYOUT_DPKEY This DataProvider key can be used to register a DataProvider with the graph to be laid out.

Fields inherited from interface y.layout.Layouter

EDGE_ID_DPKEY, NODE_ID_DPKEY, SELECTED_EDGES, SELECTED_NODES

Constructor Summary

SelfLoopLayouter()
Instantiates a new SelfLoopLayouter.

SelfLoopLayouter(Layouter coreLayouter)
Instantiates a new SelfLoopLayouter. the core layout routine will be delegated to the given layouter.

Method Summary

boolean	canLayout(LayoutGraph graph) Whether or not this layouter can layout the given graph.
void	doLayout(LayoutGraph graph) Lays out the given graph.
boolean	isKeepAllSelfloopLayoutsEnabled() Returns whether this algorithm should keep all self loops.
protected void	layoutSelfLoops(LayoutGraph graph) Lays out the self-loops of the given graph.
void	setKeepAllSelfloopLayoutsEnabled(boolean keepAllSelfloopLayouts) Sets whether this algorithm should keep all self loops.

Methods inherited from class y.layout.AbstractLayoutStage

canLayoutCore, doLayoutCore, getCoreLayouter, setCoreLayouter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEEP_SELF_LOOP_LAYOUT_DPKEY

public static final Object KEEP_SELF_LOOP_LAYOUT_DPKEY

This DataProvider key can be used to register a DataProvider with the graph to be laid out. This algorithm will query for each self loop the boolean value from the DataProvider to determine whether the current layout of the self-loop should be kept. I.e. if the DataProvider instance obtained from the graph using this key returns true for a self-loop, that self loop will not be laid out by this stage but the bends will be moved by that stage according to the movement of their node.

See Also:

setKeepAllSelfloopLayoutsEnabled(boolean)

Constructor Detail

SelfLoopLayouter

public SelfLoopLayouter()

Instantiates a new SelfLoopLayouter.

SelfLoopLayouter

public SelfLoopLayouter(Layouter coreLayouter)

Instantiates a new SelfLoopLayouter. the core layout routine will be delegated to the given layouter.

Method Detail

doLayout

public void doLayout(LayoutGraph graph)

Lays out the given graph.

canLayout

public boolean canLayout(LayoutGraph graph)

Whether or not this layouter can layout the given graph. Returns true if the core layouter can handle the given graph after all of its self-loops (reflexive) edges have been hidden.

layoutSelfLoops

protected void layoutSelfLoops(LayoutGraph graph)

Lays out the self-loops of the given graph. This method will be called after the core layouter has laid out the graph and all self-loops have been reinserted in the graph again.

isKeepAllSelfloopLayoutsEnabled

public boolean isKeepAllSelfloopLayoutsEnabled()

Returns whether this algorithm should keep all self loops. If this property is set, the KEEP_SELF_LOOP_LAYOUT_DPKEY DataProvider will be ignored. The default is false.

Returns:

whether all self loops should be kept

setKeepAllSelfloopLayoutsEnabled

public void setKeepAllSelfloopLayoutsEnabled(boolean keepAllSelfloopLayouts)

Sets whether this algorithm should keep all self loops. If this property is set, the KEEP_SELF_LOOP_LAYOUT_DPKEY DataProvider will be ignored.

Parameters:

keepAllSelfloopLayouts - whether all self loops should be kept