Package com.nomagic.magicdraw.elementreferenceintext

Enum Class DisplayMode

java.lang.Object
java.lang.Enum<DisplayMode>
com.nomagic.magicdraw.elementreferenceintext.DisplayMode
All Implemented Interfaces:
Serializable, Comparable<DisplayMode>, Constable
@OpenApiAll public enum DisplayMode extends Enum<DisplayMode>
The display mode is used to determine how an element reference will be displayed in text

  • Enum Constant Details

    • 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 Details

    • values

      public static DisplayMode[] 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 DisplayMode 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

    • getSmartListenerConfig

      @CheckForNull public abstract SmartListenerConfig getSmartListenerConfig(Element element)

    • getReferencedElementTextRepresentation

      public abstract String getReferencedElementTextRepresentation(@CheckForNull BaseElement element)

    • getDisplayMode

      public static DisplayMode getDisplayMode(String name)