Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Stardust/Enhancing and Embedding Stardust/Browser Modeler/Javascript Extension Points"

Line 54: Line 54:
 
| URL of the HTML content of the page  
 
| URL of the HTML content of the page  
 
|-  
 
|-  
−
| <code>provider</code>
+
| <code>handlerMethod</code>
−
| Arbitrary extension elements
+
| function of the JavaScript Controller to be invoked
 +
|-
 +
| <code>visibility</code>
 +
| Flag to indicate whether the Entry is always visible (<code>always</code>) or only for preview purposes (<code>preview</code>)
 
|}
 
|}
  
Line 71: Line 74:
  
 
= Toolbar Extension Points  =
 
= Toolbar Extension Points  =
−
 
  
 
The Extension Point <code>propertiesPage</code> allows to specify additional Properties Pages with the Properties Panel for a Diagram Element in Lightdust Diagrams.  
 
The Extension Point <code>propertiesPage</code> allows to specify additional Properties Pages with the Properties Panel for a Diagram Element in Lightdust Diagrams.  
Line 90: Line 92:
 
| URL of the HTML content of the page  
 
| URL of the HTML content of the page  
 
|-  
 
|-  
−
| <code>provider</code>
+
| <code>handlerMethod</code>
−
| Arbitrary extension elements
+
| function of the JavaScript Controller to be invoked
 +
|-
 +
| <code>visibility</code>
 +
| Flag to indicate whether the Entry is always visible (<code>always</code>) or only for preview purposes (<code>preview</code>)
 
|}
 
|}
  
Line 126: Line 131:
 
| URL of the HTML content of the page  
 
| URL of the HTML content of the page  
 
|-  
 
|-  
−
| <code>provider</code>
+
| <code>handlerMethod</code>
−
| Arbitrary extension elements
+
| function of the JavaScript Controller to be invoked
 +
|-
 +
| <code>visibility</code>
 +
| Flag to indicate whether the Entry is always visible (<code>always</code>) or only for preview purposes (<code>preview</code>)
 
|}
 
|}
  
Line 161: Line 169:
 
| URL of the HTML content of the page  
 
| URL of the HTML content of the page  
 
|-  
 
|-  
−
| <code>provider</code>
+
| <code>handlerMethod</code>
−
| Arbitrary extension elements
+
| function of the JavaScript Controller to be invoked
 +
|-
 +
| <code>visibility</code>
 +
| Flag to indicate whether the Entry is always visible (<code>always</code>) or only for preview purposes (<code>preview</code>)
 
|}
 
|}
  
Line 196: Line 207:
 
| URL of the HTML content of the page  
 
| URL of the HTML content of the page  
 
|-  
 
|-  
−
| <code>provider</code>
+
| <code>handlerMethod</code>
−
| Arbitrary extension elements
+
| function of the JavaScript Controller to be invoked
 +
|-
 +
| <code>visibility</code>
 +
| Flag to indicate whether the Entry is always visible (<code>always</code>) or only for preview purposes (<code>preview</code>)
 
|}
 
|}
  
Line 212: Line 226:
 
</source>  
 
</source>  
  
−
= Diagram Decoration Extension Point  =
+
= Toolbar Palette Entry Extension Point  =
  
−
The Extension Point <code>propertiesPage</code> allows to specify additional Properties Pages with the Properties Panel for a Diagram Element in Lightdust Diagrams.  
+
The Extension Point <code>toolbarPaletteEntry</code> allows to specify single entries in a palette in a diagram toolbar.  
  
 
== Properties ==
 
== Properties ==
Line 222: Line 236:
 
! Content
 
! Content
 
|-  
 
|-  
−
| <code>panelId</code>
+
| <code>id</code>
−
| ID of the Panel containing the Page, e.g. <code>activityPropertiesPanel</code>.
+
| ID of the toolbar entry
 
|-  
 
|-  
−
| <code>pageId</code>
+
| <code>paletteId</code>
−
| ID of the Properties Page, must be unique in the Properties Panel
+
| ID of the Palette the Toolbar Palette Entry is added to.
 
|-  
 
|-  
−
| <code>pageUrl</code>
+
| <code>iconUrl</code>
−
| URL of the HTML content of the page
+
| URL of the icon for the Entry
 
|-  
 
|-  
 
| <code>provider</code>
 
| <code>provider</code>
−
| Arbitrary extension elements
+
| require module reference for the code module providing the <code>create()</code> function for the JavaScript Controller of the Entry
 +
