net.frapu.code.visualization

Class Cluster

java.lang.Object

net.frapu.code.visualization.SerializableProcessObject

net.frapu.code.visualization.ProcessObject

net.frapu.code.visualization.ProcessNode

net.frapu.code.visualization.Cluster

All Implemented Interfaces:

java.lang.Cloneable, Dragable

Direct Known Subclasses:

Activity, CasePlanModel, ChoreographySubProcess, ColoredFrame, GanttChart, Group, Lane, LaneableCluster, Panel, PlanFragment, RectangularElement, RoundRectangularElement, Scene, Stage, SubProcess, Tool, UMLPackage

public abstract class Cluster
extends ProcessNode

Provides a Cluster of ProcessNodes (for Pools, Lanes, etc.)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_COLLAPSED Marks if this cluster is currently collapsed
static java.lang.String	PROP_CONTAINED_NODES Property for the contained Nodes of this Cluster

Fields inherited from class net.frapu.code.visualization.ProcessNode

PROP_ANNOTATION, PROP_BACKGROUND, PROP_HEIGHT, PROP_LABEL, PROP_MODULEID, PROP_REF, PROP_SHADOW, PROP_STEREOTYPE, PROP_TEXT, PROP_WIDTH, PROP_XPOS, PROP_YPOS, TAG_NODE, userObject

Fields inherited from class net.frapu.code.visualization.ProcessObject

contexts, FALSE, PROP_CLASS_TYPE, PROP_ID, TRUE

Constructor Summary

Constructors

Constructor and Description
Cluster()

Method Summary

Modifier and Type	Method and Description
void	addProcessNode(ProcessNode n) Adds a ProcessNode to this Cluster.
void	clearContainment()
Cluster	clone()
java.util.List<ProcessNode>	getProcessNodes() Returns the set of ProcessNodes contained in this Cluster.
java.util.List<ProcessNode>	getProcessNodesRecursivly()
boolean	isCluster() Returns if this node is an instance of a subclass of Cluster
boolean	isCollapseable() Returns if this cluster is collapseable.
boolean	isCollapsed()
boolean	isContained(ProcessNode n) Returns whether a certain ProcessNode is contained inside this Cluster.
boolean	isContainedGraphically(java.util.List<ProcessNode> allNodes, ProcessNode node, boolean onTopRequired) Returns whether a certain ProcessNode is graphically contained or not.
protected void	moveClusterNodes(int dx, int dy)
void	removeProcessNode(ProcessNode n) Removes a ProcessNode from this Cluster.
void	setPos(int x, int y) Sets the center position of this ProcessNode.
void	setPosIgnoreContainedNodes(int x, int y)
void	setProcessNodes(java.util.Collection<ProcessNode> nodes) Sets the Nodeset as the ProcessNodes of the Cluster
void	setProperty(java.lang.String key, java.lang.String value) Sets a property.
java.lang.String	toString()
void	updateContainments(java.util.List<ProcessNode> nodes) Updates the containment set.

Methods inherited from class net.frapu.code.visualization.ProcessNode

addConnectionPoint, checkDefaultConnectionPoints, connectionPointContained, contains, containsDeepInside, copy, getBackground, getBackground, getBoundingBox, getBounds, getConnectionPoint, getConnectionPoint, getConnectionPoint, getDefaultConnectionPoints, getName, getOutlineShape, getParentClusters, getPos, getSelectionOffset, getSize, getStereotype, getText, getTopLeftPos, getUserObject, getVariants, getXmlTag, handleCloning, isShadowEnabled, isVisible, newInstanceFromSerialization, paint, paintHighlight, paintInternal, paintSelection, removeAllConnectionPoints, setBackground, setPos, setShadowEnabled, setSize, setSize, setStereotype, setText, setUserObject, setVisible, updateReferences

Methods inherited from class net.frapu.code.visualization.ProcessObject

addContext, addListener, equals, getAlpha, getContexts, getId, getPropertyEditor, isHighlighted, isSelected, removeContext, removeListener, setAlpha, setHighlighted, setId, setPropertyEditor, setSelected

Methods inherited from class net.frapu.code.visualization.SerializableProcessObject

getProperty, getPropertyKeys, getSerialization, removeProperty

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROP_CONTAINED_NODES

public static final java.lang.String PROP_CONTAINED_NODES

Property for the contained Nodes of this Cluster

See Also:

Constant Field Values

PROP_COLLAPSED

public static final java.lang.String PROP_COLLAPSED

Marks if this cluster is currently collapsed

See Also:

Constant Field Values

Constructor Detail

Cluster

public Cluster()

Method Detail

isCollapseable

public boolean isCollapseable()

Returns if this cluster is collapseable. Might be overwritten by subclasses.

Returns:

isCollapsed

public boolean isCollapsed()

setPos

public void setPos(int x,
                   int y)

Description copied from class: ProcessNode

Sets the center position of this ProcessNode.

Overrides:

setPos in class ProcessNode

setPosIgnoreContainedNodes

public void setPosIgnoreContainedNodes(int x,
                                       int y)

moveClusterNodes

protected void moveClusterNodes(int dx,
                                int dy)

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Description copied from class: ProcessObject

Sets a property.

Overrides:

setProperty in class ProcessNode

addProcessNode

public void addProcessNode(ProcessNode n)

Adds a ProcessNode to this Cluster.

Parameters:

n -

removeProcessNode

public void removeProcessNode(ProcessNode n)

Removes a ProcessNode from this Cluster.

Parameters:

n -

getProcessNodes

public java.util.List<ProcessNode> getProcessNodes()

Returns the set of ProcessNodes contained in this Cluster.

Returns:

final Set

getProcessNodesRecursivly

public java.util.List<ProcessNode> getProcessNodesRecursivly()

setProcessNodes

public void setProcessNodes(java.util.Collection<ProcessNode> nodes)

Sets the Nodeset as the ProcessNodes of the Cluster

Parameters:

NODES -

isContained

public boolean isContained(ProcessNode n)

Returns whether a certain ProcessNode is contained inside this Cluster.

Parameters:

n -

Returns:

updateContainments

public void updateContainments(java.util.List<ProcessNode> nodes)

Updates the containment set. Usually required after creating a to initialize containments.

Parameters:

nodes -

clearContainment

public void clearContainment()

isContainedGraphically

public boolean isContainedGraphically(java.util.List<ProcessNode> allNodes,
                                      ProcessNode node,
                                      boolean onTopRequired)

Returns whether a certain ProcessNode is graphically contained or not.

isCluster

public boolean isCluster()

Description copied from class: ProcessNode

Returns if this node is an instance of a subclass of Cluster

Overrides:

isCluster in class ProcessNode

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class ProcessNode

clone

public Cluster clone()

Overrides:

clone in class ProcessNode