| <!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.field (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.field (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/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/odftoolkit/simple/common/navigation/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/odftoolkit/simple/common/field/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.field</h1> |
| <div class="docSummary"> |
| <div class="block">Provide convenient methods to manipulate Fields in ODF text document</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="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a></td> |
| <td class="colLast"> |
| <div class="block">VariableContainer is a container which maintains the declared variables.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <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/field/AbstractVariableContainer.html" title="class in org.odftoolkit.simple.common.field">AbstractVariableContainer</a></td> |
| <td class="colLast"> |
| <div class="block">AbstractVariableContainer is an abstract implementation of the |
| VariableContainer interface, with a default implementation for every method |
| defined in VariableContainer , except getVariableContainerElement().</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/AuthorField.html" title="class in org.odftoolkit.simple.common.field">AuthorField</a></td> |
| <td class="colLast"> |
| <div class="block">An <tt>AuthorField</tt> represents the initials of the author or the full |
| name of the author of a document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/ChapterField.html" title="class in org.odftoolkit.simple.common.field">ChapterField</a></td> |
| <td class="colLast"> |
| <div class="block">ChapterField is placed inside a header or footer, it displays the current |
| chapter name or number on every page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/ConditionField.html" title="class in org.odftoolkit.simple.common.field">ConditionField</a></td> |
| <td class="colLast"> |
| <div class="block">ConditionField specifies a condition for display of one text string or |
| another.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/DateField.html" title="class in org.odftoolkit.simple.common.field">DateField</a></td> |
| <td class="colLast"> |
| <div class="block">DateField displays a date, by default this is the current date.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/Field.html" title="class in org.odftoolkit.simple.common.field">Field</a></td> |
| <td class="colLast"> |
| <div class="block">This is the abstract class of all kinds of fields.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html" title="class in org.odftoolkit.simple.common.field">Fields</a></td> |
| <td class="colLast"> |
| <div class="block">This is a tool class to help the user creating all kinds of fields as needed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/PageCountField.html" title="class in org.odftoolkit.simple.common.field">PageCountField</a></td> |
| <td class="colLast"> |
| <div class="block">A <tt>PageCountField</tt> displays the total number of pages in a document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/PageNumberField.html" title="class in org.odftoolkit.simple.common.field">PageNumberField</a></td> |
| <td class="colLast"> |
| <div class="block">A <tt>PageNumberField</tt> displays the current page number of pages in a |
| document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.html" title="class in org.odftoolkit.simple.common.field">ReferenceField</a></td> |
| <td class="colLast"> |
| <div class="block">A ReferenceField refers to a field that appears in another location in a |
| document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/SubjectField.html" title="class in org.odftoolkit.simple.common.field">SubjectField</a></td> |
| <td class="colLast"> |
| <div class="block">A <tt>SubjectField</tt> displays the subject value contained by the document |
| meta data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/TimeField.html" title="class in org.odftoolkit.simple.common.field">TimeField</a></td> |
| <td class="colLast"> |
| <div class="block">TimeField displays a time, by default this is the current time.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/TitleField.html" title="class in org.odftoolkit.simple.common.field">TitleField</a></td> |
| <td class="colLast"> |
| <div class="block">A <tt>TitleField</tt> displays the title value contained by the document meta |
| data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a></td> |
| <td class="colLast"> |
| <div class="block">ODF document can contain variables, which are processed or displayed as |
| VariableFields.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/ChapterField.DisplayType.html" title="enum in org.odftoolkit.simple.common.field">ChapterField.DisplayType</a></td> |
| <td class="colLast"> |
| <div class="block">A <tt>DisplayType</tt> specifies the information that a chapter field |
| should display.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/Field.FieldType.html" title="enum in org.odftoolkit.simple.common.field">Field.FieldType</a></td> |
| <td class="colLast"> |
| <div class="block">A <tt>FieldType</tt> specifies the type of a field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/PageNumberField.DisplayType.html" title="enum in org.odftoolkit.simple.common.field">PageNumberField.DisplayType</a></td> |
| <td class="colLast"> |
| <div class="block">A <tt>DisplayType</tt> represents the selected page attribute of the |
| field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.DisplayType.html" title="enum in org.odftoolkit.simple.common.field">ReferenceField.DisplayType</a></td> |
| <td class="colLast"> |
| <div class="block">A <tt>DisplayType</tt> specifies the information that a reference field |
| should display.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/odftoolkit/simple/common/field/VariableField.VariableType.html" title="enum in org.odftoolkit.simple.common.field">VariableField.VariableType</a></td> |
| <td class="colLast"> |
| <div class="block">A <tt>VariableType</tt> represents the type of the variable field.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package_description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.odftoolkit.simple.common.field Description">Package org.odftoolkit.simple.common.field 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 convenient methods to manipulate Fields in ODF text document. |
| <!-- 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/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/odftoolkit/simple/common/navigation/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/odftoolkit/simple/common/field/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> |