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 / Selection.html
blob: 05309fade91f34fe26ec30785d2e284ad5b9105f [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>Selection (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="Selection (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/Selection.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/Navigation.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/TextNavigation.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/Selection.html" target="_top">Frames</a></li>
<li><a href="Selection.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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 Selection" class="title">Class Selection</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>org.odftoolkit.odfdom.incubator.search.Selection</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/odftoolkit/odfdom/incubator/search/TextSelection.html" title="class in org.odftoolkit.odfdom.incubator.search">TextSelection</a></dd>
</dl>
<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/Selection.html?is-external=true" title="class or interface in org.odftoolkit.simple.common.navigation"><code>Selection</code></a> in Simple API.</i></div>
</div>
<br>
<pre>public abstract class <span class="strong">Selection</span>
extends <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></pre>
<div class="block">Abstract class Selection describe one of the matched results The selection
can be recognized by the container mElement, the start mIndex of the text
content of this mElement and the text content.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html#Selection()">Selection</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
</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">&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>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html#cut()">cut</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">cut the current selection</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/Selection.html#getElement()">getElement</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">get the container mElement of this selection</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html#getIndex()">getIndex</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">get the start mIndex of the text content of the container mElement
this is only meaningful for TextSelection. other type Selection
will return 0.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.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 the current selection at end of the specified position selection</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.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 the current selection at front of the specified position selection</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.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 abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.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;deleteditem)</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 abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.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;inserteditem)</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>
</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#toString()" title="class or interface in java.lang">toString</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Selection()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Selection</h4>
<pre>public&nbsp;Selection()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
</ul>
<!-- ============ 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 container mElement of this selection</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the container mElement</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 mIndex of the text content of the container mElement
this is only meaningful for TextSelection. other type Selection
will return 0.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the start mIndex of the container mElement</dd></dl>
</li>
</ul>
<a name="cut()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cut</h4>
<pre>public abstract&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">cut the current selection</div>
<dl><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></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 abstract&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 the current selection at front of the specified position selection</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>positionitem</code> - the position selection</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></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 abstract&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 the current selection at end of the specified position selection</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>positionitem</code> - the position selection</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></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 abstract&nbsp;void&nbsp;refreshAfterFrontalDelete(<a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a>&nbsp;deleteditem)</pre>
<div class="block"><span class="strong">Deprecated.</span>&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>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>deleteditem</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 abstract&nbsp;void&nbsp;refreshAfterFrontalInsert(<a href="../../../../../org/odftoolkit/odfdom/incubator/search/Selection.html" title="class in org.odftoolkit.odfdom.incubator.search">Selection</a>&nbsp;inserteditem)</pre>
<div class="block"><span class="strong">Deprecated.</span>&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>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inserteditem</code> - the inserted selection</dd></dl>
</li>
</ul>
<a name="refresh(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>refresh</h4>
<pre>protected abstract&nbsp;void&nbsp;refresh(int&nbsp;offset)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">A quick method to update the mIndex of this selection</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offset</code> - the offset that the mIndex 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/Selection.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/Navigation.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/TextNavigation.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/Selection.html" target="_top">Frames</a></li>
<li><a href="Selection.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>