:: com :: sun :: star :: form :: component ::
|
service GridControl |
- Description
- specifies a model for a control which can display form data in a table-like way.
In opposite to other form controls, grid controls do not only
display the single current value of a column they are bound to. Moreover, they do
display not only the current row of the form, but all rows (at least potentially, limited
by the control size, of course).
The table rows in a grid control correspond to the rows in the DataForm
the control belongs to, and the columns correspond to single columns of the form's row set.
Columns of a grid control are modeled by own objects, too. They are very similar to usual
::com::sun::star::form::DataAwareControlModels modeling other "single-value" controls, but they are not described
as own services. Instead, they need to be created using the ::com::sun::star::form::XGridColumnFactory interface.
|
Properties' Summary |
short
Border |
returns the border style of the control.
|
long
BorderColor |
[ OPTIONAL ]
specifies the color of the border, if present
|
boolean
Enabled |
determines whether the control is enabled or disabled.
|
::com::sun::star::awt::FontDescriptor
FontDescriptor |
contains the font attributes of the text in the control.
|
long
RowHeight |
specifies the height of a row of the grid.
|
boolean
Tabstop |
determines whether the control can be reached by the tabulator key.
|
::com::sun::star::util::Color
TextColor |
specifies the text color (RGB) of the control.
|
Exported Interfaces - Details |
::com::sun::star::form::XGridColumnFactory
- Description
- allows to create column models to be inserted into the control model.
Note that the object returned by the ::com::sun::star::form::XGridColumnFactory::createColumn
method is not part of the grid control, yet. It needs to be inserted using any of the
container interfaces.
You always need to use this interface for creating columns for the grid control.
Column models not created this way will not be accepted when inserted later on.
|
|
::com::sun::star::view::XSelectionSupplier
- Usage Restrictions
- deprecated
- Description
- gives access to the currently selection.
In a grid control, single columns can be selected (at most one at a time).
For various unfortunate reaons, this selection is an aspect of the model, not of the
control as you would expect.
This interface is deprecated, new implementations should not use it anymore, as it is to
be superseeded by a solution which is bound to the control, not the model.
|
|
::com::sun::star::form::XReset
- Description
- resets the control.
The reset of the control is forwarded to all it's elements, means to all the column models.
As grid columns are very much like data-aware stand-alone controls, you can find a description
of the reset functionality in ::com::sun::star::form::DataAwareControlModel::XReset.
|
|
Properties' Details |
Border
short Border;
- Description
- returns the border style of the control.
0: No border
1: 3D border
2: simple border
|
|
BorderColor
long BorderColor;
- Usage Restrictions
- optional
- Description
- specifies the color of the border, if present
Not every border style (see Border) may support coloring.
For instance, usually a border with 3D effect will ignore the BorderColor setting.
- Since
- OOo 2.0
|
|
Enabled
boolean Enabled;
- Description
- determines whether the control is enabled or disabled.
|
|
FontDescriptor
::com::sun::star::awt::FontDescriptor FontDescriptor;
- Description
- contains the font attributes of the text in the control.
|
|
RowHeight
long RowHeight;
- Description
- specifies the height of a row of the grid.
If the value is set to NULL, the height is determined automatically according
to the current font used.
- See also
- GridControl::FontDescriptor
|
|
Tabstop
boolean Tabstop;
- Description
- determines whether the control can be reached by the tabulator key.
|
|
TextColor
::com::sun::star::util::Color TextColor;
- Description
- specifies the text color (RGB) of the control.
|
|
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.