com.yworks.yfiles.layout

Interface ILabelLayoutFactory

public interface ILabelLayoutFactory

ILabelLayoutFactory provides methods to create, add and remove node/edge labels for LayoutGraphs.

It can be used, e.g., to temporarily add labels during layout calculation.

Note that original labels which are removed during a layout calculation have to be re-added when the layout calculation is done.

An instance of this factory can be obtained with method LayoutGraphUtilities.getLabelFactory(LayoutGraph). This method uses the LayoutGraph.createLabelFactory() method to create the factory.

Note that each factory instance is bound to a specific graph instance, i.e., you can only create, add and remove labels for the graph which was given to method LayoutGraphUtilities.getLabelFactory(LayoutGraph).

Method Summary

Modifier and Type	Method and Description
void	addLabelLayout(Edge edge, IEdgeLabelLayout labelLayout) Adds the given IEdgeLabelLayout to the given edge.
void	addLabelLayout(Node node, INodeLabelLayout labelLayout) Adds the given node label layout to the given node.
IEdgeLabelLayout	createLabelLayout(Edge edge, YOrientedRectangle orientedBox) Creates a new ILabelLayout for the given edge.
IEdgeLabelLayout	createLabelLayout(Edge edge, YOrientedRectangle orientedBox, IEdgeLabelLayoutModel model, PreferredPlacementDescriptor descriptor) Creates a new ILabelLayout for the given edge.
INodeLabelLayout	createLabelLayout(Node node, YOrientedRectangle orientedBox) Creates a new ILabelLayout for the given node.
INodeLabelLayout	createLabelLayout(Node node, YOrientedRectangle orientedBox, INodeLabelLayoutModel model) Creates a new ILabelLayout for the given node.
LayoutGraph	getGraph() Gets the graph associated with this label factory instance.
void	removeLabelLayout(Edge edge, IEdgeLabelLayout labelLayout) Removes the given IEdgeLabelLayout from the given edge.
void	removeLabelLayout(Node node, INodeLabelLayout labelLayout) Removes the given node label layout from the given node.

Method Detail

addLabelLayout

void addLabelLayout(Edge edge,
                    IEdgeLabelLayout labelLayout)

Adds the given IEdgeLabelLayout to the given edge.

The given ILabelLayout has to be created with method createLabelLayout(Edge, YOrientedRectangle) or createLabelLayout(Edge, YOrientedRectangle, IEdgeLabelLayoutModel, PreferredPlacementDescriptor).

Throws:

IllegalArgumentException - if the given label layout has already been added to the graph

Implementations of this method must ensure that re-adding temporarily removed original labels during buffered layout calculations automatically restores the original order of labels of the given edge. Otherwise, the layout calculation will most likely produce incorrect results or break down with ClassCastExceptions.

Parameters:

edge - the edge

labelLayout - the edge label layout that should be added to the given edge

See Also:

createLabelLayout(Edge, YOrientedRectangle), createLabelLayout(Edge, YOrientedRectangle, IEdgeLabelLayoutModel, PreferredPlacementDescriptor)

addLabelLayout

void addLabelLayout(Node node,
                    INodeLabelLayout labelLayout)

Adds the given node label layout to the given node.

The given label layout has to be created with method createLabelLayout(Node, YOrientedRectangle) or createLabelLayout(Node, YOrientedRectangle, INodeLabelLayoutModel).

Throws:

IllegalArgumentException - if the given label layout has already been added to the graph

Implementations of this method must ensure that re-adding temporarily removed original labels during buffered layout calculations automatically restores the original order of labels at the given node. Otherwise, the layout calculation will most likely produce incorrect results or break down with ClassCastExceptions.

Parameters:

node - the node

labelLayout - the node label layout that should be added to the given node

See Also:

createLabelLayout(Node, YOrientedRectangle), createLabelLayout(Node, YOrientedRectangle, INodeLabelLayoutModel)

createLabelLayout

IEdgeLabelLayout createLabelLayout(Edge edge,
                                   YOrientedRectangle orientedBox)

Creates a new ILabelLayout for the given edge.

This method should create a ILabelLayout with an IEdgeLabelLayoutModel that supports the desired oriented label box exactly as given.

Calling this method has no effect on the edge's labels. The returned label layout has to be added to the edge using method addLabelLayout(Edge, IEdgeLabelLayout).

Parameters:

edge - the edge

orientedBox - the box specifying the size and location of the label

Returns:

a new edge label layout

See Also:

addLabelLayout(Edge, IEdgeLabelLayout)

createLabelLayout

IEdgeLabelLayout createLabelLayout(Edge edge,
                                   YOrientedRectangle orientedBox,
                                   IEdgeLabelLayoutModel model,
                                   PreferredPlacementDescriptor descriptor)

Creates a new ILabelLayout for the given edge.

Calling this method has no effect on the edge's labels. The returned ILabelLayout has to be added to the edge using method addLabelLayout(Edge, IEdgeLabelLayout).

Parameters:

edge - the edge

orientedBox - the box specifying the size and location of the label

model - specifies the model of the created edge label

descriptor - specifies the preferred placement descriptor of the created label. If this value is null, the default descriptor is used

Returns:

a new edge label layout

See Also:

addLabelLayout(Edge, IEdgeLabelLayout)

createLabelLayout

INodeLabelLayout createLabelLayout(Node node,
                                   YOrientedRectangle orientedBox)

Creates a new ILabelLayout for the given node.

This method should create a ILabelLayout with a INodeLabelLayoutModel that supports the desired oriented label box exactly as given.

Calling this method has no effect on the node's labels. The returned label layout has to be added to the node using method addLabelLayout(Node, INodeLabelLayout).

Parameters:

node - the node

orientedBox - the box specifying the size and location of the label

Returns:

a new node label layout

See Also:

addLabelLayout(Node, INodeLabelLayout)

createLabelLayout

INodeLabelLayout createLabelLayout(Node node,
                                   YOrientedRectangle orientedBox,
                                   INodeLabelLayoutModel model)

Creates a new ILabelLayout for the given node.

Calling this method has no effect on the node's labels. The returned label layout has to be added to the node using method addLabelLayout(Node, INodeLabelLayout).

Parameters:

node - the node

orientedBox - the box specifying the size and location of the label

model - specifies the model of the created node label

Returns:

a new node label layout

See Also:

addLabelLayout(Node, INodeLabelLayout)

getGraph

LayoutGraph getGraph()

Gets the graph associated with this label factory instance.

Returns:

the graph associated with this label factory instance

removeLabelLayout

void removeLabelLayout(Edge edge,
                       IEdgeLabelLayout labelLayout)

Removes the given IEdgeLabelLayout from the given edge.

Original labels which are removed during a layout calculation have to be re-added when the layout calculation is done.

Parameters:

edge - the edge

labelLayout - the label layout that should be removed from the given edge

See Also:

addLabelLayout(Edge, IEdgeLabelLayout)

removeLabelLayout

void removeLabelLayout(Node node,
                       INodeLabelLayout labelLayout)

Removes the given node label layout from the given node.

Original labels which are removed during a layout calculation have to be re-added when the layout calculation is done.

Parameters:

node - the node

labelLayout - the label layout that should be removed from the given node

See Also:

addLabelLayout(Edge, IEdgeLabelLayout)