com.onlyoffice.model.documenteditor.config.editorconfig.customization.review

Enum ReviewDisplay

java.lang.Object

java.lang.Enum<ReviewDisplay>

com.onlyoffice.model.documenteditor.config.editorconfig.customization.review.ReviewDisplay

All Implemented Interfaces:

Serializable, Comparable<ReviewDisplay>

public enum ReviewDisplay
extends Enum<ReviewDisplay>

Defines the review editing mode which will be used when the document is opened for viewing. It will only be available for the document editor if Mode is set to "view". The default value is "original".

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINAL The document is displayed with all the proposed changes applied.
MARKUP The document is displayed with proposed changes highlighted.
ORIGINAL The original document is displayed without the proposed changes.
SIMPLE The document is displayed with proposed changes highlighted, but the balloons are turned off.

Method Summary

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

MARKUP

public static final ReviewDisplay MARKUP

The document is displayed with proposed changes highlighted.

SIMPLE

public static final ReviewDisplay SIMPLE

The document is displayed with proposed changes highlighted, but the balloons are turned off.

FINAL

public static final ReviewDisplay FINAL

The document is displayed with all the proposed changes applied.

ORIGINAL

public static final ReviewDisplay ORIGINAL

The original document is displayed without the proposed changes.

Method Detail

values

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

Returns:

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

valueOf

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