com.yworks.yfiles.layout

Interface ILabelLayout

All Known Subinterfaces:

IEdgeLabelLayout, INodeLabelLayout

All Known Implementing Classes:

AbstractLabelLayout

public interface ILabelLayout

ILabelLayout defines the properties of a label from the perspective of a labeling algorithm.

Both node and edge labels need to implement this interface. It describes the size and position of a label.

Note: To avoid inconsistencies, changing the model parameter should always be combined with updating the corresponding oriented box.

Method Summary

Modifier and Type	Method and Description
YRectangle	getBoundingBox() Gets the bounding box of the label.
Object	getModelParameter() Gets the label model parameter that describes the position of this label.
YOrientedRectangle	getOrientedBox() Gets the box of the label.
void	setModelParameter(Object value) Sets the label model parameter that describes the position of this label.

Method Detail

getBoundingBox

YRectangle getBoundingBox()

Gets the bounding box of the label.

The bounding box is the smallest, paraxial rectangle that contains the whole label.

Returns:

the bounding box of the label

getModelParameter

Object getModelParameter()

Gets the label model parameter that describes the position of this label.

The model parameter must fit the according label model.

Returns:

the label model parameter

See Also:

setModelParameter(Object)

getOrientedBox

YOrientedRectangle getOrientedBox()

Gets the box of the label.

This box matches the area that is covered by the label. The up vector of the rectangle encodes the orientation of the label.

Returns:

the oriented box of the label

setModelParameter

void setModelParameter(Object value)

Sets the label model parameter that describes the position of this label.

The model parameter must fit the according label model.

Parameters:

value - the label model parameter

See Also:

getModelParameter()