| <!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:31 CEST 2017 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| Header (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="Header (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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Header.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/odftoolkit/simple/text/Footer.html" title="class in org.odftoolkit.simple.text"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/odftoolkit/simple/text/Header.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Header.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.text</FONT> |
| <BR> |
| Class Header</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 "><A HREF="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Component</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.odftoolkit.simple.text.Header</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</A>, <A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>Header</B><DT>extends <A HREF="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</A><DT>implements <A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A>, <A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</A></DL> |
| </PRE> |
| |
| <P> |
| This class represents header definition in text document. It provides methods |
| to manipulate header in text document, such as, set text, add table. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.4.5</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/text/Header.html#Header(org.odftoolkit.odfdom.dom.element.style.StyleHeaderElement)">Header</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/style/StyleHeaderElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.style">StyleHeaderElement</A> element)</CODE> |
| |
| <BR> |
| Create a header instance by an object of <code>StyleHeaderElement</code>.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> <A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#addTable()">addTable</A></B>()</CODE> |
| |
| <BR> |
| Add a new Table to this container.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#addTable(int, int)">addTable</A></B>(int numRows, |
| int numCols)</CODE> |
| |
| <BR> |
| Add a new Table to this container with a specified row number and column |
| number.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#appendSection(java.lang.String)">appendSection</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> name)</CODE> |
| |
| <BR> |
| Create an empty section and append it at the end of the footer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#declareVariable(java.lang.String, org.odftoolkit.simple.common.field.VariableField.VariableType)">declareVariable</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> name, |
| <A HREF="../../../../org/odftoolkit/simple/common/field/VariableField.VariableType.html" title="enum in org.odftoolkit.simple.common.field">VariableField.VariableType</A> type)</CODE> |
| |
| <BR> |
| Declare a new variable field to this container.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/style/StyleHeaderElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.style">StyleHeaderElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#getOdfElement()">getOdfElement</A></B>()</CODE> |
| |
| <BR> |
| Return an instance of <code>StyleHeaderElement</code> which represents |
| this feature.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#getTableBuilder()">getTableBuilder</A></B>()</CODE> |
| |
| <BR> |
| Return the table builder of this document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#getTableByName(java.lang.String)">getTableByName</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> name)</CODE> |
| |
| <BR> |
| Return an instance of table feature with the specific table name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#getTableContainerElement()">getTableContainerElement</A></B>()</CODE> |
| |
| <BR> |
| Get the ODF element which can have |
| <table:table> |
| 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> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#getTableList()">getTableList</A></B>()</CODE> |
| |
| <BR> |
| Return a list of table features in this document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#getVariableContainerElement()">getVariableContainerElement</A></B>()</CODE> |
| |
| <BR> |
| Get the ODF element which can have variable declare section 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> <A HREF="../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#getVariableFieldByName(java.lang.String)">getVariableFieldByName</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> name)</CODE> |
| |
| <BR> |
| Return the declared variable by name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#isVisible()">isVisible</A></B>()</CODE> |
| |
| <BR> |
| Get this header is visible or not.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/text/Header.html#setVisible(boolean)">setVisible</A></B>(boolean isVisible)</CODE> |
| |
| <BR> |
| Set this header visible or not.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.odftoolkit.simple.Component"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.odftoolkit.simple.<A HREF="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| <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> |
| |
| <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="Header(org.odftoolkit.odfdom.dom.element.style.StyleHeaderElement)"><!-- --></A><H3> |
| Header</H3> |
| <PRE> |
| public <B>Header</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/style/StyleHeaderElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.style">StyleHeaderElement</A> element)</PRE> |
| <DL> |
| <DD>Create a header instance by an object of <code>StyleHeaderElement</code>. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>element</CODE> - - an object of <code>StyleHeaderElement</code></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="getOdfElement()"><!-- --></A><H3> |
| getOdfElement</H3> |
| <PRE> |
| public <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/style/StyleHeaderElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.style">StyleHeaderElement</A> <B>getOdfElement</B>()</PRE> |
| <DL> |
| <DD>Return an instance of <code>StyleHeaderElement</code> which represents |
| this feature. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an instance of <code>StyleHeaderElement</code></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isVisible()"><!-- --></A><H3> |
| isVisible</H3> |
| <PRE> |
| public boolean <B>isVisible</B>()</PRE> |
| <DL> |
| <DD>Get this header is visible or not. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>If this header is visible return <code>true</code>, otherwise |
| return <code>false</code>.<DT><B>Since:</B></DT> |
| <DD>0.5.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVisible(boolean)"><!-- --></A><H3> |
| setVisible</H3> |
| <PRE> |
| public void <B>setVisible</B>(boolean isVisible)</PRE> |
| <DL> |
| <DD>Set this header visible or not. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>isVisible</CODE> - If <code>isVisible</code> is true, the header of this document |
| is visible, otherwise is invisible.<DT><B>Since:</B></DT> |
| <DD>0.5.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addTable()"><!-- --></A><H3> |
| addTable</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A> <B>addTable</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable()">TableContainer</A></CODE></B></DD> |
| <DD>Add a new Table to this container. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable()">addTable</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>added table.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addTable(int, int)"><!-- --></A><H3> |
| addTable</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A> <B>addTable</B>(int numRows, |
| int numCols)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable(int, int)">TableContainer</A></CODE></B></DD> |
| <DD>Add a new Table to this container with a specified row number and column |
| number. |
| <p> |
| The table will be inserted at the end of the tableContainer. An unique |
| table name will be given, you may set a custom table name using the |
| <code>setTableName</code> method. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable(int, int)">addTable</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>numRows</CODE> - the row number<DD><CODE>numCols</CODE> - the column number |
| <DT><B>Returns:</B><DD>a new instance of <code>Table</code></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableByName(java.lang.String)"><!-- --></A><H3> |
| getTableByName</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A> <B>getTableByName</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> name)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableByName(java.lang.String)">TableContainer</A></CODE></B></DD> |
| <DD>Return an instance of table feature with the specific table name. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableByName(java.lang.String)">getTableByName</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - of the table being searched for. |
| <DT><B>Returns:</B><DD>an instance of table feature with the specific table name.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableList()"><!-- --></A><H3> |
| getTableList</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A>> <B>getTableList</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableList()">TableContainer</A></CODE></B></DD> |
| <DD>Return a list of table features in this document. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableList()">getTableList</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a list of table features in this document.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableBuilder()"><!-- --></A><H3> |
| getTableBuilder</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</A> <B>getTableBuilder</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableBuilder()">TableContainer</A></CODE></B></DD> |
| <DD>Return the table builder of this document. Every document has a table |
| builder, which supplies all of the table creation realization, for |
| example newTable(). |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableBuilder()">getTableBuilder</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the table builder of this document.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableContainerElement()"><!-- --></A><H3> |
| getTableContainerElement</H3> |
| <PRE> |
| public <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A> <B>getTableContainerElement</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableContainerElement()">TableContainer</A></CODE></B></DD> |
| <DD>Get the ODF element which can have |
| <table:table> |
| as child element directly according to ODF specification. This Element |
| will help to find the position to insert a new Table. For example, |
| <table:table> |
| element is usable with <office:text> element, so TextDocument will return |
| OfficeTextElement. While Presentation Notes is an indirectly |
| TableContainer, which holds Table with the help of its grand-child |
| element <draw:text-box>, so for Notes, DrawTextBoxElement should be |
| return. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableContainerElement()">getTableContainerElement</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>container element which can hold <text:table>.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVariableContainerElement()"><!-- --></A><H3> |
| getVariableContainerElement</H3> |
| <PRE> |
| public <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A> <B>getVariableContainerElement</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#getVariableContainerElement()">VariableContainer</A></CODE></B></DD> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#getVariableContainerElement()">getVariableContainerElement</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>container element which can hold variable declare section.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="declareVariable(java.lang.String, org.odftoolkit.simple.common.field.VariableField.VariableType)"><!-- --></A><H3> |
| declareVariable</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</A> <B>declareVariable</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> name, |
| <A HREF="../../../../org/odftoolkit/simple/common/field/VariableField.VariableType.html" title="enum in org.odftoolkit.simple.common.field">VariableField.VariableType</A> type)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#declareVariable(java.lang.String, org.odftoolkit.simple.common.field.VariableField.VariableType)">VariableContainer</A></CODE></B></DD> |
| <DD>Declare a new variable field to this container. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#declareVariable(java.lang.String, org.odftoolkit.simple.common.field.VariableField.VariableType)">declareVariable</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the unique name of this variable field.<DD><CODE>type</CODE> - the type of this variable field. |
| <DT><B>Returns:</B><DD>declared variable field.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVariableFieldByName(java.lang.String)"><!-- --></A><H3> |
| getVariableFieldByName</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</A> <B>getVariableFieldByName</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> name)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#getVariableFieldByName(java.lang.String)">VariableContainer</A></CODE></B></DD> |
| <DD>Return the declared variable by name. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#getVariableFieldByName(java.lang.String)">getVariableFieldByName</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the unique name of this variable field. |
| <DT><B>Returns:</B><DD>the declared variable.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="appendSection(java.lang.String)"><!-- --></A><H3> |
| appendSection</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</A> <B>appendSection</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> name)</PRE> |
| <DL> |
| <DD>Create an empty section and append it at the end of the footer. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - - specify the section name |
| <DT><B>Returns:</B><DD>an instance of the section |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</A></CODE> - if content DOM could not be initialized</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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Header.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/odftoolkit/simple/text/Footer.html" title="class in org.odftoolkit.simple.text"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/odftoolkit/simple/text/Header.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Header.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2010-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
