org.graffiti.graphics
Class CoordinateAttribute

java.lang.Object
  extended by org.graffiti.attributes.AbstractAttribute
      extended by org.graffiti.attributes.AbstractCollectionAttribute
          extended by org.graffiti.attributes.LinkedHashMapAttribute
              extended by org.graffiti.graphics.CoordinateAttribute
All Implemented Interfaces:
Attribute, CollectionAttribute, SortedCollectionAttribute, DeepCopy, GraphicAttributeConstants, Displayable<Object>

public class CoordinateAttribute
extends LinkedHashMapAttribute
implements GraphicAttributeConstants

Contains the coordinate graphic attribute.

Version:
$Revision: 5768 $
Author:
breu

Field Summary
 
Fields inherited from class org.graffiti.attributes.AbstractCollectionAttribute
attributes
 
Fields inherited from class org.graffiti.attributes.AbstractAttribute
id
 
Fields inherited from interface org.graffiti.graphics.GraphicAttributeConstants
ABSOLUTE_X_OFFSET, ABSOLUTE_Y_OFFSET, ALIGNMENT, ALIGNMENT_SEGMENT, ALIGNMENT_X, ALIGNMENT_Y, ARROWHEAD, ARROWSHAPE_CLASSNAME, ARROWTAIL, BEND, BENDS, BENDS_PATH, BGIMAGE, BGIMAGE_PATH, BLUE, BOTTOM_INSIDE, BOTTOM_OUTSIDE, CENTERED, CIRCLE_CENTER, CIRCLE_CENTER_PATH, CIRCLE_CLASSNAME, CIRCLE_LINE_SEGMENTATION_CLASSNAME, CIRCLE_LINE_SEGMENTATION_SHAPE, COMMON, COORD_PATH, COORDINATE, COORDX_PATH, COORDY_PATH, COORDZ_PATH, CUBICSPLINE, CUBICSPLINE_CLASSNAME, DEFAULT_CAP, DEFAULT_EDGE_FILLCOLOR, DEFAULT_EDGE_FRAMECOLOR, DEFAULT_EDGE_FRAMETHICKNESS, DEFAULT_EDGE_THICKNESS, DEFAULT_FONT_SIZE, DEFAULT_GRAPHIC_ELEMENT_FRAMECOLOR, DEFAULT_GRAPHIC_ELEMENT_FRAMETHICKNESS, DEFAULT_JOIN, DEFAULT_MAX_WIDTH, DEFAULT_MITER, DEFAULT_NODE_FILLCOLOR, DEFAULT_NODE_FRAMECOLOR, DEFAULT_NODE_FRAMETHICKNESS, DEFAULT_NODE_SHAPE, DEFAULT_NODE_SIZE, DEPTH, DEPTH_PATH, DIM_PATH, DIMENSION, DIMH_PATH, DIMW_PATH, DOCKING, DOCKING_PATH, EDGE, ELLIPSE_CLASSNAME, END_ANGLE, FILLCOLOR, FILLCOLOR_PATH, FONT, FONT_SIZE, FRAMECOLOR, FRAMETHICKNESS, FRAMETHICKNESS_PATH, GRAPHICS, GREEN, GRID, GRID_PATH, HEIGHT, IMAGE, IN, INTRA_LEVEL_CLASSNAME, LABEL, LABEL_ATTRIBUTE_PATH, LABEL_DISTANCE, LEFT_INSIDE, LEFT_OUTSIDE, LEVEL, LINE_POINT_PATH, LINEMODE, LINEMODE_PATH, LINETYPE, LINEWIDTH_PATH, MAX_WIDTH, MAXIMIZE, NAME, NEARSOURCE, NEARTARGET, NODE, OFFSET, OPAC, OUT, OUTLINE_PATH, POLYCLOSED_CLASSNAME, POLYLINE, POLYLINE_CLASSNAME, PORT, PORTS, PORTS_PATH, POSITION, QUAD_CURVE_EDGE_SHAPE, RECTANGLE_CLASSNAME, RED, REF, RELATIVE_ALIGNMENT, RELATIVE_X_OFFSET, RELATIVE_Y_OFFSET, RIGHT_INSIDE, RIGHT_OUTSIDE, ROTATION, SHAPE, SHAPE_DESC_PATH, SHAPE_PATH, SHAPEDESCRIPTION, SMOOTH_CLASSNAME, SMOOTH_LINE_EDGE_SHAPE, SMOOTHLINE, SOURCE, SPIRAL_CLASSNAME, SQUARESPLINE, SQUARESPLINE_CLASSNAME, START_ANGLE, STRAIGHT_LINE_EDGE_SHAPE, STRAIGHTLINE, STRAIGHTLINE_CLASSNAME, TARGET, TEXTCOLOR, THICKNESS, THICKNESS_PATH, TILED, TOP_INSIDE, TOP_OUTSIDE, WIDTH, X, Y, Z
 
Fields inherited from interface org.graffiti.attributes.Attribute
SEPARATOR
 
