com.yworks.yfiles.graph.labelmodels

Class SandwichLabelModel

java.lang.Object

com.yworks.yfiles.graph.labelmodels.SandwichLabelModel

All Implemented Interfaces:

ILookup, ILabelModel, ILabelModelParameterProvider

public class SandwichLabelModel
extends Object
implements ILabelModel, ILabelModelParameterProvider

A node label model that knows only two possible positions.

The label will be placed centered on top or below the node's Layout using a specifiable YOffset.

Field Summary

Fields

Modifier and Type	Field and Description
static ILabelModelParameter	NORTH 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.

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
SandwichLabelModel() Initializes a new instance of the SandwichLabelModel class with zero offset.

Method Summary

Modifier and Type	Method and Description
ILabelModelParameter	createDefaultParameter() Creates a default parameter that can be used for this model.
ILabelModelParameter	createNorthParameter() Creates a parameter for the north side of the node.
ILabelModelParameter	createSouthParameter() Creates a parameter for the south side of the node.
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.
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.
double	getYOffset() Gets the distance between the node's Layout and the label's layout.
<TLookup> TLookup	lookup(Class<TLookup> type) Returns an instance that implements the given type or null.
void	setYOffset(double value) Sets the distance between the node's Layout and the label's layout.

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

NORTH

public static final ILabelModelParameter NORTH

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

Trying to change that instances' YOffset 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' YOffset will raise an IllegalStateException.

Constructor Detail

SandwichLabelModel

public SandwichLabelModel()

Initializes a new instance of the SandwichLabelModel class with zero offset.

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

createNorthParameter

public ILabelModelParameter createNorthParameter()

Creates a parameter for the north side of the node.

createSouthParameter

public ILabelModelParameter createSouthParameter()

Creates a parameter for the south side of the node.

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.

getParameters

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

getYOffset

public double getYOffset()

Gets the distance between the node's Layout and the label's layout.

Returns:

The YOffset.

See Also:

setYOffset(double)

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

setYOffset

public void setYOffset(double value)

Sets the distance between the node's Layout and the label's layout.

Parameters:

value - The YOffset to set.

See Also:

getYOffset()