com.smartgwt.client.types

Enum ContentsType

java.lang.Object

java.lang.Enum<ContentsType>

com.smartgwt.client.types.ContentsType

All Implemented Interfaces:

ValueEnum, java.io.Serializable, java.lang.Comparable<ContentsType>

public enum ContentsType
extends java.lang.Enum<ContentsType>
implements ValueEnum

What type of content is being displayed within the HTMLFlow? This content may come from the contentsURL or be directly specified as HTMLFlow.contents.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FRAGMENT The HTML content is treated as a snippet designed to integrate into the main page and is directly inserted into the DOM.
PAGE The HTML content is treated as a standalone document and displayed in an isolated context using an IFRAME.

Method Summary

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

PAGE

public static final ContentsType PAGE

The HTML content is treated as a standalone document and displayed in an isolated context using an IFRAME.

If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "page".

FRAGMENT

public static final ContentsType FRAGMENT

The HTML content is treated as a snippet designed to integrate into the main page and is directly inserted into the DOM.

If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "fragment".

Method Detail

values

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

Returns:

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

valueOf

public static ContentsType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public java.lang.String getValue()

Specified by:

getValue in interface ValueEnum