com.sap.tc.cmi.texts

Enum CMITextType

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

All Implemented Interfaces:

Serializable, Comparable<CMITextType>

public enum CMITextType
extends Enum<CMITextType>

Enumeration of the possible types of a UIText.

Note that the field documentation has been taken from the definition of the text types as provided by the SAP Translation group.

Since:

NY AP5

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

BUTTON_TEXT
Text for a button object, for example a PUSHBUTTON control

CAPTION
Indicates a caption, such as the caption of a dialog box

COLUMN_LABEL
Heading of a table column.

FIELD_LABEL
Indicates a label object.

LIST_BOX_ENTRY
Text for a listbox object, for example in a LISTBOX control in Windows

TAB_STRIP_HEADER
Text for graphical control element that resembles a card in a card index (Name of a Tab in a Tab Strip).

TOOLTIP
Text which is shown when the mouse is moved over a control.

Field Summary

static CMITextType[]

NO_TEXT_TYPES

Method Summary

static CMITextType	findByTranslationTextType(String translationTextType) Searches for a CMITextType that matches the given name of translation text type.
String	getTranslationTextType() Returns the name of the best matching technical text type as used by the transalation.
static CMITextType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CMITextType[]	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

FIELD_LABEL

public static final CMITextType FIELD_LABEL

Indicates a label object.

COLUMN_LABEL

public static final CMITextType COLUMN_LABEL

Heading of a table column.

TOOLTIP

public static final CMITextType TOOLTIP

Text which is shown when the mouse is moved over a control.

CAPTION

public static final CMITextType CAPTION

Indicates a caption, such as the caption of a dialog box

BUTTON_TEXT

public static final CMITextType BUTTON_TEXT

Text for a button object, for example a PUSHBUTTON control

TAB_STRIP_HEADER

public static final CMITextType TAB_STRIP_HEADER

Text for graphical control element that resembles a card in a card index (Name of a Tab in a Tab Strip).

LIST_BOX_ENTRY

public static final CMITextType LIST_BOX_ENTRY

Text for a listbox object, for example in a LISTBOX control in Windows

Field Detail

NO_TEXT_TYPES

public static final CMITextType[] NO_TEXT_TYPES

Method Detail

values

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

Returns:

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

valueOf

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

getTranslationTextType

public String getTranslationTextType()

Returns the name of the best matching technical text type as used by the transalation.

findByTranslationTextType

public static CMITextType findByTranslationTextType(String translationTextType)

Searches for a CMITextType that matches the given name of translation text type. If no matching CMITextType exists, null is returned.

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