Package com.nomagic.magicdraw.uml.symbols

Class DiagramPresentationElement

java.lang.Object

com.nomagic.magicdraw.uml.MDElementImpl

com.nomagic.magicdraw.uml.symbols.PresentationElement

com.nomagic.magicdraw.uml.symbols.AbstractDiagramPresentationElement

com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement

All Implemented Interfaces:

com.nomagic.magicdraw.core.diagram.DiagramPresentationImplementer, BaseElement, MDElement, ModelElementProvider, com.nomagic.magicdraw.uml.symbols.shapes.DiagramFrameHeaderOwner, StereotypesDisplayModeOwner, NameOwner, PropertyChangeListener, Cloneable, Comparable, EventListener

@OpenApi
public class DiagramPresentationElement
extends AbstractDiagramPresentationElement
implements com.nomagic.magicdraw.uml.symbols.shapes.DiagramFrameHeaderOwner, StereotypesDisplayModeOwner, com.nomagic.magicdraw.core.diagram.DiagramPresentationImplementer

Class for representing UML diagram. Diagram purpose is to contain set of presentation elements.
For diagram creation use ModelElementsManager class.
For working with diagram presentation elements use PresentationElementsManager class.

See Also:

• ModelElementsManager
• PresentationElementsManager

Field Summary

Fields inherited from class com.nomagic.magicdraw.uml.symbols.PresentationElement

DASHED_STROKE, DOTTED_STROKE, SOLID_STROKE

Fields inherited from interface com.nomagic.magicdraw.uml.symbols.shapes.StereotypesDisplayModeOwner

DSL_STEREOTYPE_DISPLAY_MODE_ALL, DSL_STEREOTYPE_DISPLAY_MODE_LAST, DSL_STEREOTYPE_DISPLAY_MODE_NONE, DSL_STEREOTYPE_DISPLAY_MODES, STEREOTYPE_DISPLAY_MODE_DO_NOT_DISPLAY_STEREOTYPES, STEREOTYPE_DISPLAY_MODE_ICON, STEREOTYPE_DISPLAY_MODE_SHAPE_IMAGE, STEREOTYPE_DISPLAY_MODE_SHAPE_IMAGE_AND_TEXT, STEREOTYPE_DISPLAY_MODE_TEXT, STEREOTYPE_DISPLAY_MODE_TEXT_AND_ICON, STEREOTYPES_DISPLAY_MODES, STEREOTYPES_DISPLAY_MODES_SIMPLE

Constructor Summary

Constructors

Constructor	Description
DiagramPresentationElement()	Constructs new empty diagram.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)	Method accepts visitor, and calls method visit<class name>(this) of visitor .
Diagram	getDiagram()	Returns Diagram model element of this presentation element.
DiagramFrameView	getDiagramFrame()	Get the frame of the diagram.
DiagramType	getDiagramType()	Returns the type of the diagram.
Collection<Element>	getUsedModelElements()	Returns collection of model elements that have views in this diagram.
Collection<Element>	getUsedModelElements(boolean checkOnlyPersistent)	Deprecated. checkOnlyPersistent parameter is ignored.
Set<Element>	getUsedModelElements(UsedElementPolicy usedElementPolicy)	Returns collection of model elements that are used in this diagram.
boolean	isElementInDiagram(Element element)	Checks if given element exist in any diagram.
boolean	isElementInDiagram(Element element, UsedElementPolicy usedElementPolicy)	Checks if given element exist in any diagram.
boolean	isInitialFrameSizeSet()
void	setDiagramType(DiagramType type)	Sets the type of the diagram and fires the property change event with name ExtendedPropertyNames.EDIT_DIAGRAM_TYPE .
void	setInitialFrameSizeSet(boolean value)	Set a flag that diagram frame size should not be recalculated on opening.
void	sSetDiagramType(DiagramType type)	Sets the type of the diagram.

Methods inherited from class com.nomagic.magicdraw.uml.symbols.AbstractDiagramPresentationElement

addContentPropertyChangeListener, close, collectPresentationElementsRecursively, collectShowingManipulatedElementsRecursively, collectShowingPresentationElementsRecursively, ensureLoaded, findPresentationElement, findPresentationElement, findPresentationElementForPathConnecting, findPresentationElementsForPathConnecting, isLoaded, isSymbolDiagram, layout, layout, layout, open, open, openInActiveTab, removeContentPropertyChangeListener

Methods inherited from class com.nomagic.magicdraw.uml.symbols.PresentationElement

addProperty, collectSubManipulatedElements, editName, editName, getBoundsShape, getDiagramPresentationElement, getManipulatedParent, getManipulatedPresentationElements, getMiddlePoint, getObjectParent, getParent, getPreferredDimension, getPreferredSize, getPresentationElementStroke, getPresentationElementStroke, getPropertyManager, getSelected, getStroke, getStroke, getStroke, getStroke, getStroke, getStroke, hasManipulatedPresentationElements, isSelected, onFind, onFind, setAllSelected, setSelected, setSelected

