com.nomagic.magicdraw.annotation

Class AnnotationManager

java.lang.Object

com.nomagic.magicdraw.annotation.AnnotationManager

@OpenApiAll
public class AnnotationManager
extends java.lang.Object

Handles annotations visualization on diagrams and other UI components. It takes care of drawing decorations around symbols with annotations and provides annotation actions for manipulators. Users are responsible for adding annotations and removing added annotations afterwards. Users is responsible to call update() method when some annotation is added or removed.

Method Summary

Modifier and Type	Method and Description
boolean	add(Annotation annotation) Add single annotation.
void	addListener(AnnotationManagerListener listener)
java.util.Collection<BaseElement>	getAnnotatedElements() Returns a collection of annotated elements
java.util.Collection<BaseElement>	getAnnotatedElements(Annotation.SCOPE scope)
java.util.Collection<BaseElement>	getAnnotatedElements(java.util.EnumSet<Annotation.SCOPE> scopes) Returns a collection of annotated elements.
java.util.List<Annotation>	getAnnotations(BaseElement element) Get all annotations for particular element.
java.util.List<Annotation>	getAnnotations(BaseElement element, Annotation.SCOPE scope) Get all annotations for particular element.
java.util.List<Annotation>	getAnnotations(BaseElement element, java.util.EnumSet<Annotation.SCOPE> scopes) Get all annotations for particular element.
java.util.List<Annotation>	getAnnotationsOfChildren(BaseElement element)
java.util.List<Annotation>	getAnnotationsOfChildren(BaseElement element, java.util.EnumSet<Annotation.SCOPE> scopes) Get all annotations of children of given element.
java.util.List<Annotation>	getAnnotationsOfHiddenChildren(PresentationElement view) Get all annotations of closest hidden children(recursively) of given symbol.
static AnnotationManager	getInstance() Get instance of AnnotationManager object.
java.util.Iterator<BaseElement>	getIteratorOfAnnotatedElements(BaseElement owner) Returns a collection of annotated elements
java.util.Iterator<Annotation>	getIteratorOfAnnotationsOfChildren(BaseElement element)
boolean	hasAnnotatedChildren(BaseElement element) Test if given element has children (recursively) with some annotations.
boolean	hasAnnotatedChildren(BaseElement element, java.util.EnumSet<Annotation.SCOPE> scopes) Test if given element has children (recursively) with some annotations.
boolean	hasAnnotations()
boolean	remove(Annotation annotation) Remove single annotation.
void	removeListener(AnnotationManagerListener listener)
void	update() Repaint only opened diagrams of an active project
void	update(java.util.Collection<Annotation> removed, java.util.Collection<Annotation> added) Updates annotation manager using specified data.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static AnnotationManager getInstance()

Get instance of AnnotationManager object.

Returns:

AnnotationManager object

add

public boolean add(Annotation annotation)

Add single annotation. Annotation may not be visible until the update() method has been called.

Parameters:

annotation - annotation to add

Returns:

true if annotation was added, false if such annotation already exists

remove

public boolean remove(Annotation annotation)

Remove single annotation. Changes may not be visible until the update() method has been called.

Parameters:

annotation - annotation to remove

Returns:

true if annotation was removed, false if such annotation was not added before

hasAnnotatedChildren

public boolean hasAnnotatedChildren(@CheckForNull
                                    BaseElement element)

Test if given element has children (recursively) with some annotations.

Parameters:

element - given element

Returns:

true if there are at least one annotated child of given element

hasAnnotatedChildren

public boolean hasAnnotatedChildren(@CheckForNull
                                    BaseElement element,
                                    java.util.EnumSet<Annotation.SCOPE> scopes)

Test if given element has children (recursively) with some annotations.

Parameters:

element - given element

Returns:

true if there are at least one annotated child of given element

getAnnotationsOfChildren

public java.util.List<Annotation> getAnnotationsOfChildren(BaseElement element)

getAnnotationsOfChildren

public java.util.List<Annotation> getAnnotationsOfChildren(BaseElement element,
                                                           java.util.EnumSet<Annotation.SCOPE> scopes)

Get all annotations of children of given element. Also includes informationFlows for given element.

Parameters:

element - given element

Returns:

list of annotations sorted by severity.

getIteratorOfAnnotationsOfChildren

public java.util.Iterator<Annotation> getIteratorOfAnnotationsOfChildren(BaseElement element)

getAnnotationsOfHiddenChildren

public java.util.List<Annotation> getAnnotationsOfHiddenChildren(PresentationElement view)

Get all annotations of closest hidden children(recursively) of given symbol. Also includes InformationFlows of given element, that has conveyed Info.

Parameters:

view - symbol of starting PE. dedicated to find closest hidden elements for diagrams.

Returns:

list of annotations sorted by severity.

getAnnotations

public java.util.List<Annotation> getAnnotations(BaseElement element,
                                                 Annotation.SCOPE scope)

Get all annotations for particular element.

Parameters:

element - given element

Returns:

list of annotations sorted by severity.

getAnnotations

public java.util.List<Annotation> getAnnotations(BaseElement element)

Get all annotations for particular element.

Parameters:

element - given element

Returns:

list of annotations sorted by severity.

getAnnotations

public java.util.List<Annotation> getAnnotations(BaseElement element,
                                                 @CheckForNull
                                                 java.util.EnumSet<Annotation.SCOPE> scopes)

Get all annotations for particular element.

Parameters:

element - given element

Returns:

list of annotations sorted by severity.

update

public void update()

Repaint only opened diagrams of an active project

getAnnotatedElements

public java.util.Collection<BaseElement> getAnnotatedElements()

Returns a collection of annotated elements

Returns:

all annotated elements

getAnnotatedElements

public java.util.Collection<BaseElement> getAnnotatedElements(Annotation.SCOPE scope)

getAnnotatedElements

public java.util.Collection<BaseElement> getAnnotatedElements(@CheckForNull
                                                              java.util.EnumSet<Annotation.SCOPE> scopes)

Returns a collection of annotated elements.

Returns:

all annotated elements

getIteratorOfAnnotatedElements

public java.util.Iterator<BaseElement> getIteratorOfAnnotatedElements(@CheckForNull
                                                                      BaseElement owner)

Returns a collection of annotated elements

Returns:

all annotated elements

update

public void update(java.util.Collection<Annotation> removed,
                   java.util.Collection<Annotation> added)

Updates annotation manager using specified data. No need to call update() method.

Parameters:

removed - collection of removed annotations.

added - collection of added annotations.

addListener

public void addListener(AnnotationManagerListener listener)

removeListener

public void removeListener(AnnotationManagerListener listener)

hasAnnotations

public boolean hasAnnotations()