<html> <head> <title>Interface XWordCursor</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="XWordCursor-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 XWordCursor</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XWordCursor</strong> ┗ <a href="XTextCursor.html">XTextCursor</a> ┗ <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="XTextCursor.html">XTextCursor</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>extends a text range by method to modify its position. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>makes it possible to move a cursor word by word. </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="#isStartOfWord">isStartOfWord</a></td> <td class="imsum_right">determines if the cursor is positioned at the start of a word. </td> </tr> <tr> <td class="imsum_left"><a href="#isEndOfWord">isEndOfWord</a></td> <td class="imsum_right">determines if the cursor is positioned at the end of a word. </td> </tr> <tr> <td class="imsum_left"><a href="#gotoNextWord">gotoNextWord</a></td> <td class="imsum_right">moves the cursor to the next word. </td> </tr> <tr> <td class="imsum_left"><a href="#gotoPreviousWord">gotoPreviousWord</a></td> <td class="imsum_right">moves the cursor to the previous word. </td> </tr> <tr> <td class="imsum_left"><a href="#gotoEndOfWord">gotoEndOfWord</a></td> <td class="imsum_right">moves the cursor to the end of the current word. </td> </tr> <tr> <td class="imsum_left"><a href="#gotoStartOfWord">gotoStartOfWord</a></td> <td class="imsum_right">moves the cursor to the start of the current word. </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="isStartOfWord" class="membertitle">isStartOfWord</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>isStartOfWord</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines if the cursor is positioned at the start of a word. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isEndOfWord" class="membertitle">isEndOfWord</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>isEndOfWord</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines if the cursor is positioned at the end of a word. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="gotoNextWord" class="membertitle">gotoNextWord</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>gotoNextWord</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 next word. </dd> <dd><p>Note: the function returning <b>true</b> does not necessarily mean that the cursor is located at the next word, or any word at all! This may happen for example if it travels over empty paragraphs.</p> </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the cursor was moved. It returns <b>false</b> it the cursor can not advance further. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="gotoPreviousWord" class="membertitle">gotoPreviousWord</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>gotoPreviousWord</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 previous word. </dd> <dd><p>Note: the function returning <b>true</b> does not necessarily mean that the cursor is located at the previous word, or any word at all! This may happen for example if it travels over empty paragraphs.</p> </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the cursor was moved. It returns <b>false</b> it the cursor can not advance further. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="gotoEndOfWord" class="membertitle">gotoEndOfWord</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>gotoEndOfWord</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 current word. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the cursor is now at the end of a word, <b>false</b> otherwise. If <b>false</b> was returned the cursor will remain at its original position. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="gotoStartOfWord" class="membertitle">gotoStartOfWord</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>gotoStartOfWord</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 current word. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the cursor is now at the start of a word, <b>false</b> otherwise. If <b>false</b> was returned the cursor will remain at its original position. </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>