Enum Class PlotInteger

java.lang.Object
java.lang.Enum<PlotInteger>
com.iizix.prop.ui.chart.plot2d.PlotInteger
All Implemented Interfaces:
IPropCnrInteger, Serializable, Comparable<PlotInteger>, Constable

public enum PlotInteger extends Enum<PlotInteger> implements IPropCnrInteger
The Plot2D integer settings the can be set or retrieved.
Author:
Christopher Mindus
  • Enum Constant Details

    • LABEL_OFFSET

      public static final PlotInteger LABEL_OFFSET
      Pie: the amount in pixels by which to offset labels.

      Default is 20.

    • MIN_BAR_SIZE

      public static final PlotInteger MIN_BAR_SIZE
      The minimum size for a bar (or column) in pixels.

      Default is 1.

    • MAX_BAR_SIZE

      public static final PlotInteger MAX_BAR_SIZE
      The maximum size for a bar (or column) in pixels.

      Default is 1.

    • FAN_SIZE

      public static final PlotInteger FAN_SIZE
      The amount for a radial gradient in a pie chart.

      Default is 5.

    • RADIUS

      public static final PlotInteger RADIUS
      The size of the radial gradient in a pie chart.

      Default is 0.

    • GAP

      public static final PlotInteger GAP
      Gap between columns in pixels in an OHLC chart.

      Default 2 pixels.

    • ANIMATION_DURATION

      public static final PlotInteger ANIMATION_DURATION
      Whether or not to animate the chart to place and specifies the duration in milliseconds of the animation.

      Default 0, i.e. no animation.

  • Method Details

    • values

      public static PlotInteger[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static PlotInteger valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      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 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.