Interface XStringResourceManager

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

:: com :: sun :: star :: resource ::

interface XStringResourceManager

Base Interfaces

XStringResourceManager
┗ XStringResourceResolver
   ┗ ::com::sun::star::util::XModifyBroadcaster

XStringResourceResolver

(referenced interface's summary:): Interface to access strings in a resource. The interface is derived from ::com::sun::star::util::XModifyBroadcaster All registered ::com::sun::star::util::XModifyListener interfaces will be notified if either the current locale changes or if a string is added, changed or removed. This usually will only happen if the implementing object also supports the interface XStringResourceManager and is used in the design mode of a Dialog or String table editor. But also changing the locale at runtime can be supported in this way.

Description: Interface to manage a resource string table containing a set of strings for different locales. The interface is derived from XStringResourceResolver that allows to access the string table but not to modify it. This interface also allows to modify the string table. It's designed to be used in the context of creating a string table, e.g. from a string table editor or from a Dialog Editor designing localized dialogs.

Methods' Summary
isReadOnly	Returns the resource's read only state
setCurrentLocale	Sets the locale to be used
setDefaultLocale	Sets the default locale to be used
setString	Associates a String to a Resource ID for the current locale. If an entry for the Resource ID already exists, the string associated with it will be overwritten, otherwise a new entry will be created.
setStringForLocale	Associates a String to a Resource ID for a specific locale. If an entry for the Resource ID already exists, the string associated with it will be overwritten, otherwise a new entry will be created. It's not recommended to use this method to get the best performance as the implementation may be optimized for the use of the current locale.
removeId	Removes a Resource ID including the corresponding string for the current locale.
removeIdForLocale	Removes a Resource ID including the corresponding string for s specific locale.
newLocale	Creates a new locale.
removeLocale	Removes a locale completely including the corresponding strings for each locale.
getUniqueNumericId	Provides a numeric id that is unique within all Resource IDs used in the string table. This method takes into account all Resource IDs starting with a decimal number and only evaluates the ID until the first non digit character is reached. This allows to extend unique IDs with individual identifiers without breaking the mechanism of this method. Examples: ID "42" -> numeric id 42 ID "0foo" -> numeric id 0 ID "111.MyId.Something.Else" -> numeric id 111 ID "No Digits" -> not considered for numeric id The id returned will be 0 for an empty string table and it will be reset to 0 if all locales are removed. In all other cases this method returns the maximum numeric id used so far at the beginning of a Resource ID incremented by 1. When calling this method more than once always the same number will be returned until this number is really used at the beginning of a new Resource ID passed to setString or setStringForLocale. As the numeric id is guaranteed to be unique for the complete string table all locales are taken into account. So using this methods will force the implementation to load all locale data that may not have been loaded so far.

Methods' Details

isReadOnly

boolean
isReadOnly();

Description: Returns the resource's read only state
Returns: true if the resource is read only, otherwise false

setCurrentLocale

void
setCurrentLocale(	[in] ::com::sun::star::lang::Locale	locale,
	[in] boolean	FindClosestMatch )
raises(	::com::sun::star::lang::IllegalArgumentException );

Description

Sets the locale to be used

Parameter aLocale

Specifies the current locale to be used.

Parameter FindClosestMatch

If true: If the exact locale that should be set is not available the method tries to find the closest match. E.g. if en_US is re- quired but not available, en would be the next choice. Finally the default locale will be used true.

If false: If the exact locale that should be set is not available a ::com::sun::star::lang::IllegalArgumentException is thrown.

setDefaultLocale

void
setDefaultLocale(	[in] ::com::sun::star::lang::Locale	locale )
raises(	::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::NoSupportException );

Description: Sets the default locale to be used
Parameter aLocale: Specifies the default locale to be used. If this locale is not available a ::com::sun::star::lang::IllegalArgumentException is thrown.
Throws: ::com::sun::star::lang::NoSupportException if the resource is read only, see isReadOnly

setString

void
setString(	[in] string	ResourceID,
	[in] string	Str )
raises(	::com::sun::star::lang::NoSupportException );

Description: Associates a String to a Resource ID for the current locale. If an entry for the Resource ID already exists, the string associated with it will be overwritten, otherwise a new entry will be created.
Parameter ResourceID: ID to address the string inside the resource for the current locale.
Parameter Str: String to be associated with the Resource ID.
Throws: ::com::sun::star::lang::NoSupportException if the resource is read only, see isReadOnly

setStringForLocale

void
setStringForLocale(	[in] string	ResourceID,
	[in] string	Str,
	[in] ::com::sun::star::lang::Locale	locale )
raises(	::com::sun::star::lang::NoSupportException );

Description: Associates a String to a Resource ID for a specific locale. If an entry for the Resource ID already exists, the string associated with it will be overwritten, otherwise a new entry will be created. It's not recommended to use this method to get the best performance as the implementation may be optimized for the use of the current locale.
Parameter ResourceID: ID to address the string inside the resource.
Parameter Str: String to be associated with the Resource ID.
Parameter locale: The locale the string should be set for. The locale has to match exactly with one of the locales provided by getLocales. A closest match search is not supported.
Throws: ::com::sun::star::lang::NoSupportException if the resource is read only, see isReadOnly

removeId

void
removeId(	[in] string	ResourceID )
raises(	MissingResourceException, ::com::sun::star::lang::NoSupportException );

Description: Removes a Resource ID including the corresponding string for the current locale.
Parameter ResourceID: The Resource ID to be removed for the current locale.
Throws: MissingResourceException if the Resource ID is not valid.
Throws: ::com::sun::star::lang::NoSupportException if the resource is read only, see isReadOnly

removeIdForLocale

void
removeIdForLocale(	[in] string	ResourceID,
	[in] ::com::sun::star::lang::Locale	locale )
raises(	MissingResourceException, ::com::sun::star::lang::NoSupportException );

Description: Removes a Resource ID including the corresponding string for s specific locale.
Parameter ResourceID: The Resource ID to be removed.
Parameter locale: The locale the Resource ID should be removed for. The locale has to match exactly with one of the locales provided by getLocales. A closest match search is not supported.
Throws: MissingResourceException if the Resource ID is not valid.
Throws: ::com::sun::star::lang::NoSupportException if the resource is read only, see isReadOnly

newLocale

void
newLocale(	[in] ::com::sun::star::lang::Locale	locale )
raises(	::com::sun::star::container::ElementExistException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::NoSupportException );

Description: Creates a new locale.; For each existing ResourceID an empty string will be created. The first locale created will automatically be the first default locale. Otherwise strings for all already created IDs will be copied from the default locale.
Throws: ::com::sun::star::container::ElementExistException if the Locale already has been created.
Throws: ::com::sun::star::lang::IllegalArgumentException if the Locale is not valid.
Throws: ::com::sun::star::lang::NoSupportException if the resource is read only, see isReadOnly

removeLocale

void
removeLocale(	[in] ::com::sun::star::lang::Locale	locale )
raises(	::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::NoSupportException );

Description: Removes a locale completely including the corresponding strings for each locale.
Throws: ::com::sun::star::lang::IllegalArgumentException if the Locale to be removed is not supported.
Throws: ::com::sun::star::lang::NoSupportException if the resource is read only, see isReadOnly

getUniqueNumericId

long
getUniqueNumericId()
raises(	::com::sun::star::lang::NoSupportException );

Description: Provides a numeric id that is unique within all Resource IDs used in the string table. This method takes into account all Resource IDs starting with a decimal number and only evaluates the ID until the first non digit character is reached. This allows to extend unique IDs with individual identifiers without breaking the mechanism of this method. Examples: ID "42" -> numeric id 42 ID "0foo" -> numeric id 0 ID "111.MyId.Something.Else" -> numeric id 111 ID "No Digits" -> not considered for numeric id The id returned will be 0 for an empty string table and it will be reset to 0 if all locales are removed. In all other cases this method returns the maximum numeric id used so far at the beginning of a Resource ID incremented by 1. When calling this method more than once always the same number will be returned until this number is really used at the beginning of a new Resource ID passed to setString or setStringForLocale. As the numeric id is guaranteed to be unique for the complete string table all locales are taken into account. So using this methods will force the implementation to load all locale data that may not have been loaded so far.
Throws: ::com::sun::star::lang::NoSupportException if the next available id exceeds the range of type long. So it's not recommended to use own Resource IDs starting with a decimal number near to the maximum long value if this methods should be used.

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous