org.girod.jgraphml.model

Class GraphMLGroupNode

java.lang.Object

org.girod.jgraphml.model.AbstractIDElement

org.girod.jgraphml.model.AbstractGraphMLNode

org.girod.jgraphml.model.GraphMLGroupNode

All Implemented Interfaces:

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

Direct Known Subclasses:

GraphMLGroupNodeTemplate

public class GraphMLGroupNode
extends AbstractGraphMLNode
implements ShapeType, NodeParent

A graphml node group.

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
GraphMLGroupNode(AbstractGraphMLDiagram diagram, java.lang.String id) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addChild(IGraphMLNode node) Adds a child node to the group.
GraphMLGroupNode	addGroupNode() Adds a child group node to the parent.
GraphMLGroupNode	addGroupNode(java.lang.String id) Add a group node with a specified id.
GraphMLGroupNode	addGroupNodeFromTemplate(java.lang.String id) Adds a child group node to the parent.
GraphMLGroupNode	addGroupNodeFromTemplateWithLabel(java.lang.String id, java.lang.String text) Adds a child node to the parent, using a template, and with a specified label.
GraphMLGroupNode	addGroupNodeWithLabel(java.lang.String text) Adds a group node to the parent, and with a specified label.
GraphMLNode	addNode() Add a node with an id specified automatically.
GraphMLNode	addNode(java.lang.String id) Add a node with a specified id.
GraphMLNode	addNodeFromTemplate(java.lang.String id) Add a node with an id specified automatically.
GraphMLNode	addNodeFromTemplateWithLabel(java.lang.String id, java.lang.String text) Adds a child node to the parent, using a template, and with a specified label.
GraphMLNode	addNodeWithLabel(java.lang.String text) Add a node with an id specified automatically, and with a specified label.
GraphMLGroupNode	clone() Clone the node.
void	computeSize(float groupNodePadding, boolean recurse) Compute the size of the group node.
void	computeSize(float groupNodePadding, boolean realizedState, boolean recurse) Compute the size of the node.
int	countGroupNodes() Return the number of group nodes.
int	countNodes() Return the number of children nodes.
java.util.SortedMap<java.lang.String,IGraphMLNode>	getChildren() Return the children nodes.
int	getClosedHeight() Return the closed height.
GroupStateNode	getClosedStateNode() Return the closed state node.
int	getClosedWidth() Return the closed width.
GraphMLGroupDiagram	getGroupDiagram() Return the sub-diagram of the group.
java.util.SortedMap<java.lang.String,GraphMLGroupNode>	getGroupNodes() Return the group nodes.
short	getGroupOpenedNodeSizeType() Return the type which sets how the size of the node will be computed.
ShapeNode	getOpenedShapeNode() Return the opened shape node.
GroupStateNode	getOpenedStateNode() Return the opened state node.
ShapeNode	getRealizedShapeNode() Return the current realized shape node.
GroupStateNode	getRealizedStateNode() Return the current realized state node.
boolean	getRealizedStateValue()
GroupStateNode	getStateNode(boolean stateValue) Return a state node.
java.util.Map<java.lang.Boolean,GroupStateNode>	getStateNodes() Return the state nodes.
boolean	hasBorderColor() Return true if the node has a border color.
boolean	hasFillColor() Return true if the node has a fill color.
boolean	hasGroupNodes() Return true if there are group nodes.
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	setBorderInsets(java.awt.Insets insets) Set the Insets.
void	setBorderInsets(int value) Set the border Insets.
void	setBorderStyle(LineStyle borderStyle) Set the border style.
void	setClosedHeight(int closedHeight) Set the closed height.
void	setClosedWidth(int closedWidth) Set the closed width.
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 fill color.
void	setGeometry(Geometry geometry) Set the shape geometry.
void	setGroupOpenedNodeSizeType(short nodeSizeType) Set the type which sets how the size of the node will be computed.
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	setHeightPadding(int padding) Set the height padding for the default autosized property.
void	setInsets(java.awt.Insets insets) Set the Insets.
void	setInsets(int value) Set the Insets.
void	setLabel(NodeLabel nodeLabel) Set the label.
NodeLabel	setLabel(java.lang.String text) Set the node group label text for both the states.
NodeLabel	setLabel(java.lang.String text, boolean stateValue) Set the node group label text for one state.
void	setRealizedStateValue(boolean stateValue)
void	setType(short type) Set the shape type.
void	setWidthPadding(int padding) Set the width padding for the default autosized property.
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.NodeParent

