:: com :: sun :: star :: drawing :: framework ::
|
unpublished |
interface XPaneFactory |
|
|
|
- Description
- Factory and possibly cache for creating and releasing panes.
A pane factory is registered at and used by an
XPaneController object.
A factory may want to implement a cache to reuse previously released
panes.
- See also
- XPaneController
|
Methods' Summary |
createPane |
Create a pane for the given URL. When the pane is not used anymore
then call releasePane() .
|
releasePane |
Call this method to tell a factory that the given pane is no longer
in use in any configuration. The factory can decide whether to
release its reference (and thus destroy the pane) or to keep it in a
cache in order to reuse it later.
|
Methods' Details |
createPane
- Description
- Create a pane for the given URL. When the pane is not used anymore
then call releasePane() .
- Parameter xPaneId
- The resourc URL of this id specifies the type of pane to create.
Valid values are those for which the factory has previously been
registered at the XPaneController .
- Returns
- Returns a pane object that has been just created or was taken
from a cache. When specified pane object can not be
created then an empty reference is returned. A later call may
then 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.
|
|
releasePane
void |
releasePane( |
[in] XPane |
xPane ); |
- Description
- Call this method to tell a factory that the given pane is no longer
in use in any configuration. The factory can decide whether to
release its reference (and thus destroy the pane) or to keep it in a
cache in order to reuse it later.
- Parameter xPane
- The given pane 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
Copyright © 2003 Sun Microsystems, Inc.