Constructor Summary
CoordinateAttribute(String id)
          Constructor for Coordinate that sets the coordinates to a random number.
CoordinateAttribute(String id, double x, double y)
          Constructor for Coordinate.
CoordinateAttribute(String id, double x, double y, double z)
           
CoordinateAttribute(String id, Point2D c)
          Constructor for Coordinate.
 
Method Summary
 Object copy()
          Returns a deep copy of this object.
 Point2D getCoordinate()
          Returns the encapsulated coordinate.
 double getDepth()
          Returns the depth coordinate.
 double getX()
          Returns the 'x'-value of the encapsulated coordinate.
 double getY()
          Returns the 'y'-value of the encapsulated coordinate.
 double getZ()
          Returns the 'z'-value of the encapsulated coordinate.
 void setCollection(Map<String,Attribute> attrs)
          Sets the collection of attributes contained within this CollectionAttribute.
 void setCoordinate(Point2D p)
          Sets the x and y values of this coordinate to the given points' values.
 void setDepth(double depth)
          Sets the depth coordinate.
 void setX(double x)
          Sets the 'x1'-value.
 void setY(double y)
          Sets the 'x2'-value.
 void setZ(double z)
          Sets the 'x3'-value.
 
Methods inherited from class org.graffiti.attributes.LinkedHashMapAttribute
doSetValue, getCollection, setDefaultValue, toXMLString
 
Methods inherited from class org.graffiti.attributes.AbstractCollectionAttribute
add, add, containsAttribute, getAttributable, getAttribute, getValue, isEmpty, remove, remove, setAttributable, toString
 
Methods inherited from class org.graffiti.attributes.AbstractAttribute
callPostAttributeAdded, callPostAttributeChanged, callPostAttributeRemoved, callPreAttributeAdded, callPreAttributeChanged, callPreAttributeRemoved, getDescription, getId, getName, getParent, getPath, getSpaces, getStandardXML, setDescription, setParent, setValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.graffiti.attributes.CollectionAttribute
add, add, containsAttribute, getAttribute, isEmpty, remove, remove, setAttributable
 
Methods inherited from interface org.graffiti.attributes.Attribute
getAttributable, getId, getParent, getPath, getValue, setParent, setValue, toString
 
Methods inherited from interface org.graffiti.plugin.Displayable
getDescription, getName, setDescription
 

Constructor Detail

CoordinateAttribute

public CoordinateAttribute(String id)
Constructor for Coordinate that sets the coordinates to a random number.

Parameters:
id - the id of the attribute.

CoordinateAttribute

public CoordinateAttribute(String id,
                           Point2D c)
Constructor for Coordinate.

Parameters:
id - the id of the attribute.
c - the coordinate-value of the attriubte.

CoordinateAttribute

public CoordinateAttribute(String id,
                           double x,
                           double y)
Constructor for Coordinate.

Parameters:
id - the id of the attribute.
x - the x-value of the attribute.
y - the y-value of the attribute.

CoordinateAttribute

public CoordinateAttribute(String id,
                           double x,
                           double y,
                           double z)
Method Detail

setCollection

public void setCollection(Map<String,Attribute> attrs)
Sets the collection of attributes contained within this CollectionAttribute. The coordinate 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 LinkedHashMapAttribute
Parameters:
attrs - the map that contains all attributes.
Throws:
IllegalArgumentException - DOCUMENT ME!

setCoordinate

public void setCoordinate(Point2D p)
Sets the x and y values of this coordinate to the given points' values.

Parameters:
p - Point2D to which this coordinate should be set.

getCoordinate

public Point2D getCoordinate()
Returns the encapsulated coordinate.

Returns:
the encapsulated coordinate.

setDepth

public void setDepth(double depth)
Sets the depth coordinate.

Parameters:
depth - the new depth coordinate.
See Also:
z

getDepth

public double getDepth()
Returns the depth coordinate.

Returns:
the depth coordinate.
See Also:
z

setX

public void setX(double x)
Sets the 'x1'-value.

Parameters:
x - the 'x1'-value to be set.

getX

public double getX()
Returns the 'x'-value of the encapsulated coordinate.

Returns:
the 'x'-value of the encapsulated coordinate.

setY

public void setY(double y)
Sets the 'x2'-value.

Parameters:
y - the 'x2'-value to be set.

getY

public double getY()
Returns the 'y'-value of the encapsulated coordinate.

Returns:
the 'y'-value of the encapsulated coordinate.

setZ

public void setZ(double z)
Sets the 'x3'-value.

Parameters:
z - the 'x3'-value to be set.

getZ

public double getZ()
Returns the 'z'-value of the encapsulated coordinate.

Returns:
the 'z'-value of the encapsulated coordinate.

copy

public Object copy()
Returns a deep copy of this object.

Specified by:
copy in interface DeepCopy
Overrides:
copy in class LinkedHashMapAttribute
Returns:
A deep copy of this object.


Generated at 2012-05-30 11:00:36 PM CEST