org.girod.jgraphml.model

Class EdgeLabel

java.lang.Object

org.girod.jgraphml.model.AbstractLabel

org.girod.jgraphml.model.EdgeLabel

All Implemented Interfaces:

java.lang.Cloneable, LabelStyle

public class EdgeLabel
extends AbstractLabel

Represents an edge label.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EdgeLabel.ParamModel The parameter model for the edge label.

Field Summary

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

CENTER, HORIZONTALPOS_CENTER, HORIZONTALPOS_LEFT, HORIZONTALPOS_RIGHT, LEFT, RIGHT, STYLE_BOLD, STYLE_ITALIC, STYLE_PLAIN, VERTICALPOS_BOTTOM, VERTICALPOS_CENTER, VERTICALPOS_TOP

Constructor Summary

Constructors

Constructor and Description
EdgeLabel()

Method Summary

Modifier and Type	Method and Description
EdgeLabel.ParamModel	applyOnFirstSegment() Apply the label on the first segment.
EdgeLabel.ParamModel	applyOnLastSegment() Apply the label on the last segment.
EdgeLabel.ParamModel	applyOnSegment(int segment) Set the segment on which the label is applied.
EdgeLabel	clone()
float	getAnchorX() Return the label X anchor.
float	getAnchorY() Return the label Y anchor.
java.lang.String	getBackgroundColor() Return the text background color.
java.lang.String	getBorderColor() Return the text border color.
java.awt.Insets	getInsets() Return the insets.
EdgeLabel.ParamModel	getOrCreateParameterModel() Return the parameter model, creating it if it does not exist.
EdgeLabel.ParamModel	getParameterModel() Return the parameter model.
boolean	hasParameterModel() Return true if there is a rotation model.
void	setAnchorX(float anchorX) Set the label X anchor.
void	setAnchorY(float anchorY) Set the label Y anchor.
EdgeLabel.ParamModel	setAutoFlip(boolean autoFlip) Set the auto-flip property of the model.
EdgeLabel.ParamModel	setAutoRotate(boolean autoRotate) Set the auto-rotate property of the model.
boolean	setBackgroundColor(java.awt.Color backgroundColor) Set the text background color.
boolean	setBackgroundColor(java.lang.String backgroundColor) Set the text background color.
boolean	setBorderColor(java.awt.Color borderColor) Set the text border color.
boolean	setBorderColor(java.lang.String borderColor) Set the text border color.
EdgeLabel.ParamModel	setDistance(float distance) Set the label distance from the edge.
void	setInsets(java.awt.Insets insets) Set the insets.
EdgeLabel.ParamModel	setOnSegmentAutomatic(boolean isAutomatic) Set if the label is applied automatically on the best segment depending on the ratio.
void	setParameterModel(EdgeLabel.ParamModel paramModel) Set the parameter model.
EdgeLabel.ParamModel	setPosition(short position) Set the label position.
EdgeLabel.ParamModel	setRatio(float ratio) Set the label ratio on the edge.
void	setRotationModel(EdgeLabel.ParamModel rotationModel) Deprecated. replaced by setParameterModel(org.girod.jgraphml.model.EdgeLabel.ParamModel)
EdgeLabel.ParamModel	setSmartPosition(short position, boolean onEdge) Set the label smart position.

Methods inherited from class org.girod.jgraphml.model.AbstractLabel

createLabelPlacement, createLabelPlacement, getAlignment, getFontFamily, getFontSize, getFontStyle, getHorizontalTextPosition, getLabel, getLabeledElement, getLabelPlacement, getLabelPlacementType, getMinimumHeight, getMinimumSize, getMinimumWidth, getTextColor, getVerticalTextPosition, isEmpty, setAlignment, setFontFamily, setFontSize, setFontStyle, setHorizontalTextPosition, setLabel, setLabeledElement, setTextColor, setTextColor, setVerticalTextPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeLabel

public EdgeLabel()

Method Detail

clone

public EdgeLabel clone()

Overrides:

clone in class AbstractLabel

applyOnFirstSegment

public EdgeLabel.ParamModel applyOnFirstSegment()

Apply the label on the first segment.

Returns:

