| <!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> |
| Cell (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="Cell (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/Cell.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/table/AbstractTableContainer.html" title="class in org.odftoolkit.simple.table"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/odftoolkit/simple/table/CellRange.html" title="class in org.odftoolkit.simple.table"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/odftoolkit/simple/table/Cell.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Cell.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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.table</FONT> |
| <BR> |
| Class Cell</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.table.Cell</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</A>, <A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</A>, <A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>Cell</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/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</A>, <A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</A>, <A HREF="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</A></DL> |
| </PRE> |
| |
| <P> |
| Cell represents table cell feature in ODF document. |
| <p> |
| Table provides methods to get/set/modify the cell content and cell |
| properties. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== 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/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#addList()">addList</A></B>()</CODE> |
| |
| <BR> |
| Add a new List 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/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">addList</A></B>(<A HREF="../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</A> decorator)</CODE> |
| |
| <BR> |
| Add a List with specified ListDecorator 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/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#addParagraph(java.lang.String)">addParagraph</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> text)</CODE> |
| |
| <BR> |
| Creates a new paragraph and append text</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/table/Cell.html#clearList()">clearList</A></B>()</CODE> |
| |
| <BR> |
| Remove all Lists from this container.</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/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getBooleanValue()">getBooleanValue</A></B>()</CODE> |
| |
| <BR> |
| Get the cell boolean value as Boolean object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getBorder(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType)">getBorder</A></B>(<A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</A> type)</CODE> |
| |
| <BR> |
| Return the border setting for a specific border.</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/awt/image/BufferedImage.html?is-external=true" title="class or interface in java.awt.image">BufferedImage</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getBufferedImage()">getBufferedImage</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I></I> </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/type/Color.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.type">Color</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getCellBackgroundColor()">getCellBackgroundColor</A></B>()</CODE> |
| |
| <BR> |
| Get the background color of this cell.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getCellBackgroundColorString()">getCellBackgroundColorString</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>getCellBackgroundColor()</code></I></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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getCellStyleName()">getCellStyleName</A></B>()</CODE> |
| |
| <BR> |
| Get the cell style name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getColumnIndex()">getColumnIndex</A></B>()</CODE> |
| |
| <BR> |
| Get the index of the table column which contains this cell.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getColumnSpannedNumber()">getColumnSpannedNumber</A></B>()</CODE> |
| |
| <BR> |
| Get the column spanned number of this cell.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getCurrencyCode()">getCurrencyCode</A></B>()</CODE> |
| |
| <BR> |
| Return the currency code of this cell, for example, "USD", "EUR", "CNY", |
| and etc.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getCurrencySymbol()">getCurrencySymbol</A></B>()</CODE> |
| |
| <BR> |
| Get the symbol of currency.</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/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getCurrencyValue()">getCurrencyValue</A></B>()</CODE> |
| |
| <BR> |
| Get the currency value of this cell as Double object.</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/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getDateTimeValue()">getDateTimeValue</A></B>()</CODE> |
| |
| <BR> |
| Get the cell date time value (date and time) as Calendar.</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/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getDateValue()">getDateValue</A></B>()</CODE> |
| |
| <BR> |
| Get the cell date value as Calendar.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getDisplayText()">getDisplayText</A></B>()</CODE> |
| |
| <BR> |
| Get the text displayed in this cell.</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/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getDoubleValue()">getDoubleValue</A></B>()</CODE> |
| |
| <BR> |
| Get the double value of this cell as Double object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getFont()">getFont</A></B>()</CODE> |
| |
| <BR> |
| Return the font definition for this cell.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getFormatString()">getFormatString</A></B>()</CODE> |
| |
| <BR> |
| Get the format string of the cell.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getFormula()">getFormula</A></B>()</CODE> |
| |
| <BR> |
| Get the formula string of the cell.</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/table/Cell.html#getFrameContainerElement()">getFrameContainerElement</A></B>()</CODE> |
| |
| <BR> |
| Get the ODF element which can have <draw:frame> 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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getHorizontalAlignment()">getHorizontalAlignment</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>getHorizontalAlignmentType()</code></I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getHorizontalAlignmentType()">getHorizontalAlignmentType</A></B>()</CODE> |
| |
| <BR> |
| Return the horizontal alignment setting of this cell.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getImage()">getImage</A></B>()</CODE> |
| |
| <BR> |
| Get the image from the specified cell.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getInstance(org.odftoolkit.odfdom.dom.element.table.TableTableCellElementBase)">getInstance</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/table/TableTableCellElementBase.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.table">TableTableCellElementBase</A> cellElement)</CODE> |
| |
| <BR> |
| Get the <code>Cell</code> instance from the |
| <code>TableTableCellElementBase</code> instance.</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/table/Cell.html#getListContainerElement()">getListContainerElement</A></B>()</CODE> |
| |
| <BR> |
| Get the ODF element which can have <text:list> 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/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getListIterator()">getListIterator</A></B>()</CODE> |
| |
| <BR> |
| Return an Iterator of the Lists in this ListContainer.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getNoteText()">getNoteText</A></B>()</CODE> |
| |
| <BR> |
| Get the note text of this table cell.</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/table/TableTableCellElementBase.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.table">TableTableCellElementBase</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getOdfElement()">getOdfElement</A></B>()</CODE> |
| |
| <BR> |
| Get the instance of <code>TableTableCellElementBase</code> which |
| represents this cell.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getOwnerTableCell()">getOwnerTableCell</A></B>()</CODE> |
| |
| <BR> |
| Get the cell that covers this cell.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getParagraphByIndex(int, boolean)">getParagraphByIndex</A></B>(int index, |
| boolean isEmptyParagraphSkipped)</CODE> |
| |
| <BR> |
| Return a paragraph with a given index.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getParagraphByReverseIndex(int, boolean)">getParagraphByReverseIndex</A></B>(int reverseIndex, |
| boolean isEmptyParagraphSkipped)</CODE> |
| |
| <BR> |
| Return a paragraph with a given index.</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/table/Cell.html#getParagraphContainerElement()">getParagraphContainerElement</A></B>()</CODE> |
| |
| <BR> |
| Get the ODF element which can have <text:p> as child element directly.</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/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getParagraphIterator()">getParagraphIterator</A></B>()</CODE> |
| |
| <BR> |
| Return an Iterator of the paragraph in this container.</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/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getPercentageValue()">getPercentageValue</A></B>()</CODE> |
| |
| <BR> |
| Get the cell percentage value as Double object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getRowIndex()">getRowIndex</A></B>()</CODE> |
| |
| <BR> |
| Get the index of the table row which contains this cell.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getRowSpannedNumber()">getRowSpannedNumber</A></B>()</CODE> |
| |
| <BR> |
| Get the row spanned number of this cell.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getStringValue()">getStringValue</A></B>()</CODE> |
| |
| <BR> |
| Get the cell value as a string.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/table/CellStyleHandler.html" title="class in org.odftoolkit.simple.table">CellStyleHandler</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getStyleHandler()">getStyleHandler</A></B>()</CODE> |
| |
| <BR> |
| Return style handler for this cell</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getStyleName()">getStyleName</A></B>()</CODE> |
| |
| <BR> |
| Get the style name of this cell.</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/table/Cell.html#getTable()">getTable</A></B>()</CODE> |
| |
| <BR> |
| Get an instance of table feature which contains this cell.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/table/Column.html" title="class in org.odftoolkit.simple.table">Column</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getTableColumn()">getTableColumn</A></B>()</CODE> |
| |
| <BR> |
| Get the instance of table column feature which contains this cell.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/table/Row.html" title="class in org.odftoolkit.simple.table">Row</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getTableRow()">getTableRow</A></B>()</CODE> |
| |
| <BR> |
| Get the instance of table row feature which contains this cell.</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/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getTimeValue()">getTimeValue</A></B>()</CODE> |
| |
| <BR> |
| Get the cell value as <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><CODE>java.util.Calendar</CODE></A>.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getValueType()">getValueType</A></B>()</CODE> |
| |
| <BR> |
| Get the value type of this cell.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getVerticalAlignment()">getVerticalAlignment</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>getVerticalAlignmentType()</code></I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalAlignmentType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getVerticalAlignmentType()">getVerticalAlignmentType</A></B>()</CODE> |
| |
| <BR> |
| Return the vertical alignment setting of this cell.</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/table/Cell.html#isTextWrapped()">isTextWrapped</A></B>()</CODE> |
| |
| <BR> |
| Return the wrap option of this cell.</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/table/Cell.html#removeContent()">removeContent</A></B>()</CODE> |
| |
| <BR> |
| Remove all the content of the cell.</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/table/Cell.html#removeList(org.odftoolkit.simple.text.list.List)">removeList</A></B>(<A HREF="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A> list)</CODE> |
| |
| <BR> |
| Remove the existing List from this container.</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/table/Cell.html#removeParagraph(org.odftoolkit.simple.text.Paragraph)">removeParagraph</A></B>(<A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</A> para)</CODE> |
| |
| <BR> |
| Remove paragraph from this document</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/table/Cell.html#removeTextContent()">removeTextContent</A></B>()</CODE> |
| |
| <BR> |
| Remove all the text content of cell.</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/table/Cell.html#setBooleanValue(java.lang.Boolean)">setBooleanValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> value)</CODE> |
| |
| <BR> |
| Set the cell value as a boolean and set the value type to be boolean.</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/table/Cell.html#setBorders(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType, org.odftoolkit.simple.style.Border)">setBorders</A></B>(<A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</A> bordersType, |
| <A HREF="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</A> border)</CODE> |
| |
| <BR> |
| Set the border style definitions for this cell.</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/table/Cell.html#setCellBackgroundColor(org.odftoolkit.odfdom.type.Color)">setCellBackgroundColor</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/type/Color.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.type">Color</A> cellBackgroundColor)</CODE> |
| |
| <BR> |
| Set the background color of this cell.</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/table/Cell.html#setCellBackgroundColor(java.lang.String)">setCellBackgroundColor</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> cellBackgroundColor)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>setCellBackgroundColor(Color)</code></I></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/table/Cell.html#setCellStyleName(java.lang.String)">setCellStyleName</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> styleName)</CODE> |
| |
| <BR> |
| Set the cell style name.</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/table/Cell.html#setCurrencyCode(java.lang.String)">setCurrencyCode</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> currency)</CODE> |
| |
| <BR> |
| Set the currency code of this cell, for example, "USD", "EUR", "CNY", and |
| etc.</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/table/Cell.html#setCurrencyFormat(java.lang.String, java.lang.String)">setCurrencyFormat</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> currencySymbol, |
| <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> format)</CODE> |
| |
| <BR> |
| Set the currency symbol and overall format of a currency cell.</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/table/Cell.html#setCurrencyValue(java.lang.Double, java.lang.String)">setCurrencyValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> value, |
| <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> currency)</CODE> |
| |
| <BR> |
| Set the value and currency of the cell, and set the value type as |
| "currency".</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/table/Cell.html#setDateTimeValue(java.util.Calendar)">setDateTimeValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A> date)</CODE> |
| |
| <BR> |
| Sets the cell value as a date with second precision and the value type to be "date".</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/table/Cell.html#setDateValue(java.util.Calendar)">setDateValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A> date)</CODE> |
| |
| <BR> |
| Set the cell value as a date, and set the value type to be "date".</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/table/Cell.html#setDisplayText(java.lang.String)">setDisplayText</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> content)</CODE> |
| |
| <BR> |
| Set the text displayed in this cell.</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/table/Cell.html#setDisplayText(java.lang.String, org.odftoolkit.simple.table.CellValueAdapter)">setDisplayText</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> content, |
| <A HREF="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table">CellValueAdapter</A> adapter)</CODE> |
| |
| <BR> |
| Set the text displayed in this cell.</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/table/Cell.html#setDisplayText(java.lang.String, org.odftoolkit.simple.table.CellValueAdapter, java.lang.String)">setDisplayText</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> content, |
| <A HREF="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table">CellValueAdapter</A> adapter, |
| <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> stylename)</CODE> |
| |
| <BR> |
| Set the text displayed in this cell, with a specified style name.</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/table/Cell.html#setDisplayText(java.lang.String, java.lang.String)">setDisplayText</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> content, |
| <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> stylename)</CODE> |
| |
| <BR> |
| Set the text displayed in this cell, with a specified style name.</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/table/Cell.html#setDoubleValue(java.lang.Double)">setDoubleValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> value)</CODE> |
| |
| <BR> |
| Set the cell value as a double and set the value type to be "float".</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/table/Cell.html#setFont(org.odftoolkit.simple.style.Font)">setFont</A></B>(<A HREF="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</A> font)</CODE> |
| |
| <BR> |
| Set font style for this cell.</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/table/Cell.html#setFormatString(java.lang.String)">setFormatString</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> formatStr)</CODE> |
| |
| <BR> |
| Set the format string of the cell.</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/table/Cell.html#setFormula(java.lang.String)">setFormula</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> formula)</CODE> |
| |
| <BR> |
| Set a formula to the cell.</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/table/Cell.html#setHorizontalAlignment(java.lang.String)">setHorizontalAlignment</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> horizontalAlignment)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>setHorizontalAlignment(SimpleHorizontalAlignmentType)</code></I></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/table/Cell.html#setHorizontalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalAlignmentType)">setHorizontalAlignment</A></B>(<A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</A> alignType)</CODE> |
| |
| <BR> |
| Set the horizontal alignment setting of this cell.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#setImage(java.net.URI)">setImage</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> imageUri)</CODE> |
| |
| <BR> |
| Insert an Image from the specified uri to cell.</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/table/Cell.html#setInputErrorMessage(java.lang.String, java.lang.String, java.lang.String)">setInputErrorMessage</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> title, |
| <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> text, |
| <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> messageType)</CODE> |
| |
| <BR> |
| Sets the title and text of the message box which will |
| be displayed if if invalid input is entered into the cell.</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/table/Cell.html#setInputHelpMessage(java.lang.String, java.lang.String)">setInputHelpMessage</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> title, |
| <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> text)</CODE> |
| |
| <BR> |
| Sets the title and the text of the tip, which will then be displayed if |
| the cell is selected.</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/table/Cell.html#setNoteText(java.lang.String)">setNoteText</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> note)</CODE> |
| |
| <BR> |
| Set note text for this table cell.</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/table/Cell.html#setPercentageValue(java.lang.Double)">setPercentageValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> value)</CODE> |
| |
| <BR> |
| Set the cell value as a percentage value and set the value type as |
| percentage too.</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/table/Cell.html#setStringValue(java.lang.String)">setStringValue</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> str)</CODE> |
| |
| <BR> |
| Set the cell value as a string, and set the value type to be string.</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/table/Cell.html#setTextWrapped(boolean)">setTextWrapped</A></B>(boolean isTextWrapped)</CODE> |
| |
| <BR> |
| Set the wrap option of this cell.</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/table/Cell.html#setTimeValue(java.util.Calendar)">setTimeValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A> time)</CODE> |
| |
| <BR> |
| Set the cell value as a time and set the value type to be "time" too.</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/table/Cell.html#setValidityList(java.util.List)">setValidityList</A></B>(<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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> values)</CODE> |
| |
| <BR> |
| Specifies the allowed values of this cell in a list.</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/table/Cell.html#setValueType(java.lang.String)">setValueType</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> type)</CODE> |
| |
| <BR> |
| Set the value type of this cell.</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/table/Cell.html#setVerticalAlignment(java.lang.String)">setVerticalAlignment</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> verticalAlignment)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>setVerticalAlignment(SimpleVerticalAlignmentType)</code></I></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/table/Cell.html#setVerticalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.VerticalAlignmentType)">setVerticalAlignment</A></B>(<A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalAlignmentType</A> verticalAlignment)</CODE> |
| |
| <BR> |
| Set the vertical alignment setting of this cell.</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> |
| |
| <!-- ============ 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="getInstance(org.odftoolkit.odfdom.dom.element.table.TableTableCellElementBase)"><!-- --></A><H3> |
| getInstance</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</A> <B>getInstance</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/table/TableTableCellElementBase.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.table">TableTableCellElementBase</A> cellElement)</PRE> |
| <DL> |
| <DD>Get the <code>Cell</code> instance from the |
| <code>TableTableCellElementBase</code> instance. |
| <p> |
| Each <code>TableTableCellElementBase</code> instance has a one-to-one |
| relationship to the a <code>Cell</code> instance. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>cellElement</CODE> - the cell element that need to get the corresponding |
| <code>Cell</code> instance |
| <DT><B>Returns:</B><DD>the <code>Cell</code> instance that represents a specified cell |
| element</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHorizontalAlignment()"><!-- --></A><H3> |
| getHorizontalAlignment</H3> |
| <PRE> |
| <FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> |
| </FONT>public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getHorizontalAlignment</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>getHorizontalAlignmentType()</code></I> |
| <P> |
| <DD>Return the horizontal alignment setting of this cell. |
| <p> |
| The returned value can be "center", "end", "justify", "left", "right", or |
| "start". If no horizontal alignment is set, null will be returned. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the horizontal alignment setting.<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getHorizontalAlignmentType()"><CODE>getHorizontalAlignmentType()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHorizontalAlignmentType()"><!-- --></A><H3> |
| getHorizontalAlignmentType</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</A> <B>getHorizontalAlignmentType</B>()</PRE> |
| <DL> |
| <DD>Return the horizontal alignment setting of this cell. |
| <p> |
| Null will returned if there is no explicit style definition for this |
| cell. |
| <p> |
| Default value will be returned if explicit style definition is found but |
| no horizontal alignment is set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the horizontal alignment setting.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setHorizontalAlignment(java.lang.String)"><!-- --></A><H3> |
| setHorizontalAlignment</H3> |
| <PRE> |
| <FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> |
| </FONT>public void <B>setHorizontalAlignment</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> horizontalAlignment)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>setHorizontalAlignment(SimpleHorizontalAlignmentType)</code></I> |
| <P> |
| <DD>Set the horizontal alignment setting of this cell. |
| <p> |
| The parameter can be "center", "end", "justify", "left", "right", or |
| "start". Actually, "left" will be interpreted as "start", while "right" |
| will be interpreted as "end". If argument is null, the explicit |
| horizontal alignment setting is removed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>horizontalAlignment</CODE> - the horizontal alignment setting.<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#setHorizontalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalAlignmentType)"><CODE>setHorizontalAlignment(StyleTypeDefinitions.HorizontalAlignmentType)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setHorizontalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalAlignmentType)"><!-- --></A><H3> |
| setHorizontalAlignment</H3> |
| <PRE> |
| public void <B>setHorizontalAlignment</B>(<A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</A> alignType)</PRE> |
| <DL> |
| <DD>Set the horizontal alignment setting of this cell. If the alignment is |
| set as Default, the explicit horizontal alignment setting is removed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>alignType</CODE> - the horizontal alignment setting.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVerticalAlignment()"><!-- --></A><H3> |
| getVerticalAlignment</H3> |
| <PRE> |
| <FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> |
| </FONT>public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getVerticalAlignment</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>getVerticalAlignmentType()</code></I> |
| <P> |
| <DD>Return the vertical alignment setting of this cell. |
| <p> |
| The returned value can be "auto", "automatic", "baseline", "bottom", |
| "middle", or "top". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the vertical alignment setting of this cell.<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getVerticalAlignmentType()"><CODE>getVerticalAlignmentType()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVerticalAlignmentType()"><!-- --></A><H3> |
| getVerticalAlignmentType</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalAlignmentType</A> <B>getVerticalAlignmentType</B>()</PRE> |
| <DL> |
| <DD>Return the vertical alignment setting of this cell. |
| <p> |
| Null will returned if there is no explicit style definition for this |
| cell. |
| <p> |
| Default value will be returned if explicit style definition is found but |
| no vertical alignment is set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the vertical alignment setting.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVerticalAlignment(java.lang.String)"><!-- --></A><H3> |
| setVerticalAlignment</H3> |
| <PRE> |
| <FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> |
| </FONT>public void <B>setVerticalAlignment</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> verticalAlignment)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>setVerticalAlignment(SimpleVerticalAlignmentType)</code></I> |
| <P> |
| <DD>Set the vertical alignment setting of this cell. |
| <p> |
| The parameter can be "auto", "automatic", "baseline", "bottom", "middle", |
| or "top". If argument is null, the explicit vertical alignment setting is |
| removed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>verticalAlignment</CODE> - the vertical alignment setting.<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#setVerticalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.VerticalAlignmentType)"><CODE>setVerticalAlignment(StyleTypeDefinitions.VerticalAlignmentType)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVerticalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.VerticalAlignmentType)"><!-- --></A><H3> |
| setVerticalAlignment</H3> |
| <PRE> |
| public void <B>setVerticalAlignment</B>(<A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalAlignmentType</A> verticalAlignment)</PRE> |
| <DL> |
| <DD>Set the vertical alignment setting of this cell. |
| <p> |
| If the alignment is set as Default or null, the explicit vertical |
| alignment setting is removed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>verticalAlignment</CODE> - the vertical alignment setting.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isTextWrapped()"><!-- --></A><H3> |
| isTextWrapped</H3> |
| <PRE> |
| public boolean <B>isTextWrapped</B>()</PRE> |
| <DL> |
| <DD>Return the wrap option of this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if the cell content can be wrapped; |
| <p> |
| false if the cell content cannot be wrapped.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTextWrapped(boolean)"><!-- --></A><H3> |
| setTextWrapped</H3> |
| <PRE> |
| public void <B>setTextWrapped</B>(boolean isTextWrapped)</PRE> |
| <DL> |
| <DD>Set the wrap option of this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>isTextWrapped</CODE> - whether the cell content can be wrapped or not</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRowIndex()"><!-- --></A><H3> |
| getRowIndex</H3> |
| <PRE> |
| public int <B>getRowIndex</B>()</PRE> |
| <DL> |
| <DD>Get the index of the table row which contains this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the index of the row containing this cell</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTable()"><!-- --></A><H3> |
| getTable</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A> <B>getTable</B>()</PRE> |
| <DL> |
| <DD>Get an instance of table feature which contains this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the table containing this cell</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getColumnIndex()"><!-- --></A><H3> |
| getColumnIndex</H3> |
| <PRE> |
| public int <B>getColumnIndex</B>()</PRE> |
| <DL> |
| <DD>Get the index of the table column which contains this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the index of the column containing this cell</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableColumn()"><!-- --></A><H3> |
| getTableColumn</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/table/Column.html" title="class in org.odftoolkit.simple.table">Column</A> <B>getTableColumn</B>()</PRE> |
| <DL> |
| <DD>Get the instance of table column feature which contains this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the instance of table column feature which contains the cell.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableRow()"><!-- --></A><H3> |
| getTableRow</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/table/Row.html" title="class in org.odftoolkit.simple.table">Row</A> <B>getTableRow</B>()</PRE> |
| <DL> |
| <DD>Get the instance of table row feature which contains this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the instance of table row feature which contains the cell.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOwnerTableCell()"><!-- --></A><H3> |
| getOwnerTableCell</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</A> <B>getOwnerTableCell</B>()</PRE> |
| <DL> |
| <DD>Get the cell that covers this cell. |
| <p> |
| If the cell is a covered cell, the owner cell will be returned; if the |
| cell is a real cell , the cell itself will be returned. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the cell that covers the current cell</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <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/table/TableTableCellElementBase.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.table">TableTableCellElementBase</A> <B>getOdfElement</B>()</PRE> |
| <DL> |
| <DD>Get the instance of <code>TableTableCellElementBase</code> which |
| represents this cell. |
| <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>the instance of <code>TableTableCellElementBase</code></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCurrencyCode()"><!-- --></A><H3> |
| getCurrencyCode</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getCurrencyCode</B>()</PRE> |
| <DL> |
| <DD>Return the currency code of this cell, for example, "USD", "EUR", "CNY", |
| and etc. |
| <p> |
| If the value type is not "currency", an IllegalArgumentException will be |
| thrown. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the currency code |
| <p> |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - an IllegalArgumentException will be thrown if the value type |
| is not "currency".</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCurrencyCode(java.lang.String)"><!-- --></A><H3> |
| setCurrencyCode</H3> |
| <PRE> |
| public void <B>setCurrencyCode</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> currency)</PRE> |
| <DL> |
| <DD>Set the currency code of this cell, for example, "USD", "EUR", "CNY", and |
| etc. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>currency</CODE> - the currency code that need to be set. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - If input <code>currency</code> is null, an |
| IllegalArgumentException will be thrown.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setValueType(java.lang.String)"><!-- --></A><H3> |
| setValueType</H3> |
| <PRE> |
| public void <B>setValueType</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> type)</PRE> |
| <DL> |
| <DD>Set the value type of this cell. The parameter can be "boolean", |
| "currency", "date", "float", "percentage", "string" or "time". |
| <p> |
| If the parameter <code>type</code> is not a valid cell type, an |
| IllegalArgumentException will be thrown. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>type</CODE> - the type that need to be set If input type is null, an |
| IllegalArgumentException will be thrown.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValueType()"><!-- --></A><H3> |
| getValueType</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getValueType</B>()</PRE> |
| <DL> |
| <DD>Get the value type of this cell. The returned value can be "boolean", |
| "currency", "date", "float", "percentage", "string" or "time". If no |
| value type is set, null will be returned. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the type of the cell</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDoubleValue()"><!-- --></A><H3> |
| getDoubleValue</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> <B>getDoubleValue</B>()</PRE> |
| <DL> |
| <DD>Get the double value of this cell as Double object. |
| <p> |
| Throw IllegalArgumentException if the cell type is not "float". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the double value of this cell as a Double object. If the cell |
| value is empty, null will be returned. |
| <p> |
| An IllegalArgumentException will be thrown if the cell type is |
| not "float".</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCurrencyValue()"><!-- --></A><H3> |
| getCurrencyValue</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> <B>getCurrencyValue</B>()</PRE> |
| <DL> |
| <DD>Get the currency value of this cell as Double object. |
| <p> |
| Throw IllegalArgumentException if the cell type is not "currency". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the currency value of this cell as a Double object. If the cell |
| value is empty, null will be returned. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - an IllegalArgumentException will be thrown if the cell type |
| is not "currency".</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCurrencySymbol()"><!-- --></A><H3> |
| getCurrencySymbol</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getCurrencySymbol</B>()</PRE> |
| <DL> |
| <DD>Get the symbol of currency. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the currency symbol |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - an IllegalArgumentException will be thrown if the value type |
| is not "currency".</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCurrencyValue(java.lang.Double, java.lang.String)"><!-- --></A><H3> |
| setCurrencyValue</H3> |
| <PRE> |
| public void <B>setCurrencyValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> value, |
| <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> currency)</PRE> |
| <DL> |
| <DD>Set the value and currency of the cell, and set the value type as |
| "currency". If |
| <code>value</value> is null, the cell value will be removed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value that will be set<DD><CODE>currency</CODE> - the currency that will be set. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - If input currency is null, an IllegalArgumentException will |
| be thrown.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPercentageValue()"><!-- --></A><H3> |
| getPercentageValue</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> <B>getPercentageValue</B>()</PRE> |
| <DL> |
| <DD>Get the cell percentage value as Double object. |
| <p> |
| Throw IllegalArgumentException if the cell type is not "percentage". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the percentage value of this cell as a Double object. If the cell |
| value is empty, null will be returned. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - an IllegalArgumentException will be thrown if the cell type |
| is not "percentage".</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPercentageValue(java.lang.Double)"><!-- --></A><H3> |
| setPercentageValue</H3> |
| <PRE> |
| public void <B>setPercentageValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> value)</PRE> |
| <DL> |
| <DD>Set the cell value as a percentage value and set the value type as |
| percentage too. If |
| <code>value</value> is null, the cell value will be removed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value that will be set</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDisplayText()"><!-- --></A><H3> |
| getDisplayText</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDisplayText</B>()</PRE> |
| <DL> |
| <DD>Get the text displayed in this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the text displayed in this cell</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDisplayText(java.lang.String, org.odftoolkit.simple.table.CellValueAdapter)"><!-- --></A><H3> |
| setDisplayText</H3> |
| <PRE> |
| public void <B>setDisplayText</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> content, |
| <A HREF="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table">CellValueAdapter</A> adapter)</PRE> |
| <DL> |
| <DD>Set the text displayed in this cell. If content is null, it will display |
| the empty string instead. |
| <p> |
| Please note the displayed text in ODF viewer might be different with the |
| value set by this method, because the displayed text in ODF viewer is |
| calculated and set by editor. So an adapter can be assigned to adapt cell |
| value and value type. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>content</CODE> - the displayed text.<DD><CODE>adapter</CODE> - the <code>CellValueAdapter</code> used to adapt cell value and |
| value type.<DT><B>Since:</B></DT> |
| <DD>0.3</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table"><CODE>CellValueAdapter</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDisplayText(java.lang.String)"><!-- --></A><H3> |
| setDisplayText</H3> |
| <PRE> |
| public void <B>setDisplayText</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> content)</PRE> |
| <DL> |
| <DD>Set the text displayed in this cell. If content is null, it will display |
| the empty string instead. |
| <p> |
| Please note the displayed text in ODF viewer might be different with the |
| value set by this method, because the displayed text in ODF viewer is |
| calculated and set by editor. The cell value and value type will be |
| updated follow by the rules which are designed in the |
| <A HREF="../../../../org/odftoolkit/simple/table/DefaultCellValueAdapter.html" title="class in org.odftoolkit.simple.table"><CODE><code>DefaultCellValueAdapter</code></CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>content</CODE> - the displayed text.<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table"><CODE>CellValueAdapter</CODE></A>, |
| <A HREF="../../../../org/odftoolkit/simple/table/DefaultCellValueAdapter.html" title="class in org.odftoolkit.simple.table"><CODE>DefaultCellValueAdapter</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDisplayText(java.lang.String, org.odftoolkit.simple.table.CellValueAdapter, java.lang.String)"><!-- --></A><H3> |
| setDisplayText</H3> |
| <PRE> |
| public void <B>setDisplayText</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> content, |
| <A HREF="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table">CellValueAdapter</A> adapter, |
| <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> stylename)</PRE> |
| <DL> |
| <DD>Set the text displayed in this cell, with a specified style name. |
| <p> |
| Please note the displayed text in ODF viewer might be different with the |
| value set by this method, because the displayed text in ODF viewer is |
| calculated and set by editor. So an adapter can be assigned to adapt cell |
| value and value type. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>content</CODE> - the displayed text. If content is null, it will display the |
| empty string instead.<DD><CODE>adapter</CODE> - the <code>CellValueAdapter</code> used to adapt cell value and |
| value type.<DD><CODE>stylename</CODE> - the style name. If style name is null, the content will use |
| the default paragraph style.<DT><B>Since:</B></DT> |
| <DD>0.3</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table"><CODE>CellValueAdapter</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDisplayText(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| setDisplayText</H3> |
| <PRE> |
| public void <B>setDisplayText</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> content, |
| <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> stylename)</PRE> |
| <DL> |
| <DD>Set the text displayed in this cell, with a specified style name. |
| <p> |
| Please note the displayed text in ODF viewer might be different with the |
| value set by this method, because the displayed text in ODF viewer is |
| calculated and set by editor. The cell value and value type will be |
| updated follow by the rules which are designed in the |
| <A HREF="../../../../org/odftoolkit/simple/table/DefaultCellValueAdapter.html" title="class in org.odftoolkit.simple.table"><CODE><code>DefaultCellValueAdapter</code></CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>content</CODE> - the displayed text. If content is null, it will display the |
| empty string instead.<DD><CODE>stylename</CODE> - the style name. If style name is null, the content will use |
| the default paragraph style.<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table"><CODE>CellValueAdapter</CODE></A>, |
| <A HREF="../../../../org/odftoolkit/simple/table/DefaultCellValueAdapter.html" title="class in org.odftoolkit.simple.table"><CODE>DefaultCellValueAdapter</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDoubleValue(java.lang.Double)"><!-- --></A><H3> |
| setDoubleValue</H3> |
| <PRE> |
| public void <B>setDoubleValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> value)</PRE> |
| <DL> |
| <DD>Set the cell value as a double and set the value type to be "float". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the double value that will be set. If |
| <code>value</value> is null, the cell value will be removed.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBooleanValue()"><!-- --></A><H3> |
| getBooleanValue</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> <B>getBooleanValue</B>()</PRE> |
| <DL> |
| <DD>Get the cell boolean value as Boolean object. |
| <p> |
| Throw IllegalArgumentException if the cell type is not "boolean". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the Boolean value of cell. If the cell value is empty, null will |
| be returned. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - an IllegalArgumentException will be thrown if the cell type |
| is not "boolean".</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setBooleanValue(java.lang.Boolean)"><!-- --></A><H3> |
| setBooleanValue</H3> |
| <PRE> |
| public void <B>setBooleanValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> value)</PRE> |
| <DL> |
| <DD>Set the cell value as a boolean and set the value type to be boolean. If |
| <code>value</value> is null, the cell value will be removed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value of boolean type</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDateValue()"><!-- --></A><H3> |
| getDateValue</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A> <B>getDateValue</B>()</PRE> |
| <DL> |
| <DD>Get the cell date value as Calendar. |
| <p> |
| Throw IllegalArgumentException if the cell type is not "date". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the Calendar value of cell |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - an IllegalArgumentException will be thrown, if the cell type |
| is not "date".</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDateTimeValue()"><!-- --></A><H3> |
| getDateTimeValue</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A> <B>getDateTimeValue</B>()</PRE> |
| <DL> |
| <DD>Get the cell date time value (date and time) as Calendar. |
| <p> |
| Throw IllegalArgumentException if the cell type is not "date". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the Calendar value of cell |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - an IllegalArgumentException will be thrown, if the cell type |
| is not "date".</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDateValue(java.util.Calendar)"><!-- --></A><H3> |
| setDateValue</H3> |
| <PRE> |
| public void <B>setDateValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A> date)</PRE> |
| <DL> |
| <DD>Set the cell value as a date, and set the value type to be "date". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>date</CODE> - the value of <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><CODE>java.util.Calendar</CODE></A> |
| type.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDateTimeValue(java.util.Calendar)"><!-- --></A><H3> |
| setDateTimeValue</H3> |
| <PRE> |
| public void <B>setDateTimeValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A> date)</PRE> |
| <DL> |
| <DD>Sets the cell value as a date with second precision and the value type to be "date". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>date</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCellStyleName(java.lang.String)"><!-- --></A><H3> |
| setCellStyleName</H3> |
| <PRE> |
| public void <B>setCellStyleName</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> styleName)</PRE> |
| <DL> |
| <DD>Set the cell style name. When lots of cells have the same style features, |
| the user can configuration the first one and set the other's style name |
| directly. That will improve the performance. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>styleName</CODE> - an exit cell style name.<DT><B>Since:</B></DT> |
| <DD>0.4</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCellStyleName()"><!-- --></A><H3> |
| getCellStyleName</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getCellStyleName</B>()</PRE> |
| <DL> |
| <DD>Get the cell style name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>cell style name.<DT><B>Since:</B></DT> |
| <DD>0.4</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setStringValue(java.lang.String)"><!-- --></A><H3> |
| setStringValue</H3> |
| <PRE> |
| public void <B>setStringValue</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> str)</PRE> |
| <DL> |
| <DD>Set the cell value as a string, and set the value type to be string. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>str</CODE> - the value of string type. If input string is null, an empty |
| string will be set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getStringValue()"><!-- --></A><H3> |
| getStringValue</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getStringValue</B>()</PRE> |
| <DL> |
| <DD>Get the cell value as a string. |
| <p> |
| If the cell type is not string, the display text will be returned. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the string value of this cell, or the display text</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTimeValue()"><!-- --></A><H3> |
| getTimeValue</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A> <B>getTimeValue</B>()</PRE> |
| <DL> |
| <DD>Get the cell value as <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><CODE>java.util.Calendar</CODE></A>. |
| <p> |
| Throw exception if the cell type is not "time". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the Calendar value of cell |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - an IllegalArgumentException will be thrown if the cell type |
| is not time.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTimeValue(java.util.Calendar)"><!-- --></A><H3> |
| setTimeValue</H3> |
| <PRE> |
| public void <B>setTimeValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</A> time)</PRE> |
| <DL> |
| <DD>Set the cell value as a time and set the value type to be "time" too. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>time</CODE> - the value of <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><CODE>java.util.Calendar</CODE></A> |
| type. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - If input time is null, an IllegalArgumentException exception |
| will be thrown.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCellBackgroundColor()"><!-- --></A><H3> |
| getCellBackgroundColor</H3> |
| <PRE> |
| public <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/type/Color.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.type">Color</A> <B>getCellBackgroundColor</B>()</PRE> |
| <DL> |
| <DD>Get the background color of this cell. |
| <p> |
| If no background color is set, default background color "#FFFFFF" will be |
| returned. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the background color of this cell</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCellBackgroundColorString()"><!-- --></A><H3> |
| getCellBackgroundColorString</H3> |
| <PRE> |
| <FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> |
| </FONT>public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getCellBackgroundColorString</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>getCellBackgroundColor()</code></I> |
| <P> |
| <DD>Get the background color string of this cell. |
| <p> |
| If no background color is set, default background color "#FFFFFF" will be |
| returned. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the background color of this cell<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#getCellBackgroundColor()"><CODE>getCellBackgroundColor()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCellBackgroundColor(org.odftoolkit.odfdom.type.Color)"><!-- --></A><H3> |
| setCellBackgroundColor</H3> |
| <PRE> |
| public void <B>setCellBackgroundColor</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/type/Color.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.type">Color</A> cellBackgroundColor)</PRE> |
| <DL> |
| <DD>Set the background color of this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>cellBackgroundColor</CODE> - the background color that need to set. If |
| <code>cellBackgroundColor</code> is null, default background |
| color <code>Color.WHITE</code> will be set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCellBackgroundColor(java.lang.String)"><!-- --></A><H3> |
| setCellBackgroundColor</H3> |
| <PRE> |
| <FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> |
| </FONT>public void <B>setCellBackgroundColor</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> cellBackgroundColor)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>As of Simple version 0.3, replaced by |
| <code>setCellBackgroundColor(Color)</code></I> |
| <P> |
| <DD>Set the background color of this cell using string. The string must be a |
| valid argument for constructing <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/type/Color.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.type"><CODE><code>org.odftoolkit.odfdom.type.Color</code></CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>cellBackgroundColor</CODE> - the background color that need to set. If cellBackgroundColor |
| is null, default background color #FFFFFF will be set.<DT><B>See Also:</B><DD><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/type/Color.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.type"><CODE>Color</CODE></A>, |
| <A HREF="../../../../org/odftoolkit/simple/table/Cell.html#setCellBackgroundColor(org.odftoolkit.odfdom.type.Color)"><CODE>setCellBackgroundColor(Color)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getColumnSpannedNumber()"><!-- --></A><H3> |
| getColumnSpannedNumber</H3> |
| <PRE> |
| public int <B>getColumnSpannedNumber</B>()</PRE> |
| <DL> |
| <DD>Get the column spanned number of this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the column spanned number</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRowSpannedNumber()"><!-- --></A><H3> |
| getRowSpannedNumber</H3> |
| <PRE> |
| public int <B>getRowSpannedNumber</B>()</PRE> |
| <DL> |
| <DD>Get the row spanned number of this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the row spanned number</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getStyleName()"><!-- --></A><H3> |
| getStyleName</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getStyleName</B>()</PRE> |
| <DL> |
| <DD>Get the style name of this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the name of the style</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFormula(java.lang.String)"><!-- --></A><H3> |
| setFormula</H3> |
| <PRE> |
| public void <B>setFormula</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> formula)</PRE> |
| <DL> |
| <DD>Set a formula to the cell. |
| <p> |
| Please note, the parameter <code>formula</code> will not be checked and |
| interpreted; the cell value will not be calculated. It's just simply set |
| as a formula attribute. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>formula</CODE> - the formula that need to be set. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if formula is null, an IllegalArgumentException will be |
| thrown.<DT><B>See Also:</B><DD><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/attribute/table/TableFormulaAttribute.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.attribute.table"><CODE>TableFormulaAttribute</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFormula()"><!-- --></A><H3> |
| getFormula</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getFormula</B>()</PRE> |
| <DL> |
| <DD>Get the formula string of the cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the formula representation of the cell |
| <p> |
| If the cell does not contain a formula, null will be returned.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCurrencyFormat(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| setCurrencyFormat</H3> |
| <PRE> |
| public void <B>setCurrencyFormat</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> currencySymbol, |
| <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> format)</PRE> |
| <DL> |
| <DD>Set the currency symbol and overall format of a currency cell. |
| <p> |
| Please note the overall format includes the symbol character, for |
| example: $#,##0.00. |
| <p> |
| This function only works for currency. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>currencySymbol</CODE> - the currency symbol<DD><CODE>format</CODE> - overall format |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if input currencySymbol or format is null, an |
| IllegalArgumentException will be thrown.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFormatString(java.lang.String)"><!-- --></A><H3> |
| setFormatString</H3> |
| <PRE> |
| public void <B>setFormatString</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> formatStr)</PRE> |
| <DL> |
| <DD>Set the format string of the cell. |
| <p> |
| This function only works for float, date, time and percentage, otherwise an |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalArgumentException</CODE></A> will be thrown. |
| <p> |
| For value type float and percentage, the <code>formatStr</code> must follow the encoding |
| rule of <A HREF="http://download.oracle.com/javase/6/docs/api/java/text/DecimalFormat.html?is-external=true" title="class or interface in java.text"><CODE><code>java.text.DecimalFormat</code></CODE></A>. |
| For value type date and time, the <code>formatStr</code> must follow the encoding |
| rule of <A HREF="http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><CODE><code>java.text.SimpleDateFormat</code></CODE></A>. |
| <p> |
| Refer to <A HREF="../../../../org/odftoolkit/simple/table/Cell.html#setCurrencyFormat(java.lang.String, java.lang.String)"><CODE><code>setCurrencyFormat</code></CODE></A> to set the format of currency. |
| <p> |
| If the cell value type is not set, the method will try to give it a value type, according |
| to common ordination. The adapt order is: percentage-> time-> date-> float. |
| <blockquote> |
| <table border=0 cellspacing=3 cellpadding=0 summary="Chart showing ValueType, Distinguish Symbol |
| and Distinguish Priority."> |
| <tr bgcolor="#ccccff"> |
| <th align=left>ValueType |
| <th align=left>Distinguish Symbol |
| <th align=left>Distinguish Priority |
| <tr valign=top> |
| <td>percentage |
| <td>% |
| <td>1 |
| <tr valign=top> |
| <td>time |
| <td>H, k, m, s, S |
| <td>2 |
| <tr valign=top> |
| <td>date |
| <td>y, M, w, W, D, d, F, E, K, h |
| <td>3 |
| <tr valign=top> |
| <td>float |
| <td>#, 0 |
| <td>4 |
| </table> |
| </blockquote> |
| The adapt result may be inaccurate, so you'd better set value type before call this method. |
| If adaptive failed, an <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><CODE>UnsupportedOperationException</CODE></A> will be thrown. |
| <p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>formatStr</CODE> - the cell need be formatted as this specified format string. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>formatStr</code> is null or the cell value type is supported. |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the adaptive failed, when cell value type is not set.<DT><B>See Also:</B><DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><CODE>SimpleDateFormat</CODE></A>, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/text/DecimalFormat.html?is-external=true" title="class or interface in java.text"><CODE>DecimalFormat</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFormatString()"><!-- --></A><H3> |
| getFormatString</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getFormatString</B>()</PRE> |
| <DL> |
| <DD>Get the format string of the cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the format string of the cell</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeTextContent()"><!-- --></A><H3> |
| removeTextContent</H3> |
| <PRE> |
| public void <B>removeTextContent</B>()</PRE> |
| <DL> |
| <DD>Remove all the text content of cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeContent()"><!-- --></A><H3> |
| removeContent</H3> |
| <PRE> |
| public void <B>removeContent</B>()</PRE> |
| <DL> |
| <DD>Remove all the content of the cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFont()"><!-- --></A><H3> |
| getFont</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</A> <B>getFont</B>()</PRE> |
| <DL> |
| <DD>Return the font definition for this cell. |
| <p> |
| Null will be returned if there is no explicit style definition, or even |
| default style definition, for this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the font definition null if there is no style definition for this |
| cell<DT><B>Since:</B></DT> |
| <DD>0.3</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFont(org.odftoolkit.simple.style.Font)"><!-- --></A><H3> |
| setFont</H3> |
| <PRE> |
| public void <B>setFont</B>(<A HREF="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</A> font)</PRE> |
| <DL> |
| <DD>Set font style for this cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>font</CODE> - - the font<DT><B>Since:</B></DT> |
| <DD>0.3</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setBorders(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType, org.odftoolkit.simple.style.Border)"><!-- --></A><H3> |
| setBorders</H3> |
| <PRE> |
| public void <B>setBorders</B>(<A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</A> bordersType, |
| <A HREF="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</A> border)</PRE> |
| <DL> |
| <DD>Set the border style definitions for this cell. |
| <p> |
| This method will invoke |
| <code>CellStyleHandler.setBorders(Border border, SimpleCellBordersType bordersType).</code> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bordersType</CODE> - - A predefined border type<DD><CODE>border</CODE> - - border style description<DT><B>Since:</B></DT> |
| <DD>0.3</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/CellStyleHandler.html#setBorders(org.odftoolkit.simple.style.Border, org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType)"><CODE>CellStyleHandler.setBorders(Border border, |
| StyleTypeDefinitions.CellBordersType bordersType)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBorder(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType)"><!-- --></A><H3> |
| getBorder</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</A> <B>getBorder</B>(<A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</A> type)</PRE> |
| <DL> |
| <DD>Return the border setting for a specific border. |
| <p> |
| This method will invoke |
| <code>CellStyleHandler.getBorder(SimpleCellBordersType type).</code> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>type</CODE> - - the border type which describes a single border |
| <DT><B>Returns:</B><DD>the border setting<DT><B>Since:</B></DT> |
| <DD>0.3.5</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/CellStyleHandler.html#getBorder(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType)"><CODE>CellStyleHandler.getBorder(StyleTypeDefinitions.CellBordersType |
| type)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getNoteText()"><!-- --></A><H3> |
| getNoteText</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getNoteText</B>()</PRE> |
| <DL> |
| <DD>Get the note text of this table cell. If there is no note on this cell, |
| <code>null</code> will be returned. |
| <p> |
| The note may contain text list, text paragraph and styles, but this |
| method extracts only text from them. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the note text of this cell.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setNoteText(java.lang.String)"><!-- --></A><H3> |
| setNoteText</H3> |
| <PRE> |
| public void <B>setNoteText</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> note)</PRE> |
| <DL> |
| <DD>Set note text for this table cell. This method creates a text paragraph |
| without style as note. The note text is text paragraph content. |
| <p> |
| Only simple text is supported to receive in this method, which is a sub |
| function of office annotation. So overwriting a note with text might |
| loose structure and styles. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>note</CODE> - note content.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setImage(java.net.URI)"><!-- --></A><H3> |
| setImage</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</A> <B>setImage</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> imageUri)</PRE> |
| <DL> |
| <DD>Insert an Image from the specified uri to cell. Note: if there is any |
| other text content in this cell, it will be removed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>imageUri</CODE> - The URI of the image that will be added to the cell, add image |
| stream to the package, in the 'Pictures/' graphic directory |
| with the same image file name as in the URI. If the imageURI |
| is relative first the user.dir is taken to make it absolute.<DT><B>Since:</B></DT> |
| <DD>0.4.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBufferedImage()"><!-- --></A><H3> |
| getBufferedImage</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/awt/image/BufferedImage.html?is-external=true" title="class or interface in java.awt.image">BufferedImage</A> <B>getBufferedImage</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I></I> |
| <P> |
| <DD>Get the Image from the specified cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>If there is a image exist in this cell, An <A HREF="http://download.oracle.com/javase/6/docs/api/java/awt/Image.html?is-external=true" title="class or interface in java.awt"><CODE>Image</CODE></A> will be returned.<DT><B>Since:</B></DT> |
| <DD>0.4.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getImage()"><!-- --></A><H3> |
| getImage</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</A> <B>getImage</B>()</PRE> |
| <DL> |
| <DD>Get the image from the specified cell. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>If there is a image exist in this cell, an |
| <A HREF="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw"><CODE>Image</CODE></A> will be returned.<DT><B>Since:</B></DT> |
| <DD>0.5.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getStyleHandler()"><!-- --></A><H3> |
| getStyleHandler</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/table/CellStyleHandler.html" title="class in org.odftoolkit.simple.table">CellStyleHandler</A> <B>getStyleHandler</B>()</PRE> |
| <DL> |
| <DD>Return style handler for this cell |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the style handler<DT><B>Since:</B></DT> |
| <DD>0.3</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getListContainerElement()"><!-- --></A><H3> |
| getListContainerElement</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>getListContainerElement</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListContainerElement()">ListContainer</A></CODE></B></DD> |
| <DD>Get the ODF element which can have <text:list> as child |
| element directly according to ODF specification. This Element will help to find the |
| position to insert a new List. For example, <text:list> element is |
| usable with <office:text> element, so TextDocument will return |
| OfficeTextElement. While Presentation Notes is an indirectly |
| ListContainer, which holds List 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/text/list/ListContainer.html#getListContainerElement()">getListContainerElement</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>container element which can hold <text:list>.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addList()"><!-- --></A><H3> |
| addList</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A> <B>addList</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList()">ListContainer</A></CODE></B></DD> |
| <DD>Add a new List to this container. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList()">addList</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>added list.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addList(org.odftoolkit.simple.text.list.ListDecorator)"><!-- --></A><H3> |
| addList</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A> <B>addList</B>(<A HREF="../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</A> decorator)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">ListContainer</A></CODE></B></DD> |
| <DD>Add a List with specified ListDecorator to this container. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">addList</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>decorator</CODE> - the specified ListDecorator |
| <DT><B>Returns:</B><DD>added list.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearList()"><!-- --></A><H3> |
| clearList</H3> |
| <PRE> |
| public void <B>clearList</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#clearList()">ListContainer</A></CODE></B></DD> |
| <DD>Remove all Lists from this container. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#clearList()">clearList</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getListIterator()"><!-- --></A><H3> |
| getListIterator</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><<A HREF="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A>> <B>getListIterator</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListIterator()">ListContainer</A></CODE></B></DD> |
| <DD>Return an Iterator of the Lists in this ListContainer. The Lists are |
| iterated in the same order that they occur in the ListContainer. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListIterator()">getListIterator</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an Iterator of the Lists in this ListContainer<DT><B>See Also:</B><DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><CODE>Iterator</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeList(org.odftoolkit.simple.text.list.List)"><!-- --></A><H3> |
| removeList</H3> |
| <PRE> |
| public boolean <B>removeList</B>(<A HREF="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A> list)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#removeList(org.odftoolkit.simple.text.list.List)">ListContainer</A></CODE></B></DD> |
| <DD>Remove the existing List from this container. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html#removeList(org.odftoolkit.simple.text.list.List)">removeList</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true, if the container contains this List.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addParagraph(java.lang.String)"><!-- --></A><H3> |
| addParagraph</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</A> <B>addParagraph</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> text)</PRE> |
| <DL> |
| <DD>Creates a new paragraph and append text |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#addParagraph(java.lang.String)">addParagraph</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>text</CODE> - |
| <DT><B>Returns:</B><DD>the new paragraph |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if the file DOM could not be created.<DT><B>Since:</B></DT> |
| <DD>0.5.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeParagraph(org.odftoolkit.simple.text.Paragraph)"><!-- --></A><H3> |
| removeParagraph</H3> |
| <PRE> |
| public boolean <B>removeParagraph</B>(<A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</A> para)</PRE> |
| <DL> |
| <DD>Remove paragraph from this document |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#removeParagraph(org.odftoolkit.simple.text.Paragraph)">removeParagraph</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>para</CODE> - - the instance of paragraph |
| <DT><B>Returns:</B><DD>true if the paragraph is removed successfully, false if errors |
| happen.<DT><B>Since:</B></DT> |
| <DD>0.5.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParagraphContainerElement()"><!-- --></A><H3> |
| getParagraphContainerElement</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>getParagraphContainerElement</B>()</PRE> |
| <DL> |
| <DD>Get the ODF element which can have <text:p> as child element directly. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphContainerElement()">getParagraphContainerElement</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>- an ODF element which can have paragraph as child.<DT><B>Since:</B></DT> |
| <DD>0.5.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParagraphByIndex(int, boolean)"><!-- --></A><H3> |
| getParagraphByIndex</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</A> <B>getParagraphByIndex</B>(int index, |
| boolean isEmptyParagraphSkipped)</PRE> |
| <DL> |
| <DD>Return a paragraph with a given index. |
| <p> |
| An index of zero represents the first paragraph. |
| <p> |
| If empty paragraph is skipped, the empty paragraph won't be counted. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphByIndex(int, boolean)">getParagraphByIndex</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>index</CODE> - - the index started from 0.<DD><CODE>isEmptyParagraphSkipped</CODE> - - whether the empty paragraph is skipped or not |
| <DT><B>Returns:</B><DD>the paragraph with a given index<DT><B>Since:</B></DT> |
| <DD>0.5.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParagraphByReverseIndex(int, boolean)"><!-- --></A><H3> |
| getParagraphByReverseIndex</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</A> <B>getParagraphByReverseIndex</B>(int reverseIndex, |
| boolean isEmptyParagraphSkipped)</PRE> |
| <DL> |
| <DD>Return a paragraph with a given index. The index is in reverse order. |
| <p> |
| An index of zero represents the last paragraph. |
| <p> |
| If empty paragraph is skipped, the empty paragraph won't be counted. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphByReverseIndex(int, boolean)">getParagraphByReverseIndex</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>reverseIndex</CODE> - - the index started from 0 in reverse order.<DD><CODE>isEmptyParagraphSkipped</CODE> - - whether the empty paragraph is skipped or not |
| <DT><B>Returns:</B><DD>the paragraph with a given index<DT><B>Since:</B></DT> |
| <DD>0.5.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParagraphIterator()"><!-- --></A><H3> |
| getParagraphIterator</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><<A HREF="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</A>> <B>getParagraphIterator</B>()</PRE> |
| <DL> |
| <DD>Return an Iterator of the paragraph in this container. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphIterator()">getParagraphIterator</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an Iterator of the paragraph in this container<DT><B>Since:</B></DT> |
| <DD>0.5.5</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFrameContainerElement()"><!-- --></A><H3> |
| getFrameContainerElement</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>getFrameContainerElement</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/odftoolkit/simple/draw/FrameContainer.html#getFrameContainerElement()">FrameContainer</A></CODE></B></DD> |
| <DD>Get the ODF element which can have <draw:frame> as child element directly |
| according to ODF specification. This Element will help to find the |
| position to insert a new draw:frame element. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/draw/FrameContainer.html#getFrameContainerElement()">getFrameContainerElement</A></CODE> in interface <CODE><A HREF="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the parent of draw:frame</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setValidityList(java.util.List)"><!-- --></A><H3> |
| setValidityList</H3> |
| <PRE> |
| public void <B>setValidityList</B>(<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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> values)</PRE> |
| <DL> |
| <DD>Specifies the allowed values of this cell in a list. Any value out of |
| this list is invalid. |
| <p> |
| NOTE: The validity list is per default only used for a drop down box |
| to select possible values. Validation error messages can be enabled |
| by <code>setInputErrorMessage()</code>. |
| <p> |
| NOTE: Now, the validity rule does not take effect when a cell value |
| is updated by Simple ODF API yet. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>values</CODE> - the list of allowed values.<DT><B>Since:</B></DT> |
| <DD>0.6</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#setInputErrorMessage(java.lang.String, java.lang.String, java.lang.String)"><CODE>setInputErrorMessage(String, String, String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInputHelpMessage(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| setInputHelpMessage</H3> |
| <PRE> |
| public void <B>setInputHelpMessage</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> title, |
| <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> text)</PRE> |
| <DL> |
| <DD>Sets the title and the text of the tip, which will then be displayed if |
| the cell is selected. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>title</CODE> - the title of the tip.<DD><CODE>text</CODE> - the text of the tip.<DT><B>Since:</B></DT> |
| <DD>0.6</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInputErrorMessage(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| setInputErrorMessage</H3> |
| <PRE> |
| public void <B>setInputErrorMessage</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> title, |
| <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> text, |
| <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> messageType)</PRE> |
| <DL> |
| <DD>Sets the title and text of the message box which will |
| be displayed if if invalid input is entered into the cell. |
| <p> |
| This message has only effect if a content validation is |
| active for the cell, e. g. by setting a validation list. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>title</CODE> - Title of the message box. May be <code>null</code> for using |
| default title.<DD><CODE>text</CODE> - Text of the message box. May be <code>null</code> for using |
| default message.<DD><CODE>messageType</CODE> - The severity of the message. If <code>null</code>, the |
| default is used ("stop"). Allowed values are enumerated |
| by <code>TableMessageTypeAttribute.Value</code>: <code>"stop"</code> |
| (Default), <code>"warning"</code>, <code>"information"</code>.<DT><B>Since:</B></DT> |
| <DD>0.8.2</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/Cell.html#setValidityList(java.util.List)"><CODE>setValidityList(List)</CODE></A>, |
| <CODE>TableMessageTypeAttribute.Value</CODE></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/Cell.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/table/AbstractTableContainer.html" title="class in org.odftoolkit.simple.table"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/odftoolkit/simple/table/CellRange.html" title="class in org.odftoolkit.simple.table"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/odftoolkit/simple/table/Cell.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Cell.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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> |
