Package de.xima.fc.mdl.enums

Enum ETextFileContentType

java.lang.Object

java.lang.Enum<ETextFileContentType>

de.xima.fc.mdl.enums.ETextFileContentType

All Implemented Interfaces:

INamedUiElement, Serializable, Comparable<ETextFileContentType>

public enum ETextFileContentType
extends Enum<ETextFileContentType>
implements INamedUiElement

Enumeration of the possible content types that can be selected for the EWorkflowNodeType#FC_CREATE_TEXT_FILE. When form placeholders are replaced, the text is escaped according to the selected content type.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMMA_SEPARATED_VALUES	The text file contains CSV content (comma separated)
HTML	The text file contains HTML markup
ICAL	The text file contains an ICal(endar) file
JSON	The text file contains JSON data.
PLAIN_TEXT	The text file contains plain text that does not need any escaping.
SEMICOLON_SEPARATED_VALUES	The text file contains CSV content (semicolon separated)
XML	The text file contains XML

Field Summary

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method	Description
String	getCkEditorMode()
String	getDisplayName(Locale locale)	The display name of this element in the given locale.
IPlaceholderEscaper	getEscaper()
String	getExtension()
static ETextFileContentType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ETextFileContentType[]	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

PLAIN_TEXT

public static final ETextFileContentType PLAIN_TEXT

The text file contains plain text that does not need any escaping.

JSON

public static final ETextFileContentType JSON

The text file contains JSON data.

XML

public static final ETextFileContentType XML

The text file contains XML

HTML

public static final ETextFileContentType HTML

The text file contains HTML markup

SEMICOLON_SEPARATED_VALUES

public static final ETextFileContentType SEMICOLON_SEPARATED_VALUES

The text file contains CSV content (semicolon separated)

COMMA_SEPARATED_VALUES

public static final ETextFileContentType COMMA_SEPARATED_VALUES

The text file contains CSV content (comma separated)

ICAL

public static final ETextFileContentType ICAL

The text file contains an ICal(endar) file

Method Detail

values

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

Returns:

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

valueOf

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

getCkEditorMode

public String getCkEditorMode()

Returns:

Mode for the CK editor (for syntax highlighting).

getDisplayName

public String getDisplayName(Locale locale)

Description copied from interface: INamedUiElement

The display name of this element in the given locale.

Specified by:

getDisplayName in interface INamedUiElement

Parameters:

locale - The locale to get the display name for.

Returns:

The display name of this element in the given locale.

getEscaper

public IPlaceholderEscaper getEscaper()

Returns:

The placeholder escaper to be used for this content type.

getExtension

public String getExtension()

Returns:

The default extension of this text file content type (without a period).