the parameter model

applyOnLastSegment

public EdgeLabel.ParamModel applyOnLastSegment()

Apply the label on the last segment.

Returns:

the parameter model

applyOnSegment

public EdgeLabel.ParamModel applyOnSegment(int segment)

Set the segment on which the label is applied.

Parameters:

segment - the segment

Returns:

the parameter model

setOnSegmentAutomatic

public EdgeLabel.ParamModel 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

Returns:

the parameter model

setRatio

public EdgeLabel.ParamModel setRatio(float ratio)

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

Parameters:

ratio - the ratio

Returns:

the parameter model

setBackgroundColor

public boolean setBackgroundColor(java.awt.Color backgroundColor)

Set the text background color.

Parameters:

backgroundColor - the color

Returns:

true if the color definition is valid

setBackgroundColor

public boolean setBackgroundColor(java.lang.String backgroundColor)

Set the text background color.

Parameters:

backgroundColor - the color

Returns:

true if the color definition is valid

getBackgroundColor

public java.lang.String getBackgroundColor()

Return the text background color.

Returns:

the text background color

setBorderColor

public boolean setBorderColor(java.awt.Color borderColor)

Set the text border color.

Parameters:

borderColor - the color

Returns:

true if the color definition is valid

setBorderColor

public boolean setBorderColor(java.lang.String borderColor)

Set the text border color.

Parameters:

borderColor - the color

Returns:

true if the color definition is valid

getBorderColor

public java.lang.String getBorderColor()

Return the text border color.

Returns:

the text border color

setInsets

public void setInsets(java.awt.Insets insets)

Set the insets.

Parameters:

insets - the insets

getInsets

public java.awt.Insets getInsets()

Return the insets.

Returns:

the insets

setParameterModel

public void setParameterModel(EdgeLabel.ParamModel paramModel)

Set the parameter model.

Parameters:

paramModel - the parameter model

setRotationModel

public void setRotationModel(EdgeLabel.ParamModel rotationModel)

Deprecated. replaced by setParameterModel(org.girod.jgraphml.model.EdgeLabel.ParamModel)

Set the rotation model.

Parameters:

rotationModel - the rotation model

getParameterModel

public EdgeLabel.ParamModel getParameterModel()

Return the parameter model.

Returns:

the parameter model

getOrCreateParameterModel

public EdgeLabel.ParamModel getOrCreateParameterModel()

Return the parameter model, creating it if it does not exist.

Returns:

the parameter model

setPosition

public EdgeLabel.ParamModel setPosition(short position)

Set the label position.

Parameters:

position - the position

Returns:

the parameter model

See Also:

EdgeLabelPosition

setDistance

public EdgeLabel.ParamModel setDistance(float distance)

Set the label distance from the edge.

Parameters:

distance - the distance

Returns:

the parameter model

setAutoRotate

public EdgeLabel.ParamModel setAutoRotate(boolean autoRotate)

Set the auto-rotate property of the model.

Parameters:

autoRotate - true if the label auto-rotates

Returns:

the parameter model

setAutoFlip

public EdgeLabel.ParamModel setAutoFlip(boolean autoFlip)

Set the auto-flip property of the model.

Parameters:

autoFlip - true if the label auto-flips

Returns:

the parameter model

setSmartPosition

public EdgeLabel.ParamModel setSmartPosition(short position,
                                             boolean onEdge)

Set the label smart position.

Parameters:

position - the position

onEdge - true if the label must be alongside the edge

Returns:

the parameter model

See Also:

EdgeLabel.ParamModel.setSmartPosition(short, boolean)

hasParameterModel

public boolean hasParameterModel()

Return true if there is a rotation model.

Returns:

true if there is a rotation model

setAnchorX

public void setAnchorX(float anchorX)

Set the label X anchor.

Parameters:

anchorX - the anchorX

getAnchorX

public float getAnchorX()

Return the label X anchor.

Returns:

the anchorX

setAnchorY

public void setAnchorY(float anchorY)

Set the label Y anchor.

Parameters:

anchorY - the anchor

getAnchorY

public float getAnchorY()

Return the label Y anchor.

Returns:

the anchor