<html> <head> <title>Interface XTextCursor</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="XTextCursor-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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 XTextCursor</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XTextCursor</strong> ┗ <a href="XTextRange.html">XTextRange</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XTextRange.html">XTextRange</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>describes the object's position in a text. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>extends a text range by method to modify its position. </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="#collapseToStart">collapseToStart</a></td> <td class="imsum_right">sets the end of the position to the start. </td> </tr> <tr> <td class="imsum_left"><a href="#collapseToEnd">collapseToEnd</a></td> <td class="imsum_right">sets the start of the position to the end. </td> </tr> <tr> <td class="imsum_left"><a href="#isCollapsed">isCollapsed</a></td> <td class="imsum_right">determines if the start and end positions are the same. </td> </tr> <tr> <td class="imsum_left"><a href="#goLeft">goLeft</a></td> <td class="imsum_right">moves the cursor the specified number of characters to the left. </td> </tr> <tr> <td class="imsum_left"><a href="#goRight">goRight</a></td> <td class="imsum_right">moves the cursor the specified number of characters to the right. </td> </tr> <tr> <td class="imsum_left"><a href="#gotoStart">gotoStart</a></td> <td class="imsum_right">moves the cursor to the start of the text. </td> </tr> <tr> <td class="imsum_left"><a href="#gotoEnd">gotoEnd</a></td> <td class="imsum_right">moves the cursor to the end of the text. </td> </tr> <tr> <td class="imsum_left"><a href="#gotoRange">gotoRange</a></td> <td class="imsum_right">moves or expands the cursor to a specified <a href="TextRange.html">TextRange</a>. </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="collapseToStart" class="membertitle">collapseToStart</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">[oneway] void</td> </tr> <tr> <td valign="top"><b>collapseToStart</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the end of the position to the start. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="collapseToEnd" class="membertitle">collapseToEnd</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">[oneway] void</td> </tr> <tr> <td valign="top"><b>collapseToEnd</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the start of the position to the end. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isCollapsed" class="membertitle">isCollapsed</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>isCollapsed</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines if the start and end positions are the same. </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 the specified number of characters to the left. </dd> <dt><b>Parameter nCount</b></dt> <dd>the number of characters to move. </dd> <dt><b>Parameter bExpand</b></dt> <dd>specifies if the current selection of the cursor should be expanded or not. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the command was successfully completed. <b>false</b> otherwise. <p>Note: Even if the command was not completed successfully it may be completed partially. E.g. if it was required to move 5 characters but it is only possible to move 3 <b>false</b> will be returned and the cursor moves only those 3 characters.<p> </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 the specified number of characters to the right. </dd> <dt><b>Parameter nCount</b></dt> <dd>the number of characters to move. </dd> <dt><b>Parameter bExpand</b></dt> <dd>specifies if the current selection of the cursor should be expanded or not. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the command was successfully completed. <b>false</b> otherwise. <p>Note: Even if the command was not completed successfully it may be completed partially. E.g. if it was required to move 5 characters but it is only possible to move 3 <b>false</b> will be returned and the cursor moves only those 3 characters.<p> </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 start of the text. </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 end of the text. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="gotoRange" class="membertitle">gotoRange</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>gotoRange</b>(</td> <td valign="top">[in] <a href="XTextRange.html">XTextRange</a></td> <td valign="bottom"> xRange,</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 or expands the cursor to a specified <a href="TextRange.html">TextRange</a>. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <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>