com.communote.server.api.core.note

Enum NoteRenderMode

java.lang.Object

java.lang.Enum<NoteRenderMode>

com.communote.server.api.core.note.NoteRenderMode

All Implemented Interfaces:

Serializable, Comparable<NoteRenderMode>

public enum NoteRenderMode
extends Enum<NoteRenderMode>

Enumeration of possible modes to render a note.

Author:

Communote GmbH - http://www.communote.com/

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTML the note content should be rendered in a generic HTML format, i.e.
PLAIN the note content should be rendered as plain text
PORTAL the notes are rendered by the web frontend and thus can contain custom JavaScript calls available in the frontend
REPOST The rendered note will be used to prepare an editor for creating a repost to this note.
REPOST_PLAIN The rendered note will be used to prepare an editor for creating a repost to this note.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLAIN_MODE_OPTION_KEY_BEAUTIFY Key for a mode option to inform the pre-processors that the plain text version of the content should be beautified (e.g.

Method Summary

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

HTML

public static final NoteRenderMode HTML

the note content should be rendered in a generic HTML format, i.e. the HTML should not contain JavaScript or custom CSS classes. To provide additional meta data to clients, HTML data attributes can be used.

PLAIN

public static final NoteRenderMode PLAIN

the note content should be rendered as plain text

PORTAL

public static final NoteRenderMode PORTAL

the notes are rendered by the web frontend and thus can contain custom JavaScript calls available in the frontend

REPOST

public static final NoteRenderMode REPOST

The rendered note will be used to prepare an editor for creating a repost to this note. The content is expected to be HTML but must not contain JavaScript. This mode should be used if the editor is HTML capable.

REPOST_PLAIN

public static final NoteRenderMode REPOST_PLAIN

The rendered note will be used to prepare an editor for creating a repost to this note. The content is expected to be plain text.

Field Detail

PLAIN_MODE_OPTION_KEY_BEAUTIFY

public static final String PLAIN_MODE_OPTION_KEY_BEAUTIFY

Key for a mode option to inform the pre-processors that the plain text version of the content should be beautified (e.g. indent LIs). This option should only be considered as set if the value is "true".

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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