Methods inherited from class com.nomagic.magicdraw.uml.MDElementImpl

accept, canAdd, canAddChild, canBeDeleted, compareTo, createSortKeys, getClassType, getCommandForAppending, getProject, getProjectProvider, getResourceID, getSortKeys, hasListeners, isEditable, removeAllParents, removeAllPropertyChangeListeners, setProjectProvider, sGetID, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nomagic.magicdraw.uml.BaseElement

canAdd

Constructor Details

DiagramPresentationElement

@OpenApi
public DiagramPresentationElement()

Constructs new empty diagram. Do not use this constructor to create a diagram explicitly. Open API provides method for diagrams creation.

See Also:

• ModelElementsManager.createDiagram(String, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Namespace)

Method Details

sSetDiagramType

@OpenApi
public void sSetDiagramType(@CheckForNull
 DiagramType type)

Sets the type of the diagram.

Parameters:

type - the type of the diagram

setDiagramType

@OpenApi
public void setDiagramType(DiagramType type)

Sets the type of the diagram and fires the property change event with name ExtendedPropertyNames.EDIT_DIAGRAM_TYPE .

Parameters:

type - the type of the diagram

See Also:

• ExtendedPropertyNames.EDIT_DIAGRAM_TYPE
• Project

getDiagramType

@OpenApi
public DiagramType getDiagramType()

Returns the type of the diagram.

Returns:

the type of the diagram

See Also:

• DiagramTypes.UML_CLASS_DIAGRAM
• DiagramTypes.UML_USECASE_DIAGRAM
• DiagramTypes.UML_COMMUNICATION_DIAGRAM
• DiagramTypes.UML_SEQUENCE_DIAGRAM
• DiagramTypes.UML_STATECHART_DIAGRAM
• DiagramTypes.UML_PROTOCOL_STATE_MACHINE_DIAGRAM
• DiagramTypes.UML_ACTIVITY_DIAGRAM
• DiagramTypes.UML_COMPOSITE_STRUCTURE_DIAGRAM
• DiagramTypes.UML_OBJECT_DIAGRAM
• DiagramTypes.UML_PACKAGE_DIAGRAM
• DiagramTypes.UML_COMPONENT_DIAGRAM
• DiagramTypes.UML_DEPLOYMENT_DIAGRAM
• DiagramTypes.UML_PROFILE_DIAGRAM

getDiagram

@OpenApi
public Diagram getDiagram()

Returns Diagram model element of this presentation element.

Returns:

Diagram object of this element.

See Also:

• getElement()

accept

@OpenApi
public void accept(Visitor visitor)
            throws Exception

Description copied from interface: MDElement

Method accepts visitor, and calls method visit<class name>(this) of visitor . See Visitor pattern for more details.

Specified by:

accept in interface MDElement

Overrides:

accept in class AbstractDiagramPresentationElement

Parameters:

visitor - which visits this element.

Throws:

Exception

getUsedModelElements

@OpenApi
@Deprecated
public Collection<Element> getUsedModelElements(boolean checkOnlyPersistent)

Deprecated.

checkOnlyPersistent parameter is ignored. Use getUsedModelElements()

Returns collection of model elements that are drawn in this diagram.

Parameters:

checkOnlyPersistent - if true, result includes elements for symbols which are saved to XMI and not created at run-time. If false, includes all elements.

Returns:

collection of model elements.

getUsedModelElements

@OpenApi
public Collection<Element> getUsedModelElements()

Returns collection of model elements that have views in this diagram.

Returns:

collection of model elements.

getUsedModelElements

@OpenApi
public Set<Element> getUsedModelElements(UsedElementPolicy usedElementPolicy)

Returns collection of model elements that are used in this diagram.

Parameters:

usedElementPolicy - used element policy

Returns:

collection of model elements.

isElementInDiagram

@OpenApi
public boolean isElementInDiagram(Element element)

Checks if given element exist in any diagram.

Parameters:

element - element

Returns:

true if element exist in any diagram otherwise false

isElementInDiagram

@OpenApi
public boolean isElementInDiagram(Element element,
 UsedElementPolicy usedElementPolicy)

Checks if given element exist in any diagram.

Parameters:

element - element

Returns:

true if element exist in any diagram otherwise false

getDiagramFrame

@OpenApi
@CheckForNull
public DiagramFrameView getDiagramFrame()

Get the frame of the diagram.

Returns:

frame of the diagram.

isInitialFrameSizeSet

@OpenApi
public boolean isInitialFrameSizeSet()

Returns:

false if diagram frame size should not be recalculated on opening.

setInitialFrameSizeSet

@OpenApi
public void setInitialFrameSizeSet(boolean value)

Set a flag that diagram frame size should not be recalculated on opening.

Parameters:

value - new value