Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8.9-incubating / odfdom-java / apidocs / org / odftoolkit / odfdom / incubator / search / TextSelection.html
blob: e86d69b3c8b808f1223b46dfc0ee7a2fb976731a [file] [log] [blame]
<!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:26:20 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>TextSelection (ODFDOM API v0.8.9-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 (ODFDOM API v0.8.9-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/odfdom/incubator/search/TextNavigation.html" title="class in org.odftoolkit.odfdom.incubator.search"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextStyleNavigation.html" title="class in org.odftoolkit.odfdom.incubator.search"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/odftoolkit/odfdom/incubator/search/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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.odfdom.incubator.search</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/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">org.odftoolkit.odfdom.incubator.search.Selection</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.odfdom.incubator.search.TextSelection</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of release 0.8.8, replaced by <a href="http://incubator.apache.org/odftoolkit/simple/index.html/apidocs/org/odftoolkit/simple/common/navigation/TextSelection.html?is-external=true" title="class or interface in org.odftoolkit.simple.common.navigation"><code>TextSelection</code></a> in Simple API.</i></div>
</div>
<br>
<pre>public class <span class="strong">TextSelection</span>
extends <a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a></pre>
<div class="block">A TextSelection can describe a sub element in a mParagraph element or a mHeading element.
it is recognized by the container element(which type should be OdfTextParagraph or
OdfTextHeadingt), the start index of the text content of the container element and
the text content of this selection.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</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/odfdom/incubator/search/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>&nbsp;url)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Add a hypertext reference 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/odfdom/incubator/search/TextSelection.html#applyStyle(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">applyStyle</a></strong>(<a href="../../../../../org/odftoolkit/odfdom/dom/element/OdfStyleBase.html" title="class in org.odftoolkit.odfdom.dom.element">OdfStyleBase</a>&nbsp;style)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<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="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextSelection.html#cut()">cut</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<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><a href="../../../../../org/odftoolkit/odfdom/pkg/OdfElement.html" title="class in org.odftoolkit.odfdom.pkg">OdfElement</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextSelection.html#getContainerElement()">getContainerElement</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Get the mParagraph element or mHeading element that contain this text</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/odfdom/pkg/OdfElement.html" title="class in org.odftoolkit.odfdom.pkg">OdfElement</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextSelection.html#getElement()">getElement</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Get the mParagraph element or mHeading element that contain this TextSelection</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextSelection.html#getIndex()">getIndex</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<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/odfdom/incubator/search/TextSelection.html#getText()">getText</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Get the text content of this TextSelection</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextSelection.html#pasteAtEndOf(org.odftoolkit.odfdom.incubator.search.Selection)">pasteAtEndOf</a></strong>(<a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a>&nbsp;positionItem)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Paste this selection just after a specific selection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextSelection.html#pasteAtFrontOf(org.odftoolkit.odfdom.incubator.search.Selection)">pasteAtFrontOf</a></strong>(<a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a>&nbsp;positionItem)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Paste this selection just before a specific selection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextSelection.html#refresh(int)">refresh</a></strong>(int&nbsp;offset)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">A quick method to update the mIndex of this selection</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextSelection.html#refreshAfterFrontalDelete(org.odftoolkit.odfdom.incubator.search.Selection)">refreshAfterFrontalDelete</a></strong>(<a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a>&nbsp;deleteItem)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">when a selected item has been delete, the selections after this deleted selection should be refresh
because these selections mIndex will be changed</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextSelection.html#refreshAfterFrontalInsert(org.odftoolkit.odfdom.incubator.search.Selection)">refreshAfterFrontalInsert</a></strong>(<a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a>&nbsp;pasteItem)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">when a selected item has been inserted, the selection after the inserted item should be refresh
because these selections mIndex will be changed</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/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>&nbsp;newText)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<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="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/odfdom/incubator/search/TextSelection.html#toString()">toString</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<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_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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="getElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElement</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/odfdom/pkg/OdfElement.html" title="class in org.odftoolkit.odfdom.pkg">OdfElement</a>&nbsp;getElement()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Get the mParagraph element or mHeading element that contain this TextSelection</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html#getElement()">getElement</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">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&nbsp;<a href="../../../../../org/odftoolkit/odfdom/pkg/OdfElement.html" title="class in org.odftoolkit.odfdom.pkg">OdfElement</a>&nbsp;getContainerElement()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Get the mParagraph element or mHeading element that contain 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&nbsp;int&nbsp;getIndex()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<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/odfdom/incubator/search/Selection.html#getIndex()">getIndex</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">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&nbsp;<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>&nbsp;getText()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Get the text content of this TextSelection</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&nbsp;void&nbsp;cut()
throws <a href="../../../../../org/odftoolkit/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">InvalidNavigationException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<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/odfdom/incubator/search/Selection.html#cut()">cut</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">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&nbsp;void&nbsp;applyStyle(<a href="../../../../../org/odftoolkit/odfdom/dom/element/OdfStyleBase.html" title="class in org.odftoolkit.odfdom.dom.element">OdfStyleBase</a>&nbsp;style)
throws <a href="../../../../../org/odftoolkit/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">InvalidNavigationException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<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/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">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&nbsp;void&nbsp;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>&nbsp;newText)
throws <a href="../../../../../org/odftoolkit/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">InvalidNavigationException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<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/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl>
</li>
</ul>
<a name="pasteAtFrontOf(org.odftoolkit.odfdom.incubator.search.Selection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pasteAtFrontOf</h4>
<pre>public&nbsp;void&nbsp;pasteAtFrontOf(<a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a>&nbsp;positionItem)
throws <a href="../../../../../org/odftoolkit/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">InvalidNavigationException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<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/odfdom/incubator/search/Selection.html#pasteAtFrontOf(org.odftoolkit.odfdom.incubator.search.Selection)">pasteAtFrontOf</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">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/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl>
</li>
</ul>
<a name="pasteAtEndOf(org.odftoolkit.odfdom.incubator.search.Selection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pasteAtEndOf</h4>
<pre>public&nbsp;void&nbsp;pasteAtEndOf(<a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a>&nbsp;positionItem)
throws <a href="../../../../../org/odftoolkit/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">InvalidNavigationException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<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/odfdom/incubator/search/Selection.html#pasteAtEndOf(org.odftoolkit.odfdom.incubator.search.Selection)">pasteAtEndOf</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">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/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl>
</li>
</ul>
<a name="addHref(java.net.URL)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addHref</h4>
<pre>public&nbsp;void&nbsp;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>&nbsp;url)
throws <a href="../../../../../org/odftoolkit/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">InvalidNavigationException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<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 the hypertext reference</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/InvalidNavigationException.html" title="class in org.odftoolkit.odfdom.incubator.search">InvalidNavigationException</a></code> - if the selection is unavailable.</dd></dl>
</li>
</ul>
<a name="refreshAfterFrontalDelete(org.odftoolkit.odfdom.incubator.search.Selection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refreshAfterFrontalDelete</h4>
<pre>protected&nbsp;void&nbsp;refreshAfterFrontalDelete(<a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a>&nbsp;deleteItem)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html#refreshAfterFrontalDelete(org.odftoolkit.odfdom.incubator.search.Selection)">Selection</a></code></strong></div>
<div class="block">when a selected item has been delete, the selections after this deleted selection should be refresh
because these selections mIndex will be changed</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html#refreshAfterFrontalDelete(org.odftoolkit.odfdom.incubator.search.Selection)">refreshAfterFrontalDelete</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>deleteItem</code> - the deleted selection</dd></dl>
</li>
</ul>
<a name="refreshAfterFrontalInsert(org.odftoolkit.odfdom.incubator.search.Selection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refreshAfterFrontalInsert</h4>
<pre>protected&nbsp;void&nbsp;refreshAfterFrontalInsert(<a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a>&nbsp;pasteItem)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html#refreshAfterFrontalInsert(org.odftoolkit.odfdom.incubator.search.Selection)">Selection</a></code></strong></div>
<div class="block">when a selected item has been inserted, the selection after the inserted item should be refresh
because these selections mIndex will be changed</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html#refreshAfterFrontalInsert(org.odftoolkit.odfdom.incubator.search.Selection)">refreshAfterFrontalInsert</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pasteItem</code> - the inserted selection</dd></dl>
</li>
</ul>
<a name="refresh(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refresh</h4>
<pre>protected&nbsp;void&nbsp;refresh(int&nbsp;offset)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html#refresh(int)">Selection</a></code></strong></div>
<div class="block">A quick method to update the mIndex of this selection</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html#refresh(int)">refresh</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>offset</code> - the offset that the mIndex should be added</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<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>&nbsp;toString()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<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>&nbsp;in class&nbsp;<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 TextSelection</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/odfdom/incubator/search/TextNavigation.html" title="class in org.odftoolkit.odfdom.incubator.search"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextStyleNavigation.html" title="class in org.odftoolkit.odfdom.incubator.search"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/odftoolkit/odfdom/incubator/search/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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2008-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>