Class DialCap

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.awt.Paint fillPaint
      The fill paint.
      private java.awt.Paint outlinePaint
      The paint used to draw the cap outline (this should never be null).
      private java.awt.Stroke outlineStroke
      The stroke used to draw the cap outline (this should never be null).
      private double radius
      The radius of the cap, as a percentage of the framing rectangle.
      (package private) static long serialVersionUID
      For serialization.
    • Constructor Summary

      Constructors 
      Constructor Description
      DialCap()
      Creates a new instance of StandardDialBackground.
    • Field Detail

      • serialVersionUID

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

        private double radius
        The radius of the cap, as a percentage of the framing rectangle.
      • fillPaint

        private transient java.awt.Paint fillPaint
        The fill paint. This field is transient because it requires special handling for serialization.
      • outlinePaint

        private transient java.awt.Paint outlinePaint
        The paint used to draw the cap outline (this should never be null). This field is transient because it requires special handling for serialization.
      • outlineStroke

        private transient java.awt.Stroke outlineStroke
        The stroke used to draw the cap outline (this should never be null). This field is transient because it requires special handling for serialization.
    • Constructor Detail

      • DialCap

        public DialCap()
        Creates a new instance of StandardDialBackground. The default background paint is Color.WHITE.
    • Method Detail

      • getRadius

        public double getRadius()
        Returns the radius of the cap, as a percentage of the dial's framing rectangle.
        Returns:
        The radius.
        See Also:
        setRadius(double)
      • setRadius

        public void setRadius​(double radius)
        Sets the radius of the cap, as a percentage of the dial's framing rectangle, and sends a DialLayerChangeEvent to all registered listeners.
        Parameters:
        radius - the radius (must be greater than zero).
        See Also:
        getRadius()
      • getFillPaint

        public java.awt.Paint getFillPaint()
        Returns the paint used to fill the cap.
        Returns:
        The paint (never null).
        See Also:
        setFillPaint(Paint)
      • setFillPaint

        public void setFillPaint​(java.awt.Paint paint)
        Sets the paint for the cap background and sends a DialLayerChangeEvent to all registered listeners.
        Parameters:
        paint - the paint (null not permitted).
        See Also:
        getFillPaint()
      • getOutlinePaint

        public java.awt.Paint getOutlinePaint()
        Returns the paint used to draw the outline of the cap.
        Returns:
        The paint (never null).
        See Also:
        setOutlinePaint(Paint)
      • setOutlinePaint

        public void setOutlinePaint​(java.awt.Paint paint)
        Sets the paint used to draw the outline of the cap and sends a DialLayerChangeEvent to all registered listeners.
        Parameters:
        paint - the paint (null not permitted).
        See Also:
        getOutlinePaint()
      • getOutlineStroke

        public java.awt.Stroke getOutlineStroke()
        Returns the stroke used to draw the outline of the cap.
        Returns:
        The stroke (never null).
        See Also:
        setOutlineStroke(Stroke)
      • setOutlineStroke

        public void setOutlineStroke​(java.awt.Stroke stroke)
        Sets the stroke used to draw the outline of the cap and sends a DialLayerChangeEvent to all registered listeners.
        Parameters:
        stroke - the stroke (null not permitted).
        See Also:
        getOutlineStroke()
      • isClippedToWindow

        public boolean isClippedToWindow()
        Returns true to indicate that this layer should be clipped within the dial window.
        Specified by:
        isClippedToWindow in interface DialLayer
        Returns:
        true.
      • draw

        public void draw​(java.awt.Graphics2D g2,
                         DialPlot plot,
                         java.awt.geom.Rectangle2D frame,
                         java.awt.geom.Rectangle2D view)
        Draws the background to the specified graphics device. If the dial frame specifies a window, the clipping region will already have been set to this window before this method is called.
        Specified by:
        draw in interface DialLayer
        Parameters:
        g2 - the graphics device (null not permitted).
        plot - the plot (ignored here).
        frame - the dial frame (ignored here).
        view - the view rectangle (null not permitted).
      • equals

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

        public int hashCode()
        Returns a hash code for this instance.
        Overrides:
        hashCode in class AbstractDialLayer
        Returns:
        The hash code.
      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Returns a clone of this instance.
        Specified by:
        clone in interface PublicCloneable
        Overrides:
        clone in class AbstractDialLayer
        Returns:
        A clone.
        Throws:
        java.lang.CloneNotSupportedException - if some attribute of the cap cannot be cloned.
      • 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.