Enum Type

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

    public enum Type
    extends java.lang.Enum<Type>
    Scalebar type.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BAR
      A bar with alternating black and white zones marking the sub-intervals.
      BAR_SUB
      A bar with alternating black and white zones marking the sub-intervals.
      LINE
      A simple line with ticks.
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract ScalebarDrawer createDrawer​(java.awt.Graphics2D graphics2d, ScaleBarRenderSettings settings)
      Create a ScalebarDrawer instance for this type.
      static Type fromString​(java.lang.String label)
      Get a type from its label.
      java.lang.String getLabel()  
      static Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Type[] 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

      • LINE

        public static final Type LINE
        A simple line with ticks.
      • BAR

        public static final Type BAR
        A bar with alternating black and white zones marking the sub-intervals.
      • BAR_SUB

        public static final Type BAR_SUB
        A bar with alternating black and white zones marking the sub-intervals. Intervals have small additional ticks.
    • Method Detail

      • values

        public static Type[] 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 (Type c : Type.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Type 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
      • fromString

        public static Type fromString​(java.lang.String label)
        Get a type from its label.
        Parameters:
        label - the type label
      • createDrawer

        public abstract ScalebarDrawer createDrawer​(java.awt.Graphics2D graphics2d,
                                                    ScaleBarRenderSettings settings)
        Create a ScalebarDrawer instance for this type.
        Parameters:
        graphics2d - The graphics context.
        settings - Parameters for rendering the scalebar.
      • getLabel

        public final java.lang.String getLabel()