The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star ::

module document
Description
Office document related interfaces.

Services
DocumentInfo [ DEPRECATED ]
this service provides document-specific information like the author, creation date and user fields
DocumentProperties provides document-specific information such as the author, creation date, and user-defined fields.
DocumentRevisionListPersistence interface to maintain a list of document revisions
EventDescriptor specifies an event binding for a document or a document content
Events is a collection of all events supported by a document or content of a document
ExportFilter filter for exports
ExtendedTypeDetection describes a class of service which will be used for deep TypeDetection in a generic way
ExtendedTypeDetectionFactory factory to create extended type detection components.
FilterAdapter
FilterFactory factory to create filter components.
HeaderFooterSettings describes properties that control the formatting of headers and footers for documents that do not allow individual settings for individual parts like pages or slides.
ImportFilter filter for imports
LinkTarget This service is implemented by objects inside a document object model that can be the target of a link inside a document
LinkTargets This service gives access to a collection of names that are child links of the parent object that supplied this service.
MediaDescriptor describes properties of a document, regarding the relationship between the loaded document and the resource the document is loaded from / stored to.
OOXMLDocumentPropertiesImporter allows to import document properties from OOXML format
OfficeDocument abstract service which specifies a storable and printable document
OleEmbeddedServerRegistration registers embedded server for StarOffice documents
PDFDialog This service is for a PDFDialog
Settings describes properties that apply to the whole document of any application.
StandaloneDocumentInfo [ DEPRECATED ]
extends the service DocumentInfo to have access on such document properties without loading the whole document
TypeDetection capsulate a type detection service and provide read/write access on it's configuration data.
XMLBasicExporter Filter for exporting Basic macros to the OpenOffice.org file format.
XMLBasicImporter Filter for importing Basic macros from the OpenOffice.org file format.
XMLOasisBasicExporter Filter for exporting Basic macros to the OASIS Open Office file format.
XMLOasisBasicImporter Filter for importing Basic macros from the OASIS Open Office file format.
Interfaces
XActionLockable makes it possible to prevent object internal updates for a certain period to be able to quickly change multiple parts of the objects, where the updates would invalidate each other, anyway.
XBinaryStreamResolver
XCodeNameQuery
XDocumentEventBroadcaster allows to be notified of events happening in an OfficeDocument, and to cause notification of such events.
XDocumentEventListener allows to be notified of events happening in an OfficeDocument
XDocumentInfo [ DEPRECATED ]
provides access to the user fields for the information regarding the document
XDocumentInfoSupplier [ DEPRECATED ]
through this interface documents can provide a DocumentInfo
XDocumentInsertable makes it possible to import a document from a given URL into this document.
XDocumentLanguages
XDocumentProperties provides document-specific information such as the author, creation date, and user-defined fields.
XDocumentPropertiesSupplier provides access to the XDocumentProperties instance of a document.
XDocumentRecovery is the interface to be implemented by documents who wish to participate in the document emergency-save / recovery process.
XDocumentRevisionListPersistence interface to load or store a list of document revisions from or to a document using the packed XML file format
XDocumentSubStorageSupplier through this interface documents can provide access to their substorages
XEmbeddedObjectResolver this interface converts embedded object URLs from one URL space to another.
XEmbeddedObjectSupplier represents something that provides an embedded object.
XEmbeddedObjectSupplier2 represents something that provides an embedded object.
XEmbeddedScripts is suppoerted by OfficeDocuments which allow to embed scripts
XEventBroadcaster [ DEPRECATED ]
makes it possible to register listeners which are called whenever a document event (see EventObject) occurs
XEventListener [ DEPRECATED ]
makes it possible to register listeners, which are called whenever a document or document content event occurs
XEventsSupplier gives access to a list of URLs bound to events of this object
XExporter makes it possible to connect a document with an ExportFilter
XExtendedFilterDetection provides a "deep" filter detection
XFilter interface to filter documents
XFilterAdapter This is an interface that can be used to link a filter to the FilterAdapter
XGraphicObjectResolver this interface converts graphic object URLs from one URL space to another.
XImporter makes it possible to connect a document with an ImportFilter
XInteractionFilterOptions A continuation to return filter options from interaction helper.
XInteractionFilterSelect continuation used by interaction mechanism at filter detection during loading documents
XLinkTargetSupplier interface is supplied by objects inside a document object model that have children that can be the target of a link inside a document.
XMimeTypeInfo provides information regarding which MIME types are supported by a filter.
XOOXMLDocumentPropertiesImporter allows to import the document properties from OOXML fomat
XRedlinesSupplier provides access to a container of the redline objects of the document.
XScriptInvocationContext indicates support for executing scripts contained in a, possibly foreign, document.
XStandaloneDocumentInfo [ DEPRECATED ]
makes it possible to load document information from a resource specified by a URL and to store it into a resource also specified by a URL
XStorageBasedDocument allows to initialize document with a storage, to store document to a storage, and to set document to be based on provided storage.
XStorageChangeListener allows to be notified when a document is switched to a new storage.
XTypeDetection support "flat" and "deep" type detection of a given document
XUndoAction represents a single (undoable) action on a document
XUndoManager provides access to the undo/redo stacks of a document

Undo

XUndoManagerListener implemented by components which want to be notified of changes in the Undo/Redo stacks of an Undo manager.
XUndoManagerSupplier provides access to an XUndoManager.
XViewDataSupplier gives access to some properties describing all open views to a document
Structs
DocumentEvent describes an event happening in an OfficeDocument
EventObject [ DEPRECATED ]
is thrown on document and document content events
UndoManagerEvent is an event sent by an XUndoManager implementation when the Undo/Redo stacks of the manager are modified.
Exceptions
AmbigousFilterRequest should be used for interaction to handle states of ambigous filter detection
BrokenPackageRequest Is used for interaction handle in case package is broken.
ChangedByOthersRequest Is used for interaction handle to query user decision in case the document being saved was already stored by another user during the editing.
CorruptedFilterConfigurationException This exception is thrown in case the global filter configuration does not exists or contains corrupted data.
EmptyUndoStackException is raised when an operation is attemption at an XUndoManager which requires a non-empty stack of undo actions, and this requirement is not fullfilled.
FilterOptionsRequest Is used for interaction handle to get filter options.
LockFileIgnoreRequest Is used for interaction handle to query user decision regarding storing to a location where no lock file can be created.
LockedDocumentRequest Is used for interaction handle to query user decision regarding locked document.
LockedOnSavingRequest Is used for interaction handle to query user decision regarding locked document on saving.
NoSuchFilterRequest should be used for interaction to handle states of unknown filter during detection
OwnLockOnDocumentRequest Is used for interaction handle to query user decision regarding locked document.
UndoContextNotClosedException is thrown when an operation is attempted at an XUndoManager which requires all undo contexts to be closed, but this requirement is not fullfilled.
UndoFailedException thrown when reverting to re-applying an undoable action fails.
Constant Groups
LinkUpdateModes
MacroExecMode Specify whether a macro can be executed.
PrinterIndependentLayout specifies whether the document printer metric is used.
RedlineDisplayType specifies which changes in a document are displayed.
UpdateDocMode Specify the way a document can be updated.
Top of Page

Apache Software Foundation

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

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. 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.