blob: 7b081ac69b6c51930613289de60ce73221371bbb [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_45) on Tue Mar 28 22:15:33 CEST 2017 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
AbstractFormContainer (Simple ODF v0.8.2-incubating - http://odftoolkit)
</TITLE>
<META NAME="date" CONTENT="2017-03-28">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractFormContainer (Simple ODF v0.8.2-incubating - http://odftoolkit)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractFormContainer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/odftoolkit/simple/form/Button.html" title="class in org.odftoolkit.simple.form"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/odftoolkit/simple/form/AbstractFormContainer.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="AbstractFormContainer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.odftoolkit.simple.form</FONT>
<BR>
Class AbstractFormContainer</H2>
<PRE>
<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>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.odftoolkit.simple.form.AbstractFormContainer</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>AbstractFormContainer</B><DT>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><DT>implements <A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></DL>
</PRE>
<P>
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().
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>0.8</DD>
</DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#AbstractFormContainer()">AbstractFormContainer</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#createForm(java.lang.String)">createForm</A></B>(<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>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;create and add a form into this container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getApplyDesignMode()">getApplyDesignMode</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getAutomaticFocus()">getAutomaticFocus</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getFormByName(java.lang.String)">getFormByName</A></B>(<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>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a form whose name is a given value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract &nbsp;<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/office/OfficeFormsElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.office">OfficeFormsElement</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getFormContainerElement()">getFormContainerElement</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the ODF element <code>OfficeFormsElement</code> which can have
<code>FormFormElement</code> as child element directly according to ODF
specification.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&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;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getFormIterator()">getFormIterator</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get an iterator to traverse each form in this container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/odftoolkit/simple/form/FormProvider.html" title="interface in org.odftoolkit.simple.form">FormProvider</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#getProvider()">getProvider</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the form provider of this container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#removeForm(org.odftoolkit.simple.form.Form)">removeForm</A></B>(<A HREF="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</A>&nbsp;form)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove the form and its binding shape.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#setApplyDesignMode(boolean)">setApplyDesignMode</A></B>(boolean&nbsp;isDesignMode)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#setAutomaticFocus(boolean)">setAutomaticFocus</A></B>(boolean&nbsp;isAutoFocus)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/form/AbstractFormContainer.html#setProvider(org.odftoolkit.simple.form.FormProvider)">setProvider</A></B>(<A HREF="../../../../org/odftoolkit/simple/form/FormProvider.html" title="interface in org.odftoolkit.simple.form">FormProvider</A>&nbsp;provider)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the form provider of this container.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>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></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><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></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="AbstractFormContainer()"><!-- --></A><H3>
AbstractFormContainer</H3>
<PRE>
public <B>AbstractFormContainer</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getFormContainerElement()"><!-- --></A><H3>
getFormContainerElement</H3>
<PRE>
public abstract <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/office/OfficeFormsElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.office">OfficeFormsElement</A> <B>getFormContainerElement</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormContainerElement()">FormContainer</A></CODE></B></DD>
<DD>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.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormContainerElement()">getFormContainerElement</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the element of office:forms</DL>
</DD>
</DL>
<HR>
<A NAME="createForm(java.lang.String)"><!-- --></A><H3>
createForm</H3>
<PRE>
public <A HREF="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</A> <B>createForm</B>(<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>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#createForm(java.lang.String)">FormContainer</A></CODE></B></DD>
<DD>create and add a form into this container.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#createForm(java.lang.String)">createForm</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - - form name, represents attribute <code>form:name</code>
<DT><B>Returns:</B><DD>an instance of Form</DL>
</DD>
</DL>
<HR>
<A NAME="removeForm(org.odftoolkit.simple.form.Form)"><!-- --></A><H3>
removeForm</H3>
<PRE>
public boolean <B>removeForm</B>(<A HREF="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</A>&nbsp;form)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#removeForm(org.odftoolkit.simple.form.Form)">FormContainer</A></CODE></B></DD>
<DD>Remove the form and its binding shape.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#removeForm(org.odftoolkit.simple.form.Form)">removeForm</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>form</CODE> - - the form to be removed
<DT><B>Returns:</B><DD>true if the form is removed successfully, false if errors happen.</DL>
</DD>
</DL>
<HR>
<A NAME="getFormByName(java.lang.String)"><!-- --></A><H3>
getFormByName</H3>
<PRE>
public <A HREF="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</A> <B>getFormByName</B>(<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>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormByName(java.lang.String)">FormContainer</A></CODE></B></DD>
<DD>Return a form whose name is a given value.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormByName(java.lang.String)">getFormByName</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - - the name of the form
<DT><B>Returns:</B><DD>a form whose name is a given value</DL>
</DD>
</DL>
<HR>
<A NAME="getFormIterator()"><!-- --></A><H3>
getFormIterator</H3>
<PRE>
public <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; <B>getFormIterator</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormIterator()">FormContainer</A></CODE></B></DD>
<DD>Get an iterator to traverse each form in this container.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#getFormIterator()">getFormIterator</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>form iterator</DL>
</DD>
</DL>
<HR>
<A NAME="getApplyDesignMode()"><!-- --></A><H3>
getApplyDesignMode</H3>
<PRE>
public boolean <B>getApplyDesignMode</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#getApplyDesignMode()">FormContainer</A></CODE></B></DD>
<DD>Get the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#getApplyDesignMode()">getApplyDesignMode</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if forms in document are presented in editable state;false
if forms in document are presented in completed state</DL>
</DD>
</DL>
<HR>
<A NAME="getAutomaticFocus()"><!-- --></A><H3>
getAutomaticFocus</H3>
<PRE>
public boolean <B>getAutomaticFocus</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#getAutomaticFocus()">FormContainer</A></CODE></B></DD>
<DD>Get the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#getAutomaticFocus()">getAutomaticFocus</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if sets the focus to a form control after loading the
document; false if else.</DL>
</DD>
</DL>
<HR>
<A NAME="setApplyDesignMode(boolean)"><!-- --></A><H3>
setApplyDesignMode</H3>
<PRE>
public void <B>setApplyDesignMode</B>(boolean&nbsp;isDesignMode)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#setApplyDesignMode(boolean)">FormContainer</A></CODE></B></DD>
<DD>Set the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#setApplyDesignMode(boolean)">setApplyDesignMode</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>isDesignMode</CODE> - - true if forms in document are presented in editable state;
false if forms in document are presented in completed state</DL>
</DD>
</DL>
<HR>
<A NAME="setAutomaticFocus(boolean)"><!-- --></A><H3>
setAutomaticFocus</H3>
<PRE>
public void <B>setAutomaticFocus</B>(boolean&nbsp;isAutoFocus)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#setAutomaticFocus(boolean)">FormContainer</A></CODE></B></DD>
<DD>Set the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html#setAutomaticFocus(boolean)">setAutomaticFocus</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>isAutoFocus</CODE> - -true if sets the focus to a form control after loading the
document; false if else.</DL>
</DD>
</DL>
<HR>
<A NAME="setProvider(org.odftoolkit.simple.form.FormProvider)"><!-- --></A><H3>
setProvider</H3>
<PRE>
public void <B>setProvider</B>(<A HREF="../../../../org/odftoolkit/simple/form/FormProvider.html" title="interface in org.odftoolkit.simple.form">FormProvider</A>&nbsp;provider)</PRE>
<DL>
<DD>Set the form provider of this container.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>provider</CODE> - - which is used to instantiate a form</DL>
</DD>
</DL>
<HR>
<A NAME="getProvider()"><!-- --></A><H3>
getProvider</H3>
<PRE>
public <A HREF="../../../../org/odftoolkit/simple/form/FormProvider.html" title="interface in org.odftoolkit.simple.form">FormProvider</A> <B>getProvider</B>()</PRE>
<DL>
<DD>Get the form provider of this container.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>provider - a default provider followed by OO definition will be
created if users don't appointed one.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractFormContainer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/odftoolkit/simple/form/Button.html" title="class in org.odftoolkit.simple.form"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/odftoolkit/simple/form/AbstractFormContainer.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="AbstractFormContainer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2010-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>