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

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

All Implemented Interfaces:

ILabelCandidateDescriptorProvider, ILabelModel

public class InteriorLabelModel

extends java.lang.Object

implements ILabelModel, ILabelCandidateDescriptorProvider

yFiles FLEX client label model data object that places the label at discrete locations inside the node's bounds.

Nested Class Summary

static class

InteriorLabelModel.ModelParameter Model parameter for the interior label model

Field Summary

static ILabelModelParameter	center A convenience parameter instance that can be shared between label instances.
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_CENTER Encodes a position at the center of the node interior.
static java.lang.String	POSITION_EAST Encodes a position at the right side of the node interior.
static java.lang.String	POSITION_NORTH Encodes a position at the top side of the node interior.
static java.lang.String	POSITION_NORTH_EAST Encodes a position at the top right corner of the node interior.
static java.lang.String	POSITION_NORTH_WEST Encodes a position at the top left corner of the node interior.
static java.lang.String	POSITION_SOUTH Encodes a position at the bottom side of the node interior.
static java.lang.String	POSITION_SOUTH_EAST Encodes a position at the bottom right corner of the node interior.
static java.lang.String	POSITION_SOUTH_WEST Encodes a position at the bottom left corner of the node interior.
static java.lang.String	POSITION_WEST Encodes a position at the left side of the node interior.
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

InteriorLabelModel()
Creates a new instance with default insets (0,0,0,0)

InteriorLabelModel(Insets insets)
Creates a new instance that uses the given 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() The label's insets.
void	setInsets(Insets insets) The label's insets.

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 at the top side of the node interior.

See Also:

Constant Field Values

POSITION_EAST

public static final java.lang.String POSITION_EAST

Encodes a position at the right side of the node interior.

See Also:

Constant Field Values

POSITION_SOUTH

public static final java.lang.String POSITION_SOUTH

Encodes a position at the bottom side of the node interior.

See Also:

Constant Field Values

POSITION_SOUTH_EAST

public static final java.lang.String POSITION_SOUTH_EAST

Encodes a position at the bottom right corner of the node interior.

See Also:

Constant Field Values

POSITION_SOUTH_WEST

public static final java.lang.String POSITION_SOUTH_WEST

Encodes a position at the bottom left corner of the node interior.

See Also:

Constant Field Values

POSITION_WEST

public static final java.lang.String POSITION_WEST

Encodes a position at the left side of the node interior.

See Also:

Constant Field Values

POSITION_NORTH_EAST

public static final java.lang.String POSITION_NORTH_EAST

Encodes a position at the top right corner of the node interior.

See Also:

Constant Field Values

POSITION_NORTH_WEST

public static final java.lang.String POSITION_NORTH_WEST

Encodes a position at the top left corner of the node interior.

See Also:

Constant Field Values

POSITION_CENTER

public static final java.lang.String POSITION_CENTER

Encodes a position at the center of the node interior.

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 InteriorLabelModel, 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 InteriorLabelModel, 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 InteriorLabelModel, 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 InteriorLabelModel, 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 InteriorLabelModel, 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 InteriorLabelModel, 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 InteriorLabelModel, 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 InteriorLabelModel, trying to change that instance's insets will raise an UnsupportedOperationException.

center

public static final ILabelModelParameter center

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

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

Constructor Detail

InteriorLabelModel

public InteriorLabelModel()

Creates a new instance with default insets (0,0,0,0)

InteriorLabelModel

public InteriorLabelModel(Insets insets)

Creates a new instance that uses the given insets.

Method Detail

getInsets

public Insets getInsets()

The label's insets.

setInsets

public void setInsets(Insets insets)

The label's insets.

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.