<html> <head> <title>Interface XTextTableCursor</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="XTextTableCursor-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">text</a> :: </p> </td> </tr> <tr> <td class="title">interface XTextTableCursor</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>The TextTableCursor provide methods to navigate throught the table structure, to merge and split cells </dd> <dt><b/></dt> <dd/><dt><b/></dt> <dd/><dt><b/></dt> <dd/><dt><b/></dt> <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="#getRangeName">getRangeName</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#gotoCellByName">gotoCellByName</a></td> <td class="imsum_right">moves the cursor to the cell with the specified name. </td> </tr> <tr> <td class="imsum_left"><a href="#goLeft">goLeft</a></td> <td class="imsum_right">moves the cursor to the left neighbor. </td> </tr> <tr> <td class="imsum_left"><a href="#goRight">goRight</a></td> <td class="imsum_right">moves the cursor to the right neighbor. </td> </tr> <tr> <td class="imsum_left"><a href="#goUp">goUp</a></td> <td class="imsum_right">moves the cursor to the top neighbor. </td> </tr> <tr> <td class="imsum_left"><a href="#goDown">goDown</a></td> <td class="imsum_right">moves the cursor to the bottom neighbor cell. </td> </tr> <tr> <td class="imsum_left"><a href="#gotoStart">gotoStart</a></td> <td class="imsum_right">moves the cursor to the top left cell of the table. </td> </tr> <tr> <td class="imsum_left"><a href="#gotoEnd">gotoEnd</a></td> <td class="imsum_right">moves the cursor to the bottom right cell of the table. </td> </tr> <tr> <td class="imsum_left"><a href="#mergeRange">mergeRange</a></td> <td class="imsum_right">merges the selected range of cells. </td> </tr> <tr> <td class="imsum_left"><a href="#splitRange">splitRange</a></td> <td class="imsum_right">splits the range of cells. </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="getRangeName" class="membertitle">getRangeName</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">string</td> </tr> <tr> <td valign="top"><b>getRangeName</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the name of the cell range that is selected by this cursor. <p>The name is the cell name of the top left table cell of the range contatenated by ':' with the table cell name of the bottom left table cell of the cell range. If the range consists of one table cell only then the name of that table cell is returned. </p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="gotoCellByName" class="membertitle">gotoCellByName</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>gotoCellByName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aCellName,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bExpand );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>moves the cursor to the cell with the specified name. </dd> <dt><b>Parameter aCellName</b></dt> <dd>specifies the name of the cell to go to. </dd> <dt><b>Parameter bExpand</b></dt> <dd>determines wether the selection is to be expanded. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="goLeft" class="membertitle">goLeft</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>goLeft</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nCount,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bExpand );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>moves the cursor to the left neighbor. </dd> <dt><b>Parameter nCount</b></dt> <dd>the number of cells to move. </dd> <dt><b>Parameter bExpand</b></dt> <dd>determines wether the selection is to be expanded. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="goRight" class="membertitle">goRight</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>goRight</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nCount,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bExpand );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>moves the cursor to the right neighbor. </dd> <dt><b>Parameter nCount</b></dt> <dd>the number of cells to move. </dd> <dt><b>Parameter bExpand</b></dt> <dd>determines wether the selection is to be expanded. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="goUp" class="membertitle">goUp</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>goUp</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nCount,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bExpand );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>moves the cursor to the top neighbor. </dd> <dt><b>Parameter nCount</b></dt> <dd>the number of cells to move. </dd> <dt><b>Parameter bExpand</b></dt> <dd>determines wether the selection is to be expanded. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="goDown" class="membertitle">goDown</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>goDown</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nCount,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bExpand );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>moves the cursor to the bottom neighbor cell. </dd> <dt><b>Parameter nCount</b></dt> <dd>the number of cells to move. </dd> <dt><b>Parameter bExpand</b></dt> <dd>determines wether the selection is to be expanded. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="gotoStart" class="membertitle">gotoStart</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>gotoStart</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bExpand );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>moves the cursor to the top left cell of the table. </dd> <dt><b>Parameter bExpand</b></dt> <dd>determines wether the selection is to be expanded. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="gotoEnd" class="membertitle">gotoEnd</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>gotoEnd</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bExpand );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>moves the cursor to the bottom right cell of the table. </dd> <dt><b>Parameter bExpand</b></dt> <dd>determines wether the selection is to be expanded. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="mergeRange" class="membertitle">mergeRange</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>mergeRange</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>merges the selected range of cells. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="splitRange" class="membertitle">splitRange</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>splitRange</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nCount,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bHorizontal );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>splits the range of cells. </dd> <dt><b>Parameter nCount</b></dt> <dd>specifies the number of new cells that will be created for each cell contained in the range. </dd> <dt><b>Parameter bHorizontal</b></dt> <dd><b>true</b> if the range should be split vertically. Otherwise it will be split horizontally. </dd> <dt><b/></dt> <dd/><dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2010 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
