<html> <head> <title>Service ValueBinding</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="ValueBinding-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub">Included Services</td> <td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">form</a> :: <a href="module-ix.html" class="namechain">binding</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">service ValueBinding</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>defines a component which allows access to a single value </dd> <dd><p>Read/Write access to the value represented by this component is supported, as well as (optionally) active broadcasting of value changes</p> </dd> </dl> </td> </tr> </table> <hr> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>allows access to the properties of the binding </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XValueBinding.html">XValueBinding</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows read and write access to the value represented by this binding </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XModifyBroadcaster.html">XModifyBroadcaster</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>allows other components to be notified when the value represented by the <a href="ValueBinding.html">ValueBinding</a> instance changes. </dd> <dd><p>This interface is optional, since a binding may not support actively notifying changes in it's value. Note, however, that in case this interface is not supported, the bound component cannot react on value changes, and will thus override any values which are set by an instance other than itself.</p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows life time control for the component </dd> <dd><p>An <a href="ValueBinding.html">ValueBinding</a> may be known to one ore more components supporting the <a href="XBindableValue.html">XBindableValue</a> interface, which all work with this binding. However, they will not <em>own</em> the <a href="ValueBinding.html">ValueBinding</a>. The ownership is with another instance, which may also decide to obsolete the <a href="ValueBinding.html">ValueBinding</a> for whatever reasons (e.g. because the data model which the binding reflected died). For this reason, a <a href="ValueBinding.html">ValueBinding</a> must offer a possibility to be obsoleted by it's owner, and to notify this obsoletion to other interested parties, such as <a href="XBindableValue.html">XBindableValue</a>s.</p> </dd> </dl> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">[ readonly bound ] boolean<br> <a href="#ReadOnly">ReadOnly</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determines whether the value is currently readonly </td> </tr> <tr> <td class="imsum_left">[ readonly bound ] boolean<br> <a href="#Relevant">Relevant</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determines the relevance of the value represented by the binding </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="ReadOnly" class="membertitle">ReadOnly</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly bound ] boolean <b>ReadOnly</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determines whether the value is currently readonly </dd> <dd><p>For instance, you could imagine a <a href="ValueBinding.html">ValueBinding</a> which represents a cell in a spreadsheet document, and whose value is readonly as long as the spreadsheet is locked.</p> <p>As long as this property is <b>true</b>, the value binding should throw a <a href="InvalidBindingStateException.html">InvalidBindingStateException</a> when its <a href="XValueBinding.html">XValueBinding</a>::<a href="XValueBinding.html#setValue">setValue</a> method is invoked.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Relevant" class="membertitle">Relevant</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly bound ] boolean <b>Relevant</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determines the relevance of the value represented by the binding </dd> <dd><p>In a more complex scenario, where different form controls are bound to different values, which all are part of a larger data structure, some of the items in this data structure may not be relevant currently. This is indicated by the <a href="#Relevant">Relevant</a> property being <b>false</b>.</p> <p><a href="XBindableValue.html">XBindableValue</a>s which are bound to this binding may or may not react in certain ways on the (ir)relevance of their bound value.</p> <p>One possible reaction could be that user interface elements which are associated with the <a href="XBindableValue.html">XBindableValue</a> are disabled as long as <a href="#Relevant">Relevant</a> is <b>false</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>