Enum AxisInteger

  • All Implemented Interfaces:
    IPropCnrInteger, java.io.Serializable, java.lang.Comparable<AxisInteger>

    public enum AxisInteger
    extends java.lang.Enum<AxisInteger>
    implements IPropCnrInteger
    The Axis2D integer settings the can be set or retrieved.
    Author:
    Christopher Mindus
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      MAJOR_TICK
      Major tick length.
      MAX_LABEL_SIZE
      The maximum size, in pixels, for a label.
      MICRO_TICK
      Micro tick length.
      MINOR_TICK
      Minor tick length.
      TICK
      The tick length.
      TITLE_GAP
      An optional gap between axis title and axis label in pixels.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getDefaultValue()
      Gets the default value when the property is not set.
      java.lang.String getPropName()
      Returns the name of the property, usually starting with '$'.
      void validate​(PropCnr pc, int value)
      Validates a new value.
      static AxisInteger valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AxisInteger[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • MAX_LABEL_SIZE

        public static final AxisInteger MAX_LABEL_SIZE
        The maximum size, in pixels, for a label. To be used with the optional label function.

        Default 0.

      • TITLE_GAP

        public static final AxisInteger TITLE_GAP
        An optional gap between axis title and axis label in pixels.

        Default 0.

      • TICK

        public static final AxisInteger TICK
        The tick length.
      • MAJOR_TICK

        public static final AxisInteger MAJOR_TICK
        Major tick length.
      • MINOR_TICK

        public static final AxisInteger MINOR_TICK
        Minor tick length.
      • MICRO_TICK

        public static final AxisInteger MICRO_TICK
        Micro tick length.
    • Method Detail

      • values

        public static AxisInteger[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (AxisInteger c : AxisInteger.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AxisInteger valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getDefaultValue

        public int getDefaultValue()
        Gets the default value when the property is not set.
        Specified by:
        getDefaultValue in interface IPropCnrInteger
      • getPropName

        public java.lang.String getPropName()
        Returns the name of the property, usually starting with '$'.
        Specified by:
        getPropName in interface IPropCnrInteger
      • validate

        public void validate​(PropCnr pc,
                             int value)
                      throws PropValidateException
        Validates a new value.

        Overridden to provide validation for negative values.

        Specified by:
        validate in interface IPropCnrInteger
        Parameters:
        pc - The property container that will be set.
        value - The new value to validate.
        Throws:
        PropValidateException - If the value is negative.