org.girod.jgraphml.model

Class LabelPlacement

java.lang.Object

org.girod.jgraphml.model.LabelPlacement

public class LabelPlacement
extends java.lang.Object

Represents a label placement.

Since:

1.2.8

Field Summary

Fields

Modifier and Type	Field and Description
static short	MODEL_CENTERED The internal model, used for edges only.
static short	MODEL_FREE The default free model.
static short	MODEL_INTERNAL The internal model, used for nodes only.
static short	MODEL_SIX_POS The seix pos model, used for nodes and edges.
static short	PLACEMENT_BOTTOM The bottom placement, used for the MODEL_INTERNAL model.
static short	PLACEMENT_BOTTOM_LEFT The bottom left placement, used for the MODEL_INTERNAL model.
static short	PLACEMENT_BOTTOM_RIGHT The bottom right placement, used for the MODEL_INTERNAL model.
static short	PLACEMENT_CENTER The center placement, used for the MODEL_INTERNAL and MODEL_CENTERED models.
static short	PLACEMENT_HEAD The head placement, used for the MODEL_SIX_POS model.
static short	PLACEMENT_LEFT The left placement, used for the MODEL_INTERNAL model.
static short	PLACEMENT_RIGHT The right placement, used for the MODEL_INTERNAL model.
static short	PLACEMENT_SOURCE_HEAD The source head placement, used for the MODEL_SIX_POS model.
static short	PLACEMENT_SOURCE_TAIL The source tail placement, used for the MODEL_SIX_POS model.
static short	PLACEMENT_TAIL The tail placement, used for the MODEL_SIX_POS model.
static short	PLACEMENT_TARGET_HEAD The target head placement, used for the MODEL_SIX_POS model.
static short	PLACEMENT_TARGET_TAIL The target tail placement, used for the MODEL_SIX_POS model.
static short	PLACEMENT_TOP The top placement, used for the MODEL_INTERNAL model.
static short	PLACEMENT_TOP_LEFT The top left placement, used for the MODEL_INTERNAL model.
static short	PLACEMENT_TOP_RIGHT The top right placement, used for the MODEL_INTERNAL model.
static short	PLACEMENT_UNDEFINED The undefined placement.

Constructor Summary

Constructors

Constructor and Description
LabelPlacement(Labeled labeled)

Method Summary

Modifier and Type	Method and Description
boolean	acceptPlacement(short placement) Return true if the placement can be accepted with the current placement model.
Labeled	getLabeled()
short	getPlacement() Return the placement.
short	getPlacementModel() Return the placement model.
boolean	setPlacement(short placement) Set the placement.
boolean	setPlacementModel(short placementModel) Set the placement model.

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_FREE

public static final short MODEL_FREE

The default free model.

See Also:

Constant Field Values

MODEL_INTERNAL

public static final short MODEL_INTERNAL

The internal model, used for nodes only.

See Also:

Constant Field Values

MODEL_CENTERED

public static final short MODEL_CENTERED

The internal model, used for edges only.

See Also:

Constant Field Values

MODEL_SIX_POS

public static final short MODEL_SIX_POS

The seix pos model, used for nodes and edges.

See Also:

Constant Field Values

PLACEMENT_UNDEFINED

public static final short PLACEMENT_UNDEFINED

The undefined placement. It is normally used for the MODEL_FREE model.

See Also:

Constant Field Values

PLACEMENT_TOP

public static final short PLACEMENT_TOP

The top placement, used for the MODEL_INTERNAL model.

See Also:

Constant Field Values

PLACEMENT_BOTTOM

public static final short PLACEMENT_BOTTOM

The bottom placement, used for the MODEL_INTERNAL model.

See Also:

Constant Field Values

PLACEMENT_LEFT

public static final short PLACEMENT_LEFT

The left placement, used for the MODEL_INTERNAL model.

See Also:

Constant Field Values

PLACEMENT_RIGHT

public static final short PLACEMENT_RIGHT

The right placement, used for the MODEL_INTERNAL model.

See Also:

Constant Field Values

PLACEMENT_TOP_RIGHT

public static final short PLACEMENT_TOP_RIGHT

The top right placement, used for the MODEL_INTERNAL model.

See Also:

Constant Field Values

PLACEMENT_TOP_LEFT

public static final short PLACEMENT_TOP_LEFT

The top left placement, used for the MODEL_INTERNAL model.

See Also:

Constant Field Values

PLACEMENT_BOTTOM_RIGHT

public static final short PLACEMENT_BOTTOM_RIGHT

The bottom right placement, used for the MODEL_INTERNAL model.

See Also:

Constant Field Values

PLACEMENT_BOTTOM_LEFT

public static final short PLACEMENT_BOTTOM_LEFT

The bottom left placement, used for the MODEL_INTERNAL model.

See Also:

Constant Field Values

PLACEMENT_CENTER

public static final short PLACEMENT_CENTER

The center placement, used for the MODEL_INTERNAL and MODEL_CENTERED models.

See Also:

Constant Field Values

PLACEMENT_HEAD

public static final short PLACEMENT_HEAD

The head placement, used for the MODEL_SIX_POS model.

See Also:

Constant Field Values

PLACEMENT_SOURCE_HEAD

public static final short PLACEMENT_SOURCE_HEAD

The source head placement, used for the MODEL_SIX_POS model.

See Also:

Constant Field Values

PLACEMENT_TARGET_HEAD

public static final short PLACEMENT_TARGET_HEAD

The target head placement, used for the MODEL_SIX_POS model.

See Also:

Constant Field Values

PLACEMENT_TAIL

public static final short PLACEMENT_TAIL

The tail placement, used for the MODEL_SIX_POS model.

See Also:

Constant Field Values

PLACEMENT_SOURCE_TAIL

public static final short PLACEMENT_SOURCE_TAIL

The source tail placement, used for the MODEL_SIX_POS model.

See Also:

Constant Field Values

PLACEMENT_TARGET_TAIL

public static final short PLACEMENT_TARGET_TAIL

The target tail placement, used for the MODEL_SIX_POS model.

See Also:

Constant Field Values

Constructor Detail

LabelPlacement

public LabelPlacement(Labeled labeled)

Method Detail

getLabeled

public Labeled getLabeled()

setPlacementModel

public boolean setPlacementModel(short placementModel)

Set the placement model. Note that the placement will only be set if it is compatible for the type of Labeled used at the creation.

Parameters:

placementModel - the placement model

Returns:

true if the placement could be set

getPlacementModel

public short getPlacementModel()

Return the placement model.

Returns:

the placement model

acceptPlacement

public boolean acceptPlacement(short placement)

Return true if the placement can be accepted with the current placement model.

Parameters:

placement - the placement

Returns:

true if the placement can be accepted with the current placement model

setPlacement

public boolean setPlacement(short placement)

Set the placement. Note that the placement will only be set if it is compatible for the current placement model.

Parameters:

placement - the placement

Returns:

true if the placement could be set

getPlacement

public short getPlacement()

Return the placement.

Returns:

the placement