ReportMill 10 API

com.reportmill.graphics
Class RMGradientFill

java.lang.Object
  extended by com.reportmill.base.RMObject
      extended by com.reportmill.graphics.RMFill
          extended by com.reportmill.graphics.RMGradientFill
All Implemented Interfaces:
java.lang.Cloneable

public class RMGradientFill
extends RMFill

This class represents a fill that draws a gradient of colors from the basic fill color to the end color.


Field Summary
 
Fields inherited from class com.reportmill.graphics.RMFill
DEFAULT
 
Constructor Summary
RMGradientFill()
          Creates an unitialized graident fill.
RMGradientFill(RMColor aColor1, RMColor aColor2, float aRotation)
          Creates a gradient fill from the given start color to the given end color with the given roll.
 
Method Summary
 boolean equals(java.lang.Object anObj)
          Standard equals implementation.
 java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement)
          XML unarchival.
 RMColor getColor2()
          Returns the gradients end color.
 RMColor getEndColor()
          Returns the gradients end color (obsolete).
 void getGradientAxis(RMShape aShape, RMPath aPath, java.awt.geom.Point2D p1, java.awt.geom.Point2D p2)
          Returns the 2 points, in the shape's coordinate system, which define the gradient.
 java.awt.geom.Rectangle2D getGradientBounds(java.awt.Shape aShape)
          Returns the gradient bounds for a given shape which is the bounds required to encompass the entire shape in the coordinates of the gradient rotation (effectively the bounds of the shape rotated by opposite gradient rotation).
 float getRoll()
          Returns the gradients rotation.
 void paintShape(RMShape aShape, RMPath aPath, java.awt.Graphics2D g, com.reportmill.shape.RMShapePainter sp)
          Render this fill in a Java2D Graphics2D.
 com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver)
          XML archival.
 
Methods inherited from class com.reportmill.graphics.RMFill
deriveFill, getBounds, getChild, getChildCount, getColor, setColor
 
Methods inherited from class com.reportmill.base.RMObject
clone, copy, didChange, didUndo, getAnimAttribute, getClassNameShort, undoClone, undoCopy, undoEquals
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RMGradientFill

public RMGradientFill()
Creates an unitialized graident fill.


RMGradientFill

public RMGradientFill(RMColor aColor1,
                      RMColor aColor2,
                      float aRotation)
Creates a gradient fill from the given start color to the given end color with the given roll.

Method Detail

getColor2

public RMColor getColor2()
Returns the gradients end color.


getEndColor

public RMColor getEndColor()
Returns the gradients end color (obsolete).


getRoll

public float getRoll()
Returns the gradients rotation.


getGradientBounds

public java.awt.geom.Rectangle2D getGradientBounds(java.awt.Shape aShape)
Returns the gradient bounds for a given shape which is the bounds required to encompass the entire shape in the coordinates of the gradient rotation (effectively the bounds of the shape rotated by opposite gradient rotation). The gradient should be defined in these bounds so that rendered shapes completely utilizes the color range.


getGradientAxis

public void getGradientAxis(RMShape aShape,
                            RMPath aPath,
                            java.awt.geom.Point2D p1,
                            java.awt.geom.Point2D p2)
Returns the 2 points, in the shape's coordinate system, which define the gradient.


paintShape

public void paintShape(RMShape aShape,
                       RMPath aPath,
                       java.awt.Graphics2D g,
                       com.reportmill.shape.RMShapePainter sp)
Render this fill in a Java2D Graphics2D.

Overrides:
paintShape in class RMFill

equals

public boolean equals(java.lang.Object anObj)
Standard equals implementation.

Overrides:
equals in class RMFill

toXML

public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver)
XML archival.

Overrides:
toXML in class RMFill

fromXML

public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                                com.reportmill.archiver.RXElement anElement)
XML unarchival.

Overrides:
fromXML in class RMFill

ReportMill 10 API