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 :: drawing :: framework ::

interface XConfiguration
Base Interfaces
XConfiguration
┗ ::com::sun::star::util::XCloneable

::com::sun::star::util::XCloneable
(referenced interface's summary:)
makes it possible to create a copy of the object which supports this interface.
Description
A configuration describes the resources of an application like panes, views, and tool bars and their relationships that are currently active or are requested to be activated. Resources are specified by ResourceId structures rather than references so that not only the current configuration but also a requested configuration can be represented.

Direct manipulation of a configuration object is not advised with the exception of the ConfigurationController and objects that implement the XConfigurationChangeRequest interface.

See also
XConfigurationController

Methods' Summary
getResources Returns the list of resources that are bound directly and/or indirectly to the given anchor. A URL filter can reduce the set of returned resource ids.  
hasResource  
addResource Add a resource to the configuration.  
removeResource Remove a resource from the configuration.  
Methods' Details
getResources
sequence< XResourceId >
getResources( [in] XResourceId  xAnchorId,
[in] string  sTargetURLPrefix,
[in] AnchorBindingMode  eSearchMode );

Description
Returns the list of resources that are bound directly and/or indirectly to the given anchor. A URL filter can reduce the set of returned resource ids.
Parameter xAnchorId
This anchor typically is either a pane or an empty XResourceId object. An empty reference is treated like an XResourceId object.
Parameter sURLPrefix
When a non-empty string is given then resource ids are returned only when their resource URL matches this prefix, i.e. when it begins with this prefix or is equal to it. Characters with special meaning to URLs are not interpreted. In the typical usage the prefix specifies the type of a resource. A typical value is "private:resource/floater/", which is the prefix for pane URLs. In a recursive search, only resource ids at the top level are matched against this prefix.

Use an empty string to prevent filtering out resource ids.

Parameter eSearchMode
This flag defines whether to return only resources that are directly bound to the given anchor or a recursive search is to be made. Note that for the recursive search and an empty anchor all resource ids are returned that belong to the configuration.
Returns
The set of returned resource ids may be empty when there are no resource ids that match all conditions. The resources in the sequence are ordered with respect to the XResourceId::compareTo() method.
hasResource
boolean
hasResource( [in] XResourceId  xResourceId );

Description

Returns wether the specified resource is part of the configuration.

This is independent of whether the resource does really exist and is active, i.e. has a visible representation in the GUI.
Parameter xResourceId
The id of a resource. May be empty (empty reference or empty XResourceId object) in which case false is returned.
Returns
Returns true when the resource is part of the configuration and false when it is not.
addResource
void
addResource( [in] XResourceId  xResourceId );

Description
Add a resource to the configuration.

This method should be used only by objects that implement the ::XConfigurationRequest interface or by the configuration controller.

Parameter xResourceId
The resource to add to the configuration. When the specified resource is already part of the configuration then this call is silently ignored.
Throws
IllegalArgumentException When an empty resource id is given then an IllegalArgumentException is thrown.
removeResource
void
removeResource( [in] XResourceId  xResource );

Description
Remove a resource from the configuration.

This method should be used only by objects that implement the ::XConfigurationRequest interface or by the configuration controller.

Parameter xResourceId
The resource to remove from the configuration. When the specified resource is not part of the configuration then this call is silently ignored.
Throws
IllegalArgumentException When an empty resource id is given then an IllegalArgumentException is thrown.
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.