com.bramosystems.oss.player.core.client

Enum DefaultConfigParameter

java.lang.Object

java.lang.Enum<DefaultConfigParameter>

com.bramosystems.oss.player.core.client.DefaultConfigParameter

All Implemented Interfaces:

ConfigParameter, Serializable, Comparable<DefaultConfigParameter>

public enum DefaultConfigParameter
extends Enum<DefaultConfigParameter>
implements ConfigParameter

An enum of default player configuration parameters.

The parameters are applied as HTML param tags on the underlying player plugin.

Since:

1.1

Author:

Sikiru Braheem

See Also:

ConfigParameter

Enum Constant Summary

Enum Constants

Enum Constant and Description
BackgroundColor Parameter for the background color property or a player.
TransparencyMode Parameter for the transparency mode for a player (if available).

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the name of the parameter
Class[]	getValueType() Returns the required value type for this parameter.
static DefaultConfigParameter	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultConfigParameter[]	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

TransparencyMode

public static final DefaultConfigParameter TransparencyMode

Parameter for the transparency mode for a player (if available).

This parameter requires a TransparencyMode value type

BackgroundColor

public static final DefaultConfigParameter BackgroundColor

Parameter for the background color property or a player.

This parameter is used to specify the background color for the exposed part of a players' alloted space The value should be specified as a CSS color value (i.e. hexadecimal RGB values)

Since:

1.2.1

Method Detail

values

public static DefaultConfigParameter[] 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 (DefaultConfigParameter c : DefaultConfigParameter.values())
    System.out.println(c);

Returns:

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

valueOf

public static DefaultConfigParameter 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

getValueType

public Class[] getValueType()

Description copied from interface: ConfigParameter

Returns the required value type for this parameter.

Specified by:

getValueType in interface ConfigParameter

Returns:

the required type of value

getName

public String getName()

Description copied from interface: ConfigParameter

Returns the name of the parameter

Specified by:

getName in interface ConfigParameter

Returns:

the name of the parameter