1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_binding_BindableDataAwareControlModel_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_form_binding_BindableDataAwareControlModel_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_DataAwareControlModel_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/form/DataAwareControlModel.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_binding_BindableControlModel_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/form/binding/BindableControlModel.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module form { module binding { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski/** is a specialization of the <type scope="com::sun::star::form">DataAwareControlModel</type> 42*b1cdbd2cSJim Jagielski which additionally supports binding to external value suppliers. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski <p>Control models usually have some kind of value property, which reflects the very current 45*b1cdbd2cSJim Jagielski content of the controls associated with this model. For instance, for an 46*b1cdbd2cSJim Jagielski <type scope="com::sun::star::form::component">TextField</type>, this would be the 47*b1cdbd2cSJim Jagielski <member scope="com::sun::star::awt">UnoControlEditModel::Text</member> property of the base 48*b1cdbd2cSJim Jagielski service. Similarily, a <type scope="com::sun::star::form::component">CheckBox</type> has 49*b1cdbd2cSJim Jagielski a property <member scope="com::sun::star::awt">UnoControlCheckBoxModel::State</member>, which 50*b1cdbd2cSJim Jagielski reflects the current check state.</p> 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski <p>Usual <type scope="com::sun::star::form">DataAwareControlModel</type>s can be bound to 53*b1cdbd2cSJim Jagielski a column of a <type scope="com::sun::star::form::component">DataForm</type>, and exchange 54*b1cdbd2cSJim Jagielski their content with such a column.<br/> 55*b1cdbd2cSJim Jagielski In particular, when the <type scope="com::sun::star::form::component">DataForm</type> 56*b1cdbd2cSJim Jagielski is moved to a different record, then the bound control model is updated with the value of 57*b1cdbd2cSJim Jagielski it's column in this particular row.<br/> 58*b1cdbd2cSJim Jagielski On the other hand, when any change in the control model (e.g. resulting from a user entering 59*b1cdbd2cSJim Jagielski data in a control associated with the control model) is committed 60*b1cdbd2cSJim Jagielski (<member scope="com::sun::star::form">XBoundComponent::commit</member>), then the actual 61*b1cdbd2cSJim Jagielski data of the control model is written into the associated 62*b1cdbd2cSJim Jagielski <type scope="com::sun::star::form::component">DataForm</type> column.</p> 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski <p><type>BindableDataAwareControlModel</type>'s additionally support an alternative value 65*b1cdbd2cSJim Jagielski binding, which forces them to exchange their value with another foreign instance. 66*b1cdbd2cSJim Jagielski In some sense, they are an abstraction of the data aware control models, which only 67*b1cdbd2cSJim Jagielski support a specialized, hard-coded value binding (namely the binding to a 68*b1cdbd2cSJim Jagielski <type scope="com::sun::star::form::component">DataForm</type> column).</p> 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski <p>For this, they provide the <type>XBindableValue</type> interface which allows to 71*b1cdbd2cSJim Jagielski set an external component to exchange the value with.</p> 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski <p>The following rules apply when a data aware control model is bound to an external value binding: 74*b1cdbd2cSJim Jagielski <ul><li><b>Priority</b><br/> 75*b1cdbd2cSJim Jagielski External value bindings overrule any active SQL-column binding. If an external 76*b1cdbd2cSJim Jagielski component is bound to a control model which currently has an active SQL binding, 77*b1cdbd2cSJim Jagielski this SQL binding is suspended, until the external binding is revoked. 78*b1cdbd2cSJim Jagielski </li> 79*b1cdbd2cSJim Jagielski <li><b>Activation</b><br/> 80*b1cdbd2cSJim Jagielski An external value binding becomes effective as soon as it is set. This is a 81*b1cdbd2cSJim Jagielski difference to SQL bindings, which only are effective when the parent form 82*b1cdbd2cSJim Jagielski of the control model is loaded (<type scope="com::sun::star::form">XLoadable</type>). 83*b1cdbd2cSJim Jagielski </li> 84*b1cdbd2cSJim Jagielski <li><b>Immediacy</b><br/> 85*b1cdbd2cSJim Jagielski When a <type>BindableDataAwareControlModel</type> is bound to an external value, 86*b1cdbd2cSJim Jagielski then every change in the control model's value is <em>immediately</em> reflected 87*b1cdbd2cSJim Jagielski in the external binding. This is a difference to SQL bindings of most 88*b1cdbd2cSJim Jagielski <type scope="com::sun::star::form">DataAwareControlModel</type>'s, where changes 89*b1cdbd2cSJim Jagielski in the control model's value are only propagated to the bound column upon explicit 90*b1cdbd2cSJim Jagielski request via <member scope="com::sun::star::form">XBoundComponent::commit</member>.<br/> 91*b1cdbd2cSJim Jagielski Note that this restriction is inherited from the <type>BindableControlModel</type>. 92*b1cdbd2cSJim Jagielski </li> 93*b1cdbd2cSJim Jagielski <li><b>Cloning</b><br/> 94*b1cdbd2cSJim Jagielski <type scope="com::sun::star::form">FormControlModel</type>s support cloning themself 95*b1cdbd2cSJim Jagielski via the <type scope="com::sun::star::util">XCloneable</type> interface which they 96*b1cdbd2cSJim Jagielski inherit from the <type scope="com::sun::star::awt">UnoControlModel</type> service.</br> 97*b1cdbd2cSJim Jagielski When a <type>BindableDataAwareControlModel</type> is cloned while it has an active 98*b1cdbd2cSJim Jagielski external value binding, then the clone is also bound to the same binding instance.<br/> 99*b1cdbd2cSJim Jagielski Note that this restriction is inherited from the <type>BindableControlModel</type>. 100*b1cdbd2cSJim Jagielski </li> 101*b1cdbd2cSJim Jagielski </ul> 102*b1cdbd2cSJim Jagielski </p> 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski <p>When a <type>BindableDataAwareControlModel</type> is being bound to an external value, 105*b1cdbd2cSJim Jagielski using <member>XBindableValue::setValueBinding</member>, 106*b1cdbd2cSJim Jagielski then the control model (it's value property, respectively) and the external value are 107*b1cdbd2cSJim Jagielski initially synchronized by setting the external value (<member>XValueBinding::getValue</member>) 108*b1cdbd2cSJim Jagielski at the control model.</p> 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski*/ 111*b1cdbd2cSJim Jagielskiservice BindableDataAwareControlModel 112*b1cdbd2cSJim Jagielski{ 113*b1cdbd2cSJim Jagielski /** specifies the functionality for binding the control model to a 114*b1cdbd2cSJim Jagielski column of an SQL <type scope="com::sun::star::form::component">DataForm</type>. 115*b1cdbd2cSJim Jagielski */ 116*b1cdbd2cSJim Jagielski service com::sun::star::form::DataAwareControlModel; 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski /** specifies the functionality for <em>alternatively</em> binding the control model 119*b1cdbd2cSJim Jagielski to an external value. 120*b1cdbd2cSJim Jagielski */ 121*b1cdbd2cSJim Jagielski service BindableControlModel; 122*b1cdbd2cSJim Jagielski}; 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski//============================================================================= 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski}; }; }; }; }; 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski#endif 129