Package de.xima.fc.mdl.enums

Enum EElementHelpPageTargetType

java.lang.Object

java.lang.Enum<EElementHelpPageTargetType>

de.xima.fc.mdl.enums.EElementHelpPageTargetType

All Implemented Interfaces:

Serializable, Comparable<EElementHelpPageTargetType>

public enum EElementHelpPageTargetType
extends Enum<EElementHelpPageTargetType>

Enumeration of how how a workflow element can provide the user with a usage help page.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXTERNAL_LINK	A custom external link.
HTML_DOCUMENT	A custom HTML page.
OFFICIAL_HELP_PAGE	A link to an entry in the official FORMCYCLE help pages.

Method Summary

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

EXTERNAL_LINK

public static final EElementHelpPageTargetType EXTERNAL_LINK

A custom external link. Must be an absolute link to an existing page.

HTML_DOCUMENT

public static final EElementHelpPageTargetType HTML_DOCUMENT

A custom HTML page. Must be a complete HTML file with all script and style that are required.

OFFICIAL_HELP_PAGE

public static final EElementHelpPageTargetType OFFICIAL_HELP_PAGE

A link to an entry in the official FORMCYCLE help pages. Must be a relative URL, e.g. /xwiki/bin/view/Formcycle/Designer/Workflow/Actions/CreateTextFile.

Method Detail

values

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

Returns:

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

valueOf

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