Package com.github.bordertech.wcomponents

Enum WAudio.Controls

java.lang.Object

java.lang.Enum<WAudio.Controls>

com.github.bordertech.wcomponents.WAudio.Controls

All Implemented Interfaces:

Serializable, Comparable<WAudio.Controls>

Enclosing class:

WAudio

@Deprecated
public static enum WAudio.Controls
extends Enum<WAudio.Controls>

Deprecated.

Note that the only options for HTML audio element are to show native controls or not. Not showing native controls if not an option within WComponents for a11y reasons so this whole enum is superfluous and has not been implemented in themes for years.

This is used to indicate which playback controls to display for the audio.

Note: Advances in audio support in browsers since this API was first implemented means that this is now redundant.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Deprecated. Display all controls.
DEFAULT	Deprecated. Displays the "default" set of controls for the theme.
NATIVE	Deprecated. Displays the client's native set of controls.
NONE	Deprecated. Do not display any controls.
PLAY_PAUSE	Deprecated. A combined play/pause button.

Method Summary

Modifier and Type	Method	Description
static WAudio.Controls	valueOf(String name)	Deprecated. Returns the enum constant of this type with the specified name.
static WAudio.Controls[]	values()	Deprecated. 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

NONE

public static final WAudio.Controls NONE

Deprecated.

Do not display any controls. May be incompatible with either WAudio.isAutoplay() == true or WAudio.isLoop() == true. If this is set then the WAudio control MAY NOT WORK.

ALL

public static final WAudio.Controls ALL

Deprecated.

Display all controls. What this actually means depends upon the theme.

PLAY_PAUSE

public static final WAudio.Controls PLAY_PAUSE

Deprecated.

A combined play/pause button.

DEFAULT

public static final WAudio.Controls DEFAULT

Deprecated.

Displays the "default" set of controls for the theme.

NATIVE

public static final WAudio.Controls NATIVE

Deprecated.

Displays the client's native set of controls.

Method Detail

values

public static WAudio.Controls[] values()

Deprecated.

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 (WAudio.Controls c : WAudio.Controls.values())
    System.out.println(c);

Returns:

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

valueOf

public static WAudio.Controls valueOf(String name)

Deprecated.

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