is an abstract service for specialized FormControlModels
which are data aware and thus can be bound to a data source.
The connection between a data-aware control model and a form which's data the
control should display is made by parentship relations. The parent of a data-aware
control model (see ::com::sun::star::container::XChild, inherited
via the FormControlModel and FormComponent services) has
always to be a ::com::sun::star::form::component::DataForm.
must be implemented in order to recognize when the containing form of the model connects
to its data source (loads its data). After loading the form, the model may bind to its
related field source.
This interface will seldom be used directly from outside.
makes it possible to transfer the data of the model to the connected data field.
This interface is optional, if a component doesn't support it, it has to forward
the changes of it's value to the field it is connected to immediately (means whenever a user
interaction changes it's content).
must be implemented in order to recognize when the containing form of the model connects
to its data source (loads its data). After loading the form, the model may bind to its
related field source.
This interface will seldom be used directly from outside.
In the context of a control model which is data-aware, the semantics of default value
(see XReset) is as follows:
If (and only if) the control is valid bound to a column of it's ::com::sun::star::form::component::DataForm, and the form
is not positioned on a new record (see ::com::sun::star::sdb::RowSet::IsNew), then
XReset::reset does not reset the model's value to it's default value, but uses the
underlying column value.
In all other cases, the model is reset to the default value as specified by the respective property.
This property makes sense in the context of the control model only. Normally, a control model
is a child of a ::com::sun::star::form::component::DataForm, which is bound
to a higher level object such as a table or query - more general, a result set.
This member here describes the column of this result set which the control should act for.
Not every control model can be bound to every database column. Usually, super services of the
DataAwareControlModel restrict the column types they can be used with.
determines whether or not input into this field is required, when it is actually bound to a database field.
If this property is set to false, then the form runtime will not check the control/model for
NULL values before submitting data to the database. Usually, if a control model is bound to
a database field which cannot be NULL, and the model itself does not have a value, then the database
update is prevented, showing an error message to the user. To disable this behavior on a per-control
basis, use the InputRequired property.
references to the cursor field to which the control is bound.
Applies only if the form the control model belongs to is loaded and the control is valid bound.
The referenced field supports the ::com::sun::star::sdb::Column service.
references to a control model within the same document which should be used as a label.
Any user interface action which needs to refer to the control is assumed to use this
property.
A very common design method for forms is to group a data aware control with a label control,
with the latter describing the content of the former. For instance, you may have a
::com::sun::star::form::component::TextField, which is bound to the e-mail
column of your data source. Then you will probably add a
::com::sun::star::form::component::FixedText which's label is "E-Mail",
and associate it with the TextField by setting it as LabelControl.
Now if you imagine a component offering data search in a form, this component will examine
the LabelControl property, find the ::com::sun::star::form::component::FixedText,
examine it's label, and use this label to refer to the ::com::sun::star::form::component::TextField.
When setting the property, a number of constraints apply:
The object which is to be set has to support the following interfaces
It has to be a part of the same document as the model who's property is to be modified.
Additionally, the support of a special service, indicating that the model is of the right type,
is required. Which kind of service is in the request depends on the type of the control model.
For instance, text fields (::com::sun::star::form::component::TextField) can be
labelled by label controls only (::com::sun::star::form::component::FixedText),
and radio buttons (::com::sun::star::form::component::RadioButton) can be labelled
by group boxes (::com::sun::star::form::component::GroupBox) only.
