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 XResourceFactory
Description
Factory and possibly cache for creating and releasing resources.

A resource factory is created and used by the XConfigurationController object.

A factory may want to implement a cache to reuse previously released resources.


Methods' Summary
createResource Create a resource for the given XResourceId object.  
releaseResource Call this method to tell a factory that the given resource is no longer in use. The factory can decide whether to destroy the resource or to keep it in a cache in order to reuse it later.  
Methods' Details
createResource
XResource
createResource( [in] XResourceId  xResourceId )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException );

Description
Create a resource for the given XResourceId object.
Parameter xResourceId
The resourc URL of this id specifies the type of resource to create. The anchor can be used to obtain the associated object from the configuration controller. For example, when a view is created, then the new object can be initialized with the pane that is its anchor.

Valid values are those for which the factory has previously been registered at the XConfigurationController

.
Returns
Returns a resource object that has been just created or was taken from a cache. When the requested resource can not be created then an empty reference is returned. A later call may be successfull. This, for example, can be the case with SFX based side panes. They are not available right after the creation of a new application frame.
Throws
InvalidArgumentException when the given URL is not supported by the factory.
releaseResource
void
releaseResource( [in] XResource  xResource );

Description
Call this method to tell a factory that the given resource is no longer in use. The factory can decide whether to destroy the resource or to keep it in a cache in order to reuse it later.
Parameter xResource
The given resource has to be one created by the same factory.
Throws
InvalidArgumentException when the given pane was not created by the same factory.
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.