blob: bd867cbaaed2099327933ffe37834424c4dc9e3e [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:35:17 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Span (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="Span (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/Span.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/text/Section.html" title="class in org.odftoolkit.simple.text"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/text/Span.html" target="_top">Frames</a></li>
<li><a href="Span.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.simple.text</div>
<h2 title="Class Span" class="title">Class Span</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/Component.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Component</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.simple.text.Span</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Span</span>
extends <a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a>
implements <a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></pre>
<div class="block">This class represents the application of a style to the character data of a
portion of text.
<p>
It provides convenient methods to create a span and manipulate attributes of
a span.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</dd></dl>
</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><a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#appendHyperlink(java.lang.String, java.net.URI)">appendHyperlink</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;text,
<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>&nbsp;linkto)</code>
<div class="block">Append a hyperlink at the end of the container</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#appendTextContent(java.lang.String)">appendTextContent</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;content)</code>
<div class="block">Append the text content at the end of this span.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#appendTextContent(java.lang.String, boolean)">appendTextContent</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;content,
boolean&nbsp;isStyleInherited)</code>
<div class="block">Append the text content at the end of this span.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#applyHyperlink(java.net.URI)">applyHyperlink</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>&nbsp;linkto)</code>
<div class="block">Hyperlink support</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#getHyperlinkIterator()">getHyperlinkIterator</a></strong>()</code>
<div class="block">Get the iterator of hyperlinks within this container element</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/text/Span.html" title="class in org.odftoolkit.simple.text">Span</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#getInstanceof(org.odftoolkit.odfdom.dom.element.text.TextSpanElement)">getInstanceof</a></strong>(org.odftoolkit.odfdom.dom.element.text.TextSpanElement&nbsp;sElement)</code>
<div class="block">Get a span instance by an instance of <code>TextSpanElement</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.text.TextSpanElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#getOdfElement()">getOdfElement</a></strong>()</code>
<div class="block">Return the instance of "text:span" element</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#getOwnerDocument()">getOwnerDocument</a></strong>()</code>
<div class="block">Get the owner document of this span</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/DefaultStyleHandler.html" title="class in org.odftoolkit.simple.style">DefaultStyleHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#getStyleHandler()">getStyleHandler</a></strong>()</code>
<div class="block">Get the style handler of this span.</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/simple/text/Span.html#getTextContent()">getTextContent</a></strong>()</code>
<div class="block">Return the text content of this span.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/text/Span.html" title="class in org.odftoolkit.simple.text">Span</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#newSpan(org.odftoolkit.simple.common.navigation.TextSelection)">newSpan</a></strong>(<a href="../../../../org/odftoolkit/simple/common/navigation/TextSelection.html" title="class in org.odftoolkit.simple.common.navigation">TextSelection</a>&nbsp;textSelection)</code>
<div class="block">Create a span instance with a text selection</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#removeHyperlinks()">removeHyperlinks</a></strong>()</code>
<div class="block">Remove all the hyperlinks in this container element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#removeTextContent()">removeTextContent</a></strong>()</code>
<div class="block">Remove the text content of this span.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Span.html#setTextContent(java.lang.String)">setTextContent</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;content)</code>
<div class="block">Set the text content of this span.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.Component">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></h3>
<code><a href="../../../../org/odftoolkit/simple/Component.html#getComponentByElement(org.odftoolkit.odfdom.pkg.OdfElement)">getComponentByElement</a>, <a href="../../../../org/odftoolkit/simple/Component.html#registerComponent(org.odftoolkit.simple.Component, org.odftoolkit.odfdom.pkg.OdfElement)">registerComponent</a>, <a href="../../../../org/odftoolkit/simple/Component.html#unregisterComponent(org.odftoolkit.odfdom.pkg.OdfElement)">unregisterComponent</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&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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstanceof(org.odftoolkit.odfdom.dom.element.text.TextSpanElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstanceof</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/text/Span.html" title="class in org.odftoolkit.simple.text">Span</a>&nbsp;getInstanceof(org.odftoolkit.odfdom.dom.element.text.TextSpanElement&nbsp;sElement)</pre>
<div class="block">Get a span instance by an instance of <code>TextSpanElement</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sElement</code> - - the instance of TextSpanElement</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of span</dd></dl>
</li>
</ul>
<a name="newSpan(org.odftoolkit.simple.common.navigation.TextSelection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newSpan</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/text/Span.html" title="class in org.odftoolkit.simple.text">Span</a>&nbsp;newSpan(<a href="../../../../org/odftoolkit/simple/common/navigation/TextSelection.html" title="class in org.odftoolkit.simple.common.navigation">TextSelection</a>&nbsp;textSelection)</pre>
<div class="block">Create a span instance with a text selection</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>textSelection</code> - the TextSelection which the span is applied to.</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of span</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/common/navigation/TextSelection.html" title="class in org.odftoolkit.simple.common.navigation"><code>TextSelection</code></a></dd></dl>
</li>
</ul>
<a name="getStyleHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyleHandler</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/DefaultStyleHandler.html" title="class in org.odftoolkit.simple.style">DefaultStyleHandler</a>&nbsp;getStyleHandler()</pre>
<div class="block">Get the style handler of this span.
<p>
The style handler is an instance of DefaultStyleHandler</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an instance of DefaultStyleHandler</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/style/DefaultStyleHandler.html" title="class in org.odftoolkit.simple.style"><code>DefaultStyleHandler</code></a></dd></dl>
</li>
</ul>
<a name="getOwnerDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwnerDocument</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a>&nbsp;getOwnerDocument()</pre>
<div class="block">Get the owner document of this span</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/Component.html#getOwnerDocument()">getOwnerDocument</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the document who owns this span</dd></dl>
</li>
</ul>
<a name="getOdfElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOdfElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.text.TextSpanElement&nbsp;getOdfElement()</pre>
<div class="block">Return the instance of "text:span" element</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/Component.html#getOdfElement()">getOdfElement</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the instance of "text:span" element</dd></dl>
</li>
</ul>
<a name="removeTextContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeTextContent</h4>
<pre>public&nbsp;void&nbsp;removeTextContent()</pre>
<div class="block">Remove the text content of this span.</div>
</li>
</ul>
<a name="setTextContent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTextContent</h4>
<pre>public&nbsp;void&nbsp;setTextContent(<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;content)</pre>
<div class="block">Set the text content of this span.
<p>
All the existing text content of this paragraph would be removed, and
then new text content would be set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - - the text content</dd></dl>
</li>
</ul>
<a name="getTextContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextContent</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;getTextContent()</pre>
<div class="block">Return the text content of this span.
<p>
The other child elements except text content will not be returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>- the text content of this span</dd></dl>
</li>
</ul>
<a name="appendTextContent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendTextContent</h4>
<pre>public&nbsp;void&nbsp;appendTextContent(<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;content)</pre>
<div class="block">Append the text content at the end of this span.
<p>
The appended text would follow the style of the last character.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - - the text content</dd></dl>
</li>
</ul>
<a name="appendTextContent(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendTextContent</h4>
<pre>public&nbsp;void&nbsp;appendTextContent(<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;content,
boolean&nbsp;isStyleInherited)</pre>
<div class="block">Append the text content at the end of this span.
<p>
The appended text would follow the style of the last character if the
second parameter is set to true; Or else, the appended text would follow
the default style of this paragraph.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - - the text content</dd><dd><code>isStyleInherited</code> - - whether the hyperlink style would be inherited by the
appended text</dd></dl>
</li>
</ul>
<a name="applyHyperlink(java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyHyperlink</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a>&nbsp;applyHyperlink(<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>&nbsp;linkto)</pre>
<div class="block">Hyperlink support</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#applyHyperlink(java.net.URI)">applyHyperlink</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>linkto</code> - the hyperlink</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of TextHyperlink</dd></dl>
</li>
</ul>
<a name="getHyperlinkIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHyperlinkIterator</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a>&gt;&nbsp;getHyperlinkIterator()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#getHyperlinkIterator()">TextHyperlinkContainer</a></code></strong></div>
<div class="block">Get the iterator of hyperlinks within this container element</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#getHyperlinkIterator()">getHyperlinkIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the iterator of hyperlinks within this container element</dd></dl>
</li>
</ul>
<a name="removeHyperlinks()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeHyperlinks</h4>
<pre>public&nbsp;void&nbsp;removeHyperlinks()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#removeHyperlinks()">TextHyperlinkContainer</a></code></strong></div>
<div class="block">Remove all the hyperlinks in this container element.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#removeHyperlinks()">removeHyperlinks</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></code></dd>
</dl>
</li>
</ul>
<a name="appendHyperlink(java.lang.String, java.net.URI)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>appendHyperlink</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a>&nbsp;appendHyperlink(<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;text,
<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>&nbsp;linkto)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#appendHyperlink(java.lang.String, java.net.URI)">TextHyperlinkContainer</a></code></strong></div>
<div class="block">Append a hyperlink at the end of the container</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#appendHyperlink(java.lang.String, java.net.URI)">appendHyperlink</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - - the text content</dd><dd><code>linkto</code> - - the URI of this hyperlink</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of TextHyperlink</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/Span.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/text/Section.html" title="class in org.odftoolkit.simple.text"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/text/Span.html" target="_top">Frames</a></li>
<li><a href="Span.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; 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>