com.yworks.yfiles.layout.hierarchic

Interface ILayers

public interface ILayers

This interface manages multiple ILayer instances.

HierarchicLayoutCore creates instances of this class and passes them to the instances that handle the various sub-tasks of the layout process during automatic layout.

Method createInstance() can be used as a factory method to obtain temporary ILayers instances.

See Also:

ILayer

Method Summary

Modifier and Type	Method and Description
ILayers	createInstance() Creates a new and empty ILayers instance that can be used on the same graph instance for temporary results.
ILayer	getLayer(int i) Returns the layer at the specified position in this list of layers.
ILayer	insert(LayerType type, int position) Creates, inserts and returns a layer of a given type associated with this list of layers.
void	remove(int index) Removes the layer at the specified position from this list of layers.
int	size() Returns the number of layers associated with this ILayers instance.

Method Detail

createInstance

ILayers createInstance()

Creates a new and empty ILayers instance that can be used on the same graph instance for temporary results.

Returns:

a new and empty ILayers instance

getLayer

ILayer getLayer(int i)

Returns the layer at the specified position in this list of layers.

Parameters:

i - the zero-based index of the layer to return

Returns:

the layer at the specified position

insert

ILayer insert(LayerType type,
              int position)

Creates, inserts and returns a layer of a given type associated with this list of layers.

Parameters:

type - one of the predefined layer types as defined in ILayer interface

position - the index at which the specified layer is to be inserted

Returns:

a new ILayer instance

remove

void remove(int index)

Removes the layer at the specified position from this list of layers.

Parameters:

index - the zero-based index of the layer to remove

size

int size()

Returns the number of layers associated with this ILayers instance.

Returns:

the number of layers of this ILayers instance