Enum ProgressIndicatorDelay

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

    public enum ProgressIndicatorDelay
    extends java.lang.Enum<ProgressIndicatorDelay>
    The progress indicator delay.
    Author:
    Christopher Mindus
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DISABLED
      Progress indicator is disabled (ordinal value = 0).
      IMMEDIATE
      Immediate display of indicator at UI lock (ordinal value = 1).
      LONG
      Long delay (about 3-5 seconds, but configurable for sessions, ordinal value = 4).
      NORMAL
      Normal delay (about 1-2 seconds, but configurable for sessions, ordinal value = 3).
      SHORT
      Short delay (about 300-500 milliseconds, but configurable for sessions, ordinal value = 2).
    • Field Summary

      Fields 
      Modifier and Type Field Description
      int delay
      The delay in milliseconds.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ProgressIndicatorDelay fromValue​(int value)
      Returns a delay from a value.
      static ProgressIndicatorDelay valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ProgressIndicatorDelay[] 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

      • DISABLED

        public static final ProgressIndicatorDelay DISABLED
        Progress indicator is disabled (ordinal value = 0).
      • IMMEDIATE

        public static final ProgressIndicatorDelay IMMEDIATE
        Immediate display of indicator at UI lock (ordinal value = 1).
      • SHORT

        public static final ProgressIndicatorDelay SHORT
        Short delay (about 300-500 milliseconds, but configurable for sessions, ordinal value = 2).
      • NORMAL

        public static final ProgressIndicatorDelay NORMAL
        Normal delay (about 1-2 seconds, but configurable for sessions, ordinal value = 3).
      • LONG

        public static final ProgressIndicatorDelay LONG
        Long delay (about 3-5 seconds, but configurable for sessions, ordinal value = 4).
    • Field Detail

      • delay

        public final int delay
        The delay in milliseconds.

        Values: -1 for never, 0 for immediate, otherwise the milliseconds delay value.

    • Method Detail

      • values

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

        public static ProgressIndicatorDelay 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
      • fromValue

        public static ProgressIndicatorDelay fromValue​(int value)
        Returns a delay from a value.
        Parameters:
        value - The value (should be 0-4), otherwise NORMAL is returned.
        Returns:
        If the value is out of range, NORMAL is returned.