service DataSourceBrowser in module com::sun::star::sdb:: |
service DataSourceBrowser;
implements a component which allows browsing the data sources registered on the system.
This service implements a user interface for browsing data sources registered on the
It is possible to navigate through all the data sources, it's queries and it's tables. The queries/tables can be displayed in a grid-like view, where functionality for searching, sorting, filtering, and such is provided.
Usually, you won't instantiate this service directly, instead you use the dispatch mechanisms
of the application framework to load the URL .component:DB/DataSourceBrowser into an arbitrary
frame. This should involve a
Some aspects of the browser can be controlled from outside, eg., it is possible to dispatch a sort or filter request, if a table or query is being displayed.
The communication between the browser and external instances works in two ways.
The way in is provided by the
XDispatchProvider
interface the service exports (Please see below for more details on this).
The way out works in another way. There are several URL's which an external
instance can provide dispatches for (usually by implementing a
XDispatchProviderInterceptor
for the parent frame of the browser), thus indicating that the browser should provide special functionality.
In this case, the browser displays and maintains some additional slots (to be more concrete: toolbox items), which,
upon triggering, call the
XDispatch::dispatch() methodoftheobject
provided by the external instance.
In particular, the supported URL's for communicating to an external instance are:
Included Services |
implements basic form controller functionality.
With a data source browser implementing this interface, external components have access to
Exported Interfaces |
allows the component to be plugged into frames.
is used to initialize the browser.
Parameters (passed to the method
XInitialization::initialize()
)
have to be instances of
PropertyValue
, where the
PropertyValue::Name
member specifies what the parameter controls,
with the
PropertyValue::Value
member containing the value
to be used.
Recognized parameters are:
is used to control the browser from outside.
You may use the XDispatchProvider::queryDispatch method to query for objects which implement the XDispatch interface, and which allow you to be notified on status changes and to dispatch special requests.
The recognized URLs are:
Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.