Class GrayPaintScale

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int alpha
      The alpha transparency (0-255).
      private double lowerBound
      The lower bound.
      private double upperBound
      The upper bound.
    • Constructor Summary

      Constructors 
      Constructor Description
      GrayPaintScale()
      Creates a new GrayPaintScale instance with default values.
      GrayPaintScale​(double lowerBound, double upperBound)
      Creates a new paint scale for values in the specified range.
      GrayPaintScale​(double lowerBound, double upperBound, int alpha)
      Creates a new paint scale for values in the specified range.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      Returns a clone of this GrayPaintScale instance.
      boolean equals​(java.lang.Object obj)
      Tests this GrayPaintScale instance for equality with an arbitrary object.
      int getAlpha()
      Returns the alpha transparency that was specified in the constructor.
      double getLowerBound()
      Returns the lower bound.
      java.awt.Paint getPaint​(double value)
      Returns a paint for the specified value.
      double getUpperBound()
      Returns the upper bound.
      int hashCode()
      Returns a hash code for this instance.
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • lowerBound

        private double lowerBound
        The lower bound.
      • upperBound

        private double upperBound
        The upper bound.
      • alpha

        private int alpha
        The alpha transparency (0-255).
    • Constructor Detail

      • GrayPaintScale

        public GrayPaintScale()
        Creates a new GrayPaintScale instance with default values.
      • GrayPaintScale

        public GrayPaintScale​(double lowerBound,
                              double upperBound)
        Creates a new paint scale for values in the specified range.
        Parameters:
        lowerBound - the lower bound.
        upperBound - the upper bound.
        Throws:
        java.lang.IllegalArgumentException - if lowerBound is not less than upperBound.
      • GrayPaintScale

        public GrayPaintScale​(double lowerBound,
                              double upperBound,
                              int alpha)
        Creates a new paint scale for values in the specified range.
        Parameters:
        lowerBound - the lower bound.
        upperBound - the upper bound.
        alpha - the alpha transparency (0-255).
        Throws:
        java.lang.IllegalArgumentException - if lowerBound is not less than upperBound, or alpha is not in the range 0 to 255.
    • Method Detail

      • getAlpha

        public int getAlpha()
        Returns the alpha transparency that was specified in the constructor.
        Returns:
        The alpha transparency (in the range 0 to 255).
      • getPaint

        public java.awt.Paint getPaint​(double value)
        Returns a paint for the specified value.
        Specified by:
        getPaint in interface PaintScale
        Parameters:
        value - the value (must be within the range specified by the lower and upper bounds for the scale).
        Returns:
        A paint for the specified value.
      • equals

        public boolean equals​(java.lang.Object obj)
        Tests this GrayPaintScale instance for equality with an arbitrary object. This method returns true if and only if:
        • obj is not null;
        • obj is an instance of GrayPaintScale;
        Overrides:
        equals in class java.lang.Object
        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 GrayPaintScale instance.
        Specified by:
        clone in interface PublicCloneable
        Overrides:
        clone in class java.lang.Object
        Returns:
        A clone.
        Throws:
        java.lang.CloneNotSupportedException - if there is a problem cloning this instance.