| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:35:19 CET 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>TextSelection (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)</title> |
| <meta name="date" content="2013-02-22"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TextSelection (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TextSelection.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/odftoolkit/simple/common/navigation/TextNavigation.html" title="class in org.odftoolkit.simple.common.navigation"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/odftoolkit/simple/common/navigation/TextStyleNavigation.html" title="class in org.odftoolkit.simple.common.navigation"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/odftoolkit/simple/common/navigation/TextSelection.html" target="_top">Frames</a></li> |
| <li><a href="TextSelection.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields_inherited_from_class_org.odftoolkit.simple.common.navigation.Selection">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.odftoolkit.simple.common.navigation</div> |
| <h2 title="Class TextSelection" class="title">Class TextSelection</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">org.odftoolkit.simple.common.navigation.Selection</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.odftoolkit.simple.common.navigation.TextSelection</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/odftoolkit/simple/common/navigation/CellSelection.html" title="class in org.odftoolkit.simple.common.navigation">CellSelection</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">TextSelection</span> |
| extends <a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></pre> |
| <div class="block"><code>TextSelection</code> describes a sub element in a paragraph element or |
| a heading element. It is recognized by the container element, which type |
| should be <code>OdfTextParagraph</code> or |
| <code>OdfTextHeading</code>, the start index of text content in container element and the |
| text content of this <code>Selection</code>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.odftoolkit.simple.common.navigation.Selection"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.odftoolkit.simple.common.navigation.<a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></h3> |
| <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#search">search</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#addComment(java.lang.String, java.lang.String)">addComment</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> content, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> creator)</code> |
| <div class="block">Add a comment to the selection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#addHref(java.net.URL)">addHref</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url)</code> |
| <div class="block">Add a hypertext reference to the selection.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#applyStyle(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">applyStyle</a></strong>(org.odftoolkit.odfdom.dom.element.OdfStyleBase style)</code> |
| <div class="block">Apply a style to the selection so that the text style of this selection |
| will append the specified style.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.text.TextSpanElement</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#createSpanElement()">createSpanElement</a></strong>()</code> |
| <div class="block">Create a span element for this text selection.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#cut()">cut</a></strong>()</code> |
| <div class="block">Delete the selection from the document the other matched selection in the |
| same container element will be updated automatically because the start |
| index of the following selections will be changed when the previous |
| selection has been deleted.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#getContainerElement()">getContainerElement</a></strong>()</code> |
| <div class="block">Get the paragraph element or heading element that contains this text.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#getElement()">getElement</a></strong>()</code> |
| <div class="block">Get the paragraph element or heading element that contains this |
| <code>TextSelection</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#getIndex()">getIndex</a></strong>()</code> |
| <div class="block">Get the start index of the text content of its container element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#getText()">getText</a></strong>()</code> |
| <div class="block">Get the text content of this <code>TextSelection</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/common/navigation/TextNavigation.html" title="class in org.odftoolkit.simple.common.navigation">TextNavigation</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#getTextNavigation()">getTextNavigation</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#isSelectionReplaced()">isSelectionReplaced</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html" title="class in org.odftoolkit.simple.common.navigation">TextSelection</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#newTextSelection(org.odftoolkit.simple.common.navigation.Navigation, java.lang.String, org.odftoolkit.odfdom.pkg.OdfElement, int)">newTextSelection</a></strong>(<a href="../../../../../org/odftoolkit/simple/common/navigation/Navigation.html" title="class in org.odftoolkit.simple.common.navigation">Navigation</a> search, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text, |
| org.odftoolkit.odfdom.pkg.OdfElement containerElement, |
| int index)</code> |
| <div class="block">Create a new <code>TextSelection</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#pasteAtEndOf(org.odftoolkit.simple.common.navigation.Selection)">pasteAtEndOf</a></strong>(<a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a> positionItem)</code> |
| <div class="block">Paste this selection just after a specific selection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#pasteAtFrontOf(org.odftoolkit.simple.common.navigation.Selection)">pasteAtFrontOf</a></strong>(<a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a> positionItem)</code> |
| <div class="block">Paste this selection just before a specific selection.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#refresh(int)">refresh</a></strong>(int offset)</code> |
| <div class="block">A quick method to update the index of this <code>Selection</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#refreshAfterFrontalDelete(org.odftoolkit.simple.common.navigation.Selection)">refreshAfterFrontalDelete</a></strong>(<a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a> deleteItem)</code> |
| <div class="block">When a selected item has been deleted, the <code>Selection</code>s after |
| this deleted <code>Selection</code> should be refreshed, as these |
| <code>Selection</code>s index have been changed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#refreshAfterFrontalInsert(org.odftoolkit.simple.common.navigation.Selection)">refreshAfterFrontalInsert</a></strong>(<a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a> pasteItem)</code> |
| <div class="block">When a selected item has been inserted, the <code>Selection</code> after |
| the inserted item should be refresh, as these <code>Selection</code>s |
| index have been changed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/common/field/Field.html" title="class in org.odftoolkit.simple.common.field">Field</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#replaceWith(org.odftoolkit.simple.common.field.Field)">replaceWith</a></strong>(<a href="../../../../../org/odftoolkit/simple/common/field/Field.html" title="class in org.odftoolkit.simple.common.field">Field</a> orgField)</code> |
| <div class="block">Replace the content with a Field</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#replaceWith(org.odftoolkit.simple.draw.Image)">replaceWith</a></strong>(<a href="../../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a> newImage)</code> |
| <div class="block">Replace the text content of selection with a new Image.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#replaceWith(org.odftoolkit.simple.text.Paragraph)">replaceWith</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a> newParagraph)</code> |
| <div class="block">Replace the content with a paragraph, the paragraph can be in the same TextDocument or in a different Document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#replaceWith(java.lang.String)">replaceWith</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newText)</code> |
| <div class="block">Replace the text content of selection with a new string.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#replaceWith(org.odftoolkit.simple.table.Table)">replaceWith</a></strong>(<a href="../../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a> newTable)</code> |
| <div class="block">Replace the text content of selection with a new Table.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#replaceWith(org.odftoolkit.simple.TextDocument)">replaceWith</a></strong>(<a href="../../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a> newTextDocument)</code> |
| <div class="block">Replace the content with a TextDocument with Styles.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#replaceWith(java.net.URI)">replaceWith</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> imageUri)</code> |
| <div class="block">Replace the text content of selection with a new Image.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#setSelectionReplaced(boolean)">setSelectionReplaced</a></strong>(boolean b)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html#toString()">toString</a></strong>()</code> |
| <div class="block">return a String Object representing this selection value the text content |
| of the selection, start index in the container element and the text |
| content of the container element will be provided.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.common.navigation.Selection"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.odftoolkit.simple.common.navigation.<a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></h3> |
| <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#getNavigation()">getNavigation</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getTextNavigation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTextNavigation</h4> |
| <pre>public <a href="../../../../../org/odftoolkit/simple/common/navigation/TextNavigation.html" title="class in org.odftoolkit.simple.common.navigation">TextNavigation</a> getTextNavigation()</pre> |
| </li> |
| </ul> |
| <a name="newTextSelection(org.odftoolkit.simple.common.navigation.Navigation, java.lang.String, org.odftoolkit.odfdom.pkg.OdfElement, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newTextSelection</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html" title="class in org.odftoolkit.simple.common.navigation">TextSelection</a> newTextSelection(<a href="../../../../../org/odftoolkit/simple/common/navigation/Navigation.html" title="class in org.odftoolkit.simple.common.navigation">Navigation</a> search, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text, |
| org.odftoolkit.odfdom.pkg.OdfElement containerElement, |
| int index)</pre> |
| <div class="block">Create a new <code>TextSelection</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - the text content of this <code>TextSelection</code></dd><dd><code>containerElement</code> - the paragraph element or heading element that contains this |
| <code>TextSelection</code></dd><dd><code>index</code> - the start index of the text content in container element</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.5.5</dd></dl> |
| </li> |
| </ul> |
| <a name="getElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getElement</h4> |
| <pre>public org.odftoolkit.odfdom.pkg.OdfElement getElement()</pre> |
| <div class="block">Get the paragraph element or heading element that contains this |
| <code>TextSelection</code>.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#getElement()">getElement</a></code> in class <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>OdfElement the container element</dd></dl> |
| </li> |
| </ul> |
| <a name="getContainerElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContainerElement</h4> |
| <pre>public org.odftoolkit.odfdom.pkg.OdfElement getContainerElement()</pre> |
| <div class="block">Get the paragraph element or heading element that contains this text.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>OdfElement</dd></dl> |
| </li> |
| </ul> |
| <a name="getIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndex</h4> |
| <pre>public int getIndex()</pre> |
| <div class="block">Get the start index of the text content of its container element.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#getIndex()">getIndex</a></code> in class <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>index the start index of the text content of its container |
| element</dd></dl> |
| </li> |
| </ul> |
| <a name="getText()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getText</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getText()</pre> |
| <div class="block">Get the text content of this <code>TextSelection</code>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>text the text content</dd></dl> |
| </li> |
| </ul> |
| <a name="cut()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cut</h4> |
| <pre>public void cut() |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Delete the selection from the document the other matched selection in the |
| same container element will be updated automatically because the start |
| index of the following selections will be changed when the previous |
| selection has been deleted.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#cut()">cut</a></code> in class <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="applyStyle(org.odftoolkit.odfdom.dom.element.OdfStyleBase)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyStyle</h4> |
| <pre>public void applyStyle(org.odftoolkit.odfdom.dom.element.OdfStyleBase style) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Apply a style to the selection so that the text style of this selection |
| will append the specified style.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>style</code> - the style can be from the current document or user defined</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="replaceWith(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceWith</h4> |
| <pre>public void replaceWith(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newText) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Replace the text content of selection with a new string.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>newText</code> - the replace text String</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="replaceWith(org.odftoolkit.simple.table.Table)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceWith</h4> |
| <pre>public <a href="../../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a> replaceWith(<a href="../../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a> newTable) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Replace the text content of selection with a new Table.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>newTable</code> - the replace Table</dd> |
| <dt><span class="strong">Returns:</span></dt><dd></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="replaceWith(org.odftoolkit.simple.draw.Image)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceWith</h4> |
| <pre>public <a href="../../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a> replaceWith(<a href="../../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a> newImage) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Replace the text content of selection with a new Image.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>newImage</code> - the replace Image</dd> |
| <dt><span class="strong">Returns:</span></dt><dd></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="replaceWith(java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceWith</h4> |
| <pre>public <a href="../../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a> replaceWith(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> imageUri) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Replace the text content of selection with a new Image.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>imageUri</code> - the replace Image URI</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the new Image in the TextDocument,the image name is set to "replace" + System.currentTimeMillis(), please update the name to others by yourself.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="replaceWith(org.odftoolkit.simple.common.field.Field)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceWith</h4> |
| <pre>public <a href="../../../../../org/odftoolkit/simple/common/field/Field.html" title="class in org.odftoolkit.simple.common.field">Field</a> replaceWith(<a href="../../../../../org/odftoolkit/simple/common/field/Field.html" title="class in org.odftoolkit.simple.common.field">Field</a> orgField) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Replace the content with a Field</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>orgField</code> - the reference Field to replace.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created field.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="replaceWith(org.odftoolkit.simple.text.Paragraph)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceWith</h4> |
| <pre>public <a href="../../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a> replaceWith(<a href="../../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a> newParagraph) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Replace the content with a paragraph, the paragraph can be in the same TextDocument or in a different Document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>newParagraph</code> - the reference paragraph to replace.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the replaced Paragraph.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="replaceWith(org.odftoolkit.simple.TextDocument)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceWith</h4> |
| <pre>public void replaceWith(<a href="../../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a> newTextDocument) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Replace the content with a TextDocument with Styles. |
| Note: You need cache the TextNavigation.nextSelection item because after |
| you replace currtenTextSelection with TextDocument, TextNavigation.nextSelection will search from the inserted Content, |
| it will make you into a loop if the Search keyword also can be found in the new inserted Content. |
| </p> |
| The right way to use this replaceWithTextDocument(TextDocument textDocument) method should like this: |
| <Code> |
| <p> search = new TextNavigation("SIMPLE", doc); </p> |
| <p> TextSelection currtenTextSelection,nextTextSelection=null;</p> |
| <p> while (search.hasNext()) {</p> |
| <p> if(nextTextSelection!=null){</p> |
| <p> currtenTextSelection=nextTextSelection;</p> |
| <p> }else {</p> |
| <p> currtenTextSelection = (TextSelection) search.nextSelection();</p> |
| <p> }</p> |
| <p> nextTextSelection = (TextSelection) search.nextSelection();</p> |
| <p> if(currtenTextSelection!=null){</p> |
| <p> try {</p> |
| <p> nextTextSelection.replaceWithTextDocument(sourcedoc);</p> |
| <p> } catch (Exception e) {</p> |
| <p> e.printStackTrace();</p> |
| <p> }</p> |
| <p> }</p> |
| <p> }</p> |
| <p> if(nextTextSelection!=null){</p> |
| <p> try {</p> |
| <p> nextTextSelection.replaceWithTextDocument(sourcedoc);</p> |
| <p> } catch (Exception e) {</p> |
| <p> e.printStackTrace();</p> |
| <p> }</p> |
| <p> }</p> |
| </Code></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>newTextDocument</code> - the reference TextDocument to replace.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="createSpanElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSpanElement</h4> |
| <pre>public org.odftoolkit.odfdom.dom.element.text.TextSpanElement createSpanElement() |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Create a span element for this text selection.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the created text span element for this selection</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.5.5</dd></dl> |
| </li> |
| </ul> |
| <a name="pasteAtFrontOf(org.odftoolkit.simple.common.navigation.Selection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pasteAtFrontOf</h4> |
| <pre>public void pasteAtFrontOf(<a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a> positionItem) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Paste this selection just before a specific selection.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#pasteAtFrontOf(org.odftoolkit.simple.common.navigation.Selection)">pasteAtFrontOf</a></code> in class <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>positionItem</code> - a selection that is used to point out the position</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="pasteAtEndOf(org.odftoolkit.simple.common.navigation.Selection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pasteAtEndOf</h4> |
| <pre>public void pasteAtEndOf(<a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a> positionItem) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Paste this selection just after a specific selection.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#pasteAtEndOf(org.odftoolkit.simple.common.navigation.Selection)">pasteAtEndOf</a></code> in class <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>positionItem</code> - a selection that is used to point out the position</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="setSelectionReplaced(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSelectionReplaced</h4> |
| <pre>public void setSelectionReplaced(boolean b)</pre> |
| </li> |
| </ul> |
| <a name="isSelectionReplaced()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSelectionReplaced</h4> |
| <pre>public boolean isSelectionReplaced()</pre> |
| </li> |
| </ul> |
| <a name="addHref(java.net.URL)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHref</h4> |
| <pre>public void addHref(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Add a hypertext reference to the selection.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - the URL of this hypertext reference</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl> |
| </li> |
| </ul> |
| <a name="addComment(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addComment</h4> |
| <pre>public void addComment(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> content, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> creator) |
| throws <a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></pre> |
| <div class="block">Add a comment to the selection.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - the content of this comment.</dd><dd><code>creator</code> - the creator of this comment, if <code>creator</code> is null, |
| the value of <code>System.getProperty("user.name")</code> will |
| be used.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></code> - if the selection is unavailable.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.6.5</dd></dl> |
| </li> |
| </ul> |
| <a name="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <div class="block">return a String Object representing this selection value the text content |
| of the selection, start index in the container element and the text |
| content of the container element will be provided.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a String representation of the value of this |
| <code>TextSelection</code></dd></dl> |
| </li> |
| </ul> |
| <a name="refreshAfterFrontalDelete(org.odftoolkit.simple.common.navigation.Selection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshAfterFrontalDelete</h4> |
| <pre>protected void refreshAfterFrontalDelete(<a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a> deleteItem)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#refreshAfterFrontalDelete(org.odftoolkit.simple.common.navigation.Selection)">Selection</a></code></strong></div> |
| <div class="block">When a selected item has been deleted, the <code>Selection</code>s after |
| this deleted <code>Selection</code> should be refreshed, as these |
| <code>Selection</code>s index have been changed.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#refreshAfterFrontalDelete(org.odftoolkit.simple.common.navigation.Selection)">refreshAfterFrontalDelete</a></code> in class <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>deleteItem</code> - the deleted <code>Selection</code></dd></dl> |
| </li> |
| </ul> |
| <a name="refreshAfterFrontalInsert(org.odftoolkit.simple.common.navigation.Selection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshAfterFrontalInsert</h4> |
| <pre>protected void refreshAfterFrontalInsert(<a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a> pasteItem)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#refreshAfterFrontalInsert(org.odftoolkit.simple.common.navigation.Selection)">Selection</a></code></strong></div> |
| <div class="block">When a selected item has been inserted, the <code>Selection</code> after |
| the inserted item should be refresh, as these <code>Selection</code>s |
| index have been changed.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#refreshAfterFrontalInsert(org.odftoolkit.simple.common.navigation.Selection)">refreshAfterFrontalInsert</a></code> in class <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>pasteItem</code> - the inserted <code>Selection</code></dd></dl> |
| </li> |
| </ul> |
| <a name="refresh(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>refresh</h4> |
| <pre>protected void refresh(int offset)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#refresh(int)">Selection</a></code></strong></div> |
| <div class="block">A quick method to update the index of this <code>Selection</code>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html#refresh(int)">refresh</a></code> in class <code><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>offset</code> - the offset that the index should be added.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TextSelection.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/odftoolkit/simple/common/navigation/TextNavigation.html" title="class in org.odftoolkit.simple.common.navigation"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/odftoolkit/simple/common/navigation/TextStyleNavigation.html" title="class in org.odftoolkit.simple.common.navigation"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/odftoolkit/simple/common/navigation/TextSelection.html" target="_top">Frames</a></li> |
| <li><a href="TextSelection.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields_inherited_from_class_org.odftoolkit.simple.common.navigation.Selection">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |