Package com.nomagic.magicdraw.validation

Class OpenedDiagramValidator

java.lang.Object

com.nomagic.magicdraw.validation.DiagramValidator

com.nomagic.magicdraw.validation.OpenedDiagramValidator

All Implemented Interfaces:

com.nomagic.magicdraw.core.diagram.DiagramsChangeListener, ValidationRule

@OpenApiAll
public abstract class OpenedDiagramValidator
extends DiagramValidator
implements com.nomagic.magicdraw.core.diagram.DiagramsChangeListener

Works the same as the base rule DiagramValidator, but narrows the scope down only to currently opened diagrams. When creating annotations, the diagrams in scope should be retrieved by using DiagramValidator.getDiagrams() method.

Constructor Summary

Constructors

Constructor	Description
OpenedDiagramValidator()

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptDiagram(DiagramPresentationElement diagram)
void	diagramsChanged(Collection<AbstractDiagramPresentationElement> opened, Collection<AbstractDiagramPresentationElement> closed)	Called when opened diagrams changes.
void	dispose()	Unregisters all listeners that were registered and releases other resources.
void	init(Project project, Constraint constraint)	This is the first method that is invoked on the implementation of the ValidationRule interface.

Methods inherited from class com.nomagic.magicdraw.validation.DiagramValidator

getAnnotations, getDiagrams, getDiagramsStream, getPresentationElements, getPresentationElements, getProject, isElementInScope, needsRun, needsRun, run, setNeedsRun

Methods inherited from class java.lang.Object

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

Constructor Details

OpenedDiagramValidator

public OpenedDiagramValidator()

Method Details

acceptDiagram

protected boolean acceptDiagram(DiagramPresentationElement diagram)

Overrides:

acceptDiagram in class DiagramValidator

Returns:

true if the diagram in scope should be returned by DiagramValidator.getDiagrams() method

init

public void init(Project project,
 Constraint constraint)

Description copied from interface: ValidationRule

This is the first method that is invoked on the implementation of the ValidationRule interface. Implementation can initialize internal state if required.

Specified by:

init in interface ValidationRule

Overrides:

init in class DiagramValidator

Parameters:

project - a project of the constraint

constraint - a constraint object

diagramsChanged

public void diagramsChanged(Collection<AbstractDiagramPresentationElement> opened,
 Collection<AbstractDiagramPresentationElement> closed)

Called when opened diagrams changes. Should not be called manually.

Specified by:

diagramsChanged in interface com.nomagic.magicdraw.core.diagram.DiagramsChangeListener

Parameters:

opened - newly opened diagrams including inner diagrams displayed within them.

closed - newly closed diagrams including inner diagrams, if the diagrams are no longer open in any other tab.

dispose

public void dispose()

Description copied from class: DiagramValidator

Unregisters all listeners that were registered and releases other resources.

Specified by:

dispose in interface ValidationRule

Overrides:

dispose in class DiagramValidator