getDiagram

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

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

Constructor Detail

GraphMLGroupNode

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

Constructor.

Parameters:

diagram - the diagram

id - the node id

Method Detail

getGroupDiagram

public GraphMLGroupDiagram getGroupDiagram()

Return the sub-diagram of the group.

Returns:

the sub-diagram of the group

setClosedWidth

public void setClosedWidth(int closedWidth)

Set the closed width.

Parameters:

closedWidth - the closed width

getClosedWidth

public int getClosedWidth()

Return the closed width.

Returns:

the closed width

setClosedHeight

public void setClosedHeight(int closedHeight)

Set the closed height.

Parameters:

closedHeight - the closed height

getClosedHeight

public int getClosedHeight()

Return the closed height.

Returns:

the closed height

setDefaultGeometry

public void setDefaultGeometry()

Set the default geometry.

Specified by:

setDefaultGeometry in interface IGraphMLNode

setGroupOpenedNodeSizeType

public void setGroupOpenedNodeSizeType(short nodeSizeType)

Set the type which sets how the size of the node will be computed.

Parameters:

nodeSizeType - the type which sets how the size of the node will be computed

See Also:

GroupNodeSizeType

getGroupOpenedNodeSizeType

public short getGroupOpenedNodeSizeType()

Return the type which sets how the size of the node will be computed.

Returns:

the type which sets how the size of the node will be computed

See Also:

GroupNodeSizeType

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)

Compute the size of the group node.

Specified by:

computeSize in interface IGraphMLNode

Parameters:

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

recurse - recurse on children nodes

setLabel

public NodeLabel setLabel(java.lang.String text)

Set the node group label text for both the states.

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 NodeLabel setLabel(java.lang.String text,
                          boolean stateValue)

Set the node group label text for one state.

Parameters:

text - the label text

stateValue - the state value

Returns:

the label

getStateNodes

public java.util.Map<java.lang.Boolean,GroupStateNode> getStateNodes()

Return the state nodes.

Returns:

the state nodes

getClosedStateNode

public GroupStateNode getClosedStateNode()

Return the closed state node.

Returns:

the closed state node

getOpenedStateNode

public GroupStateNode getOpenedStateNode()

Return the opened state node.

Returns:

the opened state node

getStateNode

public GroupStateNode getStateNode(boolean stateValue)

Return a state node.

Parameters:

stateValue - the state value

Returns:

the state node

setRealizedStateValue

public void setRealizedStateValue(boolean stateValue)

getRealizedStateValue

public boolean getRealizedStateValue()

getRealizedShapeNode

public ShapeNode getRealizedShapeNode()

Return the current realized shape node.

Specified by:

getRealizedShapeNode in interface IGraphMLNode

Returns:

the current realized shape node

getOpenedShapeNode

public ShapeNode getOpenedShapeNode()

Return the opened shape node.

Specified by:

getOpenedShapeNode in interface IGraphMLNode

Returns:

the opened shape node

getRealizedStateNode

public GroupStateNode getRealizedStateNode()

Return the current realized state node.

Returns:

the current realized state node

clone

public GraphMLGroupNode 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.

addChild

public boolean addChild(IGraphMLNode node)

Adds a child node to the group.

Specified by:

addChild in interface NodeParent

Parameters:

node - the node to add

Returns:

true if the add is successful, and false otherwise

addNode

public GraphMLNode addNode()

Add a node with an id specified automatically.

Specified by:

addNode in interface NodeParent

Returns:

the node

addNodeWithLabel

public GraphMLNode addNodeWithLabel(java.lang.String text)

Add a node with an id specified automatically, and with a specified label.

