org.girod.jgraphml.model

Class EdgeLabel.ParamModel

java.lang.Object

org.girod.jgraphml.model.EdgeLabel.ParamModel

All Implemented Interfaces:

EdgeLabelPosition

Enclosing class:

EdgeLabel

public static class EdgeLabel.ParamModel
extends java.lang.Object
implements EdgeLabelPosition

The parameter model for the edge label.

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_RATIO 0.5f: The default ratio.

Fields inherited from interface org.girod.jgraphml.model.EdgeLabelPosition

POSITION_HEAD, POSITION_SOURCETAIL, POSITION_TAIL, POSITION_TARGETTAIL, POSITION_UNDEF

Constructor Summary

Constructors

Constructor and Description
ParamModel()

Method Summary

Modifier and Type	Method and Description
int	appliedOnSegment() Return the segment on which the label is applied.
void	applyOnSegment(int segment) Set the segment on which the label is applied.
EdgeLabel.ParamModel	clone()
float	getDistance() Return the label distance from the edge.
short	getPosition() Return the position.
float	getRatio() Return the label ratio on the edge.
boolean	isAutoFlip() Return the auto-flip property of the model.
boolean	isAutoRotate() Return the auto-rotate property of the model.
boolean	isDefaultRatio() Return true if the ratio is the default ratio.
boolean	isOnSegmentAutomatic() Set if the label is applied automatically on the best segment depending on the ratio.
void	setAutoFlip(boolean autoFlip) Set the auto-flip property of the model.
void	setAutoRotate(boolean autoRotate) Set the auto-rotate property of the model.
void	setDistance(float distance) Set the label distance from the edge.
void	setOnSegmentAutomatic(boolean isAutomatic) Set if the label is applied automatically on the best segment depending on the ratio.
void	setPosition(short position) Set the position.
void	setRatio(float ratio) Set the label ratio on the edge.
void	setSmartPosition(short position, boolean onEdge) Set the smart position of the label.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RATIO

public static final float DEFAULT_RATIO

0.5f: The default ratio.

See Also:

Constant Field Values

Constructor Detail

ParamModel

public ParamModel()

Method Detail

clone

public EdgeLabel.ParamModel clone()

Overrides:

clone in class java.lang.Object

setDistance

public void setDistance(float distance)

Set the label distance from the edge.

Parameters:

distance - the distance

getDistance

public float getDistance()

Return the label distance from the edge.

Returns:

the distance

setOnSegmentAutomatic

public void setOnSegmentAutomatic(boolean isAutomatic)

Set if the label is applied automatically on the best segment depending on the ratio.

Parameters:

isAutomatic - true if the label is applied automatically on the best segment depending on the ratio

isOnSegmentAutomatic

public boolean isOnSegmentAutomatic()

Set if the label is applied automatically on the best segment depending on the ratio.

Returns:

true if the label is applied automatically on the best segment depending on the ratio

applyOnSegment

public void applyOnSegment(int segment)

Set the segment on which the label is applied.

Parameters:

segment - the segment

appliedOnSegment

public int appliedOnSegment()

Return the segment on which the label is applied.

Returns:

the segment

isDefaultRatio

public boolean isDefaultRatio()

Return true if the ratio is the default ratio.

Returns:

true if the ratio is the default ratio

setRatio

public void setRatio(float ratio)

Set the label ratio on the edge. The ratio must be between 0 and 1.

Parameters:

ratio - the ratio

getRatio

public float getRatio()

Return the label ratio on the edge.

Returns:

the ratio

setPosition

public void setPosition(short position)

Set the position.

Parameters:

position - the position

getPosition

public short getPosition()

Return the position.

Returns:

the position

setAutoRotate

public void setAutoRotate(boolean autoRotate)

Set the auto-rotate property of the model.

Parameters:

autoRotate - true if the label auto-rotates

isAutoRotate

public boolean isAutoRotate()

Return the auto-rotate property of the model.

Returns:

true if the label auto-rotates

setAutoFlip

public void setAutoFlip(boolean autoFlip)

Set the auto-flip property of the model.

Parameters:

autoFlip - true if the label auto-flips

isAutoFlip

public boolean isAutoFlip()

Return the auto-flip property of the model.

Returns:

true if the label auto-flips

setSmartPosition

public void setSmartPosition(short position,
                             boolean onEdge)

Set the smart position of the label.

Parameters:

position - the position

onEdge - true if the label must be alongside the edge