|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BrightSpec
This interface represents the front panel display brightness
specification. If the Indicator supports just turn on/off, the brightness
value OFF
represents turn off and value 1 represents turn on, and
a brightness level shall be 2. If the Indicator supports bright/dark/off
brightness, the brightness value OFF
represents turn off and
value 1 represents dark and value 2 represents bright, and a brightness
level shall be 3. The brightness level can be any levels corresponding to
the Indicator's capability.
Field Summary | |
---|---|
static int |
OFF
Brightness OFF setting that represents the Indicator is off. |
Method Summary | |
---|---|
int |
getBrightness()
Gets the current brightness of the Indicator. |
int |
getBrightnessLevels()
Gets the number of brightness levels supported. |
void |
setBrightness(int brightness)
Sets the brightness of the indicator. |
Field Detail |
---|
static final int OFF
Method Detail |
---|
int getBrightness()
OFF
=< brightness =< getBrightnessLevels()-1
int getBrightnessLevels()
OFF
and brightness=1 (on). This provides an on/off capability.
void setBrightness(int brightness) throws IllegalArgumentException
OFF
turns the indicator off.
brightness
- Indicator brightness.
IllegalArgumentException
- if the brightness value is not
an integer that meets:
OFF
=< brightness =< getBrightnessLevels()-1
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |