| <!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>Fields (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="Fields (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/Fields.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/Field.FieldType.html" title="enum in org.odftoolkit.simple.common.field"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/odftoolkit/simple/common/field/PageCountField.html" title="class in org.odftoolkit.simple.common.field"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/odftoolkit/simple/common/field/Fields.html" target="_top">Frames</a></li> |
| <li><a href="Fields.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.field</div> |
| <h2 title="Class Fields" class="title">Class Fields</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.simple.common.field.Fields</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">Fields</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">This is a tool class to help the user creating all kinds of fields as needed.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.5</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/odftoolkit/simple/common/navigation/FieldSelection.html" title="class in org.odftoolkit.simple.common.navigation"><code>FieldSelection</code></a></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"> </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>static <a href="../../../../../org/odftoolkit/simple/common/field/AuthorField.html" title="class in org.odftoolkit.simple.common.field">AuthorField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createAuthorInitialsField(org.odftoolkit.odfdom.pkg.OdfElement)">createAuthorInitialsField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create an author field for the specific OdfElement, which displays the |
| initials of the author of this document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/AuthorField.html" title="class in org.odftoolkit.simple.common.field">AuthorField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createAuthorNameField(org.odftoolkit.odfdom.pkg.OdfElement)">createAuthorNameField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create an author field for the specific OdfElement, which displays author |
| full name of this document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/ChapterField.html" title="class in org.odftoolkit.simple.common.field">ChapterField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createChapterField(org.odftoolkit.odfdom.pkg.OdfElement)">createChapterField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create a chapter field for the specific OdfElement.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/ConditionField.html" title="class in org.odftoolkit.simple.common.field">ConditionField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createConditionField(org.odftoolkit.odfdom.pkg.OdfElement, java.lang.String, java.lang.String, java.lang.String)">createConditionField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement, |
| <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> condition, |
| <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> trueText, |
| <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> falseText)</code> |
| <div class="block">Declare a condition field, which specifies a condition for display of one |
| text string or another.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/PageNumberField.html" title="class in org.odftoolkit.simple.common.field">PageNumberField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createCurrentPageNumberField(org.odftoolkit.odfdom.pkg.OdfElement)">createCurrentPageNumberField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create a page number field for the specific OdfElement, which displays |
| current page number.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/DateField.html" title="class in org.odftoolkit.simple.common.field">DateField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createDateField(org.odftoolkit.odfdom.pkg.OdfElement)">createDateField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create an automatically update date field for the specific OdfElement, |
| which displays current date.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/DateField.html" title="class in org.odftoolkit.simple.common.field">DateField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createFixedDateField(org.odftoolkit.odfdom.pkg.OdfElement)">createFixedDateField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create a fixed date field for the specific OdfElement, which displays the |
| field created date.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/TimeField.html" title="class in org.odftoolkit.simple.common.field">TimeField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createFixedTimeField(org.odftoolkit.odfdom.pkg.OdfElement)">createFixedTimeField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create a fixed time field for the specific OdfElement, which displays the |
| field created time.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/ConditionField.html" title="class in org.odftoolkit.simple.common.field">ConditionField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createHiddenTextField(org.odftoolkit.odfdom.pkg.OdfElement, java.lang.String, java.lang.String)">createHiddenTextField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement, |
| <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> condition, |
| <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> text)</code> |
| <div class="block">Declare a hidden text field, which hides the text it contains when a |
| specified condition is true.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/PageNumberField.html" title="class in org.odftoolkit.simple.common.field">PageNumberField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createNextPageNumberField(org.odftoolkit.odfdom.pkg.OdfElement)">createNextPageNumberField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create a page number field for the specific OdfElement, which displays |
| next page number.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/PageCountField.html" title="class in org.odftoolkit.simple.common.field">PageCountField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createPageCountField(org.odftoolkit.odfdom.pkg.OdfElement)">createPageCountField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create a page count field for the specific OdfElement, which displays |
| page total count of this document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/PageNumberField.html" title="class in org.odftoolkit.simple.common.field">PageNumberField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createPreviousPageNumberField(org.odftoolkit.odfdom.pkg.OdfElement)">createPreviousPageNumberField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create a page number field for the specific OdfElement, which displays |
| previous page number.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.html" title="class in org.odftoolkit.simple.common.field">ReferenceField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createReferenceField(org.odftoolkit.odfdom.pkg.OdfElement, java.lang.String)">createReferenceField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement, |
| <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> referenceName)</code> |
| <div class="block">Create a ReferenceField for the specific OdfElement.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createSimpleVariableField(org.odftoolkit.simple.common.field.VariableContainer, java.lang.String)">createSimpleVariableField</a></strong>(<a href="../../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a> container, |
| <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> name)</code> |
| <div class="block">Declare a simple variable field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/SubjectField.html" title="class in org.odftoolkit.simple.common.field">SubjectField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createSubjectField(org.odftoolkit.odfdom.pkg.OdfElement)">createSubjectField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create a subject field for the specific OdfElement, which displays the |
| subject data of this document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/TimeField.html" title="class in org.odftoolkit.simple.common.field">TimeField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createTimeField(org.odftoolkit.odfdom.pkg.OdfElement)">createTimeField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create an automatically update time field for the specific OdfElement, |
| which displays current time.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/TitleField.html" title="class in org.odftoolkit.simple.common.field">TitleField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createTitleField(org.odftoolkit.odfdom.pkg.OdfElement)">createTitleField</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</code> |
| <div class="block">Create a title field for the specific OdfElement, which displays title |
| data of this document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/Fields.html#createUserVariableField(org.odftoolkit.simple.common.field.VariableContainer, java.lang.String, java.lang.String)">createUserVariableField</a></strong>(<a href="../../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a> container, |
| <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> name, |
| <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> value)</code> |
| <div class="block">Declare a user variable field.</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 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="createDateField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDateField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/DateField.html" title="class in org.odftoolkit.simple.common.field">DateField</a> createDateField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create an automatically update date field for the specific OdfElement, |
| which displays current date.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created date field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createFixedDateField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFixedDateField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/DateField.html" title="class in org.odftoolkit.simple.common.field">DateField</a> createFixedDateField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create a fixed date field for the specific OdfElement, which displays the |
| field created date.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created date field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createTimeField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTimeField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/TimeField.html" title="class in org.odftoolkit.simple.common.field">TimeField</a> createTimeField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create an automatically update time field for the specific OdfElement, |
| which displays current time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created time field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createFixedTimeField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFixedTimeField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/TimeField.html" title="class in org.odftoolkit.simple.common.field">TimeField</a> createFixedTimeField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create a fixed time field for the specific OdfElement, which displays the |
| field created time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created time field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createPreviousPageNumberField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPreviousPageNumberField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/PageNumberField.html" title="class in org.odftoolkit.simple.common.field">PageNumberField</a> createPreviousPageNumberField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create a page number field for the specific OdfElement, which displays |
| previous page number.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created page number field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createCurrentPageNumberField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createCurrentPageNumberField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/PageNumberField.html" title="class in org.odftoolkit.simple.common.field">PageNumberField</a> createCurrentPageNumberField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create a page number field for the specific OdfElement, which displays |
| current page number.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created page number field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createNextPageNumberField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createNextPageNumberField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/PageNumberField.html" title="class in org.odftoolkit.simple.common.field">PageNumberField</a> createNextPageNumberField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create a page number field for the specific OdfElement, which displays |
| next page number.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created page number field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createPageCountField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPageCountField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/PageCountField.html" title="class in org.odftoolkit.simple.common.field">PageCountField</a> createPageCountField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create a page count field for the specific OdfElement, which displays |
| page total count of this document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created page count field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createTitleField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTitleField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/TitleField.html" title="class in org.odftoolkit.simple.common.field">TitleField</a> createTitleField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create a title field for the specific OdfElement, which displays title |
| data of this document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created title field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createSubjectField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSubjectField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/SubjectField.html" title="class in org.odftoolkit.simple.common.field">SubjectField</a> createSubjectField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create a subject field for the specific OdfElement, which displays the |
| subject data of this document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created author field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createAuthorNameField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAuthorNameField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/AuthorField.html" title="class in org.odftoolkit.simple.common.field">AuthorField</a> createAuthorNameField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create an author field for the specific OdfElement, which displays author |
| full name of this document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created author field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createAuthorInitialsField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAuthorInitialsField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/AuthorField.html" title="class in org.odftoolkit.simple.common.field">AuthorField</a> createAuthorInitialsField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create an author field for the specific OdfElement, which displays the |
| initials of the author of this document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created author field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createChapterField(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createChapterField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/ChapterField.html" title="class in org.odftoolkit.simple.common.field">ChapterField</a> createChapterField(org.odftoolkit.odfdom.pkg.OdfElement odfElement)</pre> |
| <div class="block">Create a chapter field for the specific OdfElement.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created chapter field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createReferenceField(org.odftoolkit.odfdom.pkg.OdfElement, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createReferenceField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.html" title="class in org.odftoolkit.simple.common.field">ReferenceField</a> createReferenceField(org.odftoolkit.odfdom.pkg.OdfElement odfElement, |
| <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> referenceName)</pre> |
| <div class="block">Create a ReferenceField for the specific OdfElement.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd><dd><code>referenceName</code> - the reference field name.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created reference field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createSimpleVariableField(org.odftoolkit.simple.common.field.VariableContainer, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSimpleVariableField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a> createSimpleVariableField(<a href="../../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a> container, |
| <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> name)</pre> |
| <div class="block">Declare a simple variable field. Simple variables, can take different |
| values at different positions throughout a document. |
| <p> |
| Simple variables can be used to display different text in recurring |
| elements, such as headers or footers.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - the container which this variable field is contained.</dd><dd><code>name</code> - the name of this variable field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created variable field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createUserVariableField(org.odftoolkit.simple.common.field.VariableContainer, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createUserVariableField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a> createUserVariableField(<a href="../../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a> container, |
| <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> name, |
| <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> value)</pre> |
| <div class="block">Declare a user variable field. User variables have the same value |
| throughout a document. If a user variable is set anywhere within the |
| document, all fields in the document that display the user variable have |
| the same value.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - the container which this variable field is contained.</dd><dd><code>name</code> - the name of this variable field.</dd><dd><code>value</code> - the initial value of this variable field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created variable field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createConditionField(org.odftoolkit.odfdom.pkg.OdfElement, java.lang.String, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createConditionField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/ConditionField.html" title="class in org.odftoolkit.simple.common.field">ConditionField</a> createConditionField(org.odftoolkit.odfdom.pkg.OdfElement odfElement, |
| <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> condition, |
| <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> trueText, |
| <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> falseText)</pre> |
| <div class="block">Declare a condition field, which specifies a condition for display of one |
| text string or another. If the condition is true, one of the text strings |
| is displayed. If the condition is false, the other text string is |
| displayed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd><dd><code>condition</code> - the condition that determines which of the two text strings is |
| displayed.</dd><dd><code>trueText</code> - the text string to display if a <code>condition</code> is |
| true.</dd><dd><code>falseText</code> - the text string to display if a <code>condition</code> is |
| false.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created condition field.</dd></dl> |
| </li> |
| </ul> |
| <a name="createHiddenTextField(org.odftoolkit.odfdom.pkg.OdfElement, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createHiddenTextField</h4> |
| <pre>public static <a href="../../../../../org/odftoolkit/simple/common/field/ConditionField.html" title="class in org.odftoolkit.simple.common.field">ConditionField</a> createHiddenTextField(org.odftoolkit.odfdom.pkg.OdfElement odfElement, |
| <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> condition, |
| <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> text)</pre> |
| <div class="block">Declare a hidden text field, which hides the text it contains when a |
| specified condition is true.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfElement</code> - the OdfElement which owns this field.</dd><dd><code>condition</code> - the condition that determines whether the text string is |
| displayed or not.</dd><dd><code>text</code> - the text string to display.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the created condition field.</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/Fields.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/Field.FieldType.html" title="enum in org.odftoolkit.simple.common.field"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/odftoolkit/simple/common/field/PageCountField.html" title="class in org.odftoolkit.simple.common.field"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/odftoolkit/simple/common/field/Fields.html" target="_top">Frames</a></li> |
| <li><a href="Fields.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
