|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.havi.ui.HScreenConfiguration
org.havi.ui.HBackgroundConfiguration
public class HBackgroundConfiguration
The HBackgroundConfiguration
class describes the characteristics
(settings) of an HBackgroundDevice
.
There can be many HBackgroundConfiguration
objects associated with a single HBackgroundDevice
.
The basic background configuration supports backgrounds of a single color. More sophisticated backgrounds can be supported by defining new classes inheriting from this class. Where a device has a single non- changeable background color, this class will provide applications the ability to read that color however all attempts to reserve control of the background will fail.
Parameter | Description | Default value | Set method | Get method |
---|---|---|---|---|
None. |
Description | Default value | Set method | Get method |
---|---|---|---|
None. |
HBackgroundDevice
Constructor Summary | |
---|---|
protected |
HBackgroundConfiguration()
An interoperable application shall not subclass the HBackgroundConfiguration class. |
Method Summary | |
---|---|
java.awt.Color |
getColor()
Obtain the current color of this background. |
HBackgroundConfigTemplate |
getConfigTemplate()
Returns an HBackgroundConfigTemplate
object that describes and uniquely
identifies this HBackgroundConfiguration . |
HBackgroundDevice |
getDevice()
Returns the HBackgroundDevice
associated with this HBackgroundConfiguration . |
void |
setColor(java.awt.Color color)
Set the current color of this background. |
Methods inherited from class org.havi.ui.HScreenConfiguration |
---|
convertTo, getFlickerFilter, getInterlaced, getOffset, getPixelAspectRatio, getPixelResolution, getScreenArea |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected HBackgroundConfiguration()
Creates an HBackgroundConfiguration
object. See the class description for
details of constructor parameters and default values.
Method Detail |
---|
public HBackgroundDevice getDevice()
HBackgroundDevice
associated with this HBackgroundConfiguration
.
HBackgroundDevice
object that is associated with this HBackgroundConfiguration
.public HBackgroundConfigTemplate getConfigTemplate()
HBackgroundConfigTemplate
object that describes and uniquely
identifies this HBackgroundConfiguration
.
Hence, the following sequence
should return the original HBackgroundConfiguration
HBackgroundDevice.getBestMatch(HBackgroundConfiguration.getConfigTemplate())
Features that are implemented in the HBackgroundConfiguration
will return HScreenConfigTemplate.REQUIRED
priority. Features that are not implemented in the HBackgroundConfiguration
will return HScreenConfigTemplate.REQUIRED_NOT
priority. Preferences that are not filled in by
the platform will return HScreenConfigTemplate.DONT_CARE
priority.
HBackgroundConfigTemplate
object which both describes and
uniquely identifies this HBackgroundConfiguration
.public java.awt.Color getColor()
setColor(java.awt.Color)
since platforms may offer a reduced color space for
backgrounds and the actual value used will be returned.
public void setColor(java.awt.Color color) throws HPermissionDeniedException, HConfigurationException
getColor()
method
will return the actual value used.
color
- the color to be used for the background
HPermissionDeniedException
- if the application has
not currently reserved the HBackgroundDevice associated with
this configuration or this configuration is not the current
configuration of that HBackgroundDevice.
HConfigurationException
- if the color specified is illegal
for this platform.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |