com.onlyoffice.model.documenteditor.config.editorconfig

Enum Mode

java.lang.Object

java.lang.Enum<Mode>

com.onlyoffice.model.documenteditor.config.editorconfig.Mode

All Implemented Interfaces:

Serializable, Comparable<Mode>

public enum Mode
extends Enum<Mode>

Defines the editor opening mode. Can be either "view" to open the document for viewing, or "edit" to open the document in the editing mode allowing to apply changes to the document data. The default value is "edit".

Enum Constant Summary

Enum Constants

Enum Constant and Description
EDIT Opens a document for editing.
VIEW Opens a document for viewing.

Method Summary

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

VIEW

public static final Mode VIEW

Opens a document for viewing.

EDIT

public static final Mode EDIT

Opens a document for editing.

Method Detail

values

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

Returns:

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

valueOf

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