org.havi.ui.HVideoConfigTemplate Maven / Gradle / Ivy
package org.havi.ui;
/*
* Copyright 2000-2003 by HAVi, Inc. Java is a trademark of Sun
* Microsystems, Inc. All rights reserved.
*/
/**
The {@link org.havi.ui.HVideoConfigTemplate}
class is used to obtain a valid {@link
org.havi.ui.HVideoConfiguration}. An
application instantiates one of these objects and then sets all
non-default attributes as desired. The object is then passed to the
{@link org.havi.ui.HVideoDevice#getBestConfiguration} method found in the
{@link org.havi.ui.HVideoDevice} class. If possible,
a valid {@link org.havi.ui.HVideoConfiguration}
is returned which meets or exceeds the requirements set in
the {@link org.havi.ui.HVideoConfigTemplate}.
This class may be subclassed to support additional
properties of video configurations which may be requested by
applications.
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.
@see HScreenConfigTemplate
@see HBackgroundConfigTemplate
@see HGraphicsConfigTemplate
*/
public class HVideoConfigTemplate
extends HScreenConfigTemplate
{
/**
* A value for use in the preference field of the {@link
* org.havi.ui.HScreenConfigTemplate#setPreference setPreference}
* and {@link org.havi.ui.HScreenConfigTemplate#getPreferencePriority
* getPreferencePriority} methods in the {@link
* org.havi.ui.HVideoConfigTemplate HVideoConfigTemplate} that
* indicates that the device configuration supports the display of
* graphics in addition to video streams. This display includes
* both configurations where the video pixels and graphics pixels
* are fully aligned (same size) as well as configurations where
* they are displayed together but where a more complex
* relationship exists between the two pixel coordinate
* spaces. The graphics configuration for mixing is specified as an
* {@link org.havi.ui.HGraphicsConfiguration
* HGraphicsConfiguration}.
* This preference is used by the platform as a constraint in
* selecting configurations. Templates generated by the platform
* and then returned to applications (e.g. from a
* getConfigTemplate method) shall not have this
* preference filled in by the platform.
*/
public static final int GRAPHICS_MIXING = 0x0F;
/**
* Creates an {@link org.havi.ui.HVideoConfigTemplate}
* object. See the class description for
* details of constructor parameters and default values.
*/
public HVideoConfigTemplate()
{
}
/**
* Returns a boolean indicating whether or not the specified
* {@link org.havi.ui.HVideoConfiguration} can
* be used to create a video plane that supports the features set
* in this template.
*
* @param hvc - the {@link org.havi.ui.HVideoConfiguration}
* object to test against this template.
* @return true if this {@link org.havi.ui.HVideoConfiguration}
* object can be used to create a video plane
* that supports the features set in this template, false
* otherwise.
*/
public boolean isConfigSupported(HVideoConfiguration hvc)
{
return (true);
}
/**
* Return the priority for the specified preference.
*
* By default the preferences in a template returned from the
* system will have a {@link
* org.havi.ui.HScreenConfigTemplate#DONT_CARE}
* priority unless specified otherwise. Any configuration always
* satisfies these attributes.
*
* @param preference the preference to be indicated. Valid values
* for an {@link org.havi.ui.HVideoConfigTemplate} are:
* {@link org.havi.ui.HScreenConfigTemplate#ZERO_BACKGROUND_IMPACT},
* {@link org.havi.ui.HScreenConfigTemplate#ZERO_GRAPHICS_IMPACT},
* {@link org.havi.ui.HScreenConfigTemplate#ZERO_VIDEO_IMPACT},
* {@link org.havi.ui.HScreenConfigTemplate#INTERLACED_DISPLAY},
* {@link org.havi.ui.HScreenConfigTemplate#FLICKER_FILTERING},
* {@link org.havi.ui.HScreenConfigTemplate#VIDEO_GRAPHICS_PIXEL_ALIGNED},
* {@link org.havi.ui.HScreenConfigTemplate#PIXEL_ASPECT_RATIO},
* {@link org.havi.ui.HScreenConfigTemplate#PIXEL_RESOLUTION},
* {@link org.havi.ui.HScreenConfigTemplate#SCREEN_RECTANGLE} and
* {@link org.havi.ui.HVideoConfigTemplate#GRAPHICS_MIXING}.
*
* Subclasses may add further valid values. An
* IllegalArgumentException shall be thrown if the preference is
* not a valid value for this instance of {@link
* org.havi.ui.HVideoConfigTemplate}
* @return the priority for the specified preference.
*/
public int getPreferencePriority(int preference)
{
return (REQUIRED);
}
/**
* Set the indicated preference (and associated value object) to
* have the specified priority. If the preference has been
* previously set, then the previous object and priority shall be
* overwritten.
*
* Attributes that are not filled in in a template (through {@link
* org.havi.ui.HVideoConfigTemplate#setPreference}),
* shall have the priority {@link
* org.havi.ui.HScreenConfigTemplate#DONT_CARE}. Any
* configuration always satisfies these attributes.
*
* An application which wishes to remove a preference from an
* existing template (e.g. one generated by the platform) may call
* this method with null for the object parameter.
* Specifying null as the object parameter shall have no effect if the
* preference is not in the template.
*
* @param preference the preference to be indicated. Valid values
* for an {@link org.havi.ui.HScreenConfigTemplate} are:
* {@link org.havi.ui.HScreenConfigTemplate#PIXEL_ASPECT_RATIO},
* {@link org.havi.ui.HScreenConfigTemplate#PIXEL_RESOLUTION},
* {@link org.havi.ui.HScreenConfigTemplate#SCREEN_RECTANGLE},
* {@link org.havi.ui.HScreenConfigTemplate#VIDEO_GRAPHICS_PIXEL_ALIGNED}
* and {@link org.havi.ui.HVideoConfigTemplate#GRAPHICS_MIXING}.
*
* Subclasses may add further valid values. An
* IllegalArgumentException shall be thrown if the preference is
* not a valid value for this instance of {@link
* org.havi.ui.HVideoConfigTemplate}
* @param object the Object associated with the given preference,
* or null.
* @param priority the priority of the preference. Valid values include:
* {@link org.havi.ui.HScreenConfigTemplate#REQUIRED},
* {@link org.havi.ui.HScreenConfigTemplate#PREFERRED},
* {@link org.havi.ui.HScreenConfigTemplate#DONT_CARE},
* {@link org.havi.ui.HScreenConfigTemplate#PREFERRED_NOT} and
* {@link org.havi.ui.HScreenConfigTemplate#REQUIRED_NOT}.
*
* If priority is not a valid priority as defined here a
* java.lang.IllegalArgumentException will be thrown.
*/
public void setPreference(int preference, Object object, int priority)
{
}
/**
* Return the preference object for the specified preference.
*
* Instances of {@link org.havi.ui.HVideoConfigTemplate}
* which have not had this preference set
* shall return null for this object. Note that instances
* constructed by the platform and returned to applications are
* required to have all preferences (except where explicitly
* identified) set by the platform before it is returned.
*
* @param preference the preference to be indicated. Valid values
* for an HVideoConfigTemplate are:
* {@link org.havi.ui.HScreenConfigTemplate#VIDEO_GRAPHICS_PIXEL_ALIGNED},
* {@link org.havi.ui.HScreenConfigTemplate#PIXEL_ASPECT_RATIO},
* {@link org.havi.ui.HScreenConfigTemplate#PIXEL_RESOLUTION},
* {@link org.havi.ui.HScreenConfigTemplate#SCREEN_RECTANGLE},
* and
* {@link org.havi.ui.HVideoConfigTemplate#GRAPHICS_MIXING}.
*
* Subclasses may add further valid values. A
* IllegalArgumentException shall be thrown if the preference is
* not a valid value for this instance of {@link
* org.havi.ui.HVideoConfigTemplate}, or
* if preference does not have an associated value object.
* @return the preference object for the specified preference.
*/
public Object getPreferenceObject(int preference)
{
return (null);
}
}