org.girod.jgraphml.model

Class GraphMLNode

java.lang.Object

org.girod.jgraphml.model.AbstractIDElement

org.girod.jgraphml.model.AbstractGraphMLNode

org.girod.jgraphml.model.GraphMLNode

All Implemented Interfaces:

java.lang.Cloneable, IDElement, IGraphMLNode, Labeled, LabeledElement, ShapeType

Direct Known Subclasses:

GraphMLNodeTemplate

public class GraphMLNode
extends AbstractGraphMLNode
implements LabeledElement, java.lang.Cloneable

A graphml node.

Field Summary

Fields inherited from class org.girod.jgraphml.model.AbstractGraphMLNode

diagram

Fields inherited from class org.girod.jgraphml.model.AbstractIDElement

id

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

DIAMOND, ELLIPSE, FATARROW, FATARROW2, HEXAGON, OCTAGON, PARALLELOGRAM, PARALLELOGRAM2, RECTANGLE, RECTANGLE3D, ROUNDRECTANGLE, TRIANGLE, TRIANGLE2

Constructor Summary

Constructors

Constructor and Description
GraphMLNode(AbstractGraphMLDiagram diagram, java.lang.String id) Constructor.

Method Summary

Modifier and Type	Method and Description
GraphMLNode	clone() Clone the node.
void	computeSize(float groupNodePadding, boolean recurse) Do nothing.
void	computeSize(float groupNodePadding, boolean realizedState, boolean recurse) Compute the size of the node.
NodeLabel	createLabel(boolean createIfExist) Create the node associated label.
float	getHeight() Return the height.
NodeLabel	getLabel() Return the node associated label.
java.lang.String	getLabelText() Return the element label text.
ShapeNode	getOpenedShapeNode() Return the shape node.
ShapeNode	getRealizedShapeNode() Return the shape node.
ShapeNode	getShapeNode() Return the shape node.
float	getWidth() Return the width.
float	getX() Return the x position.
float	getY() Return the y position.
boolean	hasBorderColor() Return true if the node has a border color.
boolean	hasFillColor() Return true if the node has a fill color.
boolean	isAutosized() Return true if the node is automatically sized depending on the node label.
void	setAutosized(boolean autosized) Set if the node is automatically sized depending on the node label.
boolean	setBorderColor(java.lang.String borderColor) Set the border color.
void	setBorderStyle(LineStyle borderStyle) Set the node border style.
void	setDefaultGeometry() Set the default geometry.
protected void	setDefaults() Set the defaults.
void	setDropShadow(DropShadow dropShadow) Set the node drop shadow.
boolean	setFillColor(java.awt.Color fillColor) Set the text color.
boolean	setFillColor(java.lang.String fillColor) Set the node fill color.
void	setGeometry(Geometry geometry) Set the shape geometry.
void	setHasBorderColor(boolean hasBorderColor) Set if the node has a border color.
void	setHasFillColor(boolean hasFillColor) Set if the node has a fill color.
void	setHeight(float height) A shortcut to set the height.
void	setHeightPadding(int padding) Set the height padding for the default autosized property.
void	setLabel(NodeLabel nodeLabel) Set the label.
NodeLabel	setLabel(java.lang.String text) Set the element label text.
void	setShapeNode(ShapeNode shape) Set the shape node.
void	setType(short type) Set the shape type.
void	setWidth(float width) A shortcut to set the width.
void	setWidthPadding(int padding) Set the width padding for the default autosized property.
void	setX(float x) A shortcut to set the x position.
void	setY(float y) A shortcut to set the y position.
void	updateLabel() Called when the label is updated.

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

addEdgeFrom, addEdgeTo, addFromEdge, addToEdge, computeSize, getDiagram, getFromEdges, getParent, getToEdges, repatriate, repatriate, setFromPortConstraint, setFromPortConstraint, setId, setParent, setToPortConstraint, setToPortConstraint

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

getDescription, getID, getURL, getURLAsString, hasURL, setDescription, setURL, setURL

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.girod.jgraphml.model.LabeledElement

createLabelPlacement, getLabelPlacement

Methods inherited from interface org.girod.jgraphml.model.IDElement

getDescription, getID, getURL, getURLAsString, hasDescription, hasURL, isTemplate, setDescription, setURL, setURL

Constructor Detail

GraphMLNode

public GraphMLNode(AbstractGraphMLDiagram diagram,
                   java.lang.String id)

Constructor.

Parameters:

diagram - the diagram

id - the node id

Method Detail

setAutosized

public void setAutosized(boolean autosized)

Set if the node is automatically sized depending on the node label.

Specified by:

setAutosized in interface ShapeType

Parameters:

autosized - true if the node is autosized

isAutosized

public boolean isAutosized()

Return true if the node is automatically sized depending on the node label.

Returns:

true if the node is autosized

clone

public GraphMLNode clone()

Description copied from interface: IGraphMLNode

Clone the node.

Specified by:

clone in interface IGraphMLNode

Overrides:

clone in class AbstractGraphMLNode

Returns:

the cloned node

setDefaults

protected void setDefaults()

Set the defaults.

setDefaultGeometry

public void setDefaultGeometry()

Set the default geometry.

Specified by:

setDefaultGeometry in interface IGraphMLNode

setType

public void setType(short type)

Set the shape type.

Specified by:

setType in interface ShapeType

Parameters:

