public class HStillImageBackgroundConfiguration extends HBackgroundConfiguration
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. | |||
| Modifier | Constructor and Description |
|---|---|
protected |
HStillImageBackgroundConfiguration()
An interoperable application shall not subclass the
HStillImageBackgroundConfiguration class.
|
| Modifier and Type | Method and Description |
|---|---|
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(Color color)
Set the current color of this background.
|
getColor, getConfigTemplate, getDeviceconvertTo, getFlickerFilter, getInterlaced, getOffset, getPixelAspectRatio, getPixelResolution, getScreenAreaprotected HStillImageBackgroundConfiguration()
Creates an HStillImageBackgroundConfiguration object. See the class
description for details of constructor parameters and default
values.
public void displayImage(HBackgroundImage image) throws 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.IOException - if the data for the
HBackgroundImage is not loaded and loading the
data is impossible or fails.IllegalArgumentException - if the
HBackgroundImage does not contain an image in a
supported image encoding formatHPermissionDeniedException - 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 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 imageIOException - if the data for the
HBackgroundImage is not loaded and loading the
data is impossible or fails.IllegalArgumentException - if the
HBackgroundImage does not contain an image in a
supported image encoding formatHPermissionDeniedException - if the HBackgroundDevice concerned is
not reserved.HConfigurationException - if the HStillImageBackgroundConfiguration is not the currently set
configuration for its HBackgroundDevice.public void setColor(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 HBackgroundConfigurationcolor - the color to be used for the backgroundHPermissionDeniedException - if this HBackgroundDevice does not have
the right to control the backgroundHConfigurationException - if the color specified is
illegal for this platform.Copyright © 2012 code4tv.com. All Rights Reserved.