Grouping of Leaves

OpenOffice.org Developer's Guide

Extensions

< Previous Section

Next Section >

• Extension Manager

• Extension Repositories
• The Active Extension
• Updating Extensions
• Processing Extensions
• Packaging Notes For Bundled Extensions
• Deployment Items
• Installing Extensions for All or a Single User
• Extension Manager in OpenOffice.org
• unopkg
• Location of Installed Extensions
• Extension Layers

• Checklist for Writing Extensions
• File Format
• description.xml

• Description of XML Elements
• Localized XML Elements
• Example

• Display Name
• Icon
• Extension Description
• Extension Identifiers
• Extension Versions
• Target Platform
• Simple License
• Dependencies
• Publisher Information
• System Integration
• Online Update of Extensions

• Running Online - Update
• Concept
• Example Scenario for Providing Updates
• Migration of Update Information
• Description of the Update Information
• Description of Atom Feed
• Examples

• Options Dialog

• Creating the GUI of the Options Page
• Saving and Reading Data for the Options Page
• Defining the Usage of Options Pages

• Adding a Leaf to an Existing Node
• Adding Several Leaves
• Grouping of Leaves
• Adding Nodes
• Adding Several Nodes
• Absolute Position of Leaves
• Grouping of Nodes
• Assigning Nodes to Modules
• Defining a Module
• Absolute Position of Nodes

• The Options Dialog of the Extension Manager

• Help Content

< Previous Page

Next Page >

When we add several Leafs to the same Node then we may wish to determine in which order they appear. This is done by using the properties GroupId and GroupIndex in Leaf. The GroupId is used to define a group. All Leafs with the same GroupId form this group. The GroupIndex determines the position of the Leaf with regard to this group. If there are multiple groups of Leafs assigned to the same Node, then it is undefined in which order the groups are displayed. However, the members of a group are always displayed contiguously .

The value for the GroupId must be unique. One can use the same patter here as for the names of Leafs, Nodes, etc.

One special GroupId is the one which has the same value as the Node name. This group is always displayed first under the node in the tree view. We will get to that later.

Usually, when an extension provides Leafs which are all assigned to the same Node, then one makes them belong to the same group.

Do not add to groups which you have not defined yourself. This may lead to clashing indices and is generally bad style. Grouping Leafs is optional. But when one does it, then all Leafs should be part of a group.

  <node oor:name="Nodes">
    <node oor:name="Writer" oor:op="fuse">
      <node oor:name="Leaves">
        <node oor:name="org.openoffice.framework.desktop.test.deployment.options.leaves2.Writer.3"
oor:op="fuse">
          <prop oor:name="Id">
            <value>org.openoffice/framework/desktop/test/deployment/options/leaves2</value>
          </prop>
          <!-- leaving out some properties for the sake of brevity -->
          <prop oor:name="GroupId">
            <value>org.openoffice.framework.desktop.test.deployment.options.leaves2.Writer.group</value>
          </prop>
          <prop oor:name="GroupIndex">
            <value>2</value>
          </prop>
        </node>
        <node oor:name="org.openoffice.framework.desktop.test.deployment.options.leaves2.Writer.1"
oor:op="fuse">
          <prop oor:name="Id">
            <value>org.openoffice/framework/desktop/test/deployment/options/leaves2</value>
          </prop>
          <!-- leaving out some properties for the sake of brevity -->
          <prop oor:name="GroupId">
            <value>org.openoffice.framework.desktop.test.deployment.options.leaves2.Writer.group</value>
          </prop>
          <prop oor:name="GroupIndex">
            <value>0</value>
          </prop>
        </node>
        <node oor:name="org.openoffice.framework.desktop.test.deployment.options.leaves2.Writer.2"
oor:op="fuse">
          <prop oor:name="Id">
            <value>org.openoffice/framework/desktop/test/deployment/options/leaves2</value>
          </prop>
          <!-- leaving out some properties for the sake of brevity --> 
          <prop oor:name="GroupId">
            <value>org.openoffice.framework.desktop.test.deployment.options.leaves2.Writer.group</value>
          </prop>
          <prop oor:name="GroupIndex">
            <value>1</value>
          </prop>
        </node>
      </node>
    </node> 
  </node>

Content on this page is licensed under the Public Documentation License (PDL).