public class HBackgroundDevice extends HScreenDevice
| Parameter | Description | Default value | Set method | Get method |
|---|---|---|---|---|
| None. | ||||
| Description | Default value | Set method | Get method |
|---|---|---|---|
| None. | |||
| Modifier | Constructor and Description |
|---|---|
protected |
HBackgroundDevice()
An interoperable application shall not subclass the
HBackgroundDevice class.
|
| Modifier and Type | Method and Description |
|---|---|
HBackgroundConfiguration |
getBestConfiguration(HBackgroundConfigTemplate hbc)
Returns the "best" configuration possible that passes
the criteria defined in this
HBackgroundConfigTemplate or null. |
HBackgroundConfiguration |
getBestConfiguration(HBackgroundConfigTemplate[] hbcta)
Returns the "best" configuration possible that passes
the criteria defined in one of the
HBackgroundConfigTemplate objects within the specified array or null. |
HBackgroundConfiguration[] |
getConfigurations()
Returns all of the
HBackgroundConfiguration objects associated with this HBackgroundDevice. |
HBackgroundConfiguration |
getCurrentConfiguration()
Returns the current
HBackgroundConfiguration for this HBackgroundDevice. |
HBackgroundConfiguration |
getDefaultConfiguration()
Returns the default
HBackgroundConfiguration associated with this HBackgroundDevice . |
boolean |
setBackgroundConfiguration(HBackgroundConfiguration hbc)
Set the background configuration for the device.
|
addResourceStatusEventListener, addScreenConfigurationListener, addScreenConfigurationListener, getClient, getIDstring, getScreenAspectRatio, releaseDevice, removeResourceStatusEventListener, removeScreenConfigurationListener, reserveDeviceprotected HBackgroundDevice()
Creates an HBackgroundDevice object. See the class description for
details of constructor parameters and default values.
public HBackgroundConfiguration[] getConfigurations()
HBackgroundConfiguration objects associated with this HBackgroundDevice.
The set of configurations returned may include ones which are
only valid for the device at particular times or when the device
is in a particular mode.HBackgroundConfiguration objectsHBackgroundConfigurationpublic HBackgroundConfiguration getDefaultConfiguration()
HBackgroundConfiguration associated with this HBackgroundDevice . This
(single) default configuration should correspond to some
well-behaved settings for the device, such as, a minimal
configuration or factory preset settings.HBackgroundConfiguration of this HBackgroundDeviceHBackgroundConfigurationpublic HBackgroundConfiguration getBestConfiguration(HBackgroundConfigTemplate hbc)
HBackgroundConfigTemplate or null.
Equally best in this sense means that the configurations
satisfy an equal number of preferences with priorities PREFERRED and
PREFERRED_NOT and all preferences with priorities REQUIRED and REQUIRED_NOT.
If there are such equally best configurations, the one which is
returned by this method is an implementation dependent
selection from among those which are equally best.
Configurations are chosen according to the following algorithm,
based on the priority as supplied to setPreference. Configurations must:
REQUIRED
REQUIRED_NOT
PREFERRED.
PREFERRED_NOT.
DONT_CARE are ignored.
This method returns null if no configuration
exists that satisfies all REQUIRED and REQUIRED_NOT
priorities.
hbc - - an HBackgroundConfigTemplate object used to obtain a valid HBackgroundConfiguration. If this parameter is null the
default configuration for the platform shall be returned.HBackgroundConfiguration object that passes the criteria
defined in the specified HGraphicsConfigTemplate or
null if no HBackgroundConfiguration passes the criteria.public HBackgroundConfiguration getBestConfiguration(HBackgroundConfigTemplate[] hbcta)
HBackgroundConfigTemplate objects within the specified array or null.
The HBackgroundTemplate objects should be considered for
matching in priority order from 0 to (hbcta.length - 1).
Equally best in this sense means that the configurations
satisfy an equal number of preferences with priorities PREFERRED and
PREFERRED_NOT and all preferences with priorities REQUIRED and REQUIRED_NOT.
If there are such equally best configurations, the one which is
returned by this method is an implementation dependent
selection from among those which are equally best.
Configurations are chosen according to the following algorithm,
based on the priority as supplied to setPreference. Configurations must:
REQUIRED
REQUIRED_NOT
PREFERRED.
PREFERRED_NOT.
DONT_CARE are ignored.
This method returns null if no configuration
exists that satisfies all REQUIRED and REQUIRED_NOT
priorities.
hbcta - the HBackgroundConfigTemplate array used to obtain a valid HBackgroundConfiguration.HBackgroundConfiguration that passes the criteria defined in
one of the HBackgroundConfigTemplate objects within the specified arraypublic HBackgroundConfiguration getCurrentConfiguration()
HBackgroundConfiguration for this HBackgroundDevice.HBackgroundConfiguration for this HBackgroundDevice.HBackgroundConfigurationpublic boolean setBackgroundConfiguration(HBackgroundConfiguration hbc) throws SecurityException, HPermissionDeniedException, HConfigurationException
An application is only allowed to call this method after it reserved the device explicitly and subject to the security policy of the platform. Subject to this, the following rules determine whether this method can succeed.
HScreen then that
configuration is selected.
HScreen which this application cannot
control due to platform security policy then this method shall
fail with a SecurityException.
HScreen which this application cannot
control due to another application owning the right to control
that device and the platform not giving that right to this
application then this method shall fail with an HPermissionDeniedException.
getCurrentConfiguration method for those devices shall return
the new configuration.
Applications can prevent or limit changes to configurations of
other, not intended, devices by using constants
HScreenConfigTemplate.ZERO_GRAPHICS_IMPACT,
HScreenConfigTemplate.ZERO_VIDEO_IMPACT and
HScreenConfigTemplate.ZERO_BACKGROUND_IMPACT
in their configuration templates.
On successful change to the specified configuration, the device
shall fire one or more HScreenConfigurationEvents for all listeners that are
currently registered (if the criteria for receiving such an
event has been satisfied). If the new configuration differs by
more than one characteristic from the previous configuration
then the device may fire one or more HScreenConfigurationEvents. This behavior is implementation
specific.
If an attempt is made to set the identical configuration to that which is current, then no such event(s) shall be fired.
hbc - the HBackgroundConfiguration to which this device should be set.SecurityException - if the application does not have
sufficient rights to set the configuration for this device.HPermissionDeniedException - if the application does not
currently have the right to set the configuration for this
device.HConfigurationException - if the specified configuration is not
valid for this device, or if it conflicts with other devices
whose configuration(s) cannot be changed by this application.Copyright © 2012 code4tv.com. All Rights Reserved.