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

unpublished interface XPaneController
Base Interfaces
XPaneControllerXResourceController

XResourceController
Description
The pane sub controller manages the set of active panes and controls their life time.

It maintains the set of active panes and the list of pane factories that take over the actual creation and deletion of panes.

See also
XControllerManager, XConfigurationController, XPane

Methods' Summary
addPaneFactory Register a new factory for the given URL.  
removePaneFactoryForURL Remove a factory for one type of pane. When the factory has been registered for other URLs as well then they remain registered. Use the removePaneFactoryForReference to remove a factory completely.  
removePaneFactoryForReference Remove a factory for pane types it has been registered for. Use removePaneFactoryForURL to remove a factory just for one URL and to leave it registered for others.  
getPane Return the pane object that has been created for the given ResourceId .  
Methods' Details
addPaneFactory
void
addPaneFactory( [in] string  sPaneURL,
[in] XPaneFactory  xPaneFactory );

Description
Register a new factory for the given URL.

When one factory is responsible for more than one type of pane then this method has to be called for each time. If this method is called multiple times for the same URL then a previously registered factory is removed for the URL.

Parameter sPaneURL
The URL of the pane that the factory can create.
Parameter xPaneFactory
The factory object.
removePaneFactoryForURL
void
removePaneFactoryForURL( [in] string  sPaneURL );

Description
Remove a factory for one type of pane. When the factory has been registered for other URLs as well then they remain registered. Use the removePaneFactoryForReference to remove a factory completely.
Parameter sPaneURL
The URL for which to remove the factory.
removePaneFactoryForReference
void
removePaneFactoryForReference( [in] XPaneFactory  xPaneFactory );

Description
Remove a factory for pane types it has been registered for. Use removePaneFactoryForURL to remove a factory just for one URL and to leave it registered for others.
Parameter xPaneFactory
The factory object to remove.
getPane
XPane
getPane( [in] XResourceId  xPaneId );

Description
Return the pane object that has been created for the given ResourceId .
Parameter xPaneId
The resource id of the pane for which to return the pane object.
Returns
Returns an empty reference when no pane has been created yet for the given ResourceId .
Top of Page