type - the type

setShapeNode

public void setShapeNode(ShapeNode shape)

Set the shape node.

Parameters:

shape - the shape node

computeSize

public void computeSize(float groupNodePadding,
                        boolean realizedState,
                        boolean recurse)

Compute the size of the node.

Specified by:

computeSize in interface IGraphMLNode

Parameters:

groupNodePadding - the padding between nodes used for computing group node sizes

realizedState - true for the state for which to compute the size

recurse - recurse on children nodes

computeSize

public void computeSize(float groupNodePadding,
                        boolean recurse)

Do nothing.

Specified by:

computeSize in interface IGraphMLNode

Parameters:

groupNodePadding - the padding between nodes used for computing group node sizes

recurse - recurse on children nodes

getOpenedShapeNode

public ShapeNode getOpenedShapeNode()

Return the shape node.

Specified by:

getOpenedShapeNode in interface IGraphMLNode

Returns:

the shape node

getRealizedShapeNode

public ShapeNode getRealizedShapeNode()

Return the shape node.

Specified by:

getRealizedShapeNode in interface IGraphMLNode

Returns:

the shape node

getShapeNode

public ShapeNode getShapeNode()

Return the shape node.

Returns:

the shape node

setX

public void setX(float x)

A shortcut to set the x position.

Parameters:

x - the x position

getX

public float getX()

Return the x position.

Returns:

the x position

setY

public void setY(float y)

A shortcut to set the y position.

Parameters:

y - the y position

getY

public float getY()

Return the y position.

Returns:

the y position

setWidth

public void setWidth(float width)

A shortcut to set the width.

Parameters:

width - the width

getWidth

public float getWidth()

Return the width.

Returns:

the width

setHeight

public void setHeight(float height)

A shortcut to set the height.

Parameters:

height - the height

getHeight

public float getHeight()

Return the height.

Returns:

the height

setWidthPadding

public void setWidthPadding(int padding)

Set the width padding for the default autosized property.

Specified by:

setWidthPadding in interface ShapeType

Parameters:

padding - the padding

setHeightPadding

public void setHeightPadding(int padding)

Set the height padding for the default autosized property.

Specified by:

setHeightPadding in interface ShapeType

Parameters:

padding - the padding

setGeometry

public void setGeometry(Geometry geometry)

Set the shape geometry.

Specified by:

setGeometry in interface ShapeType

Parameters:

geometry - the geometry

setDropShadow

public void setDropShadow(DropShadow dropShadow)

Set the node drop shadow.

Specified by:

setDropShadow in interface ShapeType

Parameters:

dropShadow - the node drop shadow

setBorderStyle

public void setBorderStyle(LineStyle borderStyle)

Set the node border style.

Specified by:

setBorderStyle in interface ShapeType

Parameters:

borderStyle - the node border style

setBorderColor

public boolean setBorderColor(java.lang.String borderColor)

Set the border color.

Specified by:

setBorderColor in interface ShapeType

Parameters:

borderColor - the color

Returns:

true if the color definition is valid

setHasBorderColor

public void setHasBorderColor(boolean hasBorderColor)

Set if the node has a border color.

Specified by:

setHasBorderColor in interface ShapeType

Parameters:

hasBorderColor - true if the node has a border color

hasBorderColor

public boolean hasBorderColor()

Return true if the node has a border color.

Specified by:

hasBorderColor in interface ShapeType

Returns:

true if the node has a border color

setFillColor

public boolean setFillColor(java.awt.Color fillColor)

Set the text color.

Specified by:

setFillColor in interface ShapeType

Parameters:

fillColor - the color

Returns:

true if the color definition is valid

setFillColor

public boolean setFillColor(java.lang.String fillColor)

Set the node fill color.

Specified by:

setFillColor in interface ShapeType

Parameters:

fillColor - the color

Returns:

true if the color definition is valid

setHasFillColor

public void setHasFillColor(boolean hasFillColor)

Set if the node has a fill color.

Specified by:

setHasFillColor in interface ShapeType

Parameters:

hasFillColor - true if the node has a fill color

hasFillColor

public boolean hasFillColor()

Return true if the node has a fill color.

Specified by:

hasFillColor in interface ShapeType

Returns:

true if the node has a fill color

getLabel

public NodeLabel getLabel()

Return the node associated label.

Specified by:

getLabel in interface LabeledElement

Returns:

the label

createLabel

public NodeLabel createLabel(boolean createIfExist)

Create the node associated label.

Specified by:

createLabel in interface LabeledElement

Parameters:

createIfExist - true if a new label will be created even if it already exists

Returns:

the label

setLabel

public NodeLabel setLabel(java.lang.String text)

Set the element label text.

Specified by:

setLabel in interface IGraphMLNode

Specified by:

setLabel in interface Labeled

Specified by:

setLabel in interface ShapeType

Parameters:

text - the label text

Returns:

the label

setLabel

public void setLabel(NodeLabel nodeLabel)

Set the label.

Specified by:

setLabel in interface ShapeType

Parameters:

nodeLabel - the label

updateLabel

public void updateLabel()

Called when the label is updated.

Specified by:

updateLabel in interface IGraphMLNode

Specified by:

updateLabel in interface LabeledElement

getLabelText

public java.lang.String getLabelText()

Return the element label text.

Specified by:

getLabelText in interface LabeledElement

Returns:

the label text