com.sun.tv.media

Class AWTVideoSizeControlImpl

java.lang.Object

com.sun.tv.media.AWTVideoSizeControlImpl

All Implemented Interfaces:

Control, AWTVideoSizeControl

public class AWTVideoSizeControlImpl
extends Object
implements AWTVideoSizeControl

An interface that allows setting clipping, scaling, and translation of a video stream in a simple, interoperable way. Not all possible combinations of positioning will be supported, so this interface provides a mechanism to discover how closely the underlying platform will approximate a request for positioning.

All interactions via AWTVideoSizeControlImpl happen in the coordinate space of the screen. For example, successfully setting the video's position to the location reported by getLocationOnScreen() on the xlet's root container will cause the upper-left hand corner of the video and the root container to coincide.

The screen, in the context of AWT, is the area into which graphics drawing operations are done. Its size is given by java.awt.Toolkit.getScreenSize(), and locations reported by Component.getLocationOnScreen() are given in the screen's coordinate system.

Version:

1.10, 04/03/00

See Also:

AWTVideoSize

Constructor Summary

Constructors

Constructor and Description
AWTVideoSizeControlImpl()

Method Summary

Methods

Modifier and Type	Method and Description
AWTVideoSize	checkSize(AWTVideoSize sz) Find out how closely the underlying platform can approximate a desired video size.
Component	getControlComponent() Get the Component associated with this Control object.
AWTVideoSize	getDefaultSize() Get the default AWTVideoSize for this control.
AWTVideoSize	getSize() Get the AWTVideoSize at which the Player is currently operating.
Dimension	getSourceVideoSize() Get the size of the source video, in the screen's coordinat system.
boolean	setSize(AWTVideoSize sz) Set the video size.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AWTVideoSizeControlImpl

public AWTVideoSizeControlImpl()

Method Detail

getSize

public AWTVideoSize getSize()

Get the AWTVideoSize at which the Player is currently operating.

Specified by:

getSize in interface AWTVideoSizeControl

Returns:

a copy of the JMF Player's current video size, in the AWT coordinate space.

getDefaultSize

public AWTVideoSize getDefaultSize()

Get the default AWTVideoSize for this control. For the background video plane, this will be the size that the video would be presented at if no program had manipulated the video size.

Specified by:

getDefaultSize in interface AWTVideoSizeControl

Returns:

The default AWTVideoSize.

getSourceVideoSize

public Dimension getSourceVideoSize()

Get the size of the source video, in the screen's coordinat system.

Specified by:

getSourceVideoSize in interface AWTVideoSizeControl

Returns:

The size of the source video.

setSize

public boolean setSize(AWTVideoSize sz)

Set the video size. If the size provided cannot be supported by the underlying platform, do nothing and return false.

Specified by:

setSize in interface AWTVideoSizeControl

Parameters:

sz - The desired video size, in the AWT coordinate space.

Returns:

true if the size was successfully changed, false if the platform is incapable of supporting the given size.

See Also:

checkSize(AWTVideoSize)

checkSize

public AWTVideoSize checkSize(AWTVideoSize sz)

Find out how closely the underlying platform can approximate a desired video size. If the underlying platform cannot support the given size, this method gives the closest approximation the platform is capable of.

Specified by:

checkSize in interface AWTVideoSizeControl

Parameters:

sz - The desired video size.

Returns:

The actual size that the platform would be able to set.

getControlComponent

public Component getControlComponent()

Get the Component associated with this Control object. For example, this method might return a slider for volume control or a panel containing radio buttons for CODEC control. The getControlComponent method can return null if there is no GUI control for this Control.

Specified by:

getControlComponent in interface Control