| <!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>ReferenceField (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="ReferenceField (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/ReferenceField.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/PageNumberField.DisplayType.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/ReferenceField.DisplayType.html" title="enum 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/ReferenceField.html" target="_top">Frames</a></li> |
| <li><a href="ReferenceField.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>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 ReferenceField" class="title">Class ReferenceField</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Component</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/odftoolkit/simple/common/field/Field.html" title="class in org.odftoolkit.simple.common.field">org.odftoolkit.simple.common.field.Field</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.odftoolkit.simple.common.field.ReferenceField</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">ReferenceField</span> |
| extends <a href="../../../../../org/odftoolkit/simple/common/field/Field.html" title="class in org.odftoolkit.simple.common.field">Field</a></pre> |
| <div class="block">A ReferenceField refers to a field that appears in another location in a |
| document. |
| <p> |
| The advantage of entering a reference as a field is that you do not have to |
| adjust the references manually every time you change the document. Just |
| update the fields and the references in the document are updated too. |
| <p> |
| NOTE: Before the document is opened in any editor, the value of this field |
| maybe invalid.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.5</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>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.DisplayType.html" title="enum in org.odftoolkit.simple.common.field">ReferenceField.DisplayType</a></strong></code> |
| <div class="block">A <tt>DisplayType</tt> specifies the information that a reference field |
| should display.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_org.odftoolkit.simple.common.field.Field"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.odftoolkit.simple.common.field.<a href="../../../../../org/odftoolkit/simple/common/field/Field.html" title="class in org.odftoolkit.simple.common.field">Field</a></h3> |
| <code><a href="../../../../../org/odftoolkit/simple/common/field/Field.FieldType.html" title="enum in org.odftoolkit.simple.common.field">Field.FieldType</a></code></li> |
| </ul> |
| </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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.html#appendReferenceTo(org.odftoolkit.odfdom.pkg.OdfElement, org.odftoolkit.simple.common.field.ReferenceField.DisplayType)">appendReferenceTo</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement odfEle, |
| <a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.DisplayType.html" title="enum in org.odftoolkit.simple.common.field">ReferenceField.DisplayType</a> type)</code> |
| <div class="block">Append this reference field after the specifics OdfElement.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/common/field/Field.FieldType.html" title="enum in org.odftoolkit.simple.common.field">Field.FieldType</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.html#getFieldType()">getFieldType</a></strong>()</code> |
| <div class="block">Return the type of this field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/field/ReferenceField.html#getName()">getName</a></strong>()</code> |
| <div class="block">Get the name of this reference field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.html#getOdfElement()">getOdfElement</a></strong>()</code> |
| <div class="block">Return the instance of OdfElement which presents this structure.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.html#setName(java.lang.String)">setName</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> referenceName)</code> |
| <div class="block">Set the name of this reference field.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.Component"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.odftoolkit.simple.<a href="../../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></h3> |
| <code><a href="../../../../../org/odftoolkit/simple/Component.html#getComponentByElement(org.odftoolkit.odfdom.pkg.OdfElement)">getComponentByElement</a>, <a href="../../../../../org/odftoolkit/simple/Component.html#getOwnerDocument()">getOwnerDocument</a>, <a href="../../../../../org/odftoolkit/simple/Component.html#registerComponent(org.odftoolkit.simple.Component, org.odftoolkit.odfdom.pkg.OdfElement)">registerComponent</a>, <a href="../../../../../org/odftoolkit/simple/Component.html#unregisterComponent(org.odftoolkit.odfdom.pkg.OdfElement)">unregisterComponent</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="setName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>public void setName(<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">Set the name of this reference field.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>referenceName</code> - the name of this content.</dd></dl> |
| </li> |
| </ul> |
| <a name="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</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> getName()</pre> |
| <div class="block">Get the name of this reference field.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the name of this reference field.</dd></dl> |
| </li> |
| </ul> |
| <a name="appendReferenceTo(org.odftoolkit.odfdom.pkg.OdfElement, org.odftoolkit.simple.common.field.ReferenceField.DisplayType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appendReferenceTo</h4> |
| <pre>public void appendReferenceTo(org.odftoolkit.odfdom.pkg.OdfElement odfEle, |
| <a href="../../../../../org/odftoolkit/simple/common/field/ReferenceField.DisplayType.html" title="enum in org.odftoolkit.simple.common.field">ReferenceField.DisplayType</a> type)</pre> |
| <div class="block">Append this reference field after the specifics OdfElement.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfEle</code> - the reference of odf element.</dd><dd><code>type</code> - the display type.</dd></dl> |
| </li> |
| </ul> |
| <a name="getOdfElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOdfElement</h4> |
| <pre>public org.odftoolkit.odfdom.pkg.OdfElement getOdfElement()</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/odftoolkit/simple/Component.html#getOdfElement()">Component</a></code></strong></div> |
| <div class="block">Return the instance of OdfElement which presents this structure.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/Component.html#getOdfElement()">getOdfElement</a></code> in class <code><a href="../../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the instance of OdfElement</dd></dl> |
| </li> |
| </ul> |
| <a name="getFieldType()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getFieldType</h4> |
| <pre>public <a href="../../../../../org/odftoolkit/simple/common/field/Field.FieldType.html" title="enum in org.odftoolkit.simple.common.field">Field.FieldType</a> getFieldType()</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/odftoolkit/simple/common/field/Field.html#getFieldType()">Field</a></code></strong></div> |
| <div class="block">Return the type of this field.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/odftoolkit/simple/common/field/Field.html#getFieldType()">getFieldType</a></code> in class <code><a href="../../../../../org/odftoolkit/simple/common/field/Field.html" title="class in org.odftoolkit.simple.common.field">Field</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the type of this 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/ReferenceField.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/PageNumberField.DisplayType.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/ReferenceField.DisplayType.html" title="enum 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/ReferenceField.html" target="_top">Frames</a></li> |
| <li><a href="ReferenceField.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>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> |
