| <!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>VariableContainer (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="VariableContainer (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/VariableContainer.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/TitleField.html" title="class in org.odftoolkit.simple.common.field"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/odftoolkit/simple/common/field/VariableField.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/VariableContainer.html" target="_top">Frames</a></li> |
| <li><a href="VariableContainer.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="Interface VariableContainer" class="title">Interface VariableContainer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/odftoolkit/simple/common/field/AbstractVariableContainer.html" title="class in org.odftoolkit.simple.common.field">AbstractVariableContainer</a>, <a href="../../../../../org/odftoolkit/simple/text/Footer.html" title="class in org.odftoolkit.simple.text">Footer</a>, <a href="../../../../../org/odftoolkit/simple/text/Header.html" title="class in org.odftoolkit.simple.text">Header</a>, <a href="../../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">VariableContainer</span></pre> |
| <div class="block">VariableContainer is a container which maintains the declared variables. |
| Variable(s) can be added in this container.</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/field/VariableField.html" title="class in org.odftoolkit.simple.common.field"><code>VariableField</code></a>, |
| <a href="../../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple"><code>TextDocument</code></a>, |
| <a href="../../../../../org/odftoolkit/simple/text/Header.html" title="class in org.odftoolkit.simple.text"><code>Header</code></a>, |
| <a href="../../../../../org/odftoolkit/simple/text/Footer.html" title="class in org.odftoolkit.simple.text"><code>Footer</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><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/VariableContainer.html#declareVariable(java.lang.String, org.odftoolkit.simple.common.field.VariableField.VariableType)">declareVariable</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> name, |
| <a href="../../../../../org/odftoolkit/simple/common/field/VariableField.VariableType.html" title="enum in org.odftoolkit.simple.common.field">VariableField.VariableType</a> type)</code> |
| <div class="block">Declare a new variable field to this container.</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/VariableContainer.html#getVariableContainerElement()">getVariableContainerElement</a></strong>()</code> |
| <div class="block">Get the ODF element which can have variable declare section as child |
| element directly according to ODF specification.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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/VariableContainer.html#getVariableFieldByName(java.lang.String)">getVariableFieldByName</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> name)</code> |
| <div class="block">Return the declared variable by name.</div> |
| </td> |
| </tr> |
| </table> |
| </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="getVariableContainerElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVariableContainerElement</h4> |
| <pre>org.odftoolkit.odfdom.pkg.OdfElement getVariableContainerElement()</pre> |
| <div class="block">Get the ODF element which can have variable declare section as child |
| element directly according to ODF specification. This element will help |
| to find the position to declare a new variable. |
| <p> |
| The variable declare section may be <text:variable-decls>, |
| <text:user-field-decls> or <text:sequence-decls>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>container element which can hold variable declare section.</dd></dl> |
| </li> |
| </ul> |
| <a name="declareVariable(java.lang.String, org.odftoolkit.simple.common.field.VariableField.VariableType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>declareVariable</h4> |
| <pre><a href="../../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a> declareVariable(<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="../../../../../org/odftoolkit/simple/common/field/VariableField.VariableType.html" title="enum in org.odftoolkit.simple.common.field">VariableField.VariableType</a> type)</pre> |
| <div class="block">Declare a new variable field to this container.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the unique name of this variable field.</dd><dd><code>type</code> - the type of this variable field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>declared variable field.</dd></dl> |
| </li> |
| </ul> |
| <a name="getVariableFieldByName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getVariableFieldByName</h4> |
| <pre><a href="../../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a> getVariableFieldByName(<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">Return the declared variable by name.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the unique name of this variable field.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the declared variable.</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/VariableContainer.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/TitleField.html" title="class in org.odftoolkit.simple.common.field"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/odftoolkit/simple/common/field/VariableField.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/VariableContainer.html" target="_top">Frames</a></li> |
| <li><a href="VariableContainer.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> |