<html> <head> <title>Interface XValidatableFormComponent</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="XValidatableFormComponent-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"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</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">validation</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">interface XValidatableFormComponent</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XValidatableFormComponent</strong> ┗ <a href="XValidatable.html">XValidatable</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XValidatable.html">XValidatable</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>specifies support for validating a component </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>is a convenience interface for accessing several aspects of a form component which supports validation. </dd> <dd><p>A validatable form component has two aspects which other parties might be interested in: <ul> <li>The pure validity flag: Whatever the user enters in the component, this is either valid (relative to the active validator), or invalid.</li> <li>The current value: Even if the validity flag does not change with the user input (e.g. because the user replaces one invalid value with another invalid value), observers might be interested in the current value, for example to include it in a feedback message to the user.</li> </ul> </p> <p>An <a href="XValidatableFormComponent.html">XValidatableFormComponent</a> allows to easily access both of these aspects.</p> <p>Note that all of the information provided at this interface can also obtained by other means, but much more inconviniently.</p> </dd> <dt><b>See also</b></dt> <dd><a href="XValidatable.html">XValidatable</a>, <a href="XValidator.html">XValidator</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#isValid">isValid</a></td> <td class="imsum_right">determines whether the current value of the component passed the validity test at the validator. </td> </tr> <tr> <td class="imsum_left"><a href="#getCurrentValue">getCurrentValue</a></td> <td class="imsum_right">retrieves the current value of the component. </td> </tr> <tr> <td class="imsum_left"><a href="#addFormComponentValidityListener">addFormComponentValidityListener</a></td> <td class="imsum_right">registers the given listener. </td> </tr> <tr> <td class="imsum_left"><a href="#removeFormComponentValidityListener">removeFormComponentValidityListener</a></td> <td class="imsum_right">registers the given listener. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="isValid" class="membertitle">isValid</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isValid</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the current value of the component passed the validity test at the validator. </dd> <dd><p>Calling this is equal to calling <a href="XValidator.html">XValidator</a>::<a href="XValidator.html#isValid">isValid</a> with the current value (see <a href="#getCurrentValue">getCurrentValue</a>) of the component, where the validator is obtained via <a href="XValidatable.html">XValidatable</a>::<a href="XValidatable.html#getValidator">getValidator</a>.</p> <p>If no validator has been set (<a href="XValidatable.html">XValidatable</a>::<a href="XValidatable.html#setValidator">setValidator</a>), this method returns true.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCurrentValue" class="membertitle">getCurrentValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>getCurrentValue</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the current value of the component. </dd> <dd><p>The type of the current value, as well as it's semantics, depend on the service implementing this interface.</p> <p>Again, this is a convenience method. For example, for a ::com::sun::star::form::<a href="../component/module-ix.html">component</a>::<a href="../component/FormattedField.html">FormattedField</a>, calling this method is equivalent to retrieving the ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlFormattedFieldModel.html">UnoControlFormattedFieldModel</a>::<a href="../../awt/UnoControlFormattedFieldModel.html#EffectiveValue">EffectiveValue</a>.</p> <p>If no validator has been set (<a href="XValidatable.html">XValidatable</a>::<a href="XValidatable.html#setValidator">setValidator</a>), the value returned here is defined by the service implementing this interface.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addFormComponentValidityListener" class="membertitle">addFormComponentValidityListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addFormComponentValidityListener</b>(</td> <td valign="top">[in] <a href="XFormComponentValidityListener.html">XFormComponentValidityListener</a></td> <td valign="bottom"> Listener )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>registers the given listener. </dd> <dd><p><a href="XFormComponentValidityListener.html">XFormComponentValidityListener</a>s are called whenever <em>any</em> of the aspects of the validatable form component (the validity flag, or the value) changed.</p> </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a> if the given listener is <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeFormComponentValidityListener" class="membertitle">removeFormComponentValidityListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeFormComponentValidityListener</b>(</td> <td valign="top">[in] <a href="XFormComponentValidityListener.html">XFormComponentValidityListener</a></td> <td valign="bottom"> Listener )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>registers the given listener. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a> if the given listener is <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
3379
