Package org.graffiti.graphics

Class DockingAttribute

java.lang.Object

org.graffiti.attributes.AbstractAttribute

org.graffiti.attributes.AbstractCollectionAttribute

org.graffiti.attributes.HashMapAttribute

org.graffiti.graphics.DockingAttribute

All Implemented Interfaces:

Comparable<Object>, Attribute, CollectionAttribute, DeepCopy, GraphicAttributeConstants, Displayable

public class DockingAttribute
extends HashMapAttribute
implements GraphicAttributeConstants

Contains the graphic attribute docking for edges. It contains the names of the ports the edge should dock to in the source/target node. Default is the empty string - the EdgeComponent knows how to interpret this correctly.

Version:

$Revision: 1.8 $

Author:

breu

Field Summary

Fields inherited from interface org.graffiti.attributes.Attribute

SEPARATOR

Fields inherited from interface org.graffiti.graphics.GraphicAttributeConstants

ABOVE, ABOVELEFT, ABOVERIGHT, ABSHOR, ABSVERT, ALIGNMENT, ALIGNSEGMENT, ANCHOR, ARROWHEAD, ARROWTAIL, AUTO_OUTSIDE, AXISCOLOR, BELOW, BELOWLEFT, BELOWRIGHT, BENDS, BENDS_PATH, BGIMAGE, BLUE, BORDER_BOTTOM_CENTER, BORDER_BOTTOM_LEFT, BORDER_BOTTOM_RIGHT, BORDER_LEFT_BOTTOM, BORDER_LEFT_CENTER, BORDER_LEFT_TOP, BORDER_RIGHT_BOTTOM, BORDER_RIGHT_CENTER, BORDER_RIGHT_TOP, BORDER_TOP_CENTER, BORDER_TOP_LEFT, BORDER_TOP_RIGHT, CATEGORY_BACKGROUND_A, CATEGORY_BACKGROUND_B, CATEGORY_BACKGROUND_C, CENTERED, CENTERED_FIT, CHARTBACKGROUNDCOLOR, CIRCLE_CLASSNAME, COLOR, COMMON, COORD_PATH, COORDINATE, COORDX_PATH, COORDY_PATH, CUBICSPLINE, CUBICSPLINE_CLASSNAME, DEFAULT_CAP_B, DEFAULT_CAP_R, DEFAULT_JOIN, DEFAULT_MITER, DIM_PATH, DIMENSION, DIMH_PATH, DIMW_PATH, DOCKING, DOCKING_PATH, ELLIPSE_CLASSNAME, FILLCOLOR, FILLCOLOR_PATH, FONTNAME, FONTSIZE, FONTSTYLE, FRAMECOLOR, FRAMETHICKNESS, FRAMETHICKNESS_PATH, GRADIENT, GRAPHICS, GREEN, GRIDCOLOR, HEATMAP_LOWER_COL, HEATMAP_MIDDLE_COL, HEATMAP_UPPER_COL, HEIGHT, HIDDEN, IMAGE, IN, INSIDEBOTTOM, INSIDEBOTTOMLEFT, INSIDEBOTTOMRIGHT, INSIDELEFT, INSIDERIGHT, INSIDETOP, INSIDETOPLEFT, INSIDETOPRIGHT, LABEL, LABEL_ATTRIBUTE_PATH, LABEL_DISTANCE, LABELGRAPHICS, LABELOFFSET, LEFT, LINEMODE, LINETYPE, LINEWIDTH_PATH, LOCALALIGN, MAXIMIZE, NAME, NEARSOURCE, NEARTARGET, OPAC, OUT, OUTLINE_PATH, POLYCLOSED_CLASSNAME, POLYLINE, POLYLINE_CLASSNAME, PORT, PORTS, PORTS_PATH, POSITION, RECTANGLE_CLASSNAME, RED, REF, RELALIGN, RELHOR, RELVERT, RIGHT, ROUNDING, SHADOWCOLOR, SHADOWOFFSET, SHAPE, SHAPE_DESC_PATH, SHAPE_PATH, SHAPEDESCRIPTION, SMOOTH_CLASSNAME, SMOOTHLINE, SOURCE, SQUARESPLINE, SQUARESPLINE_CLASSNAME, STRAIGHTLINE, STRAIGHTLINE_CLASSNAME, TARGET, TEXTCOLOR, THICKNESS, TILED, WIDTH, X, Y

Constructor Summary

Constructors

Constructor	Description
DockingAttribute(String id)	Constructor for Docking.
DockingAttribute(String id, String source, String target)	Constructor for Docking.

Method Summary

Modifier and Type	Method	Description
Object	copy()	Returns a deep copy of this object.
String	getSource()	Returns the 'source'-value of the encapsulated docking.
String	getTarget()	Returns the 'target'-value of the encapsulated docking.
void	setCollection(Map<String,Attribute> attrs)	Sets the collection of attributes contained within this CollectionAttribute.
void	setSource(String s)	Sets the 'source'-value.
void	setTarget(String t)	Sets the 'target'-value.

Methods inherited from class org.graffiti.attributes.HashMapAttribute

compareTo, getCollection, setDefaultValue, size

Methods inherited from class org.graffiti.attributes.AbstractCollectionAttribute

add, add, getAttributable, getAttribute, getValue, isEmpty, remove, remove, setAttributable, toString, toXMLString

Methods inherited from class org.graffiti.attributes.AbstractAttribute

addEdgeAttributeType, addNodeAttributeType, getDescription, getIcon, getId, getName, getParent, getPath, getTypedAttribute, isDeleted, isTypedAttributeFromID, setDeleted, setDescription, setId, setParent, setValue, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.graffiti.attributes.Attribute

getAttributable, getId, getParent, getPath, getValue, isDeleted, setDeleted, setId, setParent, setValue, toString

Methods inherited from interface org.graffiti.attributes.CollectionAttribute

add, add, getAttribute, isEmpty, remove, remove, setAttributable

Methods inherited from interface org.graffiti.plugin.Displayable

getDescription, getIcon, getName, setDescription, toXMLString

Constructor Details

DockingAttribute

public DockingAttribute(String id)

Constructor for Docking.

Parameters:

id - the id of the attriubte.

DockingAttribute

public DockingAttribute(String id,
String source,
String target)

Constructor for Docking.

Parameters:

id - the id of the attribute.

source - the source-value of the attribute.

target - the target-value of the attribute.

Method Details

setCollection

public void setCollection(Map<String,Attribute> attrs)

Sets the collection of attributes contained within this CollectionAttribute. The docking values are set, additional values are simply added (that means that if there exists already a subattribute with the same id, an exception will be thrown).

Specified by:

setCollection in interface CollectionAttribute

Overrides:

setCollection in class HashMapAttribute

Parameters:

attrs - the map that contains all attributes.

Throws:

IllegalArgumentException - DOCUMENT ME!

setSource

public void setSource(String s)

Sets the 'source'-value.

Parameters:

s - the 'source'-value to be set.

getSource

public String getSource()

Returns the 'source'-value of the encapsulated docking.

Returns:

the 'source'-value of the encapsulated docking.

setTarget

public void setTarget(String t)

Sets the 'target'-value.

Parameters:

t - the 'target'-value to be set.

getTarget

public String getTarget()

Returns the 'target'-value of the encapsulated docking.

Returns:

the 'target'-value of the encapsulated docking.

copy

public Object copy()

Returns a deep copy of this object.

Specified by:

copy in interface DeepCopy

Overrides:

copy in class HashMapAttribute

Returns:

A deep copy of this object.