Difference between revisions of "Diagram view part (extension point)"

From BioUML platform
Jump to: navigation, search
(Created page with "__NOTOC__ '''Identifier''': biouml.workbench.diagramViewPart ===Description=== BioUML workbench provides special pane where viewers for some diagram data will be shown. Any p...")
 
 
(6 intermediate revisions by one user not shown)
Line 1: Line 1:
__NOTOC__
+
{{Extension point|diagramViewPart|biouml.workbench}}
'''Identifier''': biouml.workbench.diagramViewPart
+
 
+
 
===Description===
 
===Description===
 
BioUML workbench provides special pane where viewers for some diagram data will be shown. Any plug-in can contribute specific viewers to show some diagram data. Typical example of viewer is Clipboard showing the copied element of diagram.
 
BioUML workbench provides special pane where viewers for some diagram data will be shown. Any plug-in can contribute specific viewers to show some diagram data. Typical example of viewer is Clipboard showing the copied element of diagram.
Line 16: Line 14:
 
</code>
 
</code>
  
*class - the fully-qualified name of a class which implements <code>ru.biosoft.gui.EditorPart</code>.
+
;class
*Name - tab display name
+
:the fully-qualified name of a class which implements {{Class|ru.biosoft.gui.ViewPart}}.
*ShortDescription - editor part short description, can be used as tooltip
+
;Name
*Priority - tab priority, tabs will be sorted according they priority.
+
:tab display name
 +
;ShortDescription
 +
:editor part short description, can be used as tooltip
 +
;Priority
 +
:tab priority, tabs will be sorted according they priority.
  
 
<code>diagramViewPart</code> attributes are mapped to corresponding Action properties using the associated key, so other Action or user defined attributes can be used.
 
<code>diagramViewPart</code> attributes are mapped to corresponding Action properties using the associated key, so other Action or user defined attributes can be used.
Line 28: Line 30:
 
Following is an example of a Clipboard definition:
 
Following is an example of a Clipboard definition:
  
    <extension id="Clipboard" point="biouml.workbench.diagramViewPart">  
+
<extension id="Clipboard" point="biouml.workbench.diagramViewPart">  
 
       <diagramViewPart  
 
       <diagramViewPart  
 
         class="biouml.workbench.diagram.ClipboardView"  
 
         class="biouml.workbench.diagram.ClipboardView"  
Line 35: Line 37:
 
         Priority = "2.5"
 
         Priority = "2.5"
 
       />  
 
       />  
  </extension>
+
</extension>
  
 
===API Information===
 
===API Information===
The value of the class attribute must represent an implementor of <code>ru.biosoft.gui.ViewPart</code>.
+
The value of the class attribute must represent an implementor of {{Class|ru.biosoft.gui.ViewPart}}.
 
+
[[Category:Extension points]]
+

Latest revision as of 17:04, 25 September 2014

Identifier
biouml.workbench.diagramViewPart
Plugin
biouml.workbench

[edit] Description

BioUML workbench provides special pane where viewers for some diagram data will be shown. Any plug-in can contribute specific viewers to show some diagram data. Typical example of viewer is Clipboard showing the copied element of diagram.

[edit] Configuration Markup

   <!ELEMENT diagramViewPart>
   <!ATTLIST diagramViewPart
     class             CDATA   #REQUIRED
     Name              CDATA 
     ShortDescription  CDATA 
     Priority          CDATA
   >

class
the fully-qualified name of a class which implements ViewPart.
Name
tab display name
ShortDescription
editor part short description, can be used as tooltip
Priority
tab priority, tabs will be sorted according they priority.

diagramViewPart attributes are mapped to corresponding Action properties using the associated key, so other Action or user defined attributes can be used. See Action.getValue(String key) for details.

[edit] Examples

Following is an example of a Clipboard definition:

<extension id="Clipboard" point="biouml.workbench.diagramViewPart"> 
     <diagramViewPart 
       class="biouml.workbench.diagram.ClipboardView" 
       Name="Clipboard"
       ShortDescription="Diagram clipboard is used to copy and paste diagram elements from one diagram to another."
       Priority = "2.5"
     /> 
</extension>

[edit] API Information

The value of the class attribute must represent an implementor of ViewPart.

Personal tools
Namespaces

Variants
Actions
BioUML platform
Community
Modelling
Analysis & Workflows
Collaborative research
Development
Virtual biology
Wiki
Toolbox