com.yworks.yfiles.graph.labelmodels

Class StripeLabelModel

java.lang.Object

com.yworks.yfiles.graph.labelmodels.StripeLabelModel

All Implemented Interfaces:

ILookup, ILabelModel, ILabelModelParameterProvider

public class StripeLabelModel
extends Object
implements ILabelModel, ILabelModelParameterProvider

A label model for labels that is especially tailored to be used as a model for the four default positions where the label of a stripe may lie.

This label model supports four positions inside of the stripe bounds. The east and west positions are rotated automatically. The Owner is expected to be an IStripe instance, i.e. the parameter supports only IStripe instances.

Nested Class Summary

Nested Classes

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

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	SOUTH 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
StripeLabelModel() Creates a new instance of this model with empty insets.

Method Summary

Modifier and Type	Method and Description
ILabelModelParameter	createDefaultParameter() Creates a default parameter that can be used for this model.
ILabelModelParameter	createParameter(StripeLabelModel.Position position) Creates the parameter for the given 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 in form of an IOrientedRectangle for a 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	getRatio() Gets the ratio how far the label should be positioned from the border in the header area.
boolean	isUsingActualInsetsEnabled() Gets a value indicating whether to use the actual insets or the normal Insets of a stripe for centering the label inside the stripe header area.
<TLookup> TLookup	lookup(Class<TLookup> type) Returns an instance that implements the given type or null.
void	setRatio(double value) Sets the ratio how far the label should be positioned from the border in the header area.
void	setUsingActualInsetsEnabled(boolean value) Sets a value indicating whether to use the actual insets or the normal Insets of a stripe for centering the label inside the stripe header area.

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' Ratio 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' Ratio 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' Ratio 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' Ratio will raise an IllegalStateException.

Constructor Detail

StripeLabelModel

public StripeLabelModel()

Creates a new instance of this model with empty insets.

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(StripeLabelModel.Position position)

Creates the parameter for the given position.

Parameters:

position - The position.

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)

Calculates the geometry in form of an IOrientedRectangle for a given label using the given model parameter.

The geometry is calculated in table coordinates, i.e. relative to RelativeLocation.

Specified by:

getGeometry in interface ILabelModel

Parameters:

label - the label to calculate the geometry for

layoutParameter - A parameter that has been created by this model. This is typically the parameter that yielded this instance through its Model property.

Returns:

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

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.

getRatio

public double getRatio()

Gets the ratio how far the label should be positioned from the border in the header area.

0 means the label is positioned on the outer border, 1 means it is positioned at the inner border of the header or inset area. Default value is 0.5

Returns:

The Ratio.

See Also:

setRatio(double)

isUsingActualInsetsEnabled

public boolean isUsingActualInsetsEnabled()

Gets a value indicating whether to use the actual insets or the normal Insets of a stripe for centering the label inside the stripe header area.

If true the header insets are used. Default is false

Returns:

The UsingActualInsetsEnabled.

See Also:

setUsingActualInsetsEnabled(boolean)

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

setRatio

public void setRatio(double value)

Sets the ratio how far the label should be positioned from the border in the header area.

0 means the label is positioned on the outer border, 1 means it is positioned at the inner border of the header or inset area. Default value is 0.5

Parameters:

value - The Ratio to set.

See Also:

getRatio()

setUsingActualInsetsEnabled

public void setUsingActualInsetsEnabled(boolean value)

Sets a value indicating whether to use the actual insets or the normal Insets of a stripe for centering the label inside the stripe header area.

If true the header insets are used. Default is false

Parameters:

value - The UsingActualInsetsEnabled to set.

See Also:

isUsingActualInsetsEnabled()