Package com.github.bordertech.wcomponents

Enum WContent.DisplayMode

java.lang.Object

java.lang.Enum<WContent.DisplayMode>

com.github.bordertech.wcomponents.WContent.DisplayMode

All Implemented Interfaces:

Serializable, Comparable<WContent.DisplayMode>

Enclosing class:

WContent

public static enum WContent.DisplayMode
extends Enum<WContent.DisplayMode>

An enumeration of how the content should be provided to the user.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISPLAY_INLINE	Indicates that the content should replace the current page.
OPEN_NEW_WINDOW	Indicates that the content should be displayed in another browser window.
PROMPT_TO_SAVE	Indicates that the browser should prompt the user to save the content to a file.

Method Summary

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

OPEN_NEW_WINDOW

public static final WContent.DisplayMode OPEN_NEW_WINDOW

Indicates that the content should be displayed in another browser window.

DISPLAY_INLINE

public static final WContent.DisplayMode DISPLAY_INLINE

Indicates that the content should replace the current page.

PROMPT_TO_SAVE

public static final WContent.DisplayMode PROMPT_TO_SAVE

Indicates that the browser should prompt the user to save the content to a file. Note that for this to work, the ContenetAccess MUST have its description set to the file name which the content should be saved as.

Method Detail

values

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

Returns:

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

valueOf

public static WContent.DisplayMode 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