Specified by:

addNodeWithLabel in interface NodeParent

Parameters:

text - the node label

Returns:

the node

addNodeFromTemplate

public GraphMLNode addNodeFromTemplate(java.lang.String id)

Add a node with an id specified automatically.

Specified by:

addNodeFromTemplate in interface NodeParent

Parameters:

id - tehe template id

Returns:

the node

addNodeFromTemplateWithLabel

public GraphMLNode addNodeFromTemplateWithLabel(java.lang.String id,
                                                java.lang.String text)

Adds a child node to the parent, using a template, and with a specified label.

Specified by:

addNodeFromTemplateWithLabel in interface NodeParent

Parameters:

id - the template id

text - the node label

Returns:

the group node

addNode

public GraphMLNode addNode(java.lang.String id)

Add a node with a specified id.

Specified by:

addNode in interface NodeParent

Parameters:

id - the node id

Returns:

the node

addGroupNode

public GraphMLGroupNode addGroupNode()

Adds a child group node to the parent.

Specified by:

addGroupNode in interface NodeParent

Returns:

the group node

addGroupNodeWithLabel

public GraphMLGroupNode addGroupNodeWithLabel(java.lang.String text)

Adds a group node to the parent, and with a specified label.

Specified by:

addGroupNodeWithLabel in interface NodeParent

Parameters:

text - the group node label

Returns:

the group node

addGroupNodeFromTemplate

public GraphMLGroupNode addGroupNodeFromTemplate(java.lang.String id)

Adds a child group node to the parent.

Specified by:

addGroupNodeFromTemplate in interface NodeParent

Parameters:

id - the template id

Returns:

the group node

addGroupNodeFromTemplateWithLabel

public GraphMLGroupNode addGroupNodeFromTemplateWithLabel(java.lang.String id,
                                                          java.lang.String text)

Adds a child node to the parent, using a template, and with a specified label.

Specified by:

addGroupNodeFromTemplateWithLabel in interface NodeParent

Parameters:

id - the template id

text - the node label

Returns:

the group node

addGroupNode

public GraphMLGroupNode addGroupNode(java.lang.String id)

Add a group node with a specified id.

Specified by:

addGroupNode in interface NodeParent

Parameters:

id - the group node id

Returns:

the node

getChildren

public java.util.SortedMap<java.lang.String,IGraphMLNode> getChildren()

Return the children nodes.

Specified by:

getChildren in interface NodeParent

Returns:

the nodes

getGroupNodes

public java.util.SortedMap<java.lang.String,GraphMLGroupNode> getGroupNodes()

Return the group nodes.

Specified by:

getGroupNodes in interface NodeParent

Returns:

the group nodes

countNodes

public int countNodes()

Return the number of children nodes.

Specified by:

countNodes in interface NodeParent

Returns:

the number of nodes

countGroupNodes

public int countGroupNodes()

Return the number of group nodes.

Specified by:

countGroupNodes in interface NodeParent

Returns:

the number of group nodes

hasGroupNodes

public boolean hasGroupNodes()

Return true if there are group nodes.

Specified by:

hasGroupNodes in interface NodeParent

Returns:

true if there are group nodes

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 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

setBorderStyle

public void setBorderStyle(LineStyle borderStyle)

Set the border style.

Specified by:

setBorderStyle in interface ShapeType

Parameters:

borderStyle - the 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

setInsets

public void setInsets(java.awt.Insets insets)

Set the Insets.

Parameters:

insets - the Insets

setInsets

public void setInsets(int value)

Set the Insets.

Parameters:

value - the value, identical for each insets value (top, bottm, right, left).

setBorderInsets

public void setBorderInsets(java.awt.Insets insets)

Set the Insets.

Parameters:

insets - the Insets

setBorderInsets

public void setBorderInsets(int value)

Set the border Insets.

Parameters:

value - the value, identical for each border insets value (top, bottom, right, left).

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

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

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

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

setType

public void setType(short type)

Set the shape type.

Specified by:

setType in interface ShapeType

Parameters:

type - the type