com.yworks.yfiles.layout.hierarchic

Interface ILayer

public interface ILayer

This interface describes a single layer in a hierarchic layout.

A layer consists of nodes along with the associated same-layer edges. Each layer has a type and an index representing its order in the list of layers.

See Also:

ILayers, HierarchicLayoutCore, ILayerer

Method Summary

Modifier and Type	Method and Description
void	add(Node node) Adds a newly created Node to this ILayer instance.
void	addSameLayerEdge(Edge edge) Adds a same-layer Edge to this ILayer instance.
int	getIndex() Gets the index of this ILayer instance in the list of all layers.
NodeList	getList() Gets a list of the Nodes associated with this ILayer instance.
RowDescriptor	getRow() Gets the RowDescriptor associated with this ILayer instance.
YList	getSameLayerEdges() Gets a list of all same-layer Edges associated with this ILayer instance.
LayerType	getType() Gets the type of this ILayer instance.
void	remove() Removes the current layer from the list of layers.
void	remove(Node node) Removes a Node from this ILayer instance.
void	setNodeOrder(YList list) Adjusts the order of the Nodes of this ILayer instance according to the given order.
void	setRow(RowDescriptor value) Sets the RowDescriptor associated with this ILayer instance.

Method Detail

add

void add(Node node)

Adds a newly created Node to this ILayer instance.

Parameters:

node - the Node to be added

addSameLayerEdge

void addSameLayerEdge(Edge edge)

Adds a same-layer Edge to this ILayer instance.

Parameters:

edge - the same-layer Edge to be added

getIndex

int getIndex()

Gets the index of this ILayer instance in the list of all layers.

Returns:

the index of this ILayer instance

getList

NodeList getList()

Gets a list of the Nodes associated with this ILayer instance.

Returns:

a list of the Nodes of this ILayer

getRow

RowDescriptor getRow()

Gets the RowDescriptor associated with this ILayer instance.

Returns:

a RowDescriptor instance

See Also:

setRow(RowDescriptor)

getSameLayerEdges

YList getSameLayerEdges()

Gets a list of all same-layer Edges associated with this ILayer instance.

Returns:

a list of all same-layer Edges

getType

LayerType getType()

Gets the type of this ILayer instance.

Returns:

one of the predefined layer types

remove

void remove()

Removes the current layer from the list of layers.

remove

void remove(Node node)

Removes a Node from this ILayer instance.

Parameters:

node - the Node to be removed

setNodeOrder

void setNodeOrder(YList list)

Adjusts the order of the Nodes of this ILayer instance according to the given order.

Parameters:

list - the given list to be used

setRow

void setRow(RowDescriptor value)

Sets the RowDescriptor associated with this ILayer instance.

Parameters:

value - a RowDescriptor instance

See Also:

getRow()