Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: document ::

service ImportFilter
Description
filter for imports

Such filters can be used for importing a content. Of course it's possible to combine it with the service ExportFilter if export functionality should be available at same implementation too.

See also
ExportFilter
Developers Guide
OfficeDev - Integrating Import and Export Filters

Exported Interfaces - Summary
XImporter

set target(!) document for this filter (details)

XFilter

filter interface (details)

::com::sun::star::lang::XInitialization

support initialization of filter with its own configuration (details)

::com::sun::star::container::XNamed

provides access to the internal name of this filter (details)

Exported Interfaces - Details
XImporter
Description
set target(!) document for this filter

The document must be used as the target of the filter. Any external content will be written there.

XFilter
Description
filter interface

It's used to filter a document at loading time. The target document should be already setted by using another interface XImporter which is supported by this service too.

Tip:
If same implementation provides the service ExportFilter too, code must distinguish between filtering into a target document (for import) or filtering from a source document (for export). This can be recognized by saving state of used interfaces XExporter or XImporter! Otherwise it's not clear which action is required here.

::com::sun::star::lang::XInitialization
Usage Restrictions
optional
Description
support initialization of filter with its own configuration

A filter object must be created by global service FilterFactory. If filter supports this optional interface, he will be initialized by the factory directly after creation. The factory will pass follow informations to this new instance:

See description of service FilterFactory::XNameContainer for a description of possible configuration data.

::com::sun::star::container::XNamed
Usage Restrictions
optional
Description
provides access to the internal name of this filter

This internal filter name can be used on service FilterFactory to get further informations about it (e.g. his registration for mime types or extensions etc.) It's important that returned string is the "internal name" of the filter which must be unambigous against all other registered filter in current instalation.

Attention!
Supported method setName() sould be ignored or forwarded to the FilterFactory. It's not allowed to set it directly to the configuration. Because it depends from real implementation of the FilterFactory if it will be allowed or not!


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.