| <!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>org.odftoolkit.simple.common.navigation (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="org.odftoolkit.simple.common.navigation (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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/field/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/odftoolkit/simple/draw/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/odftoolkit/simple/common/navigation/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.odftoolkit.simple.common.navigation</h1> |
| <div class="docSummary"> |
| <div class="block">Provide classes to operate the content and style of the selected text content.</div> |
| </div> |
| <p>See: <a href="#package_description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/CellSelection.html" title="class in org.odftoolkit.simple.common.navigation">CellSelection</a></td> |
| <td class="colLast"> |
| <div class="block">Based on <code>TextSelection</code>, <code>CellSelection</code> updates table |
| cell value and value type when the cell text is replaced by other content.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/FieldSelection.html" title="class in org.odftoolkit.simple.common.navigation">FieldSelection</a></td> |
| <td class="colLast"> |
| <div class="block">This is a decorator class of TextSelection, which help user replace a text |
| content with field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/ImageSelection.html" title="class in org.odftoolkit.simple.common.navigation">ImageSelection</a></td> |
| <td class="colLast"> |
| <div class="block">This is a decorator class of TextSelection, which help user replace a text content with a Image from Document or from URI.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/Navigation.html" title="class in org.odftoolkit.simple.common.navigation">Navigation</a></td> |
| <td class="colLast"> |
| <div class="block"><code>Navigation</code> is used to navigate the document and find the matched |
| element by user defined conditions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/ParagraphSelection.html" title="class in org.odftoolkit.simple.common.navigation">ParagraphSelection</a></td> |
| <td class="colLast"> |
| <div class="block">This is a decorator class of TextSelection, which help user replace a text content with a Paragraph.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/Selection.html" title="class in org.odftoolkit.simple.common.navigation">Selection</a></td> |
| <td class="colLast"> |
| <div class="block"><code>Selection</code> describes one of the matched results, which is |
| recognized by the container element, the start index of the text content in |
| this element and the text content.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/TableSelection.html" title="class in org.odftoolkit.simple.common.navigation">TableSelection</a></td> |
| <td class="colLast"> |
| <div class="block">This is a decorator class of TextSelection, which help user replace a text content with a Table.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/TextDocumentSelection.html" title="class in org.odftoolkit.simple.common.navigation">TextDocumentSelection</a></td> |
| <td class="colLast"> |
| <div class="block">This is a decorator class of TextSelection, which help user replace a text |
| content with a TextDocument, all Styles be included.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/TextNavigation.html" title="class in org.odftoolkit.simple.common.navigation">TextNavigation</a></td> |
| <td class="colLast"> |
| <div class="block">A derived <code>Navigation</code> class used to navigate the text content, |
| which can search the document and find the matched text and return |
| <code>TextSelection</code> instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/TextSelection.html" title="class in org.odftoolkit.simple.common.navigation">TextSelection</a></td> |
| <td class="colLast"> |
| <div class="block"><code>TextSelection</code> describes a sub element in a paragraph element or |
| a heading element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/TextStyleNavigation.html" title="class in org.odftoolkit.simple.common.navigation">TextStyleNavigation</a></td> |
| <td class="colLast"> |
| <div class="block">A derived <code>Navigation</code> class used to navigate the text content, |
| which can search the document and find matched style properties and return |
| <code>TextSelection</code> instance(s).</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/navigation/InvalidNavigationException.html" title="class in org.odftoolkit.simple.common.navigation">InvalidNavigationException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown to indicate that the navigation operation can not be processed on |
| selections</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package_description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.odftoolkit.simple.common.navigation Description">Package org.odftoolkit.simple.common.navigation Description</h2> |
| <div class="block"><!-- |
| ##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. ##### |
| ##### TYPE YOUR PACKAGE COMMENTS HERE. BEGIN WITH A ##### |
| ##### ONE-SENTENCE SUMMARY STARTING WITH A VERB LIKE: ##### |
| --> |
| |
| |
| Provide classes to operate the content and style of the selected text content. |
| |
| <p> |
| Abstract class Navigation represent the navigate action on the specified document, |
| and user can iterate all the results of this navigation operation. Abstract class |
| Selection describes one result of navigation. |
| |
| <p> |
| The instance of derived navigation class will give the match condition so that user |
| can get the corresponding derived Selection class instance. e.g. TextNavigation class |
| is used to search the specified text content in the document, and TextStyleNavigation |
| class can select the text which match the specified style. |
| <p> |
| TextSelection class which inherits Selection represents a snippet text of the |
| paragraph/heading/header/footer, it can be represent by the belonged element and the |
| text index of this element. User can get delete this result, or replace this text with |
| other content, add href link for this selections, append the italic style for it and paste |
| this selection at the front of or the end of other selction. |
| |
| <p> |
| CellSelection inherits TextSelection. It provides a new function to not only replace text |
| but also reset the cell values. |
| <p> |
| |
| <!-- Put @see and @since tags down here. --></div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/field/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/odftoolkit/simple/draw/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/odftoolkit/simple/common/navigation/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <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> |
