Skip to main content
Jump to: navigation, search

Difference between revisions of "Sirius/Cookbook"

Line 14: Line 14:
 
=== Have editor/properties view in read-only  ===
 
=== Have editor/properties view in read-only  ===
  
To control the permission on object edition, Sirius use an implementation of IPermissionAuthority. A default one named ReadOnlyPermissionAuthority is used by Sirius, to enable the read-only mode you can the following code snippet :
+
To control the permission on object edition, Sirius use an implementation of <code>IPermissionAuthority</code>. A default one named <code>ReadOnlyPermissionAuthority</code> is used by Sirius, to enable the read-only mode you can the following code snippet :
  
 
<pre>
 
<pre>
 
IPermissionAuthority permissionAuthority = IPermissionAuthorityRegistry.getPermissionAuthority(session.getTransactionalEditingDomain().getResourceSet());
 
IPermissionAuthority permissionAuthority = IPermissionAuthorityRegistry.getPermissionAuthority(session.getTransactionalEditingDomain().getResourceSet());
if(permissionAuthority instanceof ReadOnlyPermissionAuthority){
+
if (permissionAuthority instanceof ReadOnlyPermissionAuthority) {
   ((ReadOnlyPermissionAuthority)permissionAuthority).activate();
+
   ((ReadOnlyPermissionAuthority) permissionAuthority).activate();
 
}
 
}
 
</pre>
 
</pre>
  
To better control permissions, you can provide your own IPermissionAuthority implementation using the PermissionProvider extension point.
+
To better control permissions, you can provide your own <code>IPermissionAuthority</code> implementation using the <code>PermissionProvider</code> extension point.
  
 
=== Enable direct edit on begin/end labels ===
 
=== Enable direct edit on begin/end labels ===

Revision as of 03:46, 4 April 2016

This page gathers code snippets which can be useful when using and extending Sirius programmatically.

Retrieve a DNode (or another Sirius representation element) from given semantic element

Sirius maintains an session-scoped inverse cross-referencer which can be used to find "who references who" even in the absence of explicit navigable references in the model. Sirius representation elements have a reference to the semantic model they represents, so you can use it for this kind of task. The most convenient way is to use the org.eclipse.sirius.business.api.query.EObjectQuery:

 Collection<EObject> result = new EObjectQuery(mySemanticElement).getInverseReferences(ViewpointPackage.Literals.DSEMANTIC_DECORATOR__TARGET);

Note that this will find all the DSemanticDecorators which represent mySemanticElement in the whole session (all representations included), which may or may not be what you want. If you need more precision, you will have to filter the result (using EObjectQuery#getRepresentation(DRepresentation) for example to restrict to a specific diagram).

Have editor/properties view in read-only

To control the permission on object edition, Sirius use an implementation of IPermissionAuthority. A default one named ReadOnlyPermissionAuthority is used by Sirius, to enable the read-only mode you can the following code snippet :

IPermissionAuthority permissionAuthority = IPermissionAuthorityRegistry.getPermissionAuthority(session.getTransactionalEditingDomain().getResourceSet());
if (permissionAuthority instanceof ReadOnlyPermissionAuthority) {
   ((ReadOnlyPermissionAuthority) permissionAuthority).activate();
}

To better control permissions, you can provide your own IPermissionAuthority implementation using the PermissionProvider extension point.

Enable direct edit on begin/end labels

In addition to its "main" label, an edge on a diagram can also have optional labels at the beginning (source-side) and/or end (target-side). However direct edit tools associate with the edge only allow to edit the main label, not the begin/end ones. Currently (as of Sirius 3.1) the only way to overcome this limitation is to programmatically contribute additional edit policies on the corresponding GMF Edit Parts. UML Designer does this for UML associations: see the code here for how this can be implemented.

Back to the top