Configuration

From OpenOffice.org Wiki

OpenOffice.org Developer's Guide

Office Development

< Previous Part

Next Part >

• OpenOffice.org Application Environment

• Desktop Environment
• Framework API

• Frame-Controller-Model Paradigm in OpenOffice.org
• Frames
• Controllers
• Windows
• Dispatch Framework

• Using the Desktop
• Using the Component Framework

• Getting Frames, Controllers and Models from Each Other
• Frames
• Controllers
• Models
• Window Interfaces

• Creating Frames Manually
• Handling Documents

• Closing Documents
• Storing Documents

• Using the Dispatch Framework

• Command URL
• Processing Chain
• Dispatch Process
• Dispatch Results
• Dispatch Interception

• Java Window Integration

• Common Application Features

• Internationalization

• Overview and Using the API
• Implementing a New Locale

• Linguistics

• Using Spellchecker
• Using Hyphenator
• Using Thesaurus
• Events
• Implementing a Spell Checker
• Implementing a Hyphenator
• Implementing a Thesaurus

• Integrating Import and Export Filters

• Document API Filter Development

• Filtering Process
• Filter
• Filter Options
• Configuring a Filter in OpenOffice.org
• General Notes
• Necessary Steps
• Properties of a Type
• Properties of an ExtendedTypeDetection Service
• Properties of a Filter
• Properties of a FrameLoader

• XML Based Filter Development

• Components of a Filter
• Writing the Filtering Component
• The Importer
• The Exporter
• Configuration
• Sample Filter Component Inplementations
• Additional Components
• XML Filter Detection

• Number Formats

• Managing Number Formats
• Applying Number Formats

• Document Events
• Path Organization

• Path Settings
• Path Variables

• Predefined Variables
• Custom Path Variables
• Resolving Path Variables

• OpenOffice.org Single Sign-On API

< Previous Page

Next Page >

For OpenOffice.org to be able to make use of this filtering component, the filter and the type that it handles must be defined in the TypeDetection.xcu file.

The type section defines certain file types and their extensions. The filter section contains the actual filter definition.

Below is an example of a type and filter definition in the TypeDetection.xcu file. It describes a PocketWord filter.

<!-- Type section -->
  <node oor:name="writer_PocketWord_File" oor:op="replace">
      <prop oor:name="UIName">
          <value xml:lang="en-US">Pocket Word</value>
      </prop>
      <prop oor:name="Data">
          <value>0,,,,psw,20002,</value>
      </prop>
  </node>
 
  <!-- Filter section -->
  <node oor:name="PocketWord File" oor:op="replace">
      <prop oor:name="UIName">
          <value xml:lang="en-US">Pocket Word</value>
      </prop>
      <prop oor:name="Data">
          <value>
              0,
              writer_PocketWord_File,
              com.sun.star.text.TextDocument,
              com.sun.star.comp.Writer.XmlFilterAdaptor,
              524355,
              com.sun.star.documentconversion.XMergeBridge;
                  classes/pocketword.jar;
                  com.sun.star.comp.Writer.XMLImporter;
                  com.sun.star.comp.Writer.XMLExporter;
                  staroffice/sxw;application/x-pocket-word,
              0,
              ,
          </value>
      </prop>
      <prop oor:name="Installed" oor:type="xs:boolean">
          <value>true</value>
      </prop>
  </node>

The type section defines a type writer_PocketWord_File with "Pocket Word" as UIName in File - Open. The file extension of this type is specified as .psw in the Data property.

The filter section defines the same UI name "Pocket Word" for the filter, and a number of settings in the Data property, simply separated by commas:

Type

This is the id of the file type definition that defines the type of file that this filter can handle, in this case "writer_PocketWord_File”. This value refers to the oor:name of the type section.

Office application

This is the application that will be used to open the document, in this case Writer (“com.sun.star.text.TextDocument”).

Filter Component

This is the component that OpenOffice.org will initialize when importing or exporting, in this case “com.sun.star.comp.Writer.XmlFilterAdaptor“.

User Data

Section containing the filtering component that the XML filter adapter will initialize and use for filtering. In this example “com.sun.star.documentconversion.XMergeBridge;classes/pocketword.jar;com.sun.star.comp.Writer.XMLImporter;

com.sun.star.comp.Writer.XMLExporter;staroffice/sxw;application/x-pocket-word”

From this example, you see that this Filter uses the XML filter adapter. When the XML filter adapter initializes, it initializes the XMergeBridge that is specified in the UserData section. The rest of the information in the UserData section has been included for use by the XMergeBridge filtering component, including the com.sun.star.comp.Writer.XMLImporter, which will be used by the XML filter adapter to create the XDocumentHandler when importing.