blob: 0945fcb4b503d102beeb4c91d87692eff8073fd1 [file] [log] [blame]
<!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>AbstractFormContainer (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="AbstractFormContainer (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/AbstractFormContainer.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>Prev Class</li>
<li><a href="../../../../org/odftoolkit/simple/form/Button.html" title="class in org.odftoolkit.simple.form"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/form/AbstractFormContainer.html" target="_top">Frames</a></li>
<li><a href="AbstractFormContainer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.form</div>
<h2 title="Class AbstractFormContainer" class="title">Class AbstractFormContainer</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.form.AbstractFormContainer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractFormContainer</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>
implements <a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></pre>
<div class="block">AbstractFormContainer is an abstract implementation of the FormContainer
interface, with a default implementation for every method defined in
FormContainer, except getFormContainerElement(). A subclass must implement
the abstract method getFormContainerElement().</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.8</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#AbstractFormContainer()">AbstractFormContainer</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</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">&nbsp;</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/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#createForm(java.lang.String)">createForm</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>&nbsp;name)</code>
<div class="block">create and add a form into this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getApplyDesignMode()">getApplyDesignMode</a></strong>()</code>
<div class="block">Get the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getAutomaticFocus()">getAutomaticFocus</a></strong>()</code>
<div class="block">Get the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getFormByName(java.lang.String)">getFormByName</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>&nbsp;name)</code>
<div class="block">Return a form whose name is a given value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract org.odftoolkit.odfdom.dom.element.office.OfficeFormsElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getFormContainerElement()">getFormContainerElement</a></strong>()</code>
<div class="block">Get the ODF element <code>OfficeFormsElement</code> which can have
<code>FormFormElement</code> as child element directly according to ODF
specification.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getFormIterator()">getFormIterator</a></strong>()</code>
<div class="block">Get an iterator to traverse each form in this container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/form/FormProvider.html" title="interface in org.odftoolkit.simple.form">FormProvider</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getProvider()">getProvider</a></strong>()</code>
<div class="block">Get the form provider of this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#removeForm(org.odftoolkit.simple.form.Form)">removeForm</a></strong>(<a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&nbsp;form)</code>
<div class="block">Remove the form and its binding shape.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#setApplyDesignMode(boolean)">setApplyDesignMode</a></strong>(boolean&nbsp;isDesignMode)</code>
<div class="block">Set the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#setAutomaticFocus(boolean)">setAutomaticFocus</a></strong>(boolean&nbsp;isAutoFocus)</code>
<div class="block">Set the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#setProvider(org.odftoolkit.simple.form.FormProvider)">setProvider</a></strong>(<a href="../../../../org/odftoolkit/simple/form/FormProvider.html" title="interface in org.odftoolkit.simple.form">FormProvider</a>&nbsp;provider)</code>
<div class="block">Set the form provider of this container.</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&nbsp;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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractFormContainer()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractFormContainer</h4>
<pre>public&nbsp;AbstractFormContainer()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getFormContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormContainerElement</h4>
<pre>public abstract&nbsp;org.odftoolkit.odfdom.dom.element.office.OfficeFormsElement&nbsp;getFormContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormContainerElement()">FormContainer</a></code></strong></div>
<div class="block">Get the ODF element <code>OfficeFormsElement</code> which can have
<code>FormFormElement</code> as child element directly according to ODF
specification. This element will help to find the position to insert a
new <code>FormFormElement</code> element.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormContainerElement()">getFormContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the element of office:forms</dd></dl>
</li>
</ul>
<a name="createForm(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createForm</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&nbsp;createForm(<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>&nbsp;name)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#createForm(java.lang.String)">FormContainer</a></code></strong></div>
<div class="block">create and add a form into this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#createForm(java.lang.String)">createForm</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - form name, represents attribute <code>form:name</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of Form</dd></dl>
</li>
</ul>
<a name="removeForm(org.odftoolkit.simple.form.Form)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeForm</h4>
<pre>public&nbsp;boolean&nbsp;removeForm(<a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&nbsp;form)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#removeForm(org.odftoolkit.simple.form.Form)">FormContainer</a></code></strong></div>
<div class="block">Remove the form and its binding shape.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#removeForm(org.odftoolkit.simple.form.Form)">removeForm</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>form</code> - - the form to be removed</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the form is removed successfully, false if errors happen.</dd></dl>
</li>
</ul>
<a name="getFormByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormByName</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&nbsp;getFormByName(<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>&nbsp;name)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormByName(java.lang.String)">FormContainer</a></code></strong></div>
<div class="block">Return a form whose name is a given value.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormByName(java.lang.String)">getFormByName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - the name of the form</dd>
<dt><span class="strong">Returns:</span></dt><dd>a form whose name is a given value</dd></dl>
</li>
</ul>
<a name="getFormIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormIterator</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&gt;&nbsp;getFormIterator()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormIterator()">FormContainer</a></code></strong></div>
<div class="block">Get an iterator to traverse each form in this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormIterator()">getFormIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>form iterator</dd></dl>
</li>
</ul>
<a name="getApplyDesignMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplyDesignMode</h4>
<pre>public&nbsp;boolean&nbsp;getApplyDesignMode()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#getApplyDesignMode()">FormContainer</a></code></strong></div>
<div class="block">Get the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#getApplyDesignMode()">getApplyDesignMode</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if forms in document are presented in editable state;false
if forms in document are presented in completed state</dd></dl>
</li>
</ul>
<a name="getAutomaticFocus()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAutomaticFocus</h4>
<pre>public&nbsp;boolean&nbsp;getAutomaticFocus()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#getAutomaticFocus()">FormContainer</a></code></strong></div>
<div class="block">Get the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#getAutomaticFocus()">getAutomaticFocus</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if sets the focus to a form control after loading the
document; false if else.</dd></dl>
</li>
</ul>
<a name="setApplyDesignMode(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setApplyDesignMode</h4>
<pre>public&nbsp;void&nbsp;setApplyDesignMode(boolean&nbsp;isDesignMode)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#setApplyDesignMode(boolean)">FormContainer</a></code></strong></div>
<div class="block">Set the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#setApplyDesignMode(boolean)">setApplyDesignMode</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>isDesignMode</code> - - true if forms in document are presented in editable state;
false if forms in document are presented in completed state</dd></dl>
</li>
</ul>
<a name="setAutomaticFocus(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutomaticFocus</h4>
<pre>public&nbsp;void&nbsp;setAutomaticFocus(boolean&nbsp;isAutoFocus)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#setAutomaticFocus(boolean)">FormContainer</a></code></strong></div>
<div class="block">Set the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html#setAutomaticFocus(boolean)">setAutomaticFocus</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>isAutoFocus</code> - -true if sets the focus to a form control after loading the
document; false if else.</dd></dl>
</li>
</ul>
<a name="setProvider(org.odftoolkit.simple.form.FormProvider)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProvider</h4>
<pre>public&nbsp;void&nbsp;setProvider(<a href="../../../../org/odftoolkit/simple/form/FormProvider.html" title="interface in org.odftoolkit.simple.form">FormProvider</a>&nbsp;provider)</pre>
<div class="block">Set the form provider of this container.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>provider</code> - - which is used to instantiate a form</dd></dl>
</li>
</ul>
<a name="getProvider()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getProvider</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/form/FormProvider.html" title="interface in org.odftoolkit.simple.form">FormProvider</a>&nbsp;getProvider()</pre>
<div class="block">Get the form provider of this container.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>provider - a default provider followed by OO definition will be
created if users don't appointed one.</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/AbstractFormContainer.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>Prev Class</li>
<li><a href="../../../../org/odftoolkit/simple/form/Button.html" title="class in org.odftoolkit.simple.form"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/form/AbstractFormContainer.html" target="_top">Frames</a></li>
<li><a href="AbstractFormContainer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>