org.spiffyui.client.widgets.slider
Enum SliderOption

java.lang.Object
  extended by java.lang.Enum<SliderOption>
      extended by org.spiffyui.client.widgets.slider.SliderOption
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SliderOption>

public enum SliderOption
extends java.lang.Enum<SliderOption>

An enumeration of all the options you can set for a slider


Enum Constant Summary
ANIMATE
          animate.
DISABLED
          disabled.
MAX
          max.
MIN
          min.
ORIENTATION
          orientation.
RANGE
          range.
STEP
          step.
VALUE
          value.
VALUES
          values.
 
Method Summary
 java.lang.String toString()
           
static SliderOption valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SliderOption[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

DISABLED

public static final SliderOption DISABLED
disabled. Type Boolean. Default: false Disables (true) or enables (false) the slider. Can be set when initialising (first creating) the slider.


ANIMATE

public static final SliderOption ANIMATE
animate. Type: Boolean, String, Number. Default: false Whether to slide handle smoothly when user click outside handle on the bar. Will also accept a string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).


MAX

public static final SliderOption MAX
max. Type: Number. Default: 100 The maximum value of the slider.


MIN

public static final SliderOption MIN
min. Type: Number. Default: 0 The minimum value of the slider.


ORIENTATION

public static final SliderOption ORIENTATION
orientation. Type: String. Default: 'horizontal' This option determines whether the slider has the min at the left, the max at the right or the min at the bottom, the max at the top. Possible values: 'horizontal', 'vertical'..


RANGE

public static final SliderOption RANGE
range. Type: Boolean, String. Default: false If set to true, the slider will detect if you have two handles and create a stylable range element between these two. Two other possible values are 'min' and 'max'. A min range goes from the slider min to one handle. A max range goes from one handle to the slider max.


STEP

public static final SliderOption STEP
step. Type: Number. Default: 1 Determines the size or amount of each interval or step the slider takes between min and max. The full specified value range of the slider (max - min) needs to be evenly divisible by the step.


VALUE

public static final SliderOption VALUE
value. Type: Number. Default: 0 Determines the value of the slider, if there's only one handle. If there is more than one handle, determines the value of the first handle.


VALUES

public static final SliderOption VALUES
values. Type: Array. Default: null This option can be used to specify multiple handles. If range is set to true, the length of 'values' should be 2.

Method Detail

values

public static SliderOption[] 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 (SliderOption c : SliderOption.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SliderOption 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

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Enum<SliderOption>