Package org.jfree.chart.title

Class LegendGraphic

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, Block, org.jfree.ui.Drawable, org.jfree.util.PublicCloneable
    public class LegendGraphic
extends AbstractBlock
implements Block, org.jfree.util.PublicCloneable
    The graphical item within a legend item.
    See Also:
    Serialized Form

    • Constructor Detail

      • LegendGraphic

        public LegendGraphic​(java.awt.Shape shape,
                     java.awt.Paint fillPaint)
        Creates a new legend graphic.
        Parameters:
        shape - the shape (null not permitted).
        fillPaint - the fill paint (null not permitted).

    • Method Detail

      • setShapeVisible

        public void setShapeVisible​(boolean visible)
        Sets a flag that controls whether or not the shape is visible.
        Parameters:
        visible - the flag.
        See Also:
        isShapeVisible()

      • setShape

        public void setShape​(java.awt.Shape shape)
        Sets the shape.
        Parameters:
        shape - the shape.
        See Also:
        getShape()

      • setShapeFilled

        public void setShapeFilled​(boolean filled)
        Sets a flag that controls whether or not the shape is filled.
        Parameters:
        filled - the flag.
        See Also:
        isShapeFilled()

      • setFillPaint

        public void setFillPaint​(java.awt.Paint paint)
        Sets the paint used to fill the shape.
        Parameters:
        paint - the paint.
        See Also:
        getFillPaint()

      • setFillPaintTransformer

        public void setFillPaintTransformer​(org.jfree.ui.GradientPaintTransformer transformer)
        Sets the transformer used when the fill paint is an instance of GradientPaint.
        Parameters:
        transformer - the transformer (null not permitted).
        Since:
        1.0.4
        See Also:
        getFillPaintTransformer()

      • getShapeAnchor

        public org.jfree.ui.RectangleAnchor getShapeAnchor()
        Returns the shape anchor.
        Returns:
        The shape anchor.
        See Also:
        getShapeAnchor()

      • setShapeAnchor

        public void setShapeAnchor​(org.jfree.ui.RectangleAnchor anchor)
        Sets the shape anchor. This defines a point on the shapes bounding rectangle that will be used to align the shape to a location.
        Parameters:
        anchor - the anchor (null not permitted).
        See Also:
        setShapeAnchor(RectangleAnchor)

      • setShapeLocation

        public void setShapeLocation​(org.jfree.ui.RectangleAnchor location)
        Sets the shape location. This defines a point within the drawing area that will be used to align the shape to.
        Parameters:
        location - the location (null not permitted).
        See Also:
        getShapeLocation()

      • setLineVisible

        public void setLineVisible​(boolean visible)
        Sets the flag that controls whether or not the line is visible.
        Parameters:
        visible - the flag.
        See Also:
        isLineVisible()

      • getLine

        public java.awt.Shape getLine()
        Returns the line centered about (0, 0).
        Returns:
        The line.
        See Also:
        setLine(Shape)

      • setLine

        public void setLine​(java.awt.Shape line)
        Sets the line. A Shape is used here, because then you can use Line2D, GeneralPath or any other Shape to represent the line.
        Parameters:
        line - the line.
        See Also:
        getLine()

      • setLinePaint

        public void setLinePaint​(java.awt.Paint paint)
        Sets the line paint.
        Parameters:
        paint - the paint.
        See Also:
        getLinePaint()

      • setLineStroke

        public void setLineStroke​(java.awt.Stroke stroke)
        Sets the line stroke.
        Parameters:
        stroke - the stroke.
        See Also:
        getLineStroke()

      • arrange

        public org.jfree.ui.Size2D arrange​(java.awt.Graphics2D g2,
                                   RectangleConstraint constraint)
        Arranges the contents of the block, within the given constraints, and returns the block size.
        Specified by:
        arrange in interface Block
        Overrides:
        arrange in class AbstractBlock
        Parameters:
        g2 - the graphics device.
        constraint - the constraint (null not permitted).
        Returns:
        The block size (in Java2D units, never null).

      • arrangeNN

        protected org.jfree.ui.Size2D arrangeNN​(java.awt.Graphics2D g2)
        Performs the layout with no constraint, so the content size is determined by the bounds of the shape and/or line drawn to represent the series.
        Parameters:
        g2 - the graphics device.
        Returns:
        The content size.

      • draw

        public void draw​(java.awt.Graphics2D g2,
                 java.awt.geom.Rectangle2D area)
        Draws the graphic item within the specified area.
        Specified by:
        draw in interface org.jfree.ui.Drawable
        Parameters:
        g2 - the graphics device.
        area - the area.

      • draw

        public java.lang.Object draw​(java.awt.Graphics2D g2,
                             java.awt.geom.Rectangle2D area,
                             java.lang.Object params)
        Draws the block within the specified area.
        Specified by:
        draw in interface Block
        Parameters:
        g2 - the graphics device.
        area - the area.
        params - ignored (null permitted).
        Returns:
        Always null.

      • equals

        public boolean equals​(java.lang.Object obj)
        Tests this LegendGraphic instance for equality with an arbitrary object.
        Overrides:
        equals in class AbstractBlock
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.

      • hashCode

        public int hashCode()
        Returns a hash code for this instance.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A hash code.

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Returns a clone of this LegendGraphic instance.
        Specified by:
        clone in interface org.jfree.util.PublicCloneable
        Overrides:
        clone in class AbstractBlock
        Returns:
        A clone of this LegendGraphic instance.
        Throws:
        java.lang.CloneNotSupportedException - if there is a problem cloning.