com.bramosystems.oss.player.core.client

Enum TransparencyMode

java.lang.Object

java.lang.Enum<TransparencyMode>

com.bramosystems.oss.player.core.client.TransparencyMode

All Implemented Interfaces:

ConfigValue, Serializable, Comparable<TransparencyMode>

public enum TransparencyMode
extends Enum<TransparencyMode>
implements ConfigValue

An enum of transparency types for a player. The transparency mode is used to allow images, text, or popup windows to overlay on top of the player.

Since:

1.1

Author:

Scott Selikoff

Enum Constant Summary

Enum Constants

Enum Constant and Description
OPAQUE Hides everything on the page behind the player.
TRANSPARENT The background of the page shows through all transparent portions of the player.
WINDOW The video is placed in its own rectangular window on a page.

Method Summary

Methods

Modifier and Type	Method and Description
static TransparencyMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static TransparencyMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRANSPARENT

public static final TransparencyMode TRANSPARENT

The background of the page shows through all transparent portions of the player.

WINDOW

public static final TransparencyMode WINDOW

The video is placed in its own rectangular window on a page.

OPAQUE

public static final TransparencyMode OPAQUE

Hides everything on the page behind the player.

Method Detail

values

public static TransparencyMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TransparencyMode c : TransparencyMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TransparencyMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null