<html> <head> <title>Interface XGridColumnModel</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="XGridColumnModel-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">awt</a> :: <a href="module-ix.html" class="namechain">grid</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 XGridColumnModel</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XGridColumnModel</strong> ┣ ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XComponent.html">XComponent</a> ┣ ::com::sun::star::<a href="../../container/module-ix.html">container</a>::<a href="../../container/XContainer.html">XContainer</a> ┗ ::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XCloneable.html">XCloneable</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <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>implements life time control for the component </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../container/module-ix.html">container</a>::<a href="../../container/XContainer.html">XContainer</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to register listeners to be notified when columns are inserted or removed </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XCloneable.html">XCloneable</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows cloning the complete column model </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>An instance of this interface is used by the <a href="UnoControlGrid.html">UnoControlGrid</a> to retrieve the column structure that is displayed in the actual control. If you do not need your own model implementation, you can also use the <a href="DefaultGridColumnModel.html">DefaultGridColumnModel</a>. </dd> <dt><b>Since </b></dt> <dd>OOo 3.3</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="#getColumnCount">getColumnCount</a></td> <td class="imsum_right">Returns the number of columns. </td> </tr> <tr> <td class="imsum_left"><a href="#createColumn">createColumn</a></td> <td class="imsum_right">creates a new column for use with the column model. </td> </tr> <tr> <td class="imsum_left"><a href="#addColumn">addColumn</a></td> <td class="imsum_right">Adds a column to the model. </td> </tr> <tr> <td class="imsum_left"><a href="#removeColumn">removeColumn</a></td> <td class="imsum_right">removes a column from the model </td> </tr> <tr> <td class="imsum_left"><a href="#getColumns">getColumns</a></td> <td class="imsum_right">Returns all columns of the model. </td> </tr> <tr> <td class="imsum_left"><a href="#getColumn">getColumn</a></td> <td class="imsum_right">Returns a specific column. </td> </tr> <tr> <td class="imsum_left"><a href="#setDefaultColumns">setDefaultColumns</a></td> <td class="imsum_right">Fills the model with the given number of default columns </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="getColumnCount" class="membertitle">getColumnCount</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">long</td> </tr> <tr> <td valign="top"><b>getColumnCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the number of columns. </dd> <dt><b>Returns</b></dt> <dd>the number of columns. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createColumn" class="membertitle">createColumn</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"><a href="XGridColumn.html">XGridColumn</a></td> </tr> <tr> <td valign="top"><b>createColumn</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a new column for use with the column model. </dd> <dd><p>The newly created column is not yet inserted into the column container, you need to call <a href="#addColumn">addColumn</a> after you initialized the column object.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addColumn" class="membertitle">addColumn</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">long</td> </tr> <tr> <td valign="top"><b>addColumn</b>(</td> <td valign="top">[in] <a href="XGridColumn.html">XGridColumn</a></td> <td valign="bottom"> column )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Adds a column to the model. </dd> <dd><p>You should use the <a href="#createColumn">createColumn</a> member to create a new column. This gives implementations of the <code>XGridColumnModel</code> interface the possibility to provide own column implementations which extend the basic <a href="GridColumn.html">GridColumn</a> type.</p> <p>As soon as the column has been inserted into the model, the model takes ownership of it. This means when the column is removed, or when the column model is disposed, the grid column is disposed as well.</p> </dd> <dt><b>Parameter column</b></dt> <dd>the column to add to the model. </dd> <dt><b>Returns</b></dt> <dd>the index of new created column. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if the given column is not a valid element for the column container, or if it is <b>NULL</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeColumn" class="membertitle">removeColumn</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>removeColumn</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> ColumnIndex )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes a column from the model </dd> <dd><p>The column object will be disposed upon removal.</p> </dd> <dt><b>Parameter ColumnIndex</b></dt> <dd>denotes the index of the column to remove </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if <code>ColumnIndex</code> does not denote a valid column index. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getColumns" class="membertitle">getColumns</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">sequence< <a href="XGridColumn.html">XGridColumn</a> ></td> </tr> <tr> <td valign="top"><b>getColumns</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns all columns of the model. </dd> <dt><b>Returns</b></dt> <dd>all columns associated with the model in a sequence of <a href="XGridColumn.html">XGridColumn</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getColumn" class="membertitle">getColumn</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"><a href="XGridColumn.html">XGridColumn</a></td> </tr> <tr> <td valign="top"><b>getColumn</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> index )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns a specific column. </dd> <dt><b>Parameter index</b></dt> <dd>the position of the requested column. </dd> <dt><b>Returns</b></dt> <dd>the requested column. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setDefaultColumns" class="membertitle">setDefaultColumns</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>setDefaultColumns</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> elements );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Fills the model with the given number of default columns </dd> <dd><p>Existing columns will be removed before adding new columns. Listeners at the column model will be notified one ::com::sun::star::<a href="../../container/module-ix.html">container</a>::<a href="../../container/XContainerListener.html">XContainerListener</a>::<a href="../../container/XContainerListener.html#elementRemoved">elementRemoved</a> event for each removed column, and one ::com::sun::star::<a href="../../container/module-ix.html">container</a>::<a href="../../container/XContainerListener.html">XContainerListener</a>::<a href="../../container/XContainerListener.html#elementInserted">elementInserted</a> event for each insertion.</p> </dd> <dt><b>Parameter elements</b></dt> <dd>the number of default columns that should be set. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
