E4/Scripting/Metadata

From Eclipsepedia

< E4‎ | Scripting
Jump to: navigation, search

Metadatas are informations you can add into the header of your script in order to add extra inforamtion for UI or running a script. This page will explain you the metadata available.

Contents

Description

What

This metadata describes what the current script do. This metadata is use to display tooltip into the UI.

Example

Description : {This script is used to convert the selected IProject to script project.}

Result

Description metadata.png

Menu

What

This metadata classify script into categories (Script Set). This categories are used for UI integration. This for example used for integration into the view and into the contextual menu.

Example

Menu: Examples > Modeling > Simple EMF API
The '>' character is used to create a new sub category.

Result

Menu Metadata.png Menu Metadata contextual menu.png

Visible When

Provide a way to express when this expression have to be available. This expression use the same mechanism than Core Expression of the Eclipse platform.

Example

Menu: Examples > Modeling > Papyrus > Change Class font to Tahoma (Papyrus)
VisibleWhen:[And {
  With activeEditor {
       Equal "org.eclipse.papyrus.infra.core.papyrusEditor"
   },
   With selection {
       Iterable {
           AdaptTo "org.eclipse.gmf.runtime.notation.View"{
               InstanceOf "org.eclipse.gmf.runtime.notation.Node"
           } 
       }
   } 

} Tips: In the java script and python examples you will find a file named : CreateYourVisibleWhenExpressionHere.coreexpression

This file use an Xtext editor to write your visible when expression.

Result

VisibleWhenExpression.png

Thread

Kudos

License