|-
 +
| <code>handlerMethod</code>
 +
| function of the JavaScript Controller to be invoked
 +
|-
 +
| <code>visibility</code>
 +
| Flag to indicate whether the Entry is always visible (<code>always</code>) or only for preview purposes (<code>preview</code>)
 
|}
 
|}
  
Line 239: Line 259:
 
<source lang="javascript">
 
<source lang="javascript">
 
propertiesPage : [ ..., {
 
propertiesPage : [ ..., {
−
   panelId: "activityPropertiesPanel",
+
   id: "selectModeButton",
−
   pageId: "controllingPropertiesPage",
+
   paletteId: "drawingPalette",
−
   pageHtmlUrl: "activityControllingPropertiesPage.html",
+
   title: m_i18nUtils.getProperty("modeler.diagram.toolbar.tool.selectMode.title"),
−
   provider: m_activityControllingPropertiesPage,
+
  iconUrl: "../../images/icons/select.png",
 +
   provider: m_defaultPaletteHandler,
 +
  handlerMethod: "setSelectMode",
 
   visibility: "always"
 
   visibility: "always"
 
}, ...]
 
}, ...]
Line 266: Line 288:
 
| URL of the HTML content of the page  
 
| URL of the HTML content of the page  
 
|-  
 
|-  
−
| <code>provider</code>
+
| <code>handlerMethod</code>
−
| Arbitrary extension elements
+
| function of the JavaScript Controller to be invoked
 +
|-
 
|}
 
|}
  

Revision as of 09:12, 17 November 2012

Extension Points and Extensions - analogous to the concepts in Eclipse - allow you to plug-in JavaScript logic and HTML UI into various parts of the Browser Modeler (Lightdust).

E.g. by defining 

propertiesPage : [{
   panelId: "activityPropertiesPanel",
   pageId: "controllingPropertiesPage",
   pageHtmlUrl: "activityControllingPropertiesPage.html",
   provider: m_activityControllingPropertiesPage,
   visibility: "always"
}]

you add an additional Properties Page to the Properties Pages for Activities whose code is to be found in the file activityControllingPropertiesPage.html and whose JavaScript Controller is created by invoking 

m_activityControllingPropertiesPage.create()

whereby m_activityControllingPropertiesPage is a JavaScript module in the file m_activityControllingPropertiesPage.js.

In other words: you only have to program JavaScript and HTML!

The Extension Point mechanism described here is very close to the Plug-In mechanism of Orion. It is intended to extend Lightdust's Extension Points towards the Orion Model.

Prerequisites

In order to understand the concepts in this document you need to familiarize yourself with

  • JavaScript programming in general
  • jQuery
  • jQuery UI
  • require for JavaScript
  • the JavaScript Metamodel for Lightdust

Properties Page Extension Point

The Extension Point propertiesPage allows to specify additional Properties Pages with the Properties Panel for a Diagram Element in Lightdust Diagrams.

Properties

Property Content
panelId ID of the Panel containing the Page, e.g. activityPropertiesPanel.
pageId ID of the Properties Page, must be unique in the Properties Panel
pageUrl URL of the HTML content of the page
handlerMethod function of the JavaScript Controller to be invoked
visibility Flag to indicate whether the Entry is always visible (always) or only for preview purposes (preview)

Example

propertiesPage : [ ..., {
   panelId: "activityPropertiesPanel",
   pageId: "controllingPropertiesPage",
   pageHtmlUrl: "activityControllingPropertiesPage.html",
   provider: m_activityControllingPropertiesPage,
   visibility: "always"
}, ...]

Toolbar Extension Points

The Extension Point propertiesPage allows to specify additional Properties Pages with the Properties Panel for a Diagram Element in Lightdust Diagrams.

Properties

Property Content
panelId ID of the Panel containing the Page, e.g. activityPropertiesPanel.
pageId ID of the Properties Page, must be unique in the Properties Panel
pageUrl URL of the HTML content of the page
handlerMethod function of the JavaScript Controller to be invoked
visibility Flag to indicate whether the Entry is always visible (always) or only for preview purposes (preview)

Example

propertiesPage : [ ..., {
   panelId: "activityPropertiesPanel",
   pageId: "controllingPropertiesPage",
   pageHtmlUrl: "activityControllingPropertiesPage.html",
   provider: m_activityControllingPropertiesPage,
   visibility: "always"
}, ...]

Application Type Extension Point

