com.yworks.yfiles.graph.labelmodels

Class ExteriorLabelModel

java.lang.Object

com.yworks.yfiles.graph.labelmodels.ExteriorLabelModel

All Implemented Interfaces:

ILookup, ILabelModel, ILabelModelParameterProvider

public class ExteriorLabelModel
extends Object
implements ILabelModel, ILabelModelParameterProvider

A label model for node labels that lie outside of the node's Layout bounds.

This label model supports eight positions outside of the layout's bounds.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExteriorLabelModel.Position Enumeration of the possible positions of the ExteriorLabelModel.

Field Summary

Fields

Modifier and Type	Field and Description
static ILabelModelParameter	EAST A convenience parameter instance that can be shared between label instances.
static ILabelModelParameter	NORTH A convenience parameter instance that can be shared between label instances.
static ILabelModelParameter	NORTH_EAST A convenience parameter instance that can be shared between label instances.
static ILabelModelParameter	NORTH_WEST A convenience parameter instance that can be shared between label instances.
static ILabelModelParameter	SOUTH A convenience parameter instance that can be shared between label instances.
static ILabelModelParameter	SOUTH_EAST A convenience parameter instance that can be shared between label instances.
static ILabelModelParameter	SOUTH_WEST A convenience parameter instance that can be shared between label instances.
static ILabelModelParameter	WEST A convenience parameter instance that can be shared between label instances.

Fields inherited from interface com.yworks.yfiles.graph.ILookup

EMPTY

Constructor Summary

Constructors

Constructor and Description
ExteriorLabelModel() Creates a new instance of this model.

Method Summary

Modifier and Type	Method and Description
ILabelModelParameter	createDefaultParameter() Creates a default parameter that can be used for this model.
ILabelModelParameter	createParameter(ExteriorLabelModel.Position position) Creates a new parameter that is associated with this instance for the provided position.
ILookup	getContext(ILabel label, ILabelModelParameter layoutParameter) Provides a lookup context for the given combination of label and parameter.
IOrientedRectangle	getGeometry(ILabel label, ILabelModelParameter layoutParameter) Calculates the geometry of the given label using the given model parameter.
InsetsD	getInsets() Gets the insets to use by this model.
IEnumerable<ILabelModelParameter>	getParameters(ILabel label, ILabelModel model) Returns an enumerator over a set of possible ILabelModelParameter instances that can be used for the given label and model.
<TLookup> TLookup	lookup(Class<TLookup> type) Returns an instance that implements the given type or null.
void	setInsets(InsetsD value) Sets the insets to use by this model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.graph.ILookup

createDictionaryLookup, createDynamic, createSingle, createSingle, createWrapped, lookup, lookup, safeLookup

Field Detail

EAST

public static final ILabelModelParameter EAST

A convenience parameter instance that can be shared between label instances.

Trying to change that instances' Insets will raise an IllegalStateException.

NORTH

public static final ILabelModelParameter NORTH

A convenience parameter instance that can be shared between label instances.

Trying to change that instances' Insets will raise an IllegalStateException.

NORTH_EAST

public static final ILabelModelParameter NORTH_EAST

A convenience parameter instance that can be shared between label instances.

Trying to change that instances' Insets will raise an IllegalStateException.

NORTH_WEST

public static final ILabelModelParameter NORTH_WEST

A convenience parameter instance that can be shared between label instances.

Trying to change that instances' Insets will raise an IllegalStateException.

SOUTH

public static final ILabelModelParameter SOUTH

A convenience parameter instance that can be shared between label instances.

Trying to change that instances' Insets will raise an IllegalStateException.

SOUTH_EAST

public static final ILabelModelParameter SOUTH_EAST

A convenience parameter instance that can be shared between label instances.

Trying to change that instances' Insets will raise an IllegalStateException.

SOUTH_WEST

public static final ILabelModelParameter SOUTH_WEST

A convenience parameter instance that can be shared between label instances.

Trying to change that instances' Insets will raise an IllegalStateException.

WEST

public static final ILabelModelParameter WEST

A convenience parameter instance that can be shared between label instances.

Trying to change that instances' Insets will raise an IllegalStateException.

Constructor Detail

ExteriorLabelModel

public ExteriorLabelModel()

Creates a new instance of this model.

Method Detail

createDefaultParameter

public ILabelModelParameter createDefaultParameter()

Description copied from interface: ILabelModel

Creates a default parameter that can be used for this model.

Specified by:

createDefaultParameter in interface ILabelModel

Returns:

a parameter for this model instance

createParameter

public ILabelModelParameter createParameter(ExteriorLabelModel.Position position)

Creates a new parameter that is associated with this instance for the provided position.

Parameters:

position - The position constant that describes the position of the label.

Returns:

A new parameter instance.

getContext

public ILookup getContext(ILabel label,
                          ILabelModelParameter layoutParameter)

Description copied from interface: ILabelModel

Provides a lookup context for the given combination of label and parameter.

Specified by:

getContext in interface ILabelModel

Parameters:

label - The label to use in the context.

layoutParameter - The parameter to use for the label in the context.

Returns:

An implementation of the ILookup interface that can be used to query additional aspects of the label/parameter combination.

See Also:

ILookup.EMPTY

getGeometry

public final IOrientedRectangle getGeometry(ILabel label,
                                            ILabelModelParameter layoutParameter)

Description copied from interface: ILabelModel

Calculates the geometry of the given label using the given model parameter.

Specified by:

getGeometry in interface ILabelModel

Parameters:

label - The label to calculate the geometry for.

layoutParameter - A parameter that is compatible with this model. Typically, this is a parameter that has been created by this model, and its property Model returns this instance.

Returns:

An IOrientedRectangle that describes the geometry of the label. This is typically designed as a flyweight, therefore clients should not cache the instance but store the values if they need a snapshot for later use.

getInsets

public InsetsD getInsets()

Gets the insets to use by this model.

The insets are in fact "outsets", i.e. they are treated as margins. Positive values will increase the distance of the labels to the node.

Returns:

The Insets.

See Also:

setInsets(InsetsD)

getParameters

public IEnumerable<ILabelModelParameter> getParameters(ILabel label,
                                                       ILabelModel model)

Description copied from interface: ILabelModelParameterProvider

Returns an enumerator over a set of possible ILabelModelParameter instances that can be used for the given label and model.

Specified by:

getParameters in interface ILabelModelParameterProvider

Parameters:

label - The label instance to use.

model - The model to provide parameters for.

Returns:

A possibly empty enumerator over a set of label model parameters.

lookup

public <TLookup> TLookup lookup(Class<TLookup> type)

Description copied from interface: ILookup

Returns an instance that implements the given type or null. Typically, this method will be called in order to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile time constraints. An instance implementing this method is not required to return non-null implementations for the types, nor does it have to return the same instance any time. Also it depends on the type and context whether the instance returned stays up to date or needs to be reobtained for subsequent use.

Specified by:

lookup in interface ILookup

Parameters:

type - the type for which an instance shall be returned

Returns:

an instance that is assignable to type or null

setInsets

public void setInsets(InsetsD value)

Sets the insets to use by this model.

The insets are in fact "outsets", i.e. they are treated as margins. Positive values will increase the distance of the labels to the node.

Parameters:

value - The Insets to set.

See Also:

getInsets()