Skip to main content
Jump to: navigation, search

Difference between revisions of "MDT/Papyrus/UserGuide/Symbols"

< MDT‎ | Papyrus
Line 62: Line 62:
 
[[Image:Symbol_ActorAndTypedElementWithTypeActor.png]]
 
[[Image:Symbol_ActorAndTypedElementWithTypeActor.png]]
  
== Symbol associated to Type element ==
+
== Symbol associated to Type element ==
 +
 
 +
The last way to associate symbols to model element is to apply the PapryusInternal profile.
 +
 
 +
Steps:
 +
 
 +
*Select the model in which you want to associate symbols to types.
 +
*Go to the property view
 +
*Go to the profile Tab
 +
*Select the icon for the registered profiles in the Applied Profile section
 +
 
 +
[[Image:Symbol_ApplyRegisteredProfile.png]]
 +
 
 +
*In the dialog, select the PapyrusInternal Profile
 +
 
 +
[[Image:Symbol_ProfileSelectionDialog.png]]
 +
 
 +
*In the next dialog, select all profiles and subprofiles
 +
 
 +
[[Image:Symbol_ProfileSelectionDialogAllSubProfile.png]]
 +
 
 +
*OK
 +
 
 +
 
 +
 
 +
As soon as the Internal profile is applied, the user can apply a specific stereotype on Type elements. On this stereotype, a field allows user to define a symbol for the stereotyped Type. Then the symbol will be available for all representations of this Type and the representations of TypedElements typed by it.
 +
 
 +
Steps:
 +
 
 +
*Select the Type for which you want to associate a symbol
 +
*Go to the property view
 +
*<br>
  
 
= FAQ =
 
= FAQ =

Revision as of 11:25, 5 June 2013

This short documentation will present the support for custom representations available to Papyrus users

Introduction

The goal of the sympbol support in Papyrus is to give users access to some custom representations. They can use their own representation, i.e. their own svg files, in their diagrams, so the model can be easily read and understood. SVG file format was used, as this vectorial format scales easily.

Symbol Example.png

Symbol display place in diagrams

There are 2 manners to display symbols on the diagrams.

Symbol representation in compartments

For all nodes, like Package or Class in a Class diagram, it is possible to display the symbols in a "shape" compartment. This compartment can be displayed/hidden using the context menu on the diagram

Symbol Compartment.png

To display/hide shape compartment: 

  • Right click on the node
  • Filters
  • Show/Hide Compartments
  • Select "shape". you can also select if you wish to show/hide the title of the shape compartment.
  • OK


Hint: you can also select the node and press 'Ctrl'+'F5' simultaneously to display the Show/hide Compartment dialog

Symbol representation as a decorator

For all Nodes in diagrams, it is possible to display the available symbols as decorators. The decorators are small representations depicted above the figures. for example, validation errors and warnings are displayed as decorators on Papyrus diagrams.

Symbol Decorator.png

The Appearance tab of the properties view allows user to toggle the visibility of decorators, and the location of the display on the figure. There are 9 positions on the figure (north/east/south/west and all valid combinations)

Symbol DecoratorPropertyView.png

Hint: if the properties view is not displayed in your Eclipse environnement, you can display it using context menu on a diagram => show Properties view.

Defining symbols in models

This section explains how symbols can be associated to model elements. There are currently 3 ways to define specific symbols for model elements.

Define new symbols in profiles

UML offers the possiblity to associate new icons to stereotyped elements, via the image Property of Stereotypes. In Papyrus, one of this image can be a shape. This shape will be availalbe for any node representation of a steoretyped element.

On the property view of a Stereotype, you can associate an image to the stereotype

Symbol AddImageToStereotype.png

This shape wil now be available on all elements that are stereotyped by this given Stereotype.

Hint: You can have more documentation about profiles in Papyrus on the website, users corner

Symbol associated to Actor UML element

By default, Actors and TypedElement that are typed by an Actor have a stickman symbol associated.

Symbol ActorAndTypedElementWithTypeActor.png

Symbol associated to Type element

The last way to associate symbols to model element is to apply the PapryusInternal profile.

Steps:

  • Select the model in which you want to associate symbols to types.
  • Go to the property view
  • Go to the profile Tab
  • Select the icon for the registered profiles in the Applied Profile section

Symbol ApplyRegisteredProfile.png

  • In the dialog, select the PapyrusInternal Profile

Symbol ProfileSelectionDialog.png

  • In the next dialog, select all profiles and subprofiles

Symbol ProfileSelectionDialogAllSubProfile.png

  • OK


As soon as the Internal profile is applied, the user can apply a specific stereotype on Type elements. On this stereotype, a field allows user to define a symbol for the stereotyped Type. Then the symbol will be available for all representations of this Type and the representations of TypedElements typed by it.

Steps:

  • Select the Type for which you want to associate a symbol
  • Go to the property view

FAQ

  • What is the format supported for the symbols?
  • What are the limitations of the SVG support?
  • What is the syntax for the path to the symbol?
  • (Developers) Can I implement my own policy for Symbol support?

Copyright © Eclipse Foundation, Inc. All Rights Reserved.