Package com.mayam.wf.config.shared

Enum Class EmbedContext

java.lang.Object

java.lang.Enum<EmbedContext>

com.mayam.wf.config.shared.EmbedContext

All Implemented Interfaces:

Serializable, Comparable<EmbedContext>, Constable

public enum EmbedContext
extends Enum<EmbedContext>

Describes how the application is embedded within a parent application, such as a MAM or an NLE.

Author:

Markus Mårtensson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EmbedContext.HasEmbedContexts

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADOBE_AE	Embedded into Adobe After Effects as an HTML5 extension.
ADOBE_PR	Embedded into Adobe Premiere Pro as an HTML5 extension.
ADOBE_PS	Embedded into Adobe Photoshop as an HTML5 extension.
FULL	Full screen width, or nearly full screen if embedded.
HALF	Half screen width; typically case: embedded within software having split-screen support.

Method Summary

Modifier and Type	Method	Description
boolean	isVisible(EmbedContext.HasEmbedContexts entity)	Determine if a configuration entity, such as a field or action, should be visible given that the application is embedded as per this this context.
static EmbedContext	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EmbedContext[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FULL

public static final EmbedContext FULL

Full screen width, or nearly full screen if embedded.

HALF

public static final EmbedContext HALF

Half screen width; typically case: embedded within software having split-screen support.

ADOBE_AE

public static final EmbedContext ADOBE_AE

Embedded into Adobe After Effects as an HTML5 extension.

ADOBE_PR

public static final EmbedContext ADOBE_PR

Embedded into Adobe Premiere Pro as an HTML5 extension.

ADOBE_PS

public static final EmbedContext ADOBE_PS

Embedded into Adobe Photoshop as an HTML5 extension.

Method Details

values

public static EmbedContext[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EmbedContext valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isVisible

public boolean isVisible(EmbedContext.HasEmbedContexts entity)

Determine if a configuration entity, such as a field or action, should be visible given that the application is embedded as per this this context.

Parameters:

entity - the field or action to be tested.