Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.sound.sampled

Class FloatControl

public abstract class FloatControl
extends Control
Since:
1.3

Nested Class Summary

static class
FloatControl.Type
An instance of this class describes a particular floating point control.

Nested classes/interfaces inherited from class javax.sound.sampled.Control

Control.Type

Constructor Summary

FloatControl(FloatControl.Type type, float min, float max, float prec, int update, float init, String units)
Create a new FloatControl given its type and various parameters.
FloatControl(FloatControl.Type type, float min, float max, float prec, int update, float init, String units, String minLabel, String midLabel, String maxLabel)
Create a new FloatControl given its type and various parameters.

Method Summary

String
getMaxLabel()
Return the label for the minimum value of this control.
float
getMaximum()
Return the maximum value of this control.
String
getMidLabel()
Return the label for the midpoint of this control.
String
getMinLabel()
Return the label for the minimum value of this control.
float
getMinimum()
Return the minimum value of this control.
float
getPrecision()
Return the precision of this control.
String
getUnits()
Return the name of the units for this control.
int
getUpdatePeriod()
Return the update period of this control.
float
getValue()
Return the current value of this control.
void
setValue(float value)
Set the new value of this control.
void
shift(float from, float to, int ms)
This tells the control to start at the starting value and to shift its value incrementally to the final value over the given time interval, specified in microseconds.
String
toString()
Return a string describing this control.

Methods inherited from class javax.sound.sampled.Control

getType, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FloatControl

protected FloatControl(FloatControl.Type type,
                       float min,
                       float max,
                       float prec,
                       int update,
                       float init,
                       String units)
Create a new FloatControl given its type and various parameters. The minimum, maximum, and midpoint labels will all be the empty string.
Parameters:
type - the type
min - the minimum valuee
max - the maximum value
prec - the precision
update - the update period
init - the initial value
units - the description of the units

FloatControl

protected FloatControl(FloatControl.Type type,
                       float min,
                       float max,
                       float prec,
                       int update,
                       float init,
                       String units,
                       String minLabel,
                       String midLabel,
                       String maxLabel)
Create a new FloatControl given its type and various parameters.
Parameters:
type - the type
min - the minimum valuee
max - the maximum value
prec - the precision
update - the update period
init - the initial value
units - the description of the units
minLabel - the label for the minimum value
midLabel - the label for the midpoint
maxLabel - the label for the maximum value

Method Details

getMaxLabel

public String getMaxLabel()
Return the label for the minimum value of this control.

getMaximum

public float getMaximum()
Return the maximum value of this control.

getMidLabel

public String getMidLabel()
Return the label for the midpoint of this control.

getMinLabel

public String getMinLabel()
Return the label for the minimum value of this control.

getMinimum

public float getMinimum()
Return the minimum value of this control.

getPrecision

public float getPrecision()
Return the precision of this control.

getUnits

public String getUnits()
Return the name of the units for this control.

getUpdatePeriod

public int getUpdatePeriod()
Return the update period of this control.

getValue

public float getValue()
Return the current value of this control.

setValue

public void setValue(float value)
Set the new value of this control.
Parameters:
value - the new value
Throws:
IllegalArgumentException - if the new value is greater than the maximum or less than the minimum.

shift

public void shift(float from,
                  float to,
                  int ms)
This tells the control to start at the starting value and to shift its value incrementally to the final value over the given time interval, specified in microseconds. The default implementation does not do this, but instead simply sets the value to the final value immediately.
Parameters:
from - the starting value
to - the final value
ms - the number of microseconds

toString

public String toString()
Return a string describing this control.
Overrides:
toString in interface Control
Floating point control Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About