:: com :: sun :: star :: drawing :: framework ::

interface XConfigurationController
Base Interfaces
XConfigurationControllerXConfigurationControllerRequestQueueXConfigurationControllerBroadcasterXResourceFactoryManager

XConfigurationControllerRequestQueue
XConfigurationControllerBroadcaster
XResourceFactoryManager

Methods' Summary
requestResourceActivation Request the activation of a resource.  
requestResourceDeactivation Request the deactivation of a resource.  
getResource Return the active resource specified by the given resource id.  
lock Lock the processing of configuration change requests.  
unlock Unlock the processing of configuration change requests.  
update Explicitly request an update of the current configuration.  
getRequestedConfiguration Return a copy of the requested configuration.  
getCurrentConfiguration Return a copy of the current configuration.  
restoreConfiguration Replace the requested configuration with the given configuration and schedule an update of the current configuration.  
Methods' Details
requestResourceActivation
void
requestResourceActivation( [in] XResourceId  xResourceId,
[in] ResourceActivationMode  eMode );

Description
Request the activation of a resource.

The request is processed asynchronously. Notifications about configuration changes are sent after this call returns.

Parameter xResourceId
The resource whose activation is requested.
Parameter eMode

When eMode is REPLACE then, before adding the resource activation to the request queue, similar resources linked to the same anchor are removed. This makes it easer to switch between resources whose activation is mutually exclusive. For example, there can only be one view per pane, so before activating a new view the old one has to be deactivated.

When eMode is ADD then the resource is requested without further changes.

requestResourceDeactivation
void
requestResourceDeactivation( [in] XResourceId  xResourceId );

Description
Request the deactivation of a resource.

The request is processed asynchronously. Notifications about configuration changes are sent after this call returns.

Requesting the deactivation of a resource that is not active is not an error.

Parameter xResourceId
The resource whose deactivation is requested.
getResource
XResource
getResource( [in] XResourceId  xResourceId );

Description
Return the active resource specified by the given resource id.
Parameter xResourceId
A valid resource id. This should, but does not have to be, the resource id of an active resource.
Returns
When the given resource id specifies an active resource then that resource is returned. Otherwise an empty reference is returned.
lock
void
lock();

Description
Lock the processing of configuration change requests.

This is only necessary when more than one change request is being made in a row. It prevents an update being made (with all the visible UI changes) before all change requests are being made.

Recursive lock() calls are recognized: the configuration controller is locked while lock() was called more often than unlock().

unlock
void
unlock();

Description
Unlock the processing of configuration change requests.

When unlock() is called as many times as lock() and the queue of configuration change requests is not empty the configuration controller continues the processing of the change requests. An update of the current configuration will eventually being made.

update
void
update();

Description
Explicitly request an update of the current configuration.

Call it when a resource is activated or deactivated without the control and knowledge of the drawing framework. Calling this method (from outside the drawing framework) should hardly every be necessary.

getRequestedConfiguration
XConfiguration
getRequestedConfiguration();

Description
Return a copy of the requested configuration.

Modifications to the returned configuration have no effect on the drawing framework.

getCurrentConfiguration
XConfiguration
getCurrentConfiguration();

Description
Return a copy of the current configuration.

Modifications to the returned configuration have no effect on the drawing framework.

restoreConfiguration
void
restoreConfiguration( [in] XConfiguration  xConfiguration );

Description
Replace the requested configuration with the given configuration and schedule an update of the current configuration.

Together with the getCurrentConfiguration() and getRequestedConfiguration() methods this allows the saving and restoring of configurations. However, the given configuration can have other origins then these methods.

The given configuration is transformed into a list of of change requests so that the resulting requested configuration equals the given configuration. This has the advantage that not only the resource activations and deactivations but all configuration changes are properly broadcasted.

Note that because of the configuration change notifications listeners can make more configuration change requests, so that the resulting requested configuration can be different from the given configuration.

Parameter xConfiguration
This typically is a configuration that was obtained with an earlier getRequestedConfiguration() call.
Top of Page