<html> <head> <title>Service DataForm</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="DataForm-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="#ServicesSummary" class="navisub">Services' Summary</a></td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</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">component</a> :: </p> </td> </tr> <tr> <td class="title">service DataForm</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This service specifies a form which is connected to a database and displays the results of SQL queries. It provides the possiblity of adding new data records, modifying existing ones, or deleting them. </dd> <dd><p>A database form is a special kind of enhanced database row set which provides all information for displaying the data and has more possibilities for configuring the data manipulation.</p> </dd> </dl> </td> </tr> </table> <hr> <a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>is a client side RowSet, which use retrieves is data based on a database table, a query or a SQL command or by a rowset reader, who mustn't support SQL. The connection of the rowset is typically a named DataSource or a DataAccess component or a previous instanciated connection. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="Form.html">Form</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>This service specifies a form which is a group of FormComponents. </dd> </dl> </td> </tr> </table> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XReset.html">XReset</a></td> <td class="imsum_right"><p>is used to reset controls belonging to the form, and to reset database fields to which the controls are bound (<a href="#XReset">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XLoadable.html">XLoadable</a></td> <td class="imsum_right"><p>used to load/unload the form (<a href="#XLoadable">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/XCompletedExecution.html">XCompletedExecution</a></td> <td class="imsum_right"><p>can be used to allow an interaction handler to supply missing data during a load process. (<a href="#XCompletedExecution">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XDatabaseParameterBroadcaster.html">XDatabaseParameterBroadcaster</a></td> <td class="imsum_right"><p>can be used for filling parameters. (<a href="#XDatabaseParameterBroadcaster">details</a>)</p> </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">sequence< string ><br> <a href="#MasterFields">MasterFields</a></td> <td class="imsum_right">is used for subforms and contains the names of columns of the parent form. </td> </tr> <tr> <td class="imsum_left">sequence< string ><br> <a href="#DetailFields">DetailFields</a></td> <td class="imsum_right">is used for subforms and contains the names of the columns of the subform which are related to the master fields of the parent form. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../TabulatorCycle.html">TabulatorCycle</a><br> <a href="#Cycle">Cycle</a></td> <td class="imsum_right">returns the kind of tabulator controlling. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../NavigationBarMode.html">NavigationBarMode</a><br> <a href="#NavigationBarMode">NavigationBarMode</a></td> <td class="imsum_right">determines how an navigation bar for this form should act. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#AllowInserts">AllowInserts</a></td> <td class="imsum_right">determines if insertions into the form's row set are allowed. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#AllowUpdates">AllowUpdates</a></td> <td class="imsum_right">determines if modifications of the current record of the form are allowed. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#AllowDeletes">AllowDeletes</a></td> <td class="imsum_right">determines if deletions of records of the form are allowed. </td> </tr> </table> <a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="RowSet" class="membertitle">::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>is a client side RowSet, which use retrieves is data based on a database table, a query or a SQL command or by a rowset reader, who mustn't support SQL. The connection of the rowset is typically a named DataSource or a DataAccess component or a previous instanciated connection. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="Form" class="membertitle"><a href="Form.html">Form</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>This service specifies a form which is a group of FormComponents. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XReset" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XReset.html">XReset</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is used to reset controls belonging to the form, and to reset database fields to which the controls are bound </dd> <dd><p>A <a href="DataForm.html">DataForm</a> is reset either on explicit request, or after it is moved to the insertion row.</p> <p>The insertion row is a virtual row which is used to insert new records. It is reached by calling ::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/XResultSetUpdate.html">XResultSetUpdate</a>::<a href="../../sdbc/XResultSetUpdate.html#moveToInsertRow">moveToInsertRow</a>. The ::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a> service specifies exactly which notifications happen in which order when calling ::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/XResultSetUpdate.html">XResultSetUpdate</a>::<a href="../../sdbc/XResultSetUpdate.html#moveToInsertRow">moveToInsertRow</a>, and a <a href="DataForm.html">DataForm</a> implementation extends this with the following contract: <ul><li>After all notifications as defined in the ::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a> service have been sent, the <a href="DataForm.html">DataForm</a> resets itself, if all com::sun::star::form::XResetListeners approve this.</li> <li>After the reset happened, the ::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a>::<a href="../../sdb/RowSet.html#IsModified">IsModified</a> property is reset to <b>false</b>. This property might have been switched to <b>true</b> during listener notifications, since listeners are allowed to change field values. Also, the ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XReset.html">XReset</a>::<a href="../XReset.html#reset">reset</a> implementations of bound control models might have modified the fields they're bound to (by filling them with default values).</li> <li>The reset listeners are notified of the completed reset operation.</li> </ul></p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XLoadable" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XLoadable.html">XLoadable</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>used to load/unload the form </dd> <dd><p>Loading a form is basically the same as executing the underlying row set. In fact, all the functionality of this interface could be simulated by using setting some properties manually, ::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/XRowSet.html">XRowSet</a>::<a href="../../sdbc/XRowSet.html#execute">execute</a>, moving the row set cursor and so on.</p> <p>One main difference between ::XLoadable::load and ::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/XRowSet.html">XRowSet</a>::<a href="../../sdbc/XRowSet.html#execute">execute</a> is that if you use the former, the row set is positioned on the first record, while in the latter case it is position <em>before</em> the it.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XCompletedExecution" class="membertitle">::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/XCompletedExecution.html">XCompletedExecution</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>can be used to allow an interaction handler to supply missing data during a load process. </dd> <dd><p>If data is needed during loading a form, then this is usually obtained via broadcaster-listener mechanisms. An example for this (and currently the only one) are parameter values.</p> <p>However, if you use this method, you can pass an interaction handler which should supply these additional data.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/InteractionHandler.html">InteractionHandler</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XDatabaseParameterBroadcaster" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XDatabaseParameterBroadcaster.html">XDatabaseParameterBroadcaster</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>can be used for filling parameters. </dd> <dd><p>You can add your component as ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XDatabaseParameterListener.html">XDatabaseParameterListener</a> to a form to get notified whenever the form needs parameter values to be filled in<br/> In a first approach, the form tries to fill any parameters from it's master-detail relation (if any). All values which can't be filled are then passed to all listeners, which can fill them by their own choice.</p> <p>This is sligtly changed if the form is loaded using the ::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/XCompletedExecution.html">XCompletedExecution</a>::<a href="../../sdb/XCompletedExecution.html#connectWithCompletion">connectWithCompletion</a> method. In this case, the parameters are obtained from the interaction handler, not from the listeners</p> </dd> <dt><b>See also</b></dt> <dd>XCompletedExecution, <a href="DataForm.html#MasterFields">MasterFields</a>, <a href="DataForm.html#DetailFields">DetailFields</a></dd> </dl> </td> </tr> </table> </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="MasterFields" class="membertitle">MasterFields</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< string > <b>MasterFields</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is used for subforms and contains the names of columns of the parent form. </dd> <dd><p> These columns are typically the foreign key fields of the parent form. The values of theses columns are used to identify the data for the subform. Each time the parent form changes it's current row, the subform requeries it's data based on the values of the master fields.</p> <p>If the form is no sub form (e.g. it's parent is not a form itself), this property is not evaluated.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DetailFields" class="membertitle">DetailFields</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< string > <b>DetailFields</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is used for subforms and contains the names of the columns of the subform which are related to the master fields of the parent form. </dd> <dd><p>Entries in this sequence can either denote column names in the sub form, or paramater names.<br/> For instance, you could base the form on the SQL statement <code>SELECT * FROM invoices WHERE cust_ref = :cid</code>, and add <code>cid</code> to the DetailFields property. In this case, the parameter will be filled from the corresponding master field.<br/> Alternatively, you could simply base your form on the table <code>invoices</code>, and add the column name <code>cust_ref</code> to the DetailFields. In this case, and implicit filter clause <code>WHERE cust_ref = :<new_param_name></code> will be created, and the artificial parameter will be filled from the corresponding master field.<br/> If a string in this property denotes both a column name and a parameter name, it is undefined which way it is interpreted, but implementations of the service are required to either decide for the paramter or the column, and proceed as usual. </p> <p>The columns specified herein typically represent a part of the primary key fields or their aliases of the detail form.</p> <p>If the form is no sub form (e.g. it's parent is not a form itself), this property is not evaluated.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Cycle" class="membertitle">Cycle</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../TabulatorCycle.html">TabulatorCycle</a> <b>Cycle</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>returns the kind of tabulator controlling. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="NavigationBarMode" class="membertitle">NavigationBarMode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../NavigationBarMode.html">NavigationBarMode</a> <b>NavigationBarMode</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines how an navigation bar for this form should act. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AllowInserts" class="membertitle">AllowInserts</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AllowInserts</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if insertions into the form's row set are allowed. </dd> <dd><p>Note that this is a recommendation for user interface components displaying the form. Form implementations may decide to allow for insertions done via the API, even if the property is set to <b>false</b>, but the user interface should respect the property value.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AllowUpdates" class="membertitle">AllowUpdates</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AllowUpdates</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if modifications of the current record of the form are allowed. </dd> <dd><p>Note that this is a recommendation for user interface components displaying the form. Form implementations may decide to allow for updates done via the API, even if the property is set to <b>false</b>, but the user interface should respect the property value.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AllowDeletes" class="membertitle">AllowDeletes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AllowDeletes</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if deletions of records of the form are allowed. </dd> <dd><p>Note that this is a recommendation for user interface components displaying the form. Form implementations may decide to allow for deletions done via the API, even if the property is set to <b>false</b>, but the user interface should respect the property value.</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 © 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
>
3223
