com.yworks.yfiles.layout

Class AbstractLabelLayout

java.lang.Object

com.yworks.yfiles.layout.AbstractLabelLayout

All Implemented Interfaces:

ILabelLayout

public class AbstractLabelLayout
extends Object
implements ILabelLayout

AbstractLabelLayout is the default implementation of the ILabelLayout interface.

Constructor Summary

Constructors

Constructor and Description
AbstractLabelLayout() Creates a new AbstractLabelLayout instance.

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	setBoundingBox(YRectangle value) Sets the bounding box of the label.
void	setModelParameter(Object value) Sets the label model parameter that describes the position of this label.
void	setOrientedBox(YOrientedRectangle value) Sets the box of the label.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractLabelLayout

public AbstractLabelLayout()

Creates a new AbstractLabelLayout instance.

Method Detail

getBoundingBox

public YRectangle getBoundingBox()

Gets the bounding box of the label.

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

Specified by:

getBoundingBox in interface ILabelLayout

Returns:

the bounding box of the label

See Also:

setBoundingBox(YRectangle)

getModelParameter

public Object getModelParameter()

Description copied from interface: ILabelLayout

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

The model parameter must fit the according label model.

Specified by:

getModelParameter in interface ILabelLayout

Returns:

the label model parameter

See Also:

ILabelLayout.setModelParameter(Object)

getOrientedBox

public 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.

Specified by:

getOrientedBox in interface ILabelLayout

Returns:

the oriented box of the label

See Also:

setOrientedBox(YOrientedRectangle)

setBoundingBox

public void setBoundingBox(YRectangle value)

Sets the bounding box of the label.

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

Parameters:

value - the bounding box of the label

See Also:

getBoundingBox()

setModelParameter

public void setModelParameter(Object value)

Description copied from interface: ILabelLayout

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

The model parameter must fit the according label model.

Specified by:

setModelParameter in interface ILabelLayout

Parameters:

value - the label model parameter

See Also:

ILabelLayout.getModelParameter()

setOrientedBox

public void setOrientedBox(YOrientedRectangle value)

Sets 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.

Parameters:

value - the oriented box of the label

See Also:

getOrientedBox()