Class FloatControl

Constructor Detail

• FloatControl

  protected FloatControl(FloatControl.Type type,
              float minimum,
              float maximum,
              float precision,
              int updatePeriod,
              float initialValue,
              String units,
              String minLabel,
              String midLabel,
              String maxLabel)

  Constructs a new float control object with the given parameters

  Parameters:

  type - the kind of control represented by this float control object

  minimum - the smallest value permitted for the control

  maximum - the largest value permitted for the control

  precision - the resolution or granularity of the control. This is the size of the increment between discrete valid values.

  updatePeriod - the smallest time interval, in microseconds, over which the control can change from one discrete value to the next during a shift

  initialValue - the value that the control starts with when constructed

  units - the label for the units in which the control's values are expressed, such as "dB" or "frames per second"

  minLabel - the label for the minimum value, such as "Left" or "Off"

  midLabel - the label for the midpoint value, such as "Center" or "Default"

  maxLabel - the label for the maximum value, such as "Right" or "Full"

  Throws:

  IllegalArgumentException - if minimum is greater than maximum or initialValue does not fall within the allowable range

• FloatControl

  protected FloatControl(FloatControl.Type type,
              float minimum,
              float maximum,
              float precision,
              int updatePeriod,
              float initialValue,
              String units)

  Constructs a new float control object with the given parameters. The labels for the minimum, maximum, and mid-point values are set to zero-length strings.

  Parameters:

  type - the kind of control represented by this float control object

  minimum - the smallest value permitted for the control

  maximum - the largest value permitted for the control

  precision - the resolution or granularity of the control. This is the size of the increment between discrete valid values.

  updatePeriod - the smallest time interval, in microseconds, over which the control can change from one discrete value to the next during a shift

  initialValue - the value that the control starts with when constructed

  units - the label for the units in which the control's values are expressed, such as "dB" or "frames per second"

  Throws:

  IllegalArgumentException - if minimum is greater than maximum or initialValue does not fall within the allowable range

Method Detail

• setValue

  public void setValue(float newValue)

  Sets the current value for the control. The default implementation simply sets the value as indicated. If the value indicated is greater than the maximum value, or smaller than the minimum value, an IllegalArgumentException is thrown. Some controls require that their line be open before they can be affected by setting a value.

  Parameters:

  newValue - desired new value

  Throws:

  IllegalArgumentException - if the value indicated does not fall within the allowable range

• getValue

  public float getValue()

  Obtains this control's current value.

  Returns:

  the current value

• getMaximum

  public float getMaximum()

  Obtains the maximum value permitted.

  Returns:

  the maximum allowable value

• getMinimum

  public float getMinimum()

  Obtains the minimum value permitted.

  Returns:

  the minimum allowable value

• getUnits

  public String getUnits()

  Obtains the label for the units in which the control's values are expressed, such as "dB" or "frames per second."

  Returns:

  the units label, or a zero-length string if no label

• getMinLabel

  public String getMinLabel()

  Obtains the label for the minimum value, such as "Left" or "Off."

  Returns:

  the minimum value label, or a zero-length string if no label * has been set

• getMidLabel

  public String getMidLabel()

  Obtains the label for the mid-point value, such as "Center" or "Default."

  Returns:

  the mid-point value label, or a zero-length string if no label * has been set

• getMaxLabel

  public String getMaxLabel()

  Obtains the label for the maximum value, such as "Right" or "Full."

  Returns:

  the maximum value label, or a zero-length string if no label * has been set

• getPrecision

  public float getPrecision()

  Obtains the resolution or granularity of the control, in the units that the control measures. The precision is the size of the increment between discrete valid values for this control, over the set of supported floating-point values.

  Returns:

  the control's precision

• getUpdatePeriod

  public int getUpdatePeriod()

  Obtains the smallest time interval, in microseconds, over which the control's value can change during a shift. The update period is the inverse of the frequency with which the control updates its value during a shift. If the implementation does not support value shifting over time, it should set the control's value to the final value immediately and return -1 from this method.

  Returns:

  update period in microseconds, or -1 if shifting over time is unsupported

  See Also:

  shift(float, float, int)

• shift

  public void shift(float from,
           float to,
           int microseconds)

  Changes the control value from the initial value to the final value linearly over the specified time period, specified in microseconds. This method returns without blocking; it does not wait for the shift to complete. An implementation should complete the operation within the time specified. The default implementation simply changes the value to the final value immediately.

  Parameters:

  from - initial value at the beginning of the shift

  to - final value after the shift

  microseconds - maximum duration of the shift in microseconds

  Throws:

  IllegalArgumentException - if either from or to value does not fall within the allowable range

  See Also:

  getUpdatePeriod()

• toString

  public String toString()

  Provides a string representation of the control

  Overrides:

  toString in class Control

  Returns:

  a string description