com.yworks.yfiles.layout

Class FreeNodeLabelLayoutModel

java.lang.Object

com.yworks.yfiles.layout.FreeNodeLabelLayoutModel

All Implemented Interfaces:

INodeLabelLayoutModel

public class FreeNodeLabelLayoutModel
extends Object
implements INodeLabelLayoutModel

FreeNodeLabelLayoutModel allows placing node labels at any desired position.

The location of the label does not need to satisfy any constraints. The model parameter describes a fixed offset between the upper-left corner of the node and the center of the label.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FreeNodeLabelLayoutModel.ModelParameter The model parameter that encodes a label position within FreeNodeLabelLayoutModel.

Constructor Summary

Constructors

Constructor and Description
FreeNodeLabelLayoutModel() Returns a new instance of FreeNodeLabelLayoutModel.

Method Summary

Modifier and Type	Method and Description
Object	createModelParameter(YOrientedRectangle labelBounds, INodeLayout nodeLayout) Creates a model parameter that represents the given node label position within this model.
Object	getDefaultParameter() Gets a model parameter that encodes the default position of INodeLabelLayoutModel.
YList	getLabelCandidates(INodeLabelLayout labelLayout, INodeLayout nodeLayout) Returns the NodeLabelCandidate that describes the current label position.
YOrientedRectangle	getLabelPlacement(YDimension labelSize, INodeLayout nodeLayout, Object param) Returns the bounds of the label for the position encoded by the given model parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

FreeNodeLabelLayoutModel

public FreeNodeLabelLayoutModel()

Returns a new instance of FreeNodeLabelLayoutModel.

Method Detail

createModelParameter

public Object createModelParameter(YOrientedRectangle labelBounds,
                                   INodeLayout nodeLayout)

Creates a model parameter that represents the given node label position within this model.

The created model parameter represents the current location of the given label.

This parameter can be passed to getLabelPlacement(YDimension, INodeLayout, Object) to retrieve the current label box.

Specified by:

createModelParameter in interface INodeLabelLayoutModel

Throws:

IllegalArgumentException - if one or more of the given bounds' values are invalid, i.e., NaN

Parameters:

labelBounds - the bounds of the label the parameter represents

nodeLayout - the layout of the node to which the label belongs

Returns:

the model parameter

See Also:

getLabelPlacement(YDimension, INodeLayout, Object)

getDefaultParameter

public Object getDefaultParameter()

Gets a model parameter that encodes the default position of INodeLabelLayoutModel.

The node label's upper-left corner is placed 20 pixels to the left and 20 pixels above the node.

This parameter can be passed to getLabelPlacement(YDimension, INodeLayout, Object) to retrieve the corresponding label box.

Specified by:

getDefaultParameter in interface INodeLabelLayoutModel

Returns:

the model parameter describing the default placement of the node label

getLabelCandidates

public YList getLabelCandidates(INodeLabelLayout labelLayout,
                                INodeLayout nodeLayout)

Returns the NodeLabelCandidate that describes the current label position.

Specified by:

getLabelCandidates in interface INodeLabelLayoutModel

The returned list contains only one candidate which describes the current location.

Parameters:

labelLayout - the label for which candidates should be generated

nodeLayout - the layout of the node to which the label belongs

Returns:

a list of NodeLabelCandidate instances

getLabelPlacement

public YOrientedRectangle getLabelPlacement(YDimension labelSize,
                                            INodeLayout nodeLayout,
                                            Object param)

Description copied from interface: INodeLabelLayoutModel

Returns the bounds of the label for the position encoded by the given model parameter.

Specified by:

getLabelPlacement in interface INodeLabelLayoutModel

Parameters:

labelSize - the width and height of the label

nodeLayout - the layout of the node to which the label belongs

param - the model parameter that describes the abstract position of the label within this model

Returns:

the oriented box of the label