Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

com :: sun :: star :: sdb ::

service DataSourceBrowser

Description
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 DatabaseContext instance of the system.

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 ContentLoader service, which creates and initializes the browser.

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:

For all kinds of URL's, the parameters supplied when dispatching it are as follows:

See also
com::sun::star::sdb::ContentLoader
See also
com::sun::star::sdb::DatabaseContext
See also
com::sun::star::sdb::DataSource
See also
com::sun::star::frame::XDispatch
See also
com::sun::star::frame::XDispatchInterceptor


Included Services

com::sun::star::form::FormController
[ OPTIONAL ]
Description
implements basic form controller functionality.

With a data source browser implementing this interface, external components have access to

  • the grid control which is used to display the currently selected table/query (see XFormController::getControls() )
  • the data form used for displaying objects. As always for components implementing this service, the object returned by XTabController::getModel() isadataform.


Exported Interfaces

com::sun::star::frame::XController
Description
allows the component to be plugged into frames.
com::sun::star::lang::XInitialization
Description
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:

  • Frame
    has to be an XFrame interface specifying the frame to plug the browser component into.
  • DataSourceName
    The name of the globally registered DataSource to be used for initial display. It is only meaningful together with the other parameters specifying the object to display.
  • CommandType
    This has to be a CommandType value, specifying the type of the object to display initially. It is only meaningful together with the DataSourceName and the Command parameters.
  • Command
    This is a string giving the name of the object to display initially. Whether it is table name, a query name or a SQL string is controller by the CommandType parameter.

com::sun::star::frame::XDispatchProvider
Description
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:

  • .uno:Copy
    implements the usual Copy command. Enabled if the grid view has the focus and text in any cell is selected.
  • .uno:Cut
    implements the usual Cut command. Enabled if the grid view has the focus and text in any cell is selected.
  • .uno:Paste
    implements the usual Paste command. Enabled if the grid view has the focus and a cell which allows text input is being edited.
  • .uno:EditDoc
    allows switching the edit mode of the grid view. Enabled if editing the data is allowed in general.
  • .uno:Undo
    revokes any changes done in the current row.
  • .uno:Save
    saves the changes done in the current row.


Top of Page