com.hcl.domino.data

Enum Navigate

java.lang.Object

java.lang.Enum<Navigate>

com.hcl.domino.data.Navigate

All Implemented Interfaces:

Serializable, Comparable<Navigate>

public enum Navigate
extends Enum<Navigate>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILD_ENTRY Down 1 level to first child
CURRENT Remain at current position (reset position and return data).
FIRST_ON_SAME_LEVEL First node at our level
LAST_ON_SAME_LEVEL Last node at our level
NEXT_CATEGORY next category
NEXT_DOCUMENT next document
NEXT_ENTRY next category or document
NEXT_EXPANDED next expanded category or document
NEXT_EXPANDED_CATEGORY next expanded category
NEXT_EXPANDED_DOCUMENT next expanded document
NEXT_EXPANDED_SELECTED next expanded and selected category or document
NEXT_EXPANDED_UNREAD next expanded unread document
NEXT_ON_SAME_LEVEL next peer entry (same level)
NEXT_ON_TOPLEVEL next top level entry
NEXT_PARENT_ENTRY next parent entry
NEXT_SELECTED next selected entry
NEXT_SELECTED_ON_TOPLEVEL next selected top level entry
NEXT_UNREAD_ENTRY next unread document
NEXT_UNREAD_TOPLEVEL_ENTRY next unread toplevel entry
PARENT_ENTRY Up 1 level
PREV_CATEGORY previous category entry
PREV_DOCUMENT previous document
PREV_ENTRY previous category or document
PREV_EXPANDED previous expanded category or document
PREV_EXPANDED_CATEGORY previous expanded category
PREV_EXPANDED_DOCUMENT previous expanded document
PREV_EXPANDED_SELECTED previous expanded selected category or document
PREV_EXPANDED_UNREAD previous expanded unread document
PREV_ON_SAME_LEVEL previous peer (same level)
PREV_ON_TOPLEVEL previous top level entry
PREV_PARENT_ENTRY previous parent entry
PREV_SELECTED previous selected entry
PREV_SELECTED_ON_TOPLEVEL previous selected top level entry
PREV_UNREAD_ENTRY previous unread entry
PREV_UNREAD_TOPLEVEL_ENTRY previous unread top level entry

Method Summary

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

CURRENT

public static final Navigate CURRENT

Remain at current position (reset position and return data).

NEXT_ENTRY

public static final Navigate NEXT_ENTRY

next category or document

PARENT_ENTRY

public static final Navigate PARENT_ENTRY

Up 1 level

CHILD_ENTRY

public static final Navigate CHILD_ENTRY

Down 1 level to first child

FIRST_ON_SAME_LEVEL

public static final Navigate FIRST_ON_SAME_LEVEL

First node at our level

LAST_ON_SAME_LEVEL

public static final Navigate LAST_ON_SAME_LEVEL

Last node at our level

NEXT_ON_SAME_LEVEL

public static final Navigate NEXT_ON_SAME_LEVEL

next peer entry (same level)

NEXT_ON_TOPLEVEL

public static final Navigate NEXT_ON_TOPLEVEL

next top level entry

NEXT_PARENT_ENTRY

public static final Navigate NEXT_PARENT_ENTRY

next parent entry

NEXT_UNREAD_ENTRY

public static final Navigate NEXT_UNREAD_ENTRY

next unread document

NEXT_UNREAD_TOPLEVEL_ENTRY

public static final Navigate NEXT_UNREAD_TOPLEVEL_ENTRY

next unread toplevel entry

NEXT_SELECTED

public static final Navigate NEXT_SELECTED

next selected entry

NEXT_SELECTED_ON_TOPLEVEL

public static final Navigate NEXT_SELECTED_ON_TOPLEVEL

next selected top level entry

NEXT_EXPANDED

public static final Navigate NEXT_EXPANDED

next expanded category or document

NEXT_EXPANDED_UNREAD

public static final Navigate NEXT_EXPANDED_UNREAD

next expanded unread document

NEXT_EXPANDED_SELECTED

public static final Navigate NEXT_EXPANDED_SELECTED

next expanded and selected category or document

NEXT_EXPANDED_CATEGORY

public static final Navigate NEXT_EXPANDED_CATEGORY

next expanded category

NEXT_EXPANDED_DOCUMENT

public static final Navigate NEXT_EXPANDED_DOCUMENT

next expanded document

NEXT_CATEGORY

public static final Navigate NEXT_CATEGORY

next category

NEXT_DOCUMENT

public static final Navigate NEXT_DOCUMENT

next document

PREV_ENTRY

public static final Navigate PREV_ENTRY

previous category or document

PREV_ON_SAME_LEVEL

public static final Navigate PREV_ON_SAME_LEVEL

previous peer (same level)

PREV_ON_TOPLEVEL

public static final Navigate PREV_ON_TOPLEVEL

previous top level entry

PREV_PARENT_ENTRY

public static final Navigate PREV_PARENT_ENTRY

previous parent entry

PREV_UNREAD_ENTRY

public static final Navigate PREV_UNREAD_ENTRY

previous unread entry

PREV_UNREAD_TOPLEVEL_ENTRY

public static final Navigate PREV_UNREAD_TOPLEVEL_ENTRY

previous unread top level entry

PREV_SELECTED

public static final Navigate PREV_SELECTED

previous selected entry

PREV_SELECTED_ON_TOPLEVEL

public static final Navigate PREV_SELECTED_ON_TOPLEVEL

previous selected top level entry

PREV_EXPANDED

public static final Navigate PREV_EXPANDED

previous expanded category or document

PREV_EXPANDED_UNREAD

public static final Navigate PREV_EXPANDED_UNREAD

previous expanded unread document

PREV_EXPANDED_SELECTED

public static final Navigate PREV_EXPANDED_SELECTED

previous expanded selected category or document

PREV_EXPANDED_CATEGORY

public static final Navigate PREV_EXPANDED_CATEGORY

previous expanded category

PREV_EXPANDED_DOCUMENT

public static final Navigate PREV_EXPANDED_DOCUMENT

previous expanded document

PREV_CATEGORY

public static final Navigate PREV_CATEGORY

previous category entry

PREV_DOCUMENT

public static final Navigate PREV_DOCUMENT

previous document

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public short getValue()