org.havi.ui.HStillImageBackgroundConfiguration Maven / Gradle / Ivy
package org.havi.ui;
/*
* Copyright 2000-2003 by HAVi, Inc. Java is a trademark of Sun
* Microsystems, Inc. All rights reserved.
*/
/**
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.
The parameters to the constructors are as follows, in cases where
parameters are not used, then the constructor should use the default
values.
Default parameter values exposed in the constructors
Parameter Description Default value
Set method Get method None.
Default parameter values not exposed in the constructors
Description Default value Set method
Get method None.
*/
public class HStillImageBackgroundConfiguration
extends HBackgroundConfiguration
{
/**
* It is not intended that applications should directly construct
* {@link org.havi.ui.HStillImageBackgroundConfiguration
* HStillImageBackgroundConfiguration} objects.
*
* Creates an {@link
* org.havi.ui.HStillImageBackgroundConfiguration
* HStillImageBackgroundConfiguration} object. See the class
* description for details of constructor parameters and default
* values.
*/
protected HStillImageBackgroundConfiguration()
{
}
/**
* Display an image. If the data for the image has not been loaded
* then this method will block while the data is loaded. It is
* platform dependent whether this image is scaled to fit or
* whether it is cropped (where too large) or repeated (where too
* small). The position of the image is platform-dependent. If
* the platform does not scale the image to fit, the previous
* color set using {@link
* org.havi.ui.HBackgroundConfiguration#setColor 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 {@link
* org.havi.ui.HStillImageBackgroundConfiguration#setColor
* setColor} method.
*
* If the image parameter is null a
* java.lang.NullPointerException is thrown.
*
* @param image the image to display.
* @exception java.io.IOException if the data for the
* HBackgroundImage is not loaded and loading the
* data is impossible or fails.
* @exception java.lang.IllegalArgumentException if the
* HBackgroundImage does not contain an image in a
* supported image encoding format
* @exception HPermissionDeniedException if the {@link
* org.havi.ui.HBackgroundDevice HBackgroundDevice} concerned is
* not reserved.
* @exception HConfigurationException if the {@link
* org.havi.ui.HStillImageBackgroundConfiguration
* HStillImageBackgroundConfiguration} is not the currently set
* configuration for its {@link org.havi.ui.HBackgroundDevice
* HBackgroundDevice}.
*/
public void displayImage(HBackgroundImage image)
throws java.io.IOException,
org.havi.ui.HPermissionDeniedException,
org.havi.ui.HConfigurationException
{
}
/**
* Display an image to cover a particular area of the screen. If
* the data for the image has not been loaded then this method
* will block while the data is loaded. It is platform dependent
* whether this image is scaled to fit or whether it is cropped
* (where too large) or repeated (where too small). The position
* of the image within the rectangle is platform-dependent. If the
* platform does not scale the image to fit, or the rectangle does
* not cover the entire display area, the previous color set using
* {@link org.havi.ui.HBackgroundConfiguration#setColor 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 {@link
* org.havi.ui.HStillImageBackgroundConfiguration#setColor
* setColor} method.
*
* If either or both parameters are null a
* java.lang.NullPointerException is thrown.
*
* @param image the image to display
* @param r the area of the screen to cover with the image
* @exception java.io.IOException if the data for the
* HBackgroundImage is not loaded and loading the
* data is impossible or fails.
* @exception java.lang.IllegalArgumentException if the
* HBackgroundImage does not contain an image in a
* supported image encoding format
* @exception HPermissionDeniedException if the {@link
* org.havi.ui.HBackgroundDevice HBackgroundDevice} concerned is
* not reserved.
* @exception HConfigurationException if the {@link
* org.havi.ui.HStillImageBackgroundConfiguration
* HStillImageBackgroundConfiguration} is not the currently set
* configuration for its {@link org.havi.ui.HBackgroundDevice
* HBackgroundDevice}.
*/
public void displayImage(HBackgroundImage image, HScreenRectangle r)
throws java.io.IOException,
org.havi.ui.HPermissionDeniedException,
org.havi.ui.HConfigurationException
{
}
/**
* Set the current color of this background. On platforms where
* there is a sub-class of java.awt.Color supporting transparency
* of any kind, passing an object representing a non-opaque color
* is illegal. Platforms with a limited color resolution for
* backgrounds may approximate this value to the nearest
* available. The {@link
* org.havi.ui.HBackgroundConfiguration#getColor getColor} method
* will return the actual value used.
*
* Note that calling this method will clear any image currently
* displayed by the {@link org.havi.ui.HBackgroundDevice
* HBackgroundDevice}.
*
* @param color the color to be used for the background
* @exception HPermissionDeniedException if this {@link
* org.havi.ui.HBackgroundDevice HBackgroundDevice} does not have
* the right to control the background
* @exception HConfigurationException if the color specified is
* illegal for this platform.
*/
public void setColor(java.awt.Color color)
throws org.havi.ui.HPermissionDeniedException,
org.havi.ui.HConfigurationException
{
}
}