Package com.nomagic.magicdraw.elementreferenceintext

Class ElementReferencingInTexts

java.lang.Object

com.nomagic.magicdraw.elementreferenceintext.ElementReferencingInTexts

@OpenApiAll
public class ElementReferencingInTexts
extends java.lang.Object

Class responsible for creating rich texts(with references to other elements). For more information on usage refer to the examples.

Constructor Summary

Constructors

Constructor	Description
ElementReferencingInTexts()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	createReferencingText(BaseElement referencedElement, java.lang.String text)	Creates text referencing an element using default settings(DisplayMode.CUSTOM_TEXT, UpdateMode.AUTOMATIC_UPDATE)
static java.lang.String	createReferencingText(BaseElement referencedElement, java.lang.String text, DisplayMode displayMode)	Creates text referencing an element using provided display mode and UpdateMode.AUTOMATIC_UPDATE mode
static java.lang.String	createReferencingText(BaseElement referencedElement, java.lang.String text, DisplayMode display, UpdateMode update)	Creates text referencing an element using provided display mode and update mode
static java.util.Collection<Element>	getReferredElements(Element referringElement)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ElementReferencingInTexts

public ElementReferencingInTexts()

Method Detail

createReferencingText

public static java.lang.String createReferencingText(BaseElement referencedElement,
                                                     java.lang.String text)

Creates text referencing an element using default settings(DisplayMode.CUSTOM_TEXT, UpdateMode.AUTOMATIC_UPDATE)

Parameters:

referencedElement - element referenced in text

text - text to display

Returns:

text that refers provided element

createReferencingText

public static java.lang.String createReferencingText(BaseElement referencedElement,
                                                     java.lang.String text,
                                                     DisplayMode displayMode)

Creates text referencing an element using provided display mode and UpdateMode.AUTOMATIC_UPDATE mode

Parameters:

referencedElement - element referenced by text

text - text to display(only affective if display mode is DisplayMode.CUSTOM_TEXT)

displayMode - the reference display mode. Must not be null.

Returns:

text referring provided element

createReferencingText

public static java.lang.String createReferencingText(BaseElement referencedElement,
                                                     java.lang.String text,
                                                     DisplayMode display,
                                                     UpdateMode update)

Creates text referencing an element using provided display mode and update mode

Parameters:

referencedElement - element referenced by text

text - text to display

display - the reference display mode. Must not be null.

update - the reference update mode. Must not be null.

Returns:

text referring provided element

getReferredElements

public static java.util.Collection<Element> getReferredElements(Element referringElement)

Parameters:

referringElement - the element that is referring to other elements

Returns:

a collection of elements that are referred by provided element