| <!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>TextExtractor (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="TextExtractor (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/TextExtractor.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/EditableTextExtractor.html" title="class in org.odftoolkit.simple.common"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/common/TextExtractor.ExtractorStringBuilder.html" title="class in org.odftoolkit.simple.common"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/odftoolkit/simple/common/TextExtractor.html" target="_top">Frames</a></li> |
| <li><a href="TextExtractor.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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</div> |
| <h2 title="Class TextExtractor" class="title">Class TextExtractor</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.dom.DefaultElementVisitor</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.odftoolkit.simple.common.TextExtractor</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.odftoolkit.odfdom.pkg.ElementVisitor</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/odftoolkit/simple/common/EditableTextExtractor.html" title="class in org.odftoolkit.simple.common">EditableTextExtractor</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">TextExtractor</span> |
| extends org.odftoolkit.odfdom.dom.DefaultElementVisitor</pre> |
| <div class="block">This is a sub class of <code>DefaultElementVisitor</code>, which is used to |
| extract display text from ODF element. For example, if you want to get all of |
| the text content in a slide notes, you can call <code>getOdfElement()</code> |
| to get the ODF element of this notes, then pass it to |
| <code>newOdfTextExtractor</code> to create a TextExtractor. The last step is |
| very easy, you only need to use <code>getText()</code>, all of the text |
| content will be return as string. Another easier way is pass the ODF element |
| to the static method <code>TextExtractor.getText(OdfElement)</code> directly. |
| <p> |
| If you pass the content root which you can get by |
| <a href="../../../../org/odftoolkit/simple/Document.html#getContentRoot()"><code>Document.getContentRoot()</code></a> as the parameter, the whole document content will |
| be returned, without any tag information. |
| <p> |
| This extractor implements parts of ODF elements' white space handling |
| functions. They are text:p, text:h, text:s, text:tab and text:linebreak, |
| which <code>visit()</code> are override to process white space, according to |
| ODF specification.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><code>OdfElement</code></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.ExtractorStringBuilder.html" title="class in org.odftoolkit.simple.common">TextExtractor.ExtractorStringBuilder</a></strong></code> |
| <div class="block">This class is used to provide the string builder functions to extractor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/odftoolkit/simple/common/TextExtractor.ExtractorStringBuilder.html" title="class in org.odftoolkit.simple.common">TextExtractor.ExtractorStringBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#mTextBuilder">mTextBuilder</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static char</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#NewLineChar">NewLineChar</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static char</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#TabChar">TabChar</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#TextExtractor()">TextExtractor</a></strong>()</code> |
| <div class="block">Default constructor</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#TextExtractor(org.odftoolkit.odfdom.pkg.OdfElement)">TextExtractor</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement element)</code> |
| <div class="block">Constructor with an ODF element as parameter</div> |
| </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"> </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>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#appendElementText(org.odftoolkit.odfdom.pkg.OdfElement)">appendElementText</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement ele)</code> |
| <div class="block">Append the text content of this element to string buffer.</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/common/TextExtractor.html#getText()">getText</a></strong>()</code> |
| <div class="block">Return the text content of specified ODF element as a string.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/TextExtractor.html#getText(org.odftoolkit.odfdom.pkg.OdfElement)">getText</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement ele)</code> |
| <div class="block">Return the text content of a element as String</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/common/TextExtractor.html" title="class in org.odftoolkit.simple.common">TextExtractor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#newOdfTextExtractor(org.odftoolkit.odfdom.pkg.OdfElement)">newOdfTextExtractor</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement element)</code> |
| <div class="block">Create a TextExtractor instance using specified ODF element, which text |
| content can be extracted by <code>getText()</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/TextExtractor.html#visit(org.odftoolkit.odfdom.pkg.OdfElement)">visit</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement element)</code> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of <code>OdfElement</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#visit(org.odftoolkit.odfdom.dom.element.text.TextHElement)">visit</a></strong>(org.odftoolkit.odfdom.dom.element.text.TextHElement ele)</code> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of text:h.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#visit(org.odftoolkit.odfdom.dom.element.text.TextLineBreakElement)">visit</a></strong>(org.odftoolkit.odfdom.dom.element.text.TextLineBreakElement ele)</code> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of text:linebreak.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#visit(org.odftoolkit.odfdom.dom.element.text.TextPElement)">visit</a></strong>(org.odftoolkit.odfdom.dom.element.text.TextPElement ele)</code> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of text:p.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#visit(org.odftoolkit.odfdom.dom.element.text.TextSElement)">visit</a></strong>(org.odftoolkit.odfdom.dom.element.text.TextSElement ele)</code> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of text:s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#visit(org.odftoolkit.odfdom.dom.element.text.TextTabElement)">visit</a></strong>(org.odftoolkit.odfdom.dom.element.text.TextTabElement ele)</code> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of text:tab.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.odfdom.dom.DefaultElementVisitor"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.odftoolkit.odfdom.dom.DefaultElementVisitor</h3> |
| <code>visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit</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#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="NewLineChar"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NewLineChar</h4> |
| <pre>protected static final char NewLineChar</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.odftoolkit.simple.common.TextExtractor.NewLineChar">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="TabChar"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TabChar</h4> |
| <pre>protected static final char TabChar</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.odftoolkit.simple.common.TextExtractor.TabChar">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="mTextBuilder"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>mTextBuilder</h4> |
| <pre>protected final <a href="../../../../org/odftoolkit/simple/common/TextExtractor.ExtractorStringBuilder.html" title="class in org.odftoolkit.simple.common">TextExtractor.ExtractorStringBuilder</a> mTextBuilder</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TextExtractor()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TextExtractor</h4> |
| <pre>protected TextExtractor()</pre> |
| <div class="block">Default constructor</div> |
| </li> |
| </ul> |
| <a name="TextExtractor(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TextExtractor</h4> |
| <pre>protected TextExtractor(org.odftoolkit.odfdom.pkg.OdfElement element)</pre> |
| <div class="block">Constructor with an ODF element as parameter</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - the ODF element whose text would be extracted.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getText(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getText</h4> |
| <pre>public static <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(org.odftoolkit.odfdom.pkg.OdfElement ele)</pre> |
| <div class="block">Return the text content of a element as String</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ele</code> - the ODF element</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the text content of the element</dd></dl> |
| </li> |
| </ul> |
| <a name="newOdfTextExtractor(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newOdfTextExtractor</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/simple/common/TextExtractor.html" title="class in org.odftoolkit.simple.common">TextExtractor</a> newOdfTextExtractor(org.odftoolkit.odfdom.pkg.OdfElement element)</pre> |
| <div class="block">Create a TextExtractor instance using specified ODF element, which text |
| content can be extracted by <code>getText()</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - the ODF element whose text will be extracted.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an instance of TextExtractor</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">Return the text content of specified ODF element as a string.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the text content as a string</dd></dl> |
| </li> |
| </ul> |
| <a name="visit(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visit</h4> |
| <pre>public void visit(org.odftoolkit.odfdom.pkg.OdfElement element)</pre> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of <code>OdfElement</code>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>visit</code> in interface <code>org.odftoolkit.odfdom.pkg.ElementVisitor</code></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>visit</code> in class <code>org.odftoolkit.odfdom.dom.DefaultElementVisitor</code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><code>DefaultElementVisitor.visit(org.odftoolkit.odfdom.pkg.OdfElement)</code></dd></dl> |
| </li> |
| </ul> |
| <a name="visit(org.odftoolkit.odfdom.dom.element.text.TextPElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visit</h4> |
| <pre>public void visit(org.odftoolkit.odfdom.dom.element.text.TextPElement ele)</pre> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of text:p.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code>visit</code> in class <code>org.odftoolkit.odfdom.dom.DefaultElementVisitor</code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><code>DefaultElementVisitor.visit(org.odftoolkit.odfdom.dom.element.text.TextPElement)</code></dd></dl> |
| </li> |
| </ul> |
| <a name="visit(org.odftoolkit.odfdom.dom.element.text.TextHElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visit</h4> |
| <pre>public void visit(org.odftoolkit.odfdom.dom.element.text.TextHElement ele)</pre> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of text:h.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code>visit</code> in class <code>org.odftoolkit.odfdom.dom.DefaultElementVisitor</code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><code>DefaultElementVisitor.visit(org.odftoolkit.odfdom.dom.element.text.TextHElement)</code></dd></dl> |
| </li> |
| </ul> |
| <a name="visit(org.odftoolkit.odfdom.dom.element.text.TextSElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visit</h4> |
| <pre>public void visit(org.odftoolkit.odfdom.dom.element.text.TextSElement ele)</pre> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of text:s.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code>visit</code> in class <code>org.odftoolkit.odfdom.dom.DefaultElementVisitor</code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><code>DefaultElementVisitor.visit(org.odftoolkit.odfdom.dom.element.text.TextSElement)</code></dd></dl> |
| </li> |
| </ul> |
| <a name="visit(org.odftoolkit.odfdom.dom.element.text.TextTabElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visit</h4> |
| <pre>public void visit(org.odftoolkit.odfdom.dom.element.text.TextTabElement ele)</pre> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of text:tab.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code>visit</code> in class <code>org.odftoolkit.odfdom.dom.DefaultElementVisitor</code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><code>DefaultElementVisitor.visit(org.odftoolkit.odfdom.dom.element.text.TextTabElement)</code></dd></dl> |
| </li> |
| </ul> |
| <a name="visit(org.odftoolkit.odfdom.dom.element.text.TextLineBreakElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visit</h4> |
| <pre>public void visit(org.odftoolkit.odfdom.dom.element.text.TextLineBreakElement ele)</pre> |
| <div class="block">The end users needn't to care of this method, if you don't want to |
| override the text content handling strategy of text:linebreak.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code>visit</code> in class <code>org.odftoolkit.odfdom.dom.DefaultElementVisitor</code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><code>DefaultElementVisitor.visit(org.odftoolkit.odfdom.dom.element.text.TextLineBreakElement)</code></dd></dl> |
| </li> |
| </ul> |
| <a name="appendElementText(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>appendElementText</h4> |
| <pre>protected void appendElementText(org.odftoolkit.odfdom.pkg.OdfElement ele)</pre> |
| <div class="block">Append the text content of this element to string buffer.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ele</code> - the ODF element whose text will be appended.</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/TextExtractor.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/EditableTextExtractor.html" title="class in org.odftoolkit.simple.common"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/common/TextExtractor.ExtractorStringBuilder.html" title="class in org.odftoolkit.simple.common"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/odftoolkit/simple/common/TextExtractor.html" target="_top">Frames</a></li> |
| <li><a href="TextExtractor.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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> |
