:: com :: sun :: star :: sdb :: application ::
|
unpublished |
interface XTableUIProvider |
|
|
|
- Usage Restrictions
- not published
- Description
- is used by the database application to obtain non-default user
interface information and/or components for database tables.
- Since
- OOo 2.2
- See also
- ::com::sun::star::sdb::Connection
|
Methods' Summary |
getTableIcon |
provides the icon which should be used to represent the table in the
database application window.
|
getTableEditor |
returns a component which can be used to edit the definition of an
existing table.
|
Methods' Details |
getTableIcon
::com::sun::star::graphic::XGraphic |
getTableIcon( |
[in] string |
TableName, |
| [in] long |
ColorMode ); |
- Description
- provides the icon which should be used to represent the table in the
database application window.
The icon will usually be requested once per table, and cached. It
might be requested again if the application settings change, for instance,
if another desktop theme has been activated.
- Parameter TableName
- denotes the fully qualified name of the database table.
- Parameter ColorMode
- denotes the color mode of the graphic to retrieve, being one of the
::com::sun::star::graphic::GraphicColorMode constants.
- Returns
- the icon which should be used to represent the table in the
database application window, or NULL if the default icon
should be used.
|
|
getTableEditor
- Description
- returns a component which can be used to edit the definition of an
existing table.
- Parameter DocumentUI
- provides access to the UI in which the database document is
currently displayed.
In particular, this paramter provides access to the application's main
window, which is needed in case the table editor should be a dialog.
- Parameter TableName
- denotes the fully qualified name of an existing table.
- Returns
- a component which can be used to edit the definition of an
existing table, or NULL if the default component should
be used.
Two component types are supported so far
- modal dialogs
If the returned component supports the
::com::sun::star::ui::dialogs::XExecutableDialog
interface, the dialog will be executed modally.
- modeless frames
If the returned component supports the
::com::sun::star::frame::XController
interface, it is assumed that it represents a controller,
loaded into a new frame, which is a modeless and, in its lifetime,
depends on the application main window.
If the returned component does not support any of the above-mentioned
interfaces, it's discarded.
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if the given TableName does not denote an existing table
- Throws
- ::com::sun::star::lang::WrappedTargetException
if an error occures while creating the table editor component.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.