org.havi.ui.HBackgroundDevice 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 the ultimate background of a screen. The
   background is the very back of the video / graphics composition
   stack. It can potentially cover the entire area of a screen. Where
   a device supports multiple applications on screen at the same time
   (or even a window manager), the background is not constrained by
   any particular application or window.  The right to control the
   background of a screen is a scarce resource and managed as such.

  
  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 HBackgroundDevice
    extends HScreenDevice
{
    /**
     * It is not intended that applications should directly construct
     * {@link org.havi.ui.HBackgroundDevice HBackgroundDevice}
     * objects.
     * 
     * Creates an {@link org.havi.ui.HBackgroundDevice
     * HBackgroundDevice} object. See the class description for
     * details of constructor parameters and default values.  
     */
    protected HBackgroundDevice()
    {
    }

    /**
     * Returns all of the {@link org.havi.ui.HBackgroundConfiguration
     * HBackgroundConfiguration} objects associated with this {@link
     * org.havi.ui.HBackgroundDevice 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.
     *
     * @return an array of {@link org.havi.ui.HBackgroundConfiguration
     * HBackgroundConfiguration} objects
     * @see HBackgroundConfiguration 
     */
    public HBackgroundConfiguration[] getConfigurations()
    {
        return (null);
    }

    /**
     * Returns the default {@link org.havi.ui.HBackgroundConfiguration
     * HBackgroundConfiguration} associated with this {@link
     * org.havi.ui.HBackgroundDevice HBackgroundDevice} . This
     * (single) default configuration should correspond to some
     * well-behaved settings for the device, such as, a minimal
     * configuration or factory preset settings.
     *
     * @return the default {@link org.havi.ui.HBackgroundConfiguration
     * HBackgroundConfiguration} of this {@link
     * org.havi.ui.HBackgroundDevice HBackgroundDevice}
     *
     * @see HBackgroundConfiguration
     */
    public HBackgroundConfiguration getDefaultConfiguration()
    {
        return (null);
    }

    /**
     * Returns the "best" configuration possible that passes
     * the criteria defined in this {@link
     * org.havi.ui.HBackgroundConfigTemplate
     * HBackgroundConfigTemplate} or null.
     * 

     * Equally best in this sense means that the configurations
     * satisfy an equal number of preferences with priorities {@link
     * org.havi.ui.HScreenConfigTemplate#PREFERRED PREFERRED} and
     * {@link org.havi.ui.HScreenConfigTemplate#PREFERRED_NOT
     * PREFERRED_NOT} and all preferences with priorities {@link
     * org.havi.ui.HScreenConfigTemplate#REQUIRED REQUIRED} and {@link
     * org.havi.ui.HScreenConfigTemplate#REQUIRED_NOT 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 {@link
     * org.havi.ui.HScreenConfigTemplate#setPreference
     * setPreference}. Configurations must:
     * 
     
     *  satisfy ALL the preferences whose priority was {@link
     * HScreenConfigTemplate#REQUIRED REQUIRED}
     * 
 satisfy NONE of the preferences whose priority was
     * {@link HScreenConfigTemplate#REQUIRED_NOT REQUIRED_NOT}
     * 
 satisfy as many as possible of the preferences whose
     * priority was {@link HScreenConfigTemplate#PREFERRED PREFERRED}.
     * 
 satisfy as few as possible of the preferences whose
     * priority was {@link HScreenConfigTemplate#PREFERRED_NOT
     * PREFERRED_NOT}.
     * 


     * Preferences whose priority was {@link
     * HScreenConfigTemplate#DONT_CARE DONT_CARE} are ignored. 
     * 
     * This method returns null if no configuration
     * exists that satisfies all {@link
     * org.havi.ui.HScreenConfigTemplate#REQUIRED REQUIRED} and {@link
     * org.havi.ui.HScreenConfigTemplate#REQUIRED_NOT REQUIRED_NOT}
     * priorities.

     * 
     * @param hbc - an {@link org.havi.ui.HBackgroundConfigTemplate
     * HBackgroundConfigTemplate} object used to obtain a valid {@link
     * org.havi.ui.HBackgroundConfiguration
     * HBackgroundConfiguration}. If this parameter is null the
     * default configuration for the platform shall be returned.
     * @return an {@link org.havi.ui.HBackgroundConfiguration
     * HBackgroundConfiguration} object that passes the criteria
     * defined in the specified {@link
     * org.havi.ui.HGraphicsConfigTemplate HGraphicsConfigTemplate} or
     * null if no HBackgroundConfiguration passes the criteria.  
     */
    public HBackgroundConfiguration getBestConfiguration(HBackgroundConfigTemplate hbc)
    {
        return (null);
    }

    /**
     * Returns the "best" configuration possible that passes
     * the criteria defined in one of the {@link
     * org.havi.ui.HBackgroundConfigTemplate
     * 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 {@link
     * org.havi.ui.HScreenConfigTemplate#PREFERRED PREFERRED} and
     * {@link org.havi.ui.HScreenConfigTemplate#PREFERRED_NOT
     * PREFERRED_NOT} and all preferences with priorities {@link
     * org.havi.ui.HScreenConfigTemplate#REQUIRED REQUIRED} and {@link
     * org.havi.ui.HScreenConfigTemplate#REQUIRED_NOT 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 {@link
     * org.havi.ui.HScreenConfigTemplate#setPreference
     * setPreference}. Configurations must:
     * 
     
     *  satisfy ALL the preferences whose priority was {@link
     * HScreenConfigTemplate#REQUIRED REQUIRED}
     * 
 satisfy NONE of the preferences whose priority was
     * {@link HScreenConfigTemplate#REQUIRED_NOT REQUIRED_NOT}
     * 
 satisfy as many as possible of the preferences whose
     * priority was {@link HScreenConfigTemplate#PREFERRED PREFERRED}.
     * 
 satisfy as few as possible of the preferences whose
     * priority was {@link HScreenConfigTemplate#PREFERRED_NOT
     * PREFERRED_NOT}.
     * 


     * Preferences whose priority was {@link
     * HScreenConfigTemplate#DONT_CARE DONT_CARE} are ignored. 
     * 
     * This method returns null if no configuration
     * exists that satisfies all {@link
     * org.havi.ui.HScreenConfigTemplate#REQUIRED REQUIRED} and {@link
     * org.havi.ui.HScreenConfigTemplate#REQUIRED_NOT REQUIRED_NOT}
     * priorities.

     * 
     * @param hbcta the {@link org.havi.ui.HBackgroundConfigTemplate
     * HBackgroundConfigTemplate} array used to obtain a valid {@link
     * org.havi.ui.HBackgroundConfiguration HBackgroundConfiguration}.
     * @return an {@link org.havi.ui.HBackgroundConfiguration
     * HBackgroundConfiguration} that passes the criteria defined in
     * one of the {@link org.havi.ui.HBackgroundConfigTemplate
     * HBackgroundConfigTemplate} objects within the specified array
     */
    public HBackgroundConfiguration getBestConfiguration(HBackgroundConfigTemplate hbcta[])
    {
        return (null);
    }

    /**
     * Returns the current {@link org.havi.ui.HBackgroundConfiguration
     * HBackgroundConfiguration} for this {@link
     * org.havi.ui.HBackgroundDevice HBackgroundDevice}.
     *
     * @return the current {@link org.havi.ui.HBackgroundConfiguration
     * HBackgroundConfiguration} for this {@link
     * org.havi.ui.HBackgroundDevice HBackgroundDevice}.
     *
     * @see HBackgroundConfiguration
     */
    public HBackgroundConfiguration getCurrentConfiguration()
    {
        return (null);
    }

    /**
     * Set the background configuration for the device.
     * 

     * 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.
     * 

     * If an application tries to select a configuration which is
     * not valid for that device at that time or when the device is in a
     * particular mode then an HConfigurationException shall be thrown.
     * 
If the application selects a configuration that is not
     * conflicting with the configurations of all the other devices on
     * the same {@link org.havi.ui.HScreen HScreen} then that
     * configuration is selected.
     * 
If an application tries to select a configuration that
     * conflicts with a configuration of another device on this {@link
     * org.havi.ui.HScreen HScreen} which this application cannot
     * control due to platform security policy then this method shall
     * fail with a SecurityException.
     * 
If an application tries to select a configuration that
     * conflicts with a configuration of another device on this {@link
     * org.havi.ui.HScreen 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 {@link
     * org.havi.ui.HPermissionDeniedException
     * HPermissionDeniedException}.
     * 
If an application tries to select a configuration that
     * conflicts with a configuration of another device which this
     * application can control due to either this or no application
     * having reserved the device, then the configuration of the other
     * device is automatically changed. There is no change in the
     * resource ownership of the other device.
     *      
     * Any modifications made to the configurations of other devices
     * shall be reflected by the API for the devices concerned. The
     * {@link org.havi.ui.HGraphicsDevice#getCurrentConfiguration
     * 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
     * {@link HScreenConfigTemplate#ZERO_GRAPHICS_IMPACT},
     * {@link HScreenConfigTemplate#ZERO_VIDEO_IMPACT} and
     * {@link HScreenConfigTemplate#ZERO_BACKGROUND_IMPACT}
     * in their configuration templates.
     * 

     * On successful change to the specified configuration, the device 
     * shall fire one or more {@link
     * org.havi.ui.event.HScreenConfigurationEvent
     * 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 {@link
     * org.havi.ui.event.HScreenConfigurationEvent
     * 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.
     *
     * @param hbc the {@link HBackgroundConfiguration
     * HBackgroundConfiguration} to which this device should be set.
     * @return A boolean indicating whether the configuration could be
     * applied successfully. If the configuration could not be applied
     * successfully, the configuration after this method may not match
     * the configuration of the device prior to this method being
     * called --- applications should take steps to determine whether
     * a partial change of settings has been made.
     * @exception SecurityException if the application does not have
     * sufficient rights to set the configuration for this device.
     * @exception HPermissionDeniedException if the application does not
     * currently have the right to set the configuration for this
     * device.
     * @exception 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.  
     */
    public boolean setBackgroundConfiguration(HBackgroundConfiguration hbc)
	throws SecurityException, 
	       org.havi.ui.HPermissionDeniedException, 
	       org.havi.ui.HConfigurationException
    {
        return (false);
    }
}