com.yworks.yfiles.server.graphml.flexio.data
Class ExteriorLabelModel

java.lang.Object
  com.yworks.yfiles.server.graphml.flexio.data.ExteriorLabelModel

All Implemented Interfaces:

ILabelCandidateDescriptorProvider, ILabelModel, ISharedInstanceProvider

public class ExteriorLabelModel

extends java.lang.Object

implements ILabelModel, ILabelCandidateDescriptorProvider, ISharedInstanceProvider

yFiles FLEX client label model data object that places the label outside of the node's bounds.

Nested Class Summary

static class

ExteriorLabelModel.ModelParameter Model parameter for the exterior label model.

Field Summary

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	northEast A convenience parameter instance that can be shared between label instances.
static ILabelModelParameter	northWest A convenience parameter instance that can be shared between label instances.
static java.lang.String	POSITION_EAST Encodes a position outside the node at the right side
static java.lang.String	POSITION_NORTH Encodes a position outside the node at the top
static java.lang.String	POSITION_NORTH_EAST Encodes a position outside the node at the upper right corner
static java.lang.String	POSITION_NORTH_WEST Encodes a position outside the node at the upper left corner
static java.lang.String	POSITION_SOUTH Encodes a position outside the node at the bottom
static java.lang.String	POSITION_SOUTH_EAST Encodes a position outside the node at the lower right corner
static java.lang.String	POSITION_SOUTH_WEST Encodes a position outside the node at the lower left corner
static java.lang.String	POSITION_WEST Encodes a position outside the node at the left side
static ILabelModelParameter	south A convenience parameter instance that can be shared between label instances.
static ILabelModelParameter	southEast A convenience parameter instance that can be shared between label instances.
static ILabelModelParameter	southWest 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.

Constructor Summary

ExteriorLabelModel()

ExteriorLabelModel(Insets insets)

Method Summary

ILabelModelParameter	createDefaultParameter() Creates a default parameter that can be used for this model.
ILabelCandidateDescriptor	getDescriptor(Label label, ILabelModelParameter parameter) Gets the descriptor for a given combination of label and ILabelModelParameter.
Insets	getInsets() Insets for the labels.
java.util.Collection	getSharedInstances() Returns an Collection for objects that shall be shared.
void	setInsets(Insets insets) Insets for the labels.

Methods inherited from class java.lang.Object

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

Field Detail

POSITION_NORTH

public static final java.lang.String POSITION_NORTH

Encodes a position outside the node at the top

See Also:

Constant Field Values

POSITION_EAST

public static final java.lang.String POSITION_EAST

Encodes a position outside the node at the right side

See Also:

Constant Field Values

POSITION_SOUTH

public static final java.lang.String POSITION_SOUTH

Encodes a position outside the node at the bottom

See Also:

Constant Field Values

POSITION_SOUTH_EAST

public static final java.lang.String POSITION_SOUTH_EAST

Encodes a position outside the node at the lower right corner

See Also:

Constant Field Values

POSITION_SOUTH_WEST

public static final java.lang.String POSITION_SOUTH_WEST

Encodes a position outside the node at the lower left corner

See Also:

Constant Field Values

POSITION_WEST

public static final java.lang.String POSITION_WEST

Encodes a position outside the node at the left side

See Also:

Constant Field Values

POSITION_NORTH_EAST

public static final java.lang.String POSITION_NORTH_EAST

Encodes a position outside the node at the upper right corner

See Also:

Constant Field Values

POSITION_NORTH_WEST

public static final java.lang.String POSITION_NORTH_WEST

Encodes a position outside the node at the upper left corner

See Also:

Constant Field Values

north

public static final ILabelModelParameter north

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

Although the parameter's model can be cast to a ExteriorLabelModel, trying to change that instance's insets will raise an UnsupportedOperationException.

east

public static final ILabelModelParameter east

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

Although the parameter's model can be cast to a ExteriorLabelModel, trying to change that instance's insets will raise an UnsupportedOperationException.

south

public static final ILabelModelParameter south

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

Although the parameter's model can be cast to a ExteriorLabelModel, trying to change that instance's insets will raise an UnsupportedOperationException.

southEast

public static final ILabelModelParameter southEast

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

Although the parameter's model can be cast to a ExteriorLabelModel, trying to change that instance's insets will raise an UnsupportedOperationException.

southWest

public static final ILabelModelParameter southWest

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

Although the parameter's model can be cast to a ExteriorLabelModel, trying to change that instance's insets will raise an UnsupportedOperationException.

west

public static final ILabelModelParameter west

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

Although the parameter's model can be cast to a ExteriorLabelModel, trying to change that instance's insets will raise an UnsupportedOperationException.

northEast

public static final ILabelModelParameter northEast

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

Although the parameter's model can be cast to a ExteriorLabelModel, trying to change that instance's insets will raise an UnsupportedOperationException.

northWest

public static final ILabelModelParameter northWest

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

Although the parameter's model can be cast to a ExteriorLabelModel, trying to change that instance's insets will raise an UnsupportedOperationException.

Constructor Detail

ExteriorLabelModel

public ExteriorLabelModel(Insets insets)

ExteriorLabelModel

public ExteriorLabelModel()

Method Detail

getInsets

public Insets getInsets()

Insets for the labels.

setInsets

public void setInsets(Insets insets)

Insets for the labels.

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.

getDescriptor

public ILabelCandidateDescriptor getDescriptor(Label label,
                                               ILabelModelParameter parameter)

Gets the descriptor for a given combination of label and ILabelModelParameter.

Specified by:

getDescriptor in interface ILabelCandidateDescriptorProvider

Parameters:

label - The label to possibly assign the parameter.

parameter - The parameter to provide a descriptor for if applied to the given label

Returns:

A descriptor or null.

getSharedInstances

public java.util.Collection getSharedInstances()

Description copied from interface: ISharedInstanceProvider

Returns an Collection for objects that shall be shared.

Specified by:

getSharedInstances in interface ISharedInstanceProvider

Returns: