Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: form :: binding ::

unpublished service BindableControlModel
Usage Restrictions
not published
Description
specifies the model of a form control which supports binding to an external value supplier.

Included Services - Summary
::com::sun::star::form::FormControlModel

specifies the basic functionality for a form control model (details)

Exported Interfaces - Summary
XBindableValue

specifies support for being bound to an external value (details)

Included Services - Details
::com::sun::star::form::FormControlModel
Description
specifies the basic functionality for a form control model

Via this service, bindable control models inherit the ::com::sun::star::util::XCloneable interface.
If an bindable control model, at which a binding has been established (via XBindableValue::setValueBinding), is being cloned, then the binding is also established at the clone. Effectively, this means that both control model instances share the same binding instance.

Exported Interfaces - Details
XBindableValue
Description
specifies support for being bound to an external value

When a BindableControlModel is bound to an external value, then every change in the control model's value is immediately reflected in the external binding.

If the binding set via this interface supports the ValueBinding::ReadOnly and ValueBinding::Relevant properties, they're respected by the control model:

  • The control model's own ReadOnly property (if present) is kept in sync with the binding's ReadOnly property. That is, any control using the value binding is read-only as long as the binding is.
  • The control model's own Enabled property (if present) is kept in sync with the binding's Relevant property. That is, any control using the value binding is disabled as long as the binding is not relevant.

In both cases, explicit changes of the model's property are ignored if they would relax the restriction imposed by the binding.
For instance, if the binding declares it's value to be read-only (indicated by ValueBinding::ReadOnly being true), then any attempt to set the ReadOnly property of the control model to false will fail. However, if the binding's value is not read-only, then the ReadOnly property at the control model can be freely set.
The very same holds for the binding's ValueBinding::Relevant and the control model's Enabled properties.


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.