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 :: util ::

interface XOfficeInstallationDirectories
Description
encapsulates access to the current office installation directory and office user data directory, provides functionality to create URLs containing relocatable (not absolute) references to the current office installation directory and user data directory and vice versa.

This functionality is useful when data containing references to the current office installation directory must be made persistent and re-read later. In many cases, storing the reference directly would destroy the relocatability of an office installation.

Since
OOo 2.0

Methods' Summary
getOfficeInstallationDirectoryURL returns the absolute URL containing the directory of the current office installation (e.g. "file:///opt/OpenOffice.org".)  
getOfficeUserDataDirectoryURL returns the absolute URL containing the directory where the current office installation expects its user data (e.g. "file:///home/kso/.openoffice.org".)  
makeRelocatableURL calculates a relocatable URL from the given URL.  
makeAbsoluteURL the counterpart of makeRelocatableURL.  
Methods' Details
getOfficeInstallationDirectoryURL
string
getOfficeInstallationDirectoryURL();

Description
returns the absolute URL containing the directory of the current office installation (e.g. "file:///opt/OpenOffice.org".)
Returns
the absolute URL containing the directory of the current office installation.
getOfficeUserDataDirectoryURL
string
getOfficeUserDataDirectoryURL();

Description
returns the absolute URL containing the directory where the current office installation expects its user data (e.g. "file:///home/kso/.openoffice.org".)
Returns
the absolute URL containing the directory of the current office user data.
makeRelocatableURL
string
makeRelocatableURL( [in] string  URL );

Description
calculates a relocatable URL from the given URL.

If the given URL contains an absolute reference to the current office installation directory or office user data directory, this method will replace the absolute reference by an opaque placeholder string. makeRelocatableURL must be used in order to re-replace the placeholder by an absolute reference.

Parameter URL
The URL for that a relocatable URL is requested. In case the URL does not contain a reference to the current office installation or to the office user data directory, the input URL will be returned unchanged.
Returns
The relocatable URL.
makeAbsoluteURL
string
makeAbsoluteURL( [in] string  URL );

Description
the counterpart of makeRelocatableURL.

If the given URL contains a placeholder for an absolute reference to the current office installation directory or for the office user data directory, that was created using makeRelocatableURL, the respective placeholder will be replaced by an absolute reference to the current office installation directory or office user data directory.

Parameter URL
The URL for that an absolaute URL is requested. In case the URL does not contain the opaque relocation placholder used by makeRelocatableURL, the input URL will be returned unchanged.
Returns
The absolute URL.
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.