Class LegendGraphic

    • Field Detail

      • serialVersionUID

        static final long serialVersionUID
        For serialization.
        See Also:
        Constant Field Values
      • shapeVisible

        private boolean shapeVisible
        A flag that controls whether or not the shape is visible - see also lineVisible.
      • shape

        private transient java.awt.Shape shape
        The shape to display. To allow for accurate positioning, the center of the shape should be at (0, 0).
      • shapeLocation

        private RectangleAnchor shapeLocation
        Defines the location within the block to which the shape will be aligned.
      • shapeAnchor

        private RectangleAnchor shapeAnchor
        Defines the point on the shape's bounding rectangle that will be aligned to the drawing location when the shape is rendered.
      • shapeFilled

        private boolean shapeFilled
        A flag that controls whether or not the shape is filled.
      • fillPaint

        private transient java.awt.Paint fillPaint
        The fill paint for the shape.
      • fillPaintTransformer

        private GradientPaintTransformer fillPaintTransformer
        The fill paint transformer (used if the fillPaint is an instance of GradientPaint).
      • shapeOutlineVisible

        private boolean shapeOutlineVisible
        A flag that controls whether or not the shape outline is visible.
      • outlinePaint

        private transient java.awt.Paint outlinePaint
        The outline paint for the shape.
      • outlineStroke

        private transient java.awt.Stroke outlineStroke
        The outline stroke for the shape.
      • lineVisible

        private boolean lineVisible
        A flag that controls whether or not the line is visible - see also shapeVisible.
      • line

        private transient java.awt.Shape line
        The line.
      • lineStroke

        private transient java.awt.Stroke lineStroke
        The line stroke.
      • linePaint

        private transient java.awt.Paint linePaint
        The line paint.
    • 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

      • isShapeVisible

        public boolean isShapeVisible()
        Returns a flag that controls whether or not the shape is visible.
        Returns:
        A boolean.
        See Also:
        setShapeVisible(boolean)
      • 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()
      • getShape

        public java.awt.Shape getShape()
        Returns the shape.
        Returns:
        The shape.
        See Also:
        setShape(Shape)
      • setShape

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

        public boolean isShapeFilled()
        Returns a flag that controls whether or not the shapes are filled.
        Returns:
        A boolean.
        See Also:
        setShapeFilled(boolean)
      • 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()
      • getFillPaint

        public java.awt.Paint getFillPaint()
        Returns the paint used to fill the shape.
        Returns:
        The fill paint.
        See Also:
        setFillPaint(Paint)
      • 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​(GradientPaintTransformer transformer)
        Sets the transformer used when the fill paint is an instance of GradientPaint.
        Parameters:
        transformer - the transformer (null not permitted).
        See Also:
        getFillPaintTransformer()
      • isShapeOutlineVisible

        public boolean isShapeOutlineVisible()
        Returns a flag that controls whether the shape outline is visible.
        Returns:
        A boolean.
        See Also:
        setShapeOutlineVisible(boolean)
      • setShapeOutlineVisible

        public void setShapeOutlineVisible​(boolean visible)
        Sets a flag that controls whether or not the shape outline is visible.
        Parameters:
        visible - the flag.
        See Also:
        isShapeOutlineVisible()
      • getOutlinePaint

        public java.awt.Paint getOutlinePaint()
        Returns the outline paint.
        Returns:
        The paint.
        See Also:
        setOutlinePaint(Paint)
      • setOutlinePaint

        public void setOutlinePaint​(java.awt.Paint paint)
        Sets the outline paint.
        Parameters:
        paint - the paint.
        See Also:
        getOutlinePaint()
      • getOutlineStroke

        public java.awt.Stroke getOutlineStroke()
        Returns the outline stroke.
        Returns:
        The stroke.
        See Also:
        setOutlineStroke(Stroke)
      • setOutlineStroke

        public void setOutlineStroke​(java.awt.Stroke stroke)
        Sets the outline stroke.
        Parameters:
        stroke - the stroke.
        See Also:
        getOutlineStroke()
      • setShapeAnchor

        public void setShapeAnchor​(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​(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()
      • isLineVisible

        public boolean isLineVisible()
        Returns the flag that controls whether or not the line is visible.
        Returns:
        A boolean.
        See Also:
        setLineVisible(boolean)
      • 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()
      • getLinePaint

        public java.awt.Paint getLinePaint()
        Returns the line paint.
        Returns:
        The paint.
        See Also:
        setLinePaint(Paint)
      • setLinePaint

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

        public java.awt.Stroke getLineStroke()
        Returns the line stroke.
        Returns:
        The stroke.
        See Also:
        setLineStroke(Stroke)
      • setLineStroke

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

        public 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 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 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.
      • canEqual

        public boolean canEqual​(java.lang.Object other)
        Ensures symmetry between super/subclass implementations of equals. For more detail, see http://jqno.nl/equalsverifier/manual/inheritance.
        Overrides:
        canEqual in class AbstractBlock
        Parameters:
        other - Object
        Returns:
        true ONLY if the parameter is THIS class type
      • hashCode

        public int hashCode()
        Returns a hash code for this instance.
        Overrides:
        hashCode in class AbstractBlock
        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 PublicCloneable
        Overrides:
        clone in class AbstractBlock
        Returns:
        A clone of this LegendGraphic instance.
        Throws:
        java.lang.CloneNotSupportedException - if there is a problem cloning.
      • writeObject

        private void writeObject​(java.io.ObjectOutputStream stream)
                          throws java.io.IOException
        Provides serialization support.
        Parameters:
        stream - the output stream.
        Throws:
        java.io.IOException - if there is an I/O error.
      • readObject

        private void readObject​(java.io.ObjectInputStream stream)
                         throws java.io.IOException,
                                java.lang.ClassNotFoundException
        Provides serialization support.
        Parameters:
        stream - the input stream.
        Throws:
        java.io.IOException - if there is an I/O error.
        java.lang.ClassNotFoundException - if there is a classpath problem.