com.ibm.portal.state.accessors.pagemode
Enum PageMode

java.lang.Object
  java.lang.Enum<PageMode>
      com.ibm.portal.state.accessors.pagemode.PageMode

All Implemented Interfaces:

com.ibm.utilities.collections.stl.Functional.SerializerProvider<PageMode,java.lang.String>, java.io.Serializable, java.lang.Comparable<PageMode>

public enum PageMode
extends java.lang.Enum<PageMode>
implements com.ibm.utilities.collections.stl.Functional.SerializerProvider<PageMode,java.lang.String>

Enumerates all valid page modes. Unlike portlet modes, multiple page modes can be active at the same time.

Since:

8.5

Enum Constant Summary

EDIT
Page edit mode

HELP
Page help mode

INFO
Page info mode

Field Summary

static javax.xml.namespace.QName	QNAME Qualified name of the public render parameter that encodes the set of active page modes.
static com.ibm.utilities.collections.stl.Functional.Serializer<PageMode,java.lang.String>	serializer Enumeration serializer.
static com.ibm.utilities.collections.stl.Functional.UnaryOperator<? super java.lang.String,? extends PageMode>	valueOf Deserializer

Method Summary

com.ibm.utilities.collections.stl.Functional.UnaryOperator<? super PageMode,? extends java.lang.String>	getSerializer()
static PageMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PageMode[]	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

EDIT

public static final PageMode EDIT

Page edit mode

HELP

public static final PageMode HELP

Page help mode

INFO

public static final PageMode INFO

Page info mode

Field Detail

QNAME

public static final javax.xml.namespace.QName QNAME

Qualified name of the public render parameter that encodes the set of active page modes.

serializer

public static final com.ibm.utilities.collections.stl.Functional.Serializer<PageMode,java.lang.String> serializer

Enumeration serializer.

valueOf

public static final com.ibm.utilities.collections.stl.Functional.UnaryOperator<? super java.lang.String,? extends PageMode> valueOf

Deserializer

Method Detail

values

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

Returns:

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

valueOf

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

getSerializer

public com.ibm.utilities.collections.stl.Functional.UnaryOperator<? super PageMode,? extends java.lang.String> getSerializer()

Specified by:

getSerializer in interface com.ibm.utilities.collections.stl.Functional.SerializerProvider<PageMode,java.lang.String>