com.nomagic.magicdraw.uml

Interface RepresentationTextCreator.RepresentationTextProvider2

Enclosing class:

RepresentationTextCreator

public static interface RepresentationTextCreator.RepresentationTextProvider2

Representation text provider extension point. Plugins may register these providers and override representation text creation in MD core

Method Summary

Modifier and Type	Method and Description
boolean	accept(BaseElement element) Check if this provider must be used to create a representation text for given element
SmartListenerConfig	createSmartListenerConfig(Element element, boolean browserConfiguration) Returns representation text smart listener config for this provider.
default java.lang.String	getRepresentedText(BaseElement element, boolean addColor, boolean fullSignature, boolean addId) Deprecated. use getRepresentedText(BaseElement, boolean, boolean, boolean, LocationInTool)
default java.lang.String	getRepresentedText(BaseElement element, boolean addColor, boolean fullSignature, boolean addId, LocationInTool locationInTool) Returns representation text for a given Element.

Method Detail

getRepresentedText

@Deprecated
default java.lang.String getRepresentedText(BaseElement element,
                                                        boolean addColor,
                                                        boolean fullSignature,
                                                        boolean addId)

Deprecated. use getRepresentedText(BaseElement, boolean, boolean, boolean, LocationInTool)

Returns representation text for a given Element.

Parameters:

element - element which representation text will be created.

addColor - if true requester allows to add color information into returned text (for example some grayed out text)

fullSignature - expand typed elements type or not in representation text (browser has such option)

addId - add id(number) of the element

Returns:

representation text for any given element.

getRepresentedText

default java.lang.String getRepresentedText(BaseElement element,
                                            boolean addColor,
                                            boolean fullSignature,
                                            boolean addId,
                                            LocationInTool locationInTool)

Returns representation text for a given Element.

Parameters:

element - element which representation text will be created.

addColor - if true requester allows to add color information into returned text (for example some grayed out text)

fullSignature - expand typed elements type or not in representation text (browser has such option)

addId - add id(number) of the element

locationInTool - location in tool where text should be represented. Text providers can take into account that information and provide a different text.

Returns:

representation text for any given element.

createSmartListenerConfig

@CheckForNull
SmartListenerConfig createSmartListenerConfig(Element element,
                                                            boolean browserConfiguration)

Returns representation text smart listener config for this provider.

Parameters:

element - element which representation text will be created.

browserConfiguration - if true this config will be used in browser

Returns:

representation text for any given element.

accept

boolean accept(BaseElement element)

Check if this provider must be used to create a representation text for given element

Parameters:

element - given element

Returns:

true if this provider can create representation text for given element