y.layout
Class SubgraphLayouter

java.lang.Object
  y.layout.AbstractLayoutStage
      y.layout.SubgraphLayouter

All Implemented Interfaces:

Layouter, LayoutStage

public class SubgraphLayouter
extends AbstractLayoutStage

A layout stage that filters out all graph elements that are not part of a subgraph that is induced by the selected nodes of the input graph.

Field Summary

Fields inherited from interface y.layout.Layouter

EDGE_ID_DPKEY, NODE_ID_DPKEY, SELECTED_EDGES, SELECTED_NODES

Constructor Summary

SubgraphLayouter()

SubgraphLayouter(Layouter coreLayouter)

Method Summary

boolean	canLayout(LayoutGraph graph) Returns true iff the given graph can be laid out by this algorithm.
void	doLayout(LayoutGraph graph) Main layout routine that assigns new layout information to the given graph.
Object	getSubgraphNodesDpKey() Returns the DataProvider key which determines the nodes that induce the subgraph to be laid out.
void	setSubgraphNodesDpKey(Object key) Specifies the DataProvider key which determines the nodes that induce the subgraph to be laid out.

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

Constructor Detail

SubgraphLayouter

public SubgraphLayouter(Layouter coreLayouter)

SubgraphLayouter

public SubgraphLayouter()

Method Detail

getSubgraphNodesDpKey

public Object getSubgraphNodesDpKey()

Returns the DataProvider key which determines the nodes that induce the subgraph to be laid out.

By default, Layouter.SELECTED_NODES is used.

Returns:

the DataProvider key.

See Also:

setSubgraphNodesDpKey(Object)

setSubgraphNodesDpKey

public void setSubgraphNodesDpKey(Object key)

Specifies the DataProvider key which determines the nodes that induce the subgraph to be laid out.

By default, Layouter.SELECTED_NODES is used.

Throws:

IllegalArgumentException - if the specified key is null.

Parameters:

key - the DataProvider key.

See Also:

getSubgraphNodesDpKey()

doLayout

public void doLayout(LayoutGraph graph)

Description copied from interface: Layouter

Main layout routine that assigns new layout information to the given graph.

canLayout

public boolean canLayout(LayoutGraph graph)

Description copied from interface: Layouter

Returns true iff the given graph can be laid out by this algorithm. Calling doLayout with the given graph as its argument will only success if this method returns true.