Package io.jmix.flowui.kit.component.markdowneditor

Enum Class MarkdownEditorMode

java.lang.Object

java.lang.Enum<MarkdownEditorMode>

io.jmix.flowui.kit.component.markdowneditor.MarkdownEditorMode

All Implemented Interfaces:

Serializable, Comparable<MarkdownEditorMode>, Constable

public enum MarkdownEditorMode
extends Enum<MarkdownEditorMode>

The display mode of the JmixMarkdownEditor.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EDIT	Edit mode — the user can type and format Markdown.
PREVIEW	Preview mode — the Markdown is rendered as formatted HTML.

Method Summary

Modifier and Type	Method	Description
static MarkdownEditorMode	fromPropertyValue(String value)	Returns the Mode corresponding to the given web-component property value, falling back to EDIT for unrecognised values.
String	getPropertyValue()	Returns the web-component property value for this mode.
static MarkdownEditorMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MarkdownEditorMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EDIT

public static final MarkdownEditorMode EDIT

Edit mode — the user can type and format Markdown.

PREVIEW

public static final MarkdownEditorMode PREVIEW

Preview mode — the Markdown is rendered as formatted HTML.

Method Details

values

public static MarkdownEditorMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MarkdownEditorMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getPropertyValue

public String getPropertyValue()

Returns the web-component property value for this mode.

Returns:

the property value string

fromPropertyValue

public static MarkdownEditorMode fromPropertyValue(String value)

Returns the Mode corresponding to the given web-component property value, falling back to EDIT for unrecognised values.

Parameters:

value - the property value string

Returns:

the matching Mode