Package com.nomagic.magicdraw.elementreferenceintext

Enum DisplayMode

java.lang.Object

java.lang.Enum<DisplayMode>

com.nomagic.magicdraw.elementreferenceintext.DisplayMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DisplayMode>

@OpenApiAll
public enum DisplayMode
extends java.lang.Enum<DisplayMode>

The display mode is used to determine how an element reference will be displayed in text

Enum Constant Summary

Enum Constants

Enum Constant	Description
CUSTOM_TEXT	Custom text for referenced element shall be displayed
IMAGE_REPRESENTATION_TEXT	Element image and representation text shall be displayed for referenced element
NAME	The element name for referenced element shall be displayed
REPRESENTATION_TEXT	Element representation text for referenced element shall be displayed

Method Summary

Modifier and Type	Method	Description
static DisplayMode	getDisplayMode(java.lang.String name)
abstract java.lang.String	getReferencedElementTextRepresentation(BaseElement element)
abstract SmartListenerConfig	getSmartListenerConfig(Element element)
static DisplayMode	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static DisplayMode[]	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

NAME

public static final DisplayMode NAME

The element name for referenced element shall be displayed

IMAGE_REPRESENTATION_TEXT

public static final DisplayMode IMAGE_REPRESENTATION_TEXT

Element image and representation text shall be displayed for referenced element

REPRESENTATION_TEXT

public static final DisplayMode REPRESENTATION_TEXT

Element representation text for referenced element shall be displayed

CUSTOM_TEXT

public static final DisplayMode CUSTOM_TEXT

Custom text for referenced element shall be displayed

Method Detail

values

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

Returns:

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

valueOf

public static DisplayMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getSmartListenerConfig

@CheckForNull
public abstract SmartListenerConfig getSmartListenerConfig(Element element)

getReferencedElementTextRepresentation

public abstract java.lang.String getReferencedElementTextRepresentation(@CheckForNull
                                                                        BaseElement element)

getDisplayMode

public static DisplayMode getDisplayMode(java.lang.String name)