Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Custom Annotation Property Views"
Line 38: | Line 38: | ||
=== Add Annotation Property Tab === | === Add Annotation Property Tab === | ||
− | Another way to extend Annotation Properties View is | + | Another way to extend Annotation Properties View is add own property tab. To define new tab we need to use <i>org.eclipse.ui.views.properties.tabbed.propertyTabs</i> extension point: |
<extension | <extension | ||
point="org.eclipse.ui.views.properties.tabbed.propertyTabs"> | point="org.eclipse.ui.views.properties.tabbed.propertyTabs"> | ||
Line 55: | Line 55: | ||
* id - the unique id for the tab. | * id - the unique id for the tab. | ||
− | Next step - provide custom annotation property section (as described above) with custom tab identifier (in this case | + | Next step - provide custom annotation property section (as described above) with custom tab identifier (in this case tab="property.tab.ExampleSection"). |
=== Contribute Annotation Actions === | === Contribute Annotation Actions === |
Revision as of 23:11, 17 July 2008
Contents
< To: Tigerstripe_APIs
Introduction
Annotation Framework support 4 ways to extend Annotation Property View: override properties section, add properties tabs, add annotation actions and register custom properties editors.
Custom Annotation Property Section
To replace annotation property section in the Annotation Property View we need to provide new section and annotation filter. Annotation Property View based on the tabbed properties, so customizing can be done using org.eclipse.ui.views.properties.tabbed.propertySections extension point:
<extension point="org.eclipse.ui.views.properties.tabbed.propertySections"> <propertySections contributorId="org.eclipse.tigerstripe.annotation.ui.properties"> <propertySection class="org.eclipse.tigerstripe.annotation.ui.example.customview.CustomSection" filter="org.eclipse.tigerstripe.annotation.ui.example.customview.CustomAnnotationFilter" id="property.section.CustomSection" tab="property.tab.PropertiesPropertySection"/> </propertySections> </extension>
- contributorId="org.eclipse.tigerstripe.annotation.ui.properties" - identifier of the annotation property page contributor.
- tab="property.tab.PropertiesPropertySection" - identifier of the properties tab which we want to override.
- class - annotation section class. This class should extend org.eclipse.tigerstripe.annotation.ui.core.properties.AnnotationPropertiesSection class:
public class CustomSection extends AnnotationPropertiesSection { public void createControls(Composite parent, TabbedPropertySheetPage tabbedPropertySheetPage) { //create section controls ... } protected void updateSection(Annotation annotation) { //update section when selected annotation changed ... } }
- filter - annotation filter determines if annotation section should be overridden. Annotation filter should extend org.eclipse.tigerstripe.annotation.ui.core.properties.AnnotationFilter class:
public CustomAnnotationFilter extends AnnotationFilter { public boolean select(Annotation annotation) { //return true if section should be overridden for the specified annotation } }
- id - the unique identifier for the section
Add Annotation Property Tab
Another way to extend Annotation Properties View is add own property tab. To define new tab we need to use org.eclipse.ui.views.properties.tabbed.propertyTabs extension point:
<extension point="org.eclipse.ui.views.properties.tabbed.propertyTabs"> <propertyTabs contributorId="org.eclipse.tigerstripe.annotation.ui.properties"> <propertyTab category="Properties" id="property.tab.ExampleSection" label="Example Section"/> </propertyTabs> </extension>
- contributorId="org.eclipse.tigerstripe.annotation.ui.properties" - identifier of the annotation property page contributor.
- category="Properties" - identifier of the properties tab category.
- label - the label to be displayed on the tab.
- id - the unique id for the tab.
Next step - provide custom annotation property section (as described above) with custom tab identifier (in this case tab="property.tab.ExampleSection").
Contribute Annotation Actions
Custom actions can be contributed to the Annotation Property View using standard org.eclipse.ui.popupMenus extension point with the annotationProperties<i> as menubar path and <i>org.eclipse.tigerstripe.annotation.core.Annotation as selection:
<extension point="org.eclipse.ui.popupMenus"> <objectContribution ... objectClass="org.eclipse.tigerstripe.annotation.core.Annotation"> <action ... menubarPath="annotationProperties"/> </objectContribution> <extension/>
Register Properties Editors
TODO: add content