org.havi.ui

Interface HMatteLayer

All Known Implementing Classes:

HAnimation, HComponent, HContainer, HGraphicButton, HIcon, HListGroup, HMultilineEntry, HRange, HRangeValue, HSinglelineEntry, HStaticAnimation, HStaticIcon, HStaticRange, HStaticText, HText, HTextButton, HTMLInnerApplicationContainer, HToggleButton, HVideoComponent, HVisible, InnerApplicationContainer

public interface HMatteLayer

This HMatteLayer interface enables the presentation of components, together with an associated HMatte, for matte compositing.

See Also:

HMatte

Method Summary

Methods

Modifier and Type	Method and Description
HMatte	getMatte() Get any HMatte currently associated with this component.
void	setMatte(HMatte m) Applies an HMatte to this component, for matte compositing.

Method Detail

setMatte

void setMatte(HMatte m)
              throws HMatteException

Applies an HMatte to this component, for matte compositing. Any existing animated matte must be stopped before this method is called or an HMatteException will be thrown.

Parameters:

m - The HMatte to be applied to this component -- note that only one matte may be associated with the component, thus any previous matte will be replaced. If m is null, then any matte associated with the component is removed and further calls to getMatte() shall return null. The component shall behave as if it had a fully opaque HFlatMatte associated with it (i.e an HFlatMatte with the default value of 1.0.)

Throws:

HMatteException - if the HMatte cannot be associated with the component. This can occur:

• if the specific matte type is not supported
• if the platform does not support any matte type
• if the component is associated with an already running HFlatEffectMatte or HImageEffectMatte. The exception is thrown even if m is null.

See Also:

HMatte

getMatte

HMatte getMatte()

Get any HMatte currently associated with this component.

Returns:

the HMatte currently associated with this component or null if there is no associated matte.