com.sap.tc.cmi.texts

Enum CMITextFormat

java.lang.Object
  java.lang.Enum<CMITextFormat>
      com.sap.tc.cmi.texts.CMITextFormat

All Implemented Interfaces:

Serializable, Comparable<CMITextFormat>

public enum CMITextFormat
extends Enum<CMITextFormat>

Describes the possible format (markup) used in a text string. Might be extended in the future.

Type Classification:

This class is part of the Common Model Interface, so applications may reference it or call any method of this type, but they must not subclass it.

Enum Constant Summary

JAVA_MESSAGE_FORMAT
Text is in Java message format.

SAP_XHTML
Text uses a subset of the XHTML format, described by SAP.

UNDEFINED
Text is a java String that may contain arbitrary characters in any sequence.

Method Summary

static CMITextFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static CMITextFormat[]	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

UNDEFINED

public static final CMITextFormat UNDEFINED

Text is a java String that may contain arbitrary characters in any sequence. Note that escape sequences (like \n, \r, \t etc.) are valid characters in a Java String and somehow represent formatting info. So UNDEFINED is not necessarily unformatted.

JAVA_MESSAGE_FORMAT

public static final CMITextFormat JAVA_MESSAGE_FORMAT

Text is in Java message format.

See Also:

MessageFormat

SAP_XHTML

public static final CMITextFormat SAP_XHTML

Text uses a subset of the XHTML format, described by SAP.

Check the NetWeaver Online Help of Web Dynpro for a description of the supported XHTML subset.

Method Detail

values

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

Returns:

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

valueOf

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

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] FRAMEWORK	[sap.com] tc/cm/ejb/api	api	BC-JAS-EJB
[sap.com] FRAMEWORK	[sap.com] tc/cmi	default	BC-WD-JAV-RUN