org.graffiti.graphics
Class ColorAttribute

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

public class ColorAttribute
extends HashMapAttribute
implements GraphicAttributeConstants

Contains the color graphic attribute. (The value of opacity has no effect when applied to the outline of a node since that would lead to problems with overlapping filling and outline.)

Version:
$Revision: 5768 $

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
ColorAttribute(String id)
          Constructs a new ColorAttribute.
ColorAttribute(String id, Color c)
          Constructs a new ColorAttribute.
ColorAttribute(String id, ColorAttribute c)
          Constructs a new ColorAttribute.
ColorAttribute(String id, int r, int g, int b, int t)
          Constructs a new ColorAttribute and initialises with the given values.
 
Method Summary
 Object copy()
          Returns a deep copy of this object.
 boolean equals(Object attr)
           
 int getBlue()
          Returns the 'blue'-value of the encapsulated color.
 Color getColor()
          Comfort function to get a java.awt.Color.
 int getGreen()
          Returns the 'green'-value of the encapsulated color.
 int getOpacity()
          Returns the 'opacity'-value of the encapsulated color.
 int getRed()
          Returns the 'red'-value of the encapsulated color.
 void setBlue(int b)
          Sets the 'blue'-value.
 void setCollection(Map<String,Attribute> attrs)
          Sets the collection of attributes contained within this CollectionAttribute.
 void setColor(Color c)
          Comfort function to set a java.awt.Color.
 void setGreen(int g)
          Sets the 'green'-value.
 void setOpacity(int t)
          Sets the 'opacity'-value.
 void setRed(int r)
          Sets the 'red'-value.
 
Methods inherited from class org.graffiti.attributes.HashMapAttribute
doSetValue, getCollection, setDefaultValue
 
Methods inherited from class org.graffiti.attributes.AbstractCollectionAttribute
add, add, containsAttribute, getAttributable, getAttribute, getValue, isEmpty, remove, remove, setAttributable, toString, toXMLString
 
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, 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, toXMLString
 

Constructor Detail

ColorAttribute

public ColorAttribute(String id,
                      Color c)
Constructs a new ColorAttribute.

Parameters:
id - the id of the attribute.
c - the color-value of the attribute.

ColorAttribute

public ColorAttribute(String id,
                      ColorAttribute c)
Constructs a new ColorAttribute.

Parameters:
id - the id of the attribute.
c - the color-value of the attribute.

ColorAttribute

public ColorAttribute(String id)
Constructs a new ColorAttribute.

Parameters:
id - the id of the attribute.

ColorAttribute

public ColorAttribute(String id,
                      int r,
                      int g,
                      int b,
                      int t)
Constructs a new ColorAttribute and initialises with the given values.

Parameters:
id - the id of the attribute.
r - the red-value of the attribute.
g - the green-value of the attribute.
b - the blue-value of the attribute.
t - the opacity-value of the attribute.
Method Detail

setBlue

public void setBlue(int b)
Sets the 'blue'-value.

Parameters:
b - the 'blue'-value to be set.

getBlue

public int getBlue()
Returns the 'blue'-value of the encapsulated color.

Returns:
the 'blue'-value of the encapsulated color.

setCollection

public void setCollection(Map<String,Attribute> attrs)
Sets the collection of attributes contained within this CollectionAttribute. The color 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!

setColor

public void setColor(Color c)
Comfort function to set a java.awt.Color.

Parameters:
c - the java.awt.Color value.

getColor

public Color getColor()
Comfort function to get a java.awt.Color.

Returns:
the built java.awt.Color object.

setGreen

public void setGreen(int g)
Sets the 'green'-value.

Parameters:
g - the 'green'-value to be set.

getGreen

public int getGreen()
Returns the 'green'-value of the encapsulated color.

Returns:
the 'green'-value of the encapsulated color.

setOpacity

public void setOpacity(int t)
Sets the 'opacity'-value.

Parameters:
t - the 'opacity'-value to be set.

getOpacity

public int getOpacity()
Returns the 'opacity'-value of the encapsulated color.

Returns:
the 'opacity'-value of the encapsulated color.

setRed

public void setRed(int r)
Sets the 'red'-value.

Parameters:
r - the 'red'-value to be set.

getRed

public int getRed()
Returns the 'red'-value of the encapsulated color.

Returns:
the 'red'-value of the encapsulated color.

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.

equals

public boolean equals(Object attr)
Overrides:
equals in class Object


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