diff options
| author | ptessier | 2014-06-30 12:03:05 +0000 |
|---|---|---|
| committer | ptessier | 2014-06-30 12:03:05 +0000 |
| commit | a8db868b58a7f1c07d1a6da4089c3af140060e09 (patch) | |
| tree | 3e09de7e33d47ed65dc60f686996fbbab673fdb1 /plugins | |
| parent | 76e9548ba44554c12115701bef4c5e352e571c26 (diff) | |
| parent | af80d74c63445132e36613baf71804bee07e991e (diff) | |
| download | org.eclipse.papyrus-a8db868b58a7f1c07d1a6da4089c3af140060e09.tar.gz org.eclipse.papyrus-a8db868b58a7f1c07d1a6da4089c3af140060e09.tar.xz org.eclipse.papyrus-a8db868b58a7f1c07d1a6da4089c3af140060e09.zip | |
Merge branch 'master' of ssh://ptessier@git.eclipse.org:29418/papyrus/org.eclipse.papyrus
Diffstat (limited to 'plugins')
43 files changed, 371 insertions, 59 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/.classpath b/plugins/doc/org.eclipse.papyrus.moka.doc/.classpath new file mode 100755 index 00000000000..8a8f1668cdc --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/.classpath @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+ <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/>
+ <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+ <classpathentry kind="src" path="src"/>
+ <classpathentry kind="output" path="bin"/>
+</classpath>
diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/.project b/plugins/doc/org.eclipse.papyrus.moka.doc/.project new file mode 100755 index 00000000000..8435e8d743b --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/.project @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.papyrus.moka.doc</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.jdt.core.javabuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.ManifestBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.SchemaBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.eclipse.pde.PluginNature</nature>
+ <nature>org.eclipse.jdt.core.javanature</nature>
+ </natures>
+</projectDescription>
diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/.settings/org.eclipse.jdt.core.prefs b/plugins/doc/org.eclipse.papyrus.moka.doc/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 00000000000..f287d53cf45 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,7 @@ +eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6
+org.eclipse.jdt.core.compiler.compliance=1.6
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.source=1.6
diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.moka.doc/META-INF/MANIFEST.MF new file mode 100755 index 00000000000..8d04afcaac6 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/META-INF/MANIFEST.MF @@ -0,0 +1,11 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: Moka Documentation (Incubation) +Bundle-SymbolicName: org.eclipse.papyrus.moka.doc;singleton:=true +Bundle-Version: 1.0.0.qualifier +Bundle-Activator: org.eclipse.papyrus.moka.doc.Activator +Bundle-Vendor: Eclipse Modeling Project +Require-Bundle: org.eclipse.core.runtime, + org.eclipse.help;bundle-version="3.6.0" +Bundle-RequiredExecutionEnvironment: JavaSE-1.6 +Bundle-ActivationPolicy: lazy diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/about.html b/plugins/doc/org.eclipse.papyrus.moka.doc/about.html new file mode 100755 index 00000000000..5ddc72c177f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/about.html @@ -0,0 +1,28 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
+<title>About</title>
+</head>
+<body lang="EN-US">
+<h2>About This Content</h2>
+
+<p>November 20, 2008</p>
+<h3>License</h3>
+
+<p>The Eclipse Foundation makes available all content in this plug-in ("Content"). Unless otherwise
+indicated below, the Content is provided to you under the terms and conditions of the
+Eclipse Public License Version 1.0 ("EPL"). A copy of the EPL is available
+at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.
+For purposes of the EPL, "Program" will mean the Content.</p>
+
+<p>If you did not receive this Content directly from the Eclipse Foundation, the Content is
+being redistributed by another party ("Redistributor") and different terms and conditions may
+apply to your use of any object code in the Content. Check the Redistributor's license that was
+provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise
+indicated below, the terms and conditions of the EPL still apply to any source code in the Content
+and such source code may be obtained at <a href="http://www.eclipse.org">http://www.eclipse.org</a>.</p>
+
+</body>
+</html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/build.properties b/plugins/doc/org.eclipse.papyrus.moka.doc/build.properties new file mode 100755 index 00000000000..65c4043115b --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/build.properties @@ -0,0 +1,8 @@ +source.. = src/
+output.. = bin/
+bin.includes = META-INF/,\
+ .,\
+ about.html,\
+ resource/,\
+ plugin.xml
+src.includes = about.html
diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/plugin.pdoc b/plugins/doc/org.eclipse.papyrus.moka.doc/plugin.pdoc new file mode 100755 index 00000000000..d87f4aefba2 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/plugin.pdoc @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<doc:Documentation xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:doc="http://www.eclipse.org/papyrus/documentation/plugin/documentation" description="End-user documentation for MOKA."> + <referent firstName="Arnaud" lastName="Cuccuru" eMail="arnaud.cuccuru@cea.fr" currentCompany="CEA"/> + <referent firstName="Jeremie" lastName="Tatibouet" eMail="jeremie.tatibouet@cea.fr" currentCompany="CEA"/> + <referent firstName="Bruno" lastName="Marquès" eMail="bruno.marques@cea.fr" currentCompany="CEA"/> +</doc:Documentation> diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.moka.doc/plugin.xml new file mode 100755 index 00000000000..53bafee9b90 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/plugin.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+<plugin>
+ <extension
+ point="org.eclipse.help.toc">
+ <toc
+ file="resource/moka-main-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="resource/moka-toc.xml"
+ primary="false">
+ </toc>
+ </extension>
+
+</plugin>
diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml new file mode 100755 index 00000000000..3c1ed7dfd18 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project> + <modelVersion>4.0.0</modelVersion> + <parent> + <artifactId>org.eclipse.papyrus</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.0.0-SNAPSHOT</version> + <relativePath>../../../releng/top-pom-extras.xml</relativePath> + </parent> + <artifactId>org.eclipse.papyrus.moka.doc</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.0.0-SNAPSHOT</version> + <packaging>eclipse-plugin</packaging> +</project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ActiveClassDiagram.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ActiveClassDiagram.png Binary files differnew file mode 100644 index 00000000000..d7b42d11c98 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ActiveClassDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/AnimationConfiguration.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/AnimationConfiguration.png Binary files differnew file mode 100644 index 00000000000..812fbe6d763 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/AnimationConfiguration.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BasicActiveObjectExample.zip b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BasicActiveObjectExample.zip Binary files differnew file mode 100644 index 00000000000..8729e2f8c71 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BasicActiveObjectExample.zip diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BreakpointDiagramView.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BreakpointDiagramView.png Binary files differnew file mode 100644 index 00000000000..32ec55daa83 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BreakpointDiagramView.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BreakpointsView.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BreakpointsView.png Binary files differnew file mode 100644 index 00000000000..4e59ae7f65b --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BreakpointsView.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Debug_Configuration.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Debug_Configuration.png Binary files differnew file mode 100644 index 00000000000..400ecfe1daa --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Debug_Configuration.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/EmptyLaunchConfiguration.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/EmptyLaunchConfiguration.png Binary files differnew file mode 100644 index 00000000000..1af79b7d573 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/EmptyLaunchConfiguration.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/GenerateFactory.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/GenerateFactory.png Binary files differnew file mode 100644 index 00000000000..ccfd5c9a9f9 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/GenerateFactory.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/MyStyleSheets.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/MyStyleSheets.png Binary files differnew file mode 100644 index 00000000000..e5450262eea --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/MyStyleSheets.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/NewStyleSheets.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/NewStyleSheets.png Binary files differnew file mode 100644 index 00000000000..f64cdfa9eef --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/NewStyleSheets.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/New_Configuration.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/New_Configuration.png Binary files differnew file mode 100644 index 00000000000..b613b716098 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/New_Configuration.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Papyrus_Moka_ExecutionEngines.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Papyrus_Moka_ExecutionEngines.png Binary files differnew file mode 100644 index 00000000000..ce252a39b33 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Papyrus_Moka_ExecutionEngines.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/PropertiesView_EmptyStyleSheets.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/PropertiesView_EmptyStyleSheets.png Binary files differnew file mode 100644 index 00000000000..b6b4a6c3af0 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/PropertiesView_EmptyStyleSheets.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/RemoveBreakpoints.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/RemoveBreakpoints.png Binary files differnew file mode 100644 index 00000000000..299d3fa9c9e --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/RemoveBreakpoints.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Setup_launch_configuration.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Setup_launch_configuration.png Binary files differnew file mode 100644 index 00000000000..ec20e9e1d3f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Setup_launch_configuration.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ThreadStatusView_empty.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ThreadStatusView_empty.png Binary files differnew file mode 100644 index 00000000000..3d55740a814 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ThreadStatusView_empty.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToggleBreakpoint.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToggleBreakpoint.png Binary files differnew file mode 100644 index 00000000000..971f72af9f6 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToggleBreakpoint.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToggleBreakpointModelExplorer.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToggleBreakpointModelExplorer.png Binary files differnew file mode 100644 index 00000000000..2fd1644792e --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToggleBreakpointModelExplorer.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToogleBreakpointActivation.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToogleBreakpointActivation.png Binary files differnew file mode 100644 index 00000000000..b563f8acf4c --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToogleBreakpointActivation.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/VariableView.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/VariableView.png Binary files differnew file mode 100644 index 00000000000..d64ef6433e5 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/VariableView.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Window_Preferences.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Window_Preferences.png Binary files differnew file mode 100644 index 00000000000..b3d99eda6aa --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Window_Preferences.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/modelExplorer_Create.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/modelExplorer_Create.png Binary files differnew file mode 100644 index 00000000000..051f1e5a8ec --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/modelExplorer_Create.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-main-toc.xml b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-main-toc.xml new file mode 100755 index 00000000000..75384be892a --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-main-toc.xml @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?>
+<toc label="Model Execution" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser">
+ <topic href="resource/moka.html" label="Execute UML Models using MOKA">
+ <link toc="resource/moka-toc.xml"/>
+ <anchor id="ModelExecution"/>
+ </topic>
+</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-toc.xml b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-toc.xml new file mode 100755 index 00000000000..5e78a64999c --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-toc.xml @@ -0,0 +1,16 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc topic="resource/moka.html" label="moka"> + <topic href="resource/moka.html" label="Moka Overview"> + <topic href="resource/moka.html#Based_on_standards" label="Based on standards"></topic> + <topic href="resource/moka.html#Interactive_executions" label="Interactive executions"></topic> + <topic href="resource/moka.html#Extensible_framework" label="Extensible framework"></topic> + </topic> + <topic href="resource/moka.html#Getting_started_with_Moka" label="Getting started with Moka"> + <topic href="resource/moka.html#Your_first_executable_model" label="Your first executable model"></topic> + <topic href="resource/moka.html#Selecting_the_execution_engine" label="Selecting the execution engine"></topic> + <topic href="resource/moka.html#Starting_an_execution_with_a_launch_configuration" label="Starting an execution with a launch configuration"></topic> + <topic href="resource/moka.html#Managing_breakpoints" label="Managing breakpoints"></topic> + <topic href="resource/moka.html#Controlling_Executions" label="Controlling Executions"></topic> + <topic href="resource/moka.html#Configuring_animation" label="Configuring animation"></topic> + </topic> +</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.html b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.html new file mode 100755 index 00000000000..c753da1052a --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.html @@ -0,0 +1 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/></head><body><h1 id="Moka_Overview">Moka Overview</h1><p>Moka is a Papyrus module for execution of UML models, which natively includes an execution engine complying with OMG standards foundational UML (fUML <a href="http://www.omg.org/spec/FUML/">http://www.omg.org/spec/FUML/</a>) and Precise Semantics of UML Composite Structures (PSCS <i>[link to OMG webpage available soon</i>]). These standards deal with execution semantics of UML. Moka is integrated with the Eclipse debug framework to provide control, observation and animation facilities over executions. Moka can be easily extended to support alternative execution semantics, and thereby be adapted to multiple usage scenarios and domains. The key features of Moka are:</p><h2 id="Based_on_standards">Based on standards</h2><p>Moka provides basic execution and debugging facilities for fUML and its extension PSCS, which capture an executable subset of UML with precise and standard semantics. This subset is expressive enough to model structure and behavior of systems involving concurrent communicating entities, independently of technological platform details.</p><h2 id="Interactive_executions">Interactive executions</h2><p>Moka provides debug and animation facilities through a contribution and an extension to the Eclipse debug API. It is thereby possible to control execution of models(e.g., suspending/resuming executions after breakpoints have been encountered) as well as to observing states of executed models at runtime (e.g., emphasizing graphical views of model elements on which execution has suspended, retrieving and displaying any state information about the runtime manifestation of these model elements).</p><h2 id="Extensible_framework">Extensible framework</h2><p>Moka can be easily extended to address new execution semantics. This can be done through extension points enabling registration of executable model libraries (e.g., new MoCs, trace libraries, etc.) or simply tool-level extensions of the execution engine.</p><h1 id="Getting_started_with_Moka">Getting started with Moka</h1><h2 id="Your_first_executable_model">Your first executable model</h2><p>This tutorial is based on a simple executable model. It consists in an active class, with a classifier behavior that indefinitely increments a counter. The corresponding Papyrus model is available here <a href="https://wiki.eclipse.org/File:BasicActiveObjectExample.zip">https://wiki.eclipse.org/File:BasicActiveObjectExample.zip</a>. Download it, define a project in your workspace, and then import the model in this project. Once the model is imported and open in Papyrus, the Increment class should look like:</p><p><img title="The active class increment" alt="The active class increment" border="0" src="ActiveClassDiagram.png"/></p><p>The behaviors associated with this class (i.e., IncrementClassifierBehavior, which is the classifier behavior, and incrementMethod, which is the implementation of operation increment) are specified by activity diagrams. Corresponding activities are executable, according to the semantics given in OMG standards fUML and PSCS. Anyway, in fUML and PSCS, the execution of a model usually starts by executing a kind of "main" activity, which is responsible for instantiating objects, and stimulate them if needed (through signals or operation calls). Moka provides some facilities to generate this kind of activities. Just right click on class Increment, then go to Moka / Modeling Utils / Generate Factory.</p><p><img border="0" src="GenerateFactory.png"/></p><p>A factory activity for class Increment (Increment_Factory in the figure below) is then generated. This activity will be used in the next steps of this tutorial to actually start the execution of the model. Do not forget to save your model, otherwise the factory will not be visible in the launch configuration definition step described below in this tutorial.</p><p><img border="0" src="modelExplorer_Create.png"/></p><h2 id="Selecting_the_execution_engine">Selecting the execution engine</h2><p>Since Moka is an extensible execution framework, multiple execution engines can be registered in your environment. Before starting an execution, you should make sure that the appropriate execution engine is selected. To do so, go to Eclipse preferences, as shown in the figure below.</p><p><img border="0" src="Window_Preferences.png"/></p><p>Once the preference page is open, go to Papyrus/Moka. Moka is released with 3 execution engines. There are two versions of the PSCS execution engine (one is multi-threaded, with on thread per active object, and the other one is single-threaded). There is also an implementation of the fUML execution engine.</p><p><img border="0" src="Papyrus_Moka_ExecutionEngines.png"/></p><p>To make sure that the Increment example properly executes, you should select one of the two PSCS engines, press Apply and then OK.</p><h2 id="Starting_an_execution_with_a_launch_configuration">Starting an execution with a launch configuration</h2><p>Moka is integrated with the Eclipse Debug Framework. It implies that, in order to start an execution, a launch configuration has to be defined. A launch configuration can be created by clicking on the "Debug As" tool from the Eclipse tool bar, and then by pressing Debug Configurations.</p><p><img border="0" src="Debug_Configuration.png"/></p><p>Then create a new Moka launch configuration, as shown in the figure below.</p><p><img border="0" src="New_Configuration.png"/></p><p>A Moka launch configuration requires two pieces of information: the UML model from which the execution will be started, and the actual model element to be executed.</p><p><img border="0" src="EmptyLaunchConfiguration.png"/></p><p>Press the Browse button to select a UML model from your workspace (a .uml file shall be selected). Then, select the actual model element to be executed in the list "Element to be executed". This list is sorted alphabetically, by qualified names. Note that, in the case of the fUML and PSCS execution engines provided by Moka, the "Element to be executed" shall be an Activity. Your launch configuration should now look like:</p><p><img border="0" src="Setup_launch_configuration.png"/></p><p>To start the execution, simply press the Debug button. In our example, according to the semantics of PSCS, the effect of executing activity Increment_Factory will be to instantiate an Increment object, to construct this object (please refer to the default construction strategy described in the PSCS specification), and then start its classifier behavior. Our increment object will start to increment, and will go on until you stop the execution. Note that a Launch configuration is a persistent artifact, so that, if you close Papyrus and then open it again, your launch configuration will still be available, and you will be able to relaunch it.</p><h2 id="Managing_breakpoints">Managing breakpoints</h2><p>In order to easily observe and control the state of you model at some specific points of the execution, Moka lets you associate breakpoints with model elements. This can be done through the contextual menu Moka/Debug, which is available from the model explorer and from diagrams.</p><p><img border="0" src="ToggleBreakpointModelExplorer.png"/></p><p><img border="0" src="ToggleBreakpoint.png"/></p><p>Once a breakpoint has been created, a small icon (blue circle) appears on top of the corresponding model element.</p><p><img border="0" src="BreakpointDiagramView.png"/></p><p>Using the Moka/Debug menu, an existing breakpoing can also be de-activated (without being removed), using the "Toggle breakpoint activation" button. In this case, it will be depicted by a small white circle on top of the corresponding model element.</p><p><img border="0" src="ToogleBreakpointActivation.png"/></p><p>The set of existing breakpoints (as well as their status - Enabled / Disabled) is given in the breakpoint control panel, which is usually located in the upper, righ-hand part of the Debug perspective.</p><p><img border="0" src="BreakpointsView.png"/></p><p>The breakpoint control panel more generally lets you enable, disable and remove breakpoints. Just right click in the panel, as depicted in the figure below.</p><p><img border="0" src="RemoveBreakpoints.png"/></p><p>From an execution standpoint, it is important to note that the selected execution engine (see section on "Selecting the execution engine") is responsible for interpreting breakpoints. In the case of the fUML and PSCS execution engines provided by Moka, only breakpoints associated with activity nodes or edges will be taken into account (even if Moka lets you associate breakpoints with any kind of model element). Other breakpoints are simply ignored.</p><h2 id="Controlling_Executions">Controlling Executions</h2><p>Executions can be controlled using the execution control panel, provided by the Eclipse Debug perspective.</p><p><img border="0" src="ThreadStatusView_empty.png"/></p><p>It is thereby possible to resume, suspend, stop, or even do step-by-step executions. Note also that, when execution is suspended, variables may be observable in the variable panel.</p><p><img border="0" src="VariableView.png"/></p><p>The selected execution engine is responsible to determine what the visible variables are in the context of an execution. In the case of the fUML and PSCS engines provided by Moka, visible variables are properties of the context object in which in the suspended activity is executing (in our example, the suspended activity is the classifier behavior of class Increment, which executes in the context of a particular Increment object, which holds a value for property counter).</p><h2 id="Configuring_animation">Configuring animation</h2><p>By default, Moka is configured to animate diagrams during executions, without automatically giving focus / making visible a diagram where a model element being executed has a graphical representation. This can be configured in the Animation control panel, which is available in the Debug perspective.</p><p><img border="0" src="AnimationConfiguration.png"/></p><p>The slide bar enables to control the artificial animation delay between two animation steps. Note that option "Open diagrams automatically" may decrease performances of the execution engine. By default, Moka is released with some default animation styles, which determine the emphasis style to be applied to graphical elements when the execution is suspended, or more generally for animation. This default style can be overloaded per diagram, by attaching a CSS style sheet, as depicted in the figures below.</p><p><img border="0" src="PropertiesView_EmptyStyleSheets.png"/></p><p><img border="0" src="NewStyleSheets.png"/></p><p><img border="0" src="MyStyleSheets.png"/></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.mediawiki b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.mediawiki new file mode 100755 index 00000000000..cf4262b98af --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.mediawiki @@ -0,0 +1,115 @@ += Moka Overview = +Moka is a Papyrus module for execution of UML models, which natively includes an execution engine complying with OMG standards foundational UML (fUML [http://www.omg.org/spec/FUML/]) and Precise Semantics of UML Composite Structures (PSCS ''[link to OMG webpage available soon'']). These standards deal with execution semantics of UML. Moka is integrated with the Eclipse debug framework to provide control, observation and animation facilities over executions. Moka can be easily extended to support alternative execution semantics, and thereby be adapted to multiple usage scenarios and domains. The key features of Moka are: + +== Based on standards == + +Moka provides basic execution and debugging facilities for fUML and its extension PSCS, which capture an executable subset of UML with precise and standard semantics. This subset is expressive enough to model structure and behavior of systems involving concurrent communicating entities, independently of technological platform details. + +== Interactive executions == + +Moka provides debug and animation facilities through a contribution and an extension to the Eclipse debug API. It is thereby possible to control execution of models(e.g., suspending/resuming executions after breakpoints have been encountered) as well as to observing states of executed models at runtime (e.g., emphasizing graphical views of model elements on which execution has suspended, retrieving and displaying any state information about the runtime manifestation of these model elements). + +== Extensible framework == + +Moka can be easily extended to address new execution semantics. This can be done through extension points enabling registration of executable model libraries (e.g., new MoCs, trace libraries, etc.) or simply tool-level extensions of the execution engine. + += Getting started with Moka = + +== Your first executable model == + +This tutorial is based on a simple executable model. It consists in an active class, with a classifier behavior that indefinitely increments a counter. The corresponding Papyrus model is available here [https://wiki.eclipse.org/File:BasicActiveObjectExample.zip]. Download it, define a project in your workspace, and then import the model in this project. Once the model is imported and open in Papyrus, the Increment class should look like: + +[[Image:ActiveClassDiagram.png|The active class increment]] + +The behaviors associated with this class (i.e., IncrementClassifierBehavior, which is the classifier behavior, and incrementMethod, which is the implementation of operation increment) are specified by activity diagrams. Corresponding activities are executable, according to the semantics given in OMG standards fUML and PSCS. Anyway, in fUML and PSCS, the execution of a model usually starts by executing a kind of "main" activity, which is responsible for instantiating objects, and stimulate them if needed (through signals or operation calls). Moka provides some facilities to generate this kind of activities. Just right click on class Increment, then go to Moka / Modeling Utils / Generate Factory. + +[[Image:GenerateFactory.png]] + +A factory activity for class Increment (Increment_Factory in the figure below) is then generated. This activity will be used in the next steps of this tutorial to actually start the execution of the model. Do not forget to save your model, otherwise the factory will not be visible in the launch configuration definition step described below in this tutorial. + +[[Image:modelExplorer_Create.png]] + +== Selecting the execution engine == + +Since Moka is an extensible execution framework, multiple execution engines can be registered in your environment. Before starting an execution, you should make sure that the appropriate execution engine is selected. To do so, go to Eclipse preferences, as shown in the figure below. + +[[Image:Window_Preferences.png]] + +Once the preference page is open, go to Papyrus/Moka. Moka is released with 3 execution engines. There are two versions of the PSCS execution engine (one is multi-threaded, with on thread per active object, and the other one is single-threaded). There is also an implementation of the fUML execution engine. + +[[Image:Papyrus_Moka_ExecutionEngines.png]] + +To make sure that the Increment example properly executes, you should select one of the two PSCS engines, press Apply and then OK. + +== Starting an execution with a launch configuration == + +Moka is integrated with the Eclipse Debug Framework. It implies that, in order to start an execution, a launch configuration has to be defined. A launch configuration can be created by clicking on the "Debug As" tool from the Eclipse tool bar, and then by pressing Debug Configurations. + +[[Image:Debug_Configuration.png]] + +Then create a new Moka launch configuration, as shown in the figure below. + +[[Image:New_Configuration.png]] + +A Moka launch configuration requires two pieces of information: the UML model from which the execution will be started, and the actual model element to be executed. + +[[Image:EmptyLaunchConfiguration.png]] + +Press the Browse button to select a UML model from your workspace (a .uml file shall be selected). Then, select the actual model element to be executed in the list "Element to be executed". This list is sorted alphabetically, by qualified names. Note that, in the case of the fUML and PSCS execution engines provided by Moka, the "Element to be executed" shall be an Activity. Your launch configuration should now look like: + +[[Image:Setup_launch_configuration.png]] + +To start the execution, simply press the Debug button. In our example, according to the semantics of PSCS, the effect of executing activity Increment_Factory will be to instantiate an Increment object, to construct this object (please refer to the default construction strategy described in the PSCS specification), and then start its classifier behavior. Our increment object will start to increment, and will go on until you stop the execution. Note that a Launch configuration is a persistent artifact, so that, if you close Papyrus and then open it again, your launch configuration will still be available, and you will be able to relaunch it. + +== Managing breakpoints == + +In order to easily observe and control the state of you model at some specific points of the execution, Moka lets you associate breakpoints with model elements. This can be done through the contextual menu Moka/Debug, which is available from the model explorer and from diagrams. + +[[Image:ToggleBreakpointModelExplorer.png]] + +[[Image:ToggleBreakpoint.png]] + +Once a breakpoint has been created, a small icon (blue circle) appears on top of the corresponding model element. + +[[Image:BreakpointDiagramView.png]] + +Using the Moka/Debug menu, an existing breakpoing can also be de-activated (without being removed), using the "Toggle breakpoint activation" button. In this case, it will be depicted by a small white circle on top of the corresponding model element. + +[[Image:ToogleBreakpointActivation.png]] + +The set of existing breakpoints (as well as their status - Enabled / Disabled) is given in the breakpoint control panel, which is usually located in the upper, righ-hand part of the Debug perspective. + +[[Image:BreakpointsView.png]] + +The breakpoint control panel more generally lets you enable, disable and remove breakpoints. Just right click in the panel, as depicted in the figure below. + +[[Image:RemoveBreakpoints.png]] + +From an execution standpoint, it is important to note that the selected execution engine (see section on "Selecting the execution engine") is responsible for interpreting breakpoints. In the case of the fUML and PSCS execution engines provided by Moka, only breakpoints associated with activity nodes or edges will be taken into account (even if Moka lets you associate breakpoints with any kind of model element). Other breakpoints are simply ignored. + +== Controlling Executions == + +Executions can be controlled using the execution control panel, provided by the Eclipse Debug perspective. + +[[Image:ThreadStatusView_empty.png]] + +It is thereby possible to resume, suspend, stop, or even do step-by-step executions. Note also that, when execution is suspended, variables may be observable in the variable panel. + +[[Image:VariableView.png]] + +The selected execution engine is responsible to determine what the visible variables are in the context of an execution. In the case of the fUML and PSCS engines provided by Moka, visible variables are properties of the context object in which in the suspended activity is executing (in our example, the suspended activity is the classifier behavior of class Increment, which executes in the context of a particular Increment object, which holds a value for property counter). + +== Configuring animation == + +By default, Moka is configured to animate diagrams during executions, without automatically giving focus / making visible a diagram where a model element being executed has a graphical representation. This can be configured in the Animation control panel, which is available in the Debug perspective. + +[[Image:AnimationConfiguration.png]] + +The slide bar enables to control the artificial animation delay between two animation steps. Note that option "Open diagrams automatically" may decrease performances of the execution engine. By default, Moka is released with some default animation styles, which determine the emphasis style to be applied to graphical elements when the execution is suspended, or more generally for animation. This default style can be overloaded per diagram, by attaching a CSS style sheet, as depicted in the figures below. + +[[Image:PropertiesView_EmptyStyleSheets.png]] + +[[Image:NewStyleSheets.png]] + +[[Image:MyStyleSheets.png]] + diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/src/org/eclipse/papyrus/moka/doc/Activator.java b/plugins/doc/org.eclipse.papyrus.moka.doc/src/org/eclipse/papyrus/moka/doc/Activator.java new file mode 100755 index 00000000000..71ef3d7fb68 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/src/org/eclipse/papyrus/moka/doc/Activator.java @@ -0,0 +1,30 @@ +package org.eclipse.papyrus.moka.doc;
+
+import org.osgi.framework.BundleActivator;
+import org.osgi.framework.BundleContext;
+
+public class Activator implements BundleActivator {
+
+ private static BundleContext context;
+
+ static BundleContext getContext() {
+ return context;
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)
+ */
+ public void start(BundleContext bundleContext) throws Exception {
+ Activator.context = bundleContext;
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)
+ */
+ public void stop(BundleContext bundleContext) throws Exception {
+ Activator.context = null;
+ }
+
+}
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.html index c74e4681a87..49b57fdb171 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.html +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.html @@ -1,6 +1,6 @@ -<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/></head><body><p>This short documentation will present the support for custom representations available to Papyrus users </p><h1 id="Introduction">Introduction</h1><p>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. </p><p><img border="0" src="Symbol_Example.png"/> </p><h1 id="Symbol_display_place_in_diagrams">Symbol display place in diagrams</h1><p>There are 2 manners to display symbols on the diagrams. </p><h2 id="Symbol_representation_in_compartments">Symbol representation in compartments</h2><p>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 </p><p><img border="0" src="Symbol_Compartment.png"/> </p><p>To display/hide shape compartment: </p><ul><li>Right click on the node </li><li>Filters </li><li>Show/Hide Compartments </li><li>Select "shape". you can also select if you wish to show/hide the title of the shape compartment. </li><li>OK</li></ul><p><br/> </p><pre>Hint: you can also select the node and press 'Ctrl'+'F5' simultaneously to display the Show/hide Compartment dialog -</pre><p> </p><h2 id="Symbol_representation_as_a_decorator">Symbol representation as a decorator</h2><p>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. </p><p><img border="0" src="Symbol_Decorator.png"/> </p><p>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) </p><p><img border="0" src="Symbol_DecoratorPropertyView.png"/> </p><pre>Hint: if the properties view is not displayed in your Eclipse environnement, you can display it using context menu on a diagram =&gt; show Properties view. -</pre><p> </p><h1 id="Defining_symbols_in_models">Defining symbols in models</h1><p>This section explains how symbols can be associated to model elements. There are currently 3 ways to define specific symbols for model elements. </p><h2 id="Define_new_symbols_in_profiles">Define new symbols in profiles</h2><p>UML offers the possiblity to associate new icons to stereotyped elements, via the <i>image</i> 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. </p><p>On the property view of a Stereotype, you can associate an image to the stereotype </p><p><img border="0" src="Symbol_AddImageToStereotype.png"/> </p><p>This shape wil now be available on all elements that are stereotyped by this given Stereotype. </p><pre>Hint: You can have more documentation about profiles in Papyrus on the website, users corner +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/></head><body><ol style="list-style: none;"><li><a href="#Introduction">Introduction</a></li><li><a href="#Symbol_display_place_in_diagrams">Symbol display place in diagrams</a><ol style="list-style: none;"><li><a href="#Symbol_representation_in_compartments">Symbol representation in compartments</a></li><li><a href="#Symbol_representation_as_a_decorator">Symbol representation as a decorator</a></li></ol></li><li><a href="#Defining_symbols_in_models">Defining symbols in models</a><ol style="list-style: none;"><li><a href="#Define_new_symbols_in_profiles">Define new symbols in profiles</a></li><li><a href="#Symbol_associated_to_Actor_UML_element">Symbol associated to Actor UML element</a></li><li><a href="#Symbol_associated_to_Type_element">Symbol associated to Type element</a></li></ol></li><li><a href="#FAQ">FAQ</a></li></ol><p>This short documentation will present the support for custom representations available to Papyrus users </p><h1 id="Introduction">Introduction</h1><p>The goal of the symbol 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. </p><p><img border="0" src="Symbol_Example.png"/> </p><h1 id="Symbol_display_place_in_diagrams">Symbol display place in diagrams</h1><p>There are 2 manners to display symbols on the diagrams, in compartments and as decorators.</p><h2 id="Symbol_representation_in_compartments">Symbol representation in compartments</h2><p>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 </p><p><img border="0" src="Symbol_Compartment.png"/> </p><p>To display/hide shape compartment: </p><ul><li>Right click on the node </li><li>Filters </li><li>Show/Hide Compartments </li><li>Select "shape". you can also select if you wish to show/hide the title of the shape compartment. </li><li>OK</li></ul><p><br/> </p><pre>Hint: you can also select the node and press 'Ctrl'+'F5' simultaneously to display the Show/hide Compartment dialog +</pre><p> </p><h2 id="Symbol_representation_as_a_decorator">Symbol representation as a decorator</h2><p>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. </p><p><img border="0" src="Symbol_Decorator.png"/> </p><p>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) </p><p><img border="0" src="Symbol_DecoratorPropertyView.png"/> </p><pre>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. +</pre><p> </p><h1 id="Defining_symbols_in_models">Defining symbols in models</h1><p>This section explains how symbols can be associated to model elements. There are currently 3 ways to define specific symbols for model elements. </p><h2 id="Define_new_symbols_in_profiles">Define new symbols in profiles</h2><p>UML offers the possiblity to associate new icons to stereotyped elements, via the <i>image</i> Property of Stereotypes. In Papyrus, one of these images can be a shape. This shape will be availalbe for any node representation of a steoretyped element. </p><p>On the property view of a Stereotype, you can associate an image to the stereotype </p><p><img border="0" src="Symbol_AddImageToStereotype.png"/> </p><p>This shape wil now be available on all elements that are stereotyped by this given Stereotype. </p><pre>Hint: You can have more documentation about profiles in Papyrus on the website, users corner </pre><p> </p><h2 id="Symbol_associated_to_Actor_UML_element">Symbol associated to Actor UML element</h2><p>By default, Actors and TypedElement that are typed by an Actor have a stickman symbol associated. </p><p><img border="0" src="Symbol_ActorAndTypedElementWithTypeActor.png"/> </p><h2 id="Symbol_associated_to_Type_element">Symbol associated to Type element</h2><p>The last way to associate symbols to model element is to apply the PapryusInternal profile. </p><p>Steps: </p><ul><li>Select the model in which you want to associate symbols to types. </li><li>Go to the property view </li><li>Go to the profile Tab </li><li>Select the icon for the registered profiles in the Applied Profile section</li></ul><p><img border="0" src="Symbol_ApplyRegisteredProfile.png"/> </p><ul><li>In the dialog, select the PapyrusInternal Profile</li></ul><p><img border="0" src="Symbol_ProfileSelectionDialog.png"/> </p><ul><li>In the next dialog, select all profiles and subprofiles</li></ul><p><img border="0" src="Symbol_ProfileSelectionDialogAllSubProfile.png"/> </p><ul><li>OK</li></ul><p><br/> </p><p>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. </p><p>Steps: </p><ul><li>Select the Type for which you want to associate a symbol </li><li>Go to the property view </li><li>Go to the profile Tab </li><li>Apply the TypeSymbolDefinition stereotype (available on Type elements, as soon as the internal profile is applied on the model)</li></ul><p><img border="0" src="Symbol_ApplyTypeSymbolDefinitionStereotype.png"/> </p><p><img border="0" src="Symbol_ApplyTypeSymbolDefinitionStereotypeDialog.png"/> </p><ul><li>Select the property symbolPath of the TypeSymbolDefinition stereotype.</li></ul><ul><li>Set the path to the symbol file</li></ul><p><img border="0" src="Symbol_TypeSymbolDefinition_SymbolPath.png"/> </p><h1 id="FAQ">FAQ</h1><ul><li>What is the format supported for the symbols?</li></ul><p>Currently, Papyrus supports SVG and PNG files. </p><ul><li>What are the limitations of the SVG support?</li></ul><p>Papyrus relies on a SVG render provided by the GMF project. This renderer do not support all the funny things provided by the SVG format. For example, it is known that the gradients are not supported. If a svg file has some gradient in its definition, it will not be displayed at all by Papryus. </p><ul><li>What is the syntax for the path to the symbol?</li></ul><p>Paths can be expressed as Eclipse URIs (Either absolute or relative to the current model), e.g: </p><pre>platform:/plugin/org.eclipse.papyrus.uml.diagram.common/icons/symbols/actor.svg </pre><p> => This is a svg image contained in the plug-in {oep}.uml.diagram.common </p><pre>Images/logo.svg diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.mediawiki index 0df6c7334ff..c07d80b1d29 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.mediawiki @@ -1,14 +1,16 @@ +__TOC__
+
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.
+The goal of the symbol 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.
[[Image:Symbol Example.png]]
= Symbol display place in diagrams =
-There are 2 manners to display symbols on the diagrams.
+There are 2 manners to display symbols on the diagrams, in compartments and as decorators.
== Symbol representation in compartments ==
@@ -36,7 +38,7 @@ For all Nodes in diagrams, it is possible to display the available symbols as de 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)
[[Image:Symbol DecoratorPropertyView.png]]
-<pre>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.
+<pre>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.
</pre>
= Defining symbols in models =
@@ -44,7 +46,7 @@ This section explains how symbols can be associated to model elements. There are == 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.
+UML offers the possiblity to associate new icons to stereotyped elements, via the ''image'' Property of Stereotypes. In Papyrus, one of these images 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
diff --git a/plugins/infra/gmfdiag/org.eclipse.papyrus.infra.gmfdiag.properties/src/org/eclipse/papyrus/infra/gmfdiag/properties/modelelement/GMFModelElement.java b/plugins/infra/gmfdiag/org.eclipse.papyrus.infra.gmfdiag.properties/src/org/eclipse/papyrus/infra/gmfdiag/properties/modelelement/GMFModelElement.java index b5f765896f2..0df75e11d41 100644 --- a/plugins/infra/gmfdiag/org.eclipse.papyrus.infra.gmfdiag.properties/src/org/eclipse/papyrus/infra/gmfdiag/properties/modelelement/GMFModelElement.java +++ b/plugins/infra/gmfdiag/org.eclipse.papyrus.infra.gmfdiag.properties/src/org/eclipse/papyrus/infra/gmfdiag/properties/modelelement/GMFModelElement.java @@ -1,6 +1,6 @@ /*****************************************************************************
* Copyright (c) 2011 CEA LIST.
- *
+ *
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -36,6 +36,7 @@ import org.eclipse.papyrus.infra.services.labelprovider.service.LabelProviderSer import org.eclipse.papyrus.infra.viewpoints.policy.PolicyChecker;
import org.eclipse.papyrus.infra.viewpoints.policy.ViewPrototype;
import org.eclipse.papyrus.infra.viewpoints.style.StylePackage;
+import org.eclipse.papyrus.infra.widgets.providers.EmptyContentProvider;
import org.eclipse.papyrus.infra.widgets.providers.IStaticContentProvider;
import org.eclipse.papyrus.uml.tools.databinding.PapyrusObservableList;
import org.eclipse.papyrus.uml.tools.databinding.PapyrusObservableValue;
@@ -44,16 +45,16 @@ import org.eclipse.swt.graphics.Image; /**
* A ModelElement to represent an element of the GMF Notation metamodel
- *
+ *
* @author Camille Letavernier
- *
+ *
*/
public class GMFModelElement extends EMFModelElement {
/**
- *
+ *
* Constructor.
- *
+ *
* @param source
* The source element (from the Notation metamodel)
*/
@@ -62,9 +63,9 @@ public class GMFModelElement extends EMFModelElement { }
/**
- *
+ *
* Constructor.
- *
+ *
* @param source
* The source element (from the Notation metamodel)
* @param domain
@@ -77,7 +78,7 @@ public class GMFModelElement extends EMFModelElement { @Override
protected boolean isFeatureEditable(String propertyPath) {
- if (propertyPath.endsWith("owner")) {
+ if(propertyPath.endsWith("owner")) {
return true;
}
return super.isFeatureEditable(propertyPath);
@@ -85,20 +86,22 @@ public class GMFModelElement extends EMFModelElement { @Override
protected IObservable doGetObservable(String propertyPath) {
- if (propertyPath.endsWith("owner")) {
+ if(propertyPath.endsWith("owner")) {
Diagram diagram = (Diagram)source;
Style style = diagram.getStyle(StylePackage.Literals.PAPYRUS_VIEW_STYLE);
- if (style != null)
+ if(style != null) {
return new PapyrusObservableValue(style, StylePackage.Literals.PAPYRUS_VIEW_STYLE__OWNER, domain);
+ }
return new LegacyOwnerObservable(diagram, StylePackage.Literals.PAPYRUS_VIEW_STYLE__OWNER, domain);
- } else if (propertyPath.endsWith("prototype")) {
+ } else if(propertyPath.endsWith("prototype")) {
Diagram diagram = (Diagram)source;
Style style = diagram.getStyle(StylePackage.Literals.PAPYRUS_VIEW_STYLE);
- if (style != null)
+ if(style != null) {
return new PapyrusObservableValue(style, StylePackage.Literals.PAPYRUS_VIEW_STYLE__CONFIGURATION, domain);
+ }
return new LegacyOwnerObservable(diagram, StylePackage.Literals.PAPYRUS_VIEW_STYLE__CONFIGURATION, domain);
}
-
+
FeaturePath featurePath = getFeaturePath(propertyPath);
EStructuralFeature feature = getFeature(propertyPath);
@@ -121,16 +124,27 @@ public class GMFModelElement extends EMFModelElement { @Override
public ILabelProvider getLabelProvider(String propertyPath) {
- if (propertyPath.endsWith("prototype")) {
+ if(propertyPath.endsWith("prototype")) {
return new ILabelProvider() {
- public void addListener(ILabelProviderListener listener) { }
- public void removeListener(ILabelProviderListener listener) { }
- public void dispose() { }
- public boolean isLabelProperty(Object element, String property) { return false; }
+
+ public void addListener(ILabelProviderListener listener) {
+ }
+
+ public void removeListener(ILabelProviderListener listener) {
+ }
+
+ public void dispose() {
+ }
+
+ public boolean isLabelProperty(Object element, String property) {
+ return false;
+ }
+
public Image getImage(Object element) {
ViewPrototype proto = DiagramUtils.getPrototype((Diagram)source);
return proto.getIcon();
}
+
public String getText(Object element) {
ViewPrototype proto = DiagramUtils.getPrototype((Diagram)source);
return proto.getQualifiedName();
@@ -150,17 +164,23 @@ public class GMFModelElement extends EMFModelElement { */
@Override
public IStaticContentProvider getContentProvider(String propertyPath) {
- if (propertyPath.endsWith("element")) {
+ if("element".equals(propertyPath)) {
+ if(source instanceof Diagram) {
+ Diagram diagram = (Diagram)source;
+ return new ModelContentProvider(diagram, getRoot(diagram.getElement())) {
+
+ @Override
+ protected boolean isValid(EObject selection, Diagram diagram, ViewPrototype prototype) {
+ return PolicyChecker.getCurrent().canHaveNewView(selection, DiagramUtils.getOwner(diagram), prototype);
+ }
+ };
+ } else {
+ return EmptyContentProvider.instance;
+ }
+ } else if("owner".equals(propertyPath)) {
Diagram diagram = (Diagram)source;
return new ModelContentProvider(diagram, getRoot(diagram.getElement())) {
- @Override
- protected boolean isValid(EObject selection, Diagram diagram, ViewPrototype prototype) {
- return PolicyChecker.getCurrent().canHaveNewView(selection, DiagramUtils.getOwner(diagram), prototype);
- }
- };
- } else if (propertyPath.endsWith("owner")) {
- Diagram diagram = (Diagram) source;
- return new ModelContentProvider(diagram, getRoot(diagram.getElement())) {
+
@Override
protected boolean isValid(EObject selection, Diagram diagram, ViewPrototype prototype) {
return (PolicyChecker.getCurrent().getOwningRuleFor(prototype, selection) != null);
@@ -169,16 +189,18 @@ public class GMFModelElement extends EMFModelElement { }
return super.getContentProvider(propertyPath);
}
-
+
/**
* Gets the root EObject from the given one
- * @param obj An object
+ *
+ * @param obj
+ * An object
* @return The root object which is an ancestor of the given one
*/
private EObject getRoot(EObject obj) {
EObject current = obj;
EObject parent = obj.eContainer();
- while (parent != null) {
+ while(parent != null) {
current = parent;
parent = parent.eContainer();
}
diff --git a/plugins/infra/viewpoints/org.eclipse.papyrus.infra.viewpoints.policy/src/org/eclipse/papyrus/infra/viewpoints/policy/PolicyChecker.java b/plugins/infra/viewpoints/org.eclipse.papyrus.infra.viewpoints.policy/src/org/eclipse/papyrus/infra/viewpoints/policy/PolicyChecker.java index 19f68ecd8f4..02804729480 100755 --- a/plugins/infra/viewpoints/org.eclipse.papyrus.infra.viewpoints.policy/src/org/eclipse/papyrus/infra/viewpoints/policy/PolicyChecker.java +++ b/plugins/infra/viewpoints/org.eclipse.papyrus.infra.viewpoints.policy/src/org/eclipse/papyrus/infra/viewpoints/policy/PolicyChecker.java @@ -990,11 +990,11 @@ public class PolicyChecker { * The stereotypes applied on <code>element</code> * @return The check result */ - private int allows(ChildRule rule, EObject origin, EObject element, Collection<EClass> stereotypes) { + private int allows(ChildRule rule, EClass origin, EClass element, Collection<EClass> stereotypes) { EClass ce = rule.getElement(); EClass co = rule.getOrigin(); - if ((ce == null || ce.isSuperTypeOf(element.eClass())) - && (co == null || co.isSuperTypeOf(origin.eClass()))) { + if ((ce == null || ce.isSuperTypeOf(element)) + && (co == null || co.isSuperTypeOf(origin))) { // matching type => check the application of the required stereotypes for (EClass stereotype : rule.getStereotypes()) if (!stereotypes.contains(stereotype)) diff --git a/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/UML.ctx b/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/UML.ctx index d0d4bedb039..1490dcefe42 100644 --- a/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/UML.ctx +++ b/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/UML.ctx @@ -4546,7 +4546,7 @@ </elements>
<elements name="Trigger" supertypes="//@dataContexts.0/@elements.4">
<properties name="event" type="Reference" description="The event that causes the trigger."/>
- <properties name="port" type="Reference" description="A optional port of the receiver object on which the behavioral feature is invoked."/>
+ <properties name="port" type="Reference" multiplicity="-1" description="A optional port of the receiver object on which the behavioral feature is invoked."/>
</elements>
<elements name="Event" supertypes="//@dataContexts.0/@elements.3"/>
<elements name="Port" supertypes="//@dataContexts.0/@elements.35">
diff --git a/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/ui/MultiplePort.xwt b/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/ui/MultiplePort.xwt index a02598d88d5..90b1711e117 100644 --- a/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/ui/MultiplePort.xwt +++ b/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/ui/MultiplePort.xwt @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?>
-<Composite xmlns:j="clr-namespace:java.lang" xmlns="http://www.eclipse.org/xwt/presentation"
- xmlns:ppe="clr-namespace:org.eclipse.papyrus.views.properties.widgets"
+<Composite
xmlns:ppel="clr-namespace:org.eclipse.papyrus.views.properties.widgets.layout"
- xmlns:x="http://www.eclipse.org/xwt">
+ xmlns:j="clr-namespace:java.lang" xmlns:ppe="clr-namespace:org.eclipse.papyrus.views.properties.widgets"
+ xmlns:x="http://www.eclipse.org/xwt" xmlns="http://www.eclipse.org/xwt/presentation">
<Composite.layout>
<ppel:PropertiesLayout></ppel:PropertiesLayout>
</Composite.layout>
@@ -23,8 +23,7 @@ <ppe:BooleanRadio input="{Binding}" property="UML:Feature:isStatic"></ppe:BooleanRadio>
<ppe:BooleanRadio input="{Binding}"
property="UML:MultiplicityElement:isUnique"></ppe:BooleanRadio>
- <ppe:BooleanRadio property="UML:Port:isConjugated"
- input="{Binding}"></ppe:BooleanRadio>
+ <ppe:BooleanRadio input="{Binding}" property="UML:Port:isConjugated"></ppe:BooleanRadio>
</Composite>
<Composite>
<Composite.layout>
@@ -32,5 +31,7 @@ </Composite.layout>
<ppe:EnumCombo input="{Binding}" property="UML:Property:aggregation"></ppe:EnumCombo>
<ppe:EnumCombo input="{Binding}" property="UML:NamedElement:visibility"></ppe:EnumCombo>
+ <ppe:ReferenceDialog property="UML:TypedElement:type"
+ input="{Binding}"></ppe:ReferenceDialog>
</Composite>
</Composite>
\ No newline at end of file diff --git a/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/ui/SingleTrigger.xwt b/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/ui/SingleTrigger.xwt index 21ae379355b..0e81d304c04 100644 --- a/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/ui/SingleTrigger.xwt +++ b/plugins/uml/properties/org.eclipse.papyrus.uml.properties/Model/UML/ui/SingleTrigger.xwt @@ -1,7 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?>
-<Composite xmlns:ppe="clr-namespace:org.eclipse.papyrus.views.properties.widgets"
- xmlns:x="http://www.eclipse.org/xwt" xmlns:ppel="clr-namespace:org.eclipse.papyrus.views.properties.widgets.layout"
- xmlns:j="clr-namespace:java.lang" xmlns="http://www.eclipse.org/xwt/presentation">
+<Composite xmlns:x="http://www.eclipse.org/xwt" xmlns="http://www.eclipse.org/xwt/presentation"
+ xmlns:j="clr-namespace:java.lang"
+ xmlns:ppel="clr-namespace:org.eclipse.papyrus.views.properties.widgets.layout"
+ xmlns:ppe="clr-namespace:org.eclipse.papyrus.views.properties.widgets">
<Composite.layout>
<ppel:PropertiesLayout></ppel:PropertiesLayout>
</Composite.layout>
@@ -10,17 +11,9 @@ <ppel:PropertiesLayout></ppel:PropertiesLayout>
</Composite.layout>
<ppe:StringEditor input="{Binding}" property="UML:NamedElement:name"></ppe:StringEditor>
- </Composite>
- <Composite>
- <Composite.layout>
- <ppel:PropertiesLayout></ppel:PropertiesLayout>
- </Composite.layout>
<ppe:EnumCombo input="{Binding}" property="UML:NamedElement:visibility"></ppe:EnumCombo>
- </Composite>
- <Composite>
- <Composite.layout>
- <ppel:PropertiesLayout></ppel:PropertiesLayout>
- </Composite.layout>
<ppe:ReferenceDialog input="{Binding}" property="UML:Trigger:event"></ppe:ReferenceDialog>
+ <ppe:MultiReference property="UML:Trigger:port"
+ input="{Binding}"></ppe:MultiReference>
</Composite>
</Composite>
\ No newline at end of file |
