|
||||||||||
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
org.havi.ui.HStillImageBackgroundConfiguration
This class represents a background configuration which supports the
installation of still images. The platform using the HAVi
user-interface specification must specify which image formats are
supported. The java.awt.Image
class is intentionally
not used in order to allow the support of image formats which carry
sufficient restrictions that expressing them through the API of that
class would require extensive use of runtime errors. One specific
example of this is MPEG I-frames.
Parameter | Description | Default value | Set method | Get method |
---|---|---|---|---|
None. |
Description | Default value | Set method | Get method |
---|---|---|---|
None. |
Constructor Summary | |
protected |
HStillImageBackgroundConfiguration()
It is not intended that applications should directly construct HStillImageBackgroundConfiguration objects.
|
Method Summary | |
void |
displayImage(HBackgroundImage image)
Display an image. |
void |
displayImage(HBackgroundImage image,
HScreenRectangle r)
Display an image to cover a particular area of the screen. |
void |
setColor(java.awt.Color color)
Set the current color of this background. |
Methods inherited from class org.havi.ui.HBackgroundConfiguration |
getColor, getConfigTemplate, getDevice |
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 HStillImageBackgroundConfiguration()
HStillImageBackgroundConfiguration
objects.
Creates an HStillImageBackgroundConfiguration
object. See the class
description for details of constructor parameters and default
values.
Method Detail |
public void displayImage(HBackgroundImage image) throws java.io.IOException, HPermissionDeniedException, HConfigurationException
setColor
is
shown in the areas where no image is displayed. If no color has
been set what is shown in this area is platform dependent.
What is displayed while the image is loading is implementation
specific.
Note that the image may be removed by calling the setColor
method.
If the image
parameter is null a
java.lang.NullPointerException is thrown.
image
- the image to display.
java.io.IOException
- if the data for the
HBackgroundImage
is not loaded and loading the
data is impossible or fails.
java.lang.IllegalArgumentException
- if the
HBackgroundImage
does not contain an image in a
supported image encoding format
HPermissionDeniedException
- if the HBackgroundDevice
concerned is
not reserved.
HConfigurationException
- if the HStillImageBackgroundConfiguration
is not the currently set
configuration for its HBackgroundDevice
.public void displayImage(HBackgroundImage image, HScreenRectangle r) throws java.io.IOException, HPermissionDeniedException, HConfigurationException
setColor
is shown in the areas where no image is displayed. If no color
has been set what is shown in this area is platform dependent.
Note that the image may be removed by calling the setColor
method.
If either or both parameters are null a java.lang.NullPointerException is thrown.
image
- the image to displayr
- the area of the screen to cover with the image
java.io.IOException
- if the data for the
HBackgroundImage
is not loaded and loading the
data is impossible or fails.
java.lang.IllegalArgumentException
- if the
HBackgroundImage
does not contain an image in a
supported image encoding format
HPermissionDeniedException
- if the HBackgroundDevice
concerned is
not reserved.
HConfigurationException
- if the HStillImageBackgroundConfiguration
is not the currently set
configuration for its HBackgroundDevice
.public void setColor(java.awt.Color color) throws HPermissionDeniedException, HConfigurationException
getColor
method
will return the actual value used.
Note that calling this method will clear any image currently
displayed by the HBackgroundDevice
.
setColor
in class HBackgroundConfiguration
color
- the color to be used for the background
HPermissionDeniedException
- if this HBackgroundDevice
does not have
the right to control the background
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 |