The Extension Point propertiesPage allows to specify additional Properties Pages with the Properties Panel for a Diagram Element in Lightdust Diagrams.

Properties

Property Content
panelId ID of the Panel containing the Page, e.g. activityPropertiesPanel.
pageId ID of the Properties Page, must be unique in the Properties Panel
pageUrl URL of the HTML content of the page
handlerMethod function of the JavaScript Controller to be invoked
visibility Flag to indicate whether the Entry is always visible (always) or only for preview purposes (preview)

Example

propertiesPage : [ ..., {
   panelId: "activityPropertiesPanel",
   pageId: "controllingPropertiesPage",
   pageHtmlUrl: "activityControllingPropertiesPage.html",
   provider: m_activityControllingPropertiesPage,
   visibility: "always"
}, ...]

Data Type Extension Point

The Extension Point propertiesPage allows to specify additional Properties Pages with the Properties Panel for a Diagram Element in Lightdust Diagrams.

Properties

Property Content
panelId ID of the Panel containing the Page, e.g. activityPropertiesPanel.
pageId ID of the Properties Page, must be unique in the Properties Panel
pageUrl URL of the HTML content of the page
handlerMethod function of the JavaScript Controller to be invoked
visibility Flag to indicate whether the Entry is always visible (always) or only for preview purposes (preview)

Example

propertiesPage : [ ..., {
   panelId: "activityPropertiesPanel",
   pageId: "controllingPropertiesPage",
   pageHtmlUrl: "activityControllingPropertiesPage.html",
   provider: m_activityControllingPropertiesPage,
   visibility: "always"
}, ...]

Toolbar Palette Extension Point

The Extension Point toolbarPalette allows to specify additional Properties Pages with the Properties Panel for a Diagram Element in Lightdust Diagrams.

Properties

Property Content
panelId ID of the Panel containing the Page, e.g. activityPropertiesPanel.
pageId ID of the Properties Page, must be unique in the Properties Panel
pageUrl URL of the HTML content of the page
handlerMethod function of the JavaScript Controller to be invoked
visibility Flag to indicate whether the Entry is always visible (always) or only for preview purposes (preview)

Example

propertiesPage : [ ..., {
   panelId: "activityPropertiesPanel",
   pageId: "controllingPropertiesPage",
   pageHtmlUrl: "activityControllingPropertiesPage.html",
   provider: m_activityControllingPropertiesPage,
   visibility: "always"
}, ...]

Toolbar Palette Entry Extension Point

The Extension Point toolbarPaletteEntry allows to specify single entries in a palette in a diagram toolbar.

Properties

Property Content
id ID of the toolbar entry
paletteId ID of the Palette the Toolbar Palette Entry is added to.
iconUrl URL of the icon for the Entry
provider require module reference for the code module providing the create() function for the JavaScript Controller of the Entry
handlerMethod function of the JavaScript Controller to be invoked
visibility Flag to indicate whether the Entry is always visible (always) or only for preview purposes (preview)

Example

propertiesPage : [ ..., {
   id: "selectModeButton",
   paletteId: "drawingPalette",
   title: m_i18nUtils.getProperty("modeler.diagram.toolbar.tool.selectMode.title"),
   iconUrl: "../../images/icons/select.png",
   provider: m_defaultPaletteHandler,
   handlerMethod: "setSelectMode",
   visibility: "always"
}, ...]

Diagram Decoration Extension Point

The Extension Point propertiesPage allows to specify additional Properties Pages with the Properties Panel for a Diagram Element in Lightdust Diagrams.

Properties

Property Content
panelId ID of the Panel containing the Page, e.g. activityPropertiesPanel.
pageId ID of the Properties Page, must be unique in the Properties Panel
pageUrl URL of the HTML content of the page
handlerMethod function of the JavaScript Controller to be invoked

Example

propertiesPage : [ ..., {
   panelId: "activityPropertiesPanel",
   pageId: "controllingPropertiesPage",
   pageHtmlUrl: "activityControllingPropertiesPage.html",
   provider: m_activityControllingPropertiesPage,
   visibility: "always"
}, ...]

Define a New Extension Point

You may define your own extension points and evaluate those in the JavaScript code.

Extension Point Registration

Extension Registration

Extensions need to be registered in JavaScript files underneath the /modelerExtensions/<Extension Point Id> folder.

Retrieved from "https://wiki.eclipse.org/index.php?title=Stardust/Enhancing_and_Embedding_Stardust/Browser_Modeler/Javascript_Extension_Points&oldid=322463"

Back to the top