blob: 7736c87aea92cfb28c18bc1b5ce8c7702ccc5d30 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:35:16 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Cell (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)</title>
<meta name="date" content="2013-02-22">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Cell (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Cell.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/table/AbstractTableContainer.html" title="class in org.odftoolkit.simple.table"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/table/CellRange.html" title="class in org.odftoolkit.simple.table"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/table/Cell.html" target="_top">Frames</a></li>
<li><a href="Cell.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.odftoolkit.simple.table</div>
<h2 title="Class Cell" class="title">Class Cell</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Component</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.simple.table.Cell</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/odftoolkit/simple/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>
<br>
<pre>public class <span class="strong">Cell</span>
extends <a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a>
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></pre>
<div class="block">Cell represents table cell feature in ODF document.
<p>
Table provides methods to get/set/modify the cell content and cell
properties.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#addList()">addList</a></strong>()</code>
<div class="block">Add a new List to this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">addList</a></strong>(<a href="../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</a>&nbsp;decorator)</code>
<div class="block">Add a List with specified ListDecorator to this container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#addParagraph(java.lang.String)">addParagraph</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;text)</code>
<div class="block">Creates a new paragraph and append text</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#clearList()">clearList</a></strong>()</code>
<div class="block">Remove all Lists from this container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getBooleanValue()">getBooleanValue</a></strong>()</code>
<div class="block">Get the cell boolean value as Boolean object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getBorder(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType)">getBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</a>&nbsp;type)</code>
<div class="block">Return the border setting for a specific border.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getBufferedImage()">getBufferedImage</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;&nbsp;</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.type.Color</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getCellBackgroundColor()">getCellBackgroundColor</a></strong>()</code>
<div class="block">Get the background color of this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getCellBackgroundColorString()">getCellBackgroundColorString</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of Simple version 0.3, replaced by
<code>getCellBackgroundColor()</code></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getCellStyleName()">getCellStyleName</a></strong>()</code>
<div class="block">Get the cell style name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getColumnIndex()">getColumnIndex</a></strong>()</code>
<div class="block">Get the index of the table column which contains this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getColumnSpannedNumber()">getColumnSpannedNumber</a></strong>()</code>
<div class="block">Get the column spanned number of this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getCurrencyCode()">getCurrencyCode</a></strong>()</code>
<div class="block">Return the currency code of this cell, for example, "USD", "EUR", "CNY",
and etc.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getCurrencySymbol()">getCurrencySymbol</a></strong>()</code>
<div class="block">Get the symbol of currency.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getCurrencyValue()">getCurrencyValue</a></strong>()</code>
<div class="block">Get the currency value of this cell as Double object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getDateValue()">getDateValue</a></strong>()</code>
<div class="block">Get the cell date value as Calendar.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getDisplayText()">getDisplayText</a></strong>()</code>
<div class="block">Get the text displayed in this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getDoubleValue()">getDoubleValue</a></strong>()</code>
<div class="block">Get the double value of this cell as Double object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getFont()">getFont</a></strong>()</code>
<div class="block">Return the font definition for this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getFormatString()">getFormatString</a></strong>()</code>
<div class="block">Get the format string of the cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getFormula()">getFormula</a></strong>()</code>
<div class="block">Get the formula string of the cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getFrameContainerElement()">getFrameContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have <draw:frame> as child element directly
according to ODF specification.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getHorizontalAlignment()">getHorizontalAlignment</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of Simple version 0.3, replaced by
<code>getHorizontalAlignmentType()</code></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getHorizontalAlignmentType()">getHorizontalAlignmentType</a></strong>()</code>
<div class="block">Return the horizontal alignment setting of this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getImage()">getImage</a></strong>()</code>
<div class="block">Get the image from the specified cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getInstance(org.odftoolkit.odfdom.dom.element.table.TableTableCellElementBase)">getInstance</a></strong>(org.odftoolkit.odfdom.dom.element.table.TableTableCellElementBase&nbsp;cellElement)</code>
<div class="block">Get the <code>Cell</code> instance from the
<code>TableTableCellElementBase</code> instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getListContainerElement()">getListContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have <text:list> as child
element directly according to ODF specification.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getListIterator()">getListIterator</a></strong>()</code>
<div class="block">Return an Iterator of the Lists in this ListContainer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getNoteText()">getNoteText</a></strong>()</code>
<div class="block">Get the note text of this table cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.table.TableTableCellElementBase</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getOdfElement()">getOdfElement</a></strong>()</code>
<div class="block">Get the instance of <code>TableTableCellElementBase</code> which
represents this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getOwnerTableCell()">getOwnerTableCell</a></strong>()</code>
<div class="block">Get the cell that covers this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getParagraphByIndex(int, boolean)">getParagraphByIndex</a></strong>(int&nbsp;index,
boolean&nbsp;isEmptyParagraphSkipped)</code>
<div class="block">Return a paragraph with a given index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getParagraphByReverseIndex(int, boolean)">getParagraphByReverseIndex</a></strong>(int&nbsp;reverseIndex,
boolean&nbsp;isEmptyParagraphSkipped)</code>
<div class="block">Return a paragraph with a given index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getParagraphContainerElement()">getParagraphContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have <text:p> as child element directly.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getParagraphIterator()">getParagraphIterator</a></strong>()</code>
<div class="block">Return an Iterator of the paragraph in this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getPercentageValue()">getPercentageValue</a></strong>()</code>
<div class="block">Get the cell percentage value as Double object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getRowIndex()">getRowIndex</a></strong>()</code>
<div class="block">Get the index of the table row which contains this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getRowSpannedNumber()">getRowSpannedNumber</a></strong>()</code>
<div class="block">Get the row spanned number of this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getStringValue()">getStringValue</a></strong>()</code>
<div class="block">Get the cell value as a string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/CellStyleHandler.html" title="class in org.odftoolkit.simple.table">CellStyleHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getStyleHandler()">getStyleHandler</a></strong>()</code>
<div class="block">Return style handler for this cell</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getStyleName()">getStyleName</a></strong>()</code>
<div class="block">Get the style name of this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getTable()">getTable</a></strong>()</code>
<div class="block">Get an instance of table feature which contains this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Column.html" title="class in org.odftoolkit.simple.table">Column</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getTableColumn()">getTableColumn</a></strong>()</code>
<div class="block">Get the instance of table column feature which contains this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Row.html" title="class in org.odftoolkit.simple.table">Row</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getTableRow()">getTableRow</a></strong>()</code>
<div class="block">Get the instance of table row feature which contains this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getTimeValue()">getTimeValue</a></strong>()</code>
<div class="block">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>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getValueType()">getValueType</a></strong>()</code>
<div class="block">Get the value type of this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getVerticalAlignment()">getVerticalAlignment</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of Simple version 0.3, replaced by
<code>getVerticalAlignmentType()</code></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalAlignmentType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#getVerticalAlignmentType()">getVerticalAlignmentType</a></strong>()</code>
<div class="block">Return the vertical alignment setting of this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#isTextWrapped()">isTextWrapped</a></strong>()</code>
<div class="block">Return the wrap option of this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#removeContent()">removeContent</a></strong>()</code>
<div class="block">Remove all the content of the cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#removeList(org.odftoolkit.simple.text.list.List)">removeList</a></strong>(<a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;list)</code>
<div class="block">Remove the existing List from this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#removeParagraph(org.odftoolkit.simple.text.Paragraph)">removeParagraph</a></strong>(<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;para)</code>
<div class="block">Remove paragraph from this document</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#removeTextContent()">removeTextContent</a></strong>()</code>
<div class="block">Remove all the text content of cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setBooleanValue(java.lang.Boolean)">setBooleanValue</a></strong>(<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>&nbsp;value)</code>
<div class="block">Set the cell value as a boolean and set the value type to be boolean.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setBorders(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType, org.odftoolkit.simple.style.Border)">setBorders</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</a>&nbsp;bordersType,
<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</code>
<div class="block">Set the border style definitions for this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setCellBackgroundColor(org.odftoolkit.odfdom.type.Color)">setCellBackgroundColor</a></strong>(org.odftoolkit.odfdom.type.Color&nbsp;cellBackgroundColor)</code>
<div class="block">Set the background color of this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setCellBackgroundColor(java.lang.String)">setCellBackgroundColor</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cellBackgroundColor)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of Simple version 0.3, replaced by
<code>setCellBackgroundColor(Color)</code></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setCellStyleName(java.lang.String)">setCellStyleName</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;styleName)</code>
<div class="block">Set the cell style name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setCurrencyCode(java.lang.String)">setCurrencyCode</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;currency)</code>
<div class="block">Set the currency code of this cell, for example, "USD", "EUR", "CNY", and
etc.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setCurrencyFormat(java.lang.String, java.lang.String)">setCurrencyFormat</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;format)</code>
<div class="block">Set the currency symbol and overall format of a currency cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setCurrencyValue(java.lang.Double, java.lang.String)">setCurrencyValue</a></strong>(<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>&nbsp;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>&nbsp;currency)</code>
<div class="block">Set the value and currency of the cell, and set the value type as
"currency".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setDateValue(java.util.Calendar)">setDateValue</a></strong>(<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>&nbsp;date)</code>
<div class="block">Set the cell value as a date, and set the value type to be "date".</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setDisplayText(java.lang.String)">setDisplayText</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;content)</code>
<div class="block">Set the text displayed in this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setDisplayText(java.lang.String, org.odftoolkit.simple.table.CellValueAdapter)">setDisplayText</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;content,
<a href="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table">CellValueAdapter</a>&nbsp;adapter)</code>
<div class="block">Set the text displayed in this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setDisplayText(java.lang.String, org.odftoolkit.simple.table.CellValueAdapter, java.lang.String)">setDisplayText</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;content,
<a href="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table">CellValueAdapter</a>&nbsp;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>&nbsp;stylename)</code>
<div class="block">Set the text displayed in this cell, with a specified style name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setDisplayText(java.lang.String, java.lang.String)">setDisplayText</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;stylename)</code>
<div class="block">Set the text displayed in this cell, with a specified style name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setDoubleValue(java.lang.Double)">setDoubleValue</a></strong>(<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>&nbsp;value)</code>
<div class="block">Set the cell value as a double and set the value type to be "float".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setFont(org.odftoolkit.simple.style.Font)">setFont</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</a>&nbsp;font)</code>
<div class="block">Set font style for this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setFormatString(java.lang.String)">setFormatString</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;formatStr)</code>
<div class="block">Set the format string of the cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setFormula(java.lang.String)">setFormula</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;formula)</code>
<div class="block">Set a formula to the cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setHorizontalAlignment(java.lang.String)">setHorizontalAlignment</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;horizontalAlignment)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of Simple version 0.3, replaced by
<code>setHorizontalAlignment(SimpleHorizontalAlignmentType)</code></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setHorizontalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalAlignmentType)">setHorizontalAlignment</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</a>&nbsp;alignType)</code>
<div class="block">Set the horizontal alignment setting of this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setImage(java.net.URI)">setImage</a></strong>(<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>&nbsp;imageUri)</code>
<div class="block">Insert an Image from the specified uri to cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setInputHelpMessage(java.lang.String, java.lang.String)">setInputHelpMessage</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;text)</code>
<div class="block">Sets the title and the text of the tip, which will then be displayed if
the cell is selected.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setNoteText(java.lang.String)">setNoteText</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;note)</code>
<div class="block">Set note text for this table cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setPercentageValue(java.lang.Double)">setPercentageValue</a></strong>(<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>&nbsp;value)</code>
<div class="block">Set the cell value as a percentage value and set the value type as
percentage too.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setStringValue(java.lang.String)">setStringValue</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str)</code>
<div class="block">Set the cell value as a string, and set the value type to be string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setTextWrapped(boolean)">setTextWrapped</a></strong>(boolean&nbsp;isTextWrapped)</code>
<div class="block">Set the wrap option of this cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setTimeValue(java.util.Calendar)">setTimeValue</a></strong>(<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>&nbsp;time)</code>
<div class="block">Set the cell value as a time and set the value type to be "time" too.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setValidityList(java.util.List)">setValidityList</a></strong>(<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>&lt;<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>&gt;&nbsp;values)</code>
<div class="block">Specifies the allowed values of this cell in a list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setValueType(java.lang.String)">setValueType</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type)</code>
<div class="block">Set the value type of this cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setVerticalAlignment(java.lang.String)">setVerticalAlignment</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;verticalAlignment)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of Simple version 0.3, replaced by
<code>setVerticalAlignment(SimpleVerticalAlignmentType)</code></i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/Cell.html#setVerticalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.VerticalAlignmentType)">setVerticalAlignment</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalAlignmentType</a>&nbsp;verticalAlignment)</code>
<div class="block">Set the vertical alignment setting of this cell.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.Component">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></h3>
<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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance(org.odftoolkit.odfdom.dom.element.table.TableTableCellElementBase)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</a>&nbsp;getInstance(org.odftoolkit.odfdom.dom.element.table.TableTableCellElementBase&nbsp;cellElement)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cellElement</code> - the cell element that need to get the corresponding
<code>Cell</code> instance</dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>Cell</code> instance that represents a specified cell
element</dd></dl>
</li>
</ul>
<a name="getHorizontalAlignment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHorizontalAlignment</h4>
<pre><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>
public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getHorizontalAlignment()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>As of Simple version 0.3, replaced by
<code>getHorizontalAlignmentType()</code></i></div>
<div class="block">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.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the horizontal alignment setting.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/table/Cell.html#getHorizontalAlignmentType()"><code>getHorizontalAlignmentType()</code></a></dd></dl>
</li>
</ul>
<a name="getHorizontalAlignmentType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHorizontalAlignmentType</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</a>&nbsp;getHorizontalAlignmentType()</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the horizontal alignment setting.</dd></dl>
</li>
</ul>
<a name="setHorizontalAlignment(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHorizontalAlignment</h4>
<pre><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>
public&nbsp;void&nbsp;setHorizontalAlignment(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;horizontalAlignment)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>As of Simple version 0.3, replaced by
<code>setHorizontalAlignment(SimpleHorizontalAlignmentType)</code></i></div>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>horizontalAlignment</code> - the horizontal alignment setting.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/table/Cell.html#setHorizontalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalAlignmentType)"><code>setHorizontalAlignment(StyleTypeDefinitions.HorizontalAlignmentType)</code></a></dd></dl>
</li>
</ul>
<a name="setHorizontalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalAlignmentType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHorizontalAlignment</h4>
<pre>public&nbsp;void&nbsp;setHorizontalAlignment(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</a>&nbsp;alignType)</pre>
<div class="block">Set the horizontal alignment setting of this cell. If the alignment is
set as Default, the explicit horizontal alignment setting is removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>alignType</code> - the horizontal alignment setting.</dd></dl>
</li>
</ul>
<a name="getVerticalAlignment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVerticalAlignment</h4>
<pre><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>
public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getVerticalAlignment()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>As of Simple version 0.3, replaced by
<code>getVerticalAlignmentType()</code></i></div>
<div class="block">Return the vertical alignment setting of this cell.
<p>
The returned value can be "auto", "automatic", "baseline", "bottom",
"middle", or "top".</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the vertical alignment setting of this cell.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/table/Cell.html#getVerticalAlignmentType()"><code>getVerticalAlignmentType()</code></a></dd></dl>
</li>
</ul>
<a name="getVerticalAlignmentType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVerticalAlignmentType</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalAlignmentType</a>&nbsp;getVerticalAlignmentType()</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the vertical alignment setting.</dd></dl>
</li>
</ul>
<a name="setVerticalAlignment(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVerticalAlignment</h4>
<pre><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>
public&nbsp;void&nbsp;setVerticalAlignment(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;verticalAlignment)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>As of Simple version 0.3, replaced by
<code>setVerticalAlignment(SimpleVerticalAlignmentType)</code></i></div>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verticalAlignment</code> - the vertical alignment setting.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/table/Cell.html#setVerticalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.VerticalAlignmentType)"><code>setVerticalAlignment(StyleTypeDefinitions.VerticalAlignmentType)</code></a></dd></dl>
</li>
</ul>
<a name="setVerticalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.VerticalAlignmentType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVerticalAlignment</h4>
<pre>public&nbsp;void&nbsp;setVerticalAlignment(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalAlignmentType</a>&nbsp;verticalAlignment)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verticalAlignment</code> - the vertical alignment setting.</dd></dl>
</li>
</ul>
<a name="isTextWrapped()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTextWrapped</h4>
<pre>public&nbsp;boolean&nbsp;isTextWrapped()</pre>
<div class="block">Return the wrap option of this cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the cell content can be wrapped;
<p>
false if the cell content cannot be wrapped.</dd></dl>
</li>
</ul>
<a name="setTextWrapped(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTextWrapped</h4>
<pre>public&nbsp;void&nbsp;setTextWrapped(boolean&nbsp;isTextWrapped)</pre>
<div class="block">Set the wrap option of this cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isTextWrapped</code> - whether the cell content can be wrapped or not</dd></dl>
</li>
</ul>
<a name="getRowIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowIndex</h4>
<pre>public&nbsp;int&nbsp;getRowIndex()</pre>
<div class="block">Get the index of the table row which contains this cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the index of the row containing this cell</dd></dl>
</li>
</ul>
<a name="getTable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTable</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;getTable()</pre>
<div class="block">Get an instance of table feature which contains this cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the table containing this cell</dd></dl>
</li>
</ul>
<a name="getColumnIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnIndex</h4>
<pre>public&nbsp;int&nbsp;getColumnIndex()</pre>
<div class="block">Get the index of the table column which contains this cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the index of the column containing this cell</dd></dl>
</li>
</ul>
<a name="getTableColumn()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableColumn</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/table/Column.html" title="class in org.odftoolkit.simple.table">Column</a>&nbsp;getTableColumn()</pre>
<div class="block">Get the instance of table column feature which contains this cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the instance of table column feature which contains the cell.</dd></dl>
</li>
</ul>
<a name="getTableRow()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableRow</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/table/Row.html" title="class in org.odftoolkit.simple.table">Row</a>&nbsp;getTableRow()</pre>
<div class="block">Get the instance of table row feature which contains this cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the instance of table row feature which contains the cell.</dd></dl>
</li>
</ul>
<a name="getOwnerTableCell()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwnerTableCell</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</a>&nbsp;getOwnerTableCell()</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the cell that covers the current cell</dd></dl>
</li>
</ul>
<a name="getOdfElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOdfElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.table.TableTableCellElementBase&nbsp;getOdfElement()</pre>
<div class="block">Get the instance of <code>TableTableCellElementBase</code> which
represents this cell.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/Component.html#getOdfElement()">getOdfElement</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the instance of <code>TableTableCellElementBase</code></dd></dl>
</li>
</ul>
<a name="getCurrencyCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrencyCode</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCurrencyCode()</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the currency code
<p></dd>
<dt><span class="strong">Throws:</span></dt>
<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".</dd></dl>
</li>
</ul>
<a name="setCurrencyCode(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCurrencyCode</h4>
<pre>public&nbsp;void&nbsp;setCurrencyCode(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;currency)</pre>
<div class="block">Set the currency code of this cell, for example, "USD", "EUR", "CNY", and
etc.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>currency</code> - the currency code that need to be set.</dd>
<dt><span class="strong">Throws:</span></dt>
<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.</dd></dl>
</li>
</ul>
<a name="setValueType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValueType</h4>
<pre>public&nbsp;void&nbsp;setValueType(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the type that need to be set If input type is null, an
IllegalArgumentException will be thrown.</dd></dl>
</li>
</ul>
<a name="getValueType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueType</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getValueType()</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the type of the cell</dd></dl>
</li>
</ul>
<a name="getDoubleValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDoubleValue</h4>
<pre>public&nbsp;<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>&nbsp;getDoubleValue()</pre>
<div class="block">Get the double value of this cell as Double object.
<p>
Throw IllegalArgumentException if the cell type is not "float".</div>
<dl><dt><span class="strong">Returns:</span></dt><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".</dd></dl>
</li>
</ul>
<a name="getCurrencyValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrencyValue</h4>
<pre>public&nbsp;<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>&nbsp;getCurrencyValue()</pre>
<div class="block">Get the currency value of this cell as Double object.
<p>
Throw IllegalArgumentException if the cell type is not "currency".</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the currency value of this cell as a Double object. If the cell
value is empty, null will be returned.</dd>
<dt><span class="strong">Throws:</span></dt>
<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".</dd></dl>
</li>
</ul>
<a name="getCurrencySymbol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrencySymbol</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCurrencySymbol()</pre>
<div class="block">Get the symbol of currency.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the currency symbol</dd>
<dt><span class="strong">Throws:</span></dt>
<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".</dd></dl>
</li>
</ul>
<a name="setCurrencyValue(java.lang.Double, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCurrencyValue</h4>
<pre>public&nbsp;void&nbsp;setCurrencyValue(<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>&nbsp;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>&nbsp;currency)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value that will be set</dd><dd><code>currency</code> - the currency that will be set.</dd>
<dt><span class="strong">Throws:</span></dt>
<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.</dd></dl>
</li>
</ul>
<a name="getPercentageValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPercentageValue</h4>
<pre>public&nbsp;<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>&nbsp;getPercentageValue()</pre>
<div class="block">Get the cell percentage value as Double object.
<p>
Throw IllegalArgumentException if the cell type is not "percentage".</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the percentage value of this cell as a Double object. If the cell
value is empty, null will be returned.</dd>
<dt><span class="strong">Throws:</span></dt>
<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".</dd></dl>
</li>
</ul>
<a name="setPercentageValue(java.lang.Double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPercentageValue</h4>
<pre>public&nbsp;void&nbsp;setPercentageValue(<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>&nbsp;value)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value that will be set</dd></dl>
</li>
</ul>
<a name="getDisplayText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisplayText</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDisplayText()</pre>
<div class="block">Get the text displayed in this cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the text displayed in this cell</dd></dl>
</li>
</ul>
<a name="setDisplayText(java.lang.String, org.odftoolkit.simple.table.CellValueAdapter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDisplayText</h4>
<pre>public&nbsp;void&nbsp;setDisplayText(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;content,
<a href="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table">CellValueAdapter</a>&nbsp;adapter)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - the displayed text.</dd><dd><code>adapter</code> - the <code>CellValueAdapter</code> used to adapt cell value and
value type.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.3</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table"><code>CellValueAdapter</code></a></dd></dl>
</li>
</ul>
<a name="setDisplayText(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDisplayText</h4>
<pre>public&nbsp;void&nbsp;setDisplayText(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;content)</pre>
<div class="block">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>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - the displayed text.</dd><dt><span class="strong">See Also:</span></dt><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></dd></dl>
</li>
</ul>
<a name="setDisplayText(java.lang.String, org.odftoolkit.simple.table.CellValueAdapter, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDisplayText</h4>
<pre>public&nbsp;void&nbsp;setDisplayText(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;content,
<a href="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table">CellValueAdapter</a>&nbsp;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>&nbsp;stylename)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - the displayed text. If content is null, it will display the
empty string instead.</dd><dd><code>adapter</code> - the <code>CellValueAdapter</code> used to adapt cell value and
value type.</dd><dd><code>stylename</code> - the style name. If style name is null, the content will use
the default paragraph style.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.3</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/table/CellValueAdapter.html" title="interface in org.odftoolkit.simple.table"><code>CellValueAdapter</code></a></dd></dl>
</li>
</ul>
<a name="setDisplayText(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDisplayText</h4>
<pre>public&nbsp;void&nbsp;setDisplayText(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;stylename)</pre>
<div class="block">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>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - the displayed text. If content is null, it will display the
empty string instead.</dd><dd><code>stylename</code> - the style name. If style name is null, the content will use
the default paragraph style.</dd><dt><span class="strong">See Also:</span></dt><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></dd></dl>
</li>
</ul>
<a name="setDoubleValue(java.lang.Double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDoubleValue</h4>
<pre>public&nbsp;void&nbsp;setDoubleValue(<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>&nbsp;value)</pre>
<div class="block">Set the cell value as a double and set the value type to be "float".</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the double value that will be set. If
<code>value</value> is null, the cell value will be removed.</dd></dl>
</li>
</ul>
<a name="getBooleanValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBooleanValue</h4>
<pre>public&nbsp;<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>&nbsp;getBooleanValue()</pre>
<div class="block">Get the cell boolean value as Boolean object.
<p>
Throw IllegalArgumentException if the cell type is not "boolean".</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the Boolean value of cell. If the cell value is empty, null will
be returned.</dd>
<dt><span class="strong">Throws:</span></dt>
<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".</dd></dl>
</li>
</ul>
<a name="setBooleanValue(java.lang.Boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBooleanValue</h4>
<pre>public&nbsp;void&nbsp;setBooleanValue(<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>&nbsp;value)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value of boolean type</dd></dl>
</li>
</ul>
<a name="getDateValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDateValue</h4>
<pre>public&nbsp;<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>&nbsp;getDateValue()</pre>
<div class="block">Get the cell date value as Calendar.
<p>
Throw IllegalArgumentException if the cell type is not "date".</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the Calendar value of cell</dd>
<dt><span class="strong">Throws:</span></dt>
<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".</dd></dl>
</li>
</ul>
<a name="setDateValue(java.util.Calendar)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDateValue</h4>
<pre>public&nbsp;void&nbsp;setDateValue(<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>&nbsp;date)</pre>
<div class="block">Set the cell value as a date, and set the value type to be "date".</div>
<dl><dt><span class="strong">Parameters:</span></dt><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.</dd></dl>
</li>
</ul>
<a name="setCellStyleName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCellStyleName</h4>
<pre>public&nbsp;void&nbsp;setCellStyleName(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;styleName)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>styleName</code> - an exit cell style name.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.4</dd></dl>
</li>
</ul>
<a name="getCellStyleName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCellStyleName</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCellStyleName()</pre>
<div class="block">Get the cell style name.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>cell style name.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.4</dd></dl>
</li>
</ul>
<a name="setStringValue(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStringValue</h4>
<pre>public&nbsp;void&nbsp;setStringValue(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str)</pre>
<div class="block">Set the cell value as a string, and set the value type to be string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - the value of string type. If input string is null, an empty
string will be set.</dd></dl>
</li>
</ul>
<a name="getStringValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringValue</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getStringValue()</pre>
<div class="block">Get the cell value as a string.
<p>
If the cell type is not string, the display text will be returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the string value of this cell, or the display text</dd></dl>
</li>
</ul>
<a name="getTimeValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeValue</h4>
<pre>public&nbsp;<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>&nbsp;getTimeValue()</pre>
<div class="block">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".</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the Calendar value of cell</dd>
<dt><span class="strong">Throws:</span></dt>
<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.</dd></dl>
</li>
</ul>
<a name="setTimeValue(java.util.Calendar)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeValue</h4>
<pre>public&nbsp;void&nbsp;setTimeValue(<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>&nbsp;time)</pre>
<div class="block">Set the cell value as a time and set the value type to be "time" too.</div>
<dl><dt><span class="strong">Parameters:</span></dt><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.</dd>
<dt><span class="strong">Throws:</span></dt>
<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.</dd></dl>
</li>
</ul>
<a name="getCellBackgroundColor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCellBackgroundColor</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.type.Color&nbsp;getCellBackgroundColor()</pre>
<div class="block">Get the background color of this cell.
<p>
If no background color is set, default background color "#FFFFFF" will be
returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the background color of this cell</dd></dl>
</li>
</ul>
<a name="getCellBackgroundColorString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCellBackgroundColorString</h4>
<pre><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>
public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCellBackgroundColorString()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>As of Simple version 0.3, replaced by
<code>getCellBackgroundColor()</code></i></div>
<div class="block">Get the background color string of this cell.
<p>
If no background color is set, default background color "#FFFFFF" will be
returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the background color of this cell</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/table/Cell.html#getCellBackgroundColor()"><code>getCellBackgroundColor()</code></a></dd></dl>
</li>
</ul>
<a name="setCellBackgroundColor(org.odftoolkit.odfdom.type.Color)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCellBackgroundColor</h4>
<pre>public&nbsp;void&nbsp;setCellBackgroundColor(org.odftoolkit.odfdom.type.Color&nbsp;cellBackgroundColor)</pre>
<div class="block">Set the background color of this cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><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.</dd></dl>
</li>
</ul>
<a name="setCellBackgroundColor(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCellBackgroundColor</h4>
<pre><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>
public&nbsp;void&nbsp;setCellBackgroundColor(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cellBackgroundColor)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>As of Simple version 0.3, replaced by
<code>setCellBackgroundColor(Color)</code></i></div>
<div class="block">Set the background color of this cell using string. The string must be a
valid argument for constructing <code><code>org.odftoolkit.odfdom.type.Color</code></code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cellBackgroundColor</code> - the background color that need to set. If cellBackgroundColor
is null, default background color #FFFFFF will be set.</dd><dt><span class="strong">See Also:</span></dt><dd><code>Color</code>,
<a href="../../../../org/odftoolkit/simple/table/Cell.html#setCellBackgroundColor(org.odftoolkit.odfdom.type.Color)"><code>setCellBackgroundColor(Color)</code></a></dd></dl>
</li>
</ul>
<a name="getColumnSpannedNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnSpannedNumber</h4>
<pre>public&nbsp;int&nbsp;getColumnSpannedNumber()</pre>
<div class="block">Get the column spanned number of this cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the column spanned number</dd></dl>
</li>
</ul>
<a name="getRowSpannedNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowSpannedNumber</h4>
<pre>public&nbsp;int&nbsp;getRowSpannedNumber()</pre>
<div class="block">Get the row spanned number of this cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the row spanned number</dd></dl>
</li>
</ul>
<a name="getStyleName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyleName</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getStyleName()</pre>
<div class="block">Get the style name of this cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the style</dd></dl>
</li>
</ul>
<a name="setFormula(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFormula</h4>
<pre>public&nbsp;void&nbsp;setFormula(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;formula)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formula</code> - the formula that need to be set.</dd>
<dt><span class="strong">Throws:</span></dt>
<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.</dd><dt><span class="strong">See Also:</span></dt><dd><code>TableFormulaAttribute</code></dd></dl>
</li>
</ul>
<a name="getFormula()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormula</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getFormula()</pre>
<div class="block">Get the formula string of the cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the formula representation of the cell
<p>
If the cell does not contain a formula, null will be returned.</dd></dl>
</li>
</ul>
<a name="setCurrencyFormat(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCurrencyFormat</h4>
<pre>public&nbsp;void&nbsp;setCurrencyFormat(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;format)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>currencySymbol</code> - the currency symbol</dd><dd><code>format</code> - overall format</dd>
<dt><span class="strong">Throws:</span></dt>
<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.</dd></dl>
</li>
</ul>
<a name="setFormatString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFormatString</h4>
<pre>public&nbsp;void&nbsp;setFormatString(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;formatStr)</pre>
<div class="block">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></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatStr</code> - the cell need be formatted as this specified format string.</dd>
<dt><span class="strong">Throws:</span></dt>
<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>
<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.</dd><dt><span class="strong">See Also:</span></dt><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></dd></dl>
</li>
</ul>
<a name="getFormatString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormatString</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getFormatString()</pre>
<div class="block">Get the format string of the cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the format string of the cell</dd></dl>
</li>
</ul>
<a name="removeTextContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeTextContent</h4>
<pre>public&nbsp;void&nbsp;removeTextContent()</pre>
<div class="block">Remove all the text content of cell.</div>
</li>
</ul>
<a name="removeContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContent</h4>
<pre>public&nbsp;void&nbsp;removeContent()</pre>
<div class="block">Remove all the content of the cell.</div>
</li>
</ul>
<a name="getFont()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFont</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</a>&nbsp;getFont()</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the font definition null if there is no style definition for this
cell</dd><dt><span class="strong">Since:</span></dt>
<dd>0.3</dd></dl>
</li>
</ul>
<a name="setFont(org.odftoolkit.simple.style.Font)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFont</h4>
<pre>public&nbsp;void&nbsp;setFont(<a href="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</a>&nbsp;font)</pre>
<div class="block">Set font style for this cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>font</code> - - the font</dd><dt><span class="strong">Since:</span></dt>
<dd>0.3</dd></dl>
</li>
</ul>
<a name="setBorders(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType, org.odftoolkit.simple.style.Border)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBorders</h4>
<pre>public&nbsp;void&nbsp;setBorders(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</a>&nbsp;bordersType,
<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</pre>
<div class="block">Set the border style definitions for this cell.
<p>
This method will invoke
<code>CellStyleHandler.setBorders(Border border, SimpleCellBordersType bordersType).</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bordersType</code> - - A predefined border type</dd><dd><code>border</code> - - border style description</dd><dt><span class="strong">Since:</span></dt>
<dd>0.3</dd>
<dt><span class="strong">See Also:</span></dt><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></dd></dl>
</li>
</ul>
<a name="getBorder(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBorder</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;getBorder(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</a>&nbsp;type)</pre>
<div class="block">Return the border setting for a specific border.
<p>
This method will invoke
<code>CellStyleHandler.getBorder(SimpleCellBordersType type).</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - - the border type which describes a single border</dd>
<dt><span class="strong">Returns:</span></dt><dd>the border setting</dd><dt><span class="strong">Since:</span></dt>
<dd>0.3.5</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/table/CellStyleHandler.html#getBorder(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType)"><code>CellStyleHandler.getBorder(StyleTypeDefinitions.CellBordersType
type)</code></a></dd></dl>
</li>
</ul>
<a name="getNoteText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNoteText</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getNoteText()</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the note text of this cell.</dd></dl>
</li>
</ul>
<a name="setNoteText(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNoteText</h4>
<pre>public&nbsp;void&nbsp;setNoteText(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;note)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>note</code> - note content.</dd></dl>
</li>
</ul>
<a name="setImage(java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setImage</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a>&nbsp;setImage(<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>&nbsp;imageUri)</pre>
<div class="block">Insert an Image from the specified uri to cell. Note: if there is any
other text content in this cell, it will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><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.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.4.5</dd></dl>
</li>
</ul>
<a name="getBufferedImage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferedImage</h4>
<pre>public&nbsp;<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>&nbsp;getBufferedImage()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i></i></div>
<div class="block">Get the Image from the specified cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><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.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.4.5</dd></dl>
</li>
</ul>
<a name="getImage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImage</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a>&nbsp;getImage()</pre>
<div class="block">Get the image from the specified cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><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.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</dd></dl>
</li>
</ul>
<a name="getStyleHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyleHandler</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/table/CellStyleHandler.html" title="class in org.odftoolkit.simple.table">CellStyleHandler</a>&nbsp;getStyleHandler()</pre>
<div class="block">Return style handler for this cell</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the style handler</dd><dt><span class="strong">Since:</span></dt>
<dd>0.3</dd></dl>
</li>
</ul>
<a name="getListContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getListContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListContainerElement()">ListContainer</a></code></strong></div>
<div class="block">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.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListContainerElement()">getListContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>container element which can hold <text:list>.</dd></dl>
</li>
</ul>
<a name="addList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addList</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;addList()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList()">ListContainer</a></code></strong></div>
<div class="block">Add a new List to this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList()">addList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>added list.</dd></dl>
</li>
</ul>
<a name="addList(org.odftoolkit.simple.text.list.ListDecorator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addList</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;addList(<a href="../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</a>&nbsp;decorator)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">ListContainer</a></code></strong></div>
<div class="block">Add a List with specified ListDecorator to this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">addList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>decorator</code> - the specified ListDecorator</dd>
<dt><span class="strong">Returns:</span></dt><dd>added list.</dd></dl>
</li>
</ul>
<a name="clearList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearList</h4>
<pre>public&nbsp;void&nbsp;clearList()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#clearList()">ListContainer</a></code></strong></div>
<div class="block">Remove all Lists from this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#clearList()">clearList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
</dl>
</li>
</ul>
<a name="getListIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListIterator</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&gt;&nbsp;getListIterator()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListIterator()">ListContainer</a></code></strong></div>
<div class="block">Return an Iterator of the Lists in this ListContainer. The Lists are
iterated in the same order that they occur in the ListContainer.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListIterator()">getListIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an Iterator of the Lists in this ListContainer</dd><dt><span class="strong">See Also:</span></dt><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></dd></dl>
</li>
</ul>
<a name="removeList(org.odftoolkit.simple.text.list.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeList</h4>
<pre>public&nbsp;boolean&nbsp;removeList(<a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;list)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#removeList(org.odftoolkit.simple.text.list.List)">ListContainer</a></code></strong></div>
<div class="block">Remove the existing List from this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html#removeList(org.odftoolkit.simple.text.list.List)">removeList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true, if the container contains this List.</dd></dl>
</li>
</ul>
<a name="addParagraph(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParagraph</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;addParagraph(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;text)</pre>
<div class="block">Creates a new paragraph and append text</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#addParagraph(java.lang.String)">addParagraph</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the new paragraph</dd>
<dt><span class="strong">Throws:</span></dt>
<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.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</dd></dl>
</li>
</ul>
<a name="removeParagraph(org.odftoolkit.simple.text.Paragraph)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeParagraph</h4>
<pre>public&nbsp;boolean&nbsp;removeParagraph(<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;para)</pre>
<div class="block">Remove paragraph from this document</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#removeParagraph(org.odftoolkit.simple.text.Paragraph)">removeParagraph</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>para</code> - - the instance of paragraph</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the paragraph is removed successfully, false if errors
happen.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</dd></dl>
</li>
</ul>
<a name="getParagraphContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getParagraphContainerElement()</pre>
<div class="block">Get the ODF element which can have <text:p> as child element directly.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphContainerElement()">getParagraphContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>- an ODF element which can have paragraph as child.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</dd></dl>
</li>
</ul>
<a name="getParagraphByIndex(int, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphByIndex</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;getParagraphByIndex(int&nbsp;index,
boolean&nbsp;isEmptyParagraphSkipped)</pre>
<div class="block">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.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphByIndex(int, boolean)">getParagraphByIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - the index started from 0.</dd><dd><code>isEmptyParagraphSkipped</code> - - whether the empty paragraph is skipped or not</dd>
<dt><span class="strong">Returns:</span></dt><dd>the paragraph with a given index</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</dd></dl>
</li>
</ul>
<a name="getParagraphByReverseIndex(int, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphByReverseIndex</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;getParagraphByReverseIndex(int&nbsp;reverseIndex,
boolean&nbsp;isEmptyParagraphSkipped)</pre>
<div class="block">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.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphByReverseIndex(int, boolean)">getParagraphByReverseIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>reverseIndex</code> - - the index started from 0 in reverse order.</dd><dd><code>isEmptyParagraphSkipped</code> - - whether the empty paragraph is skipped or not</dd>
<dt><span class="strong">Returns:</span></dt><dd>the paragraph with a given index</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</dd></dl>
</li>
</ul>
<a name="getParagraphIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphIterator</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&gt;&nbsp;getParagraphIterator()</pre>
<div class="block">Return an Iterator of the paragraph in this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphIterator()">getParagraphIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an Iterator of the paragraph in this container</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</dd></dl>
</li>
</ul>
<a name="getFrameContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getFrameContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html#getFrameContainerElement()">FrameContainer</a></code></strong></div>
<div class="block">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.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html#getFrameContainerElement()">getFrameContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the parent of draw:frame</dd></dl>
</li>
</ul>
<a name="setValidityList(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValidityList</h4>
<pre>public&nbsp;void&nbsp;setValidityList(<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>&lt;<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>&gt;&nbsp;values)</pre>
<div class="block">Specifies the allowed values of this cell in a list. Any value out of
this list is invalid.
<p>
NOTE: Now, the validity rule does not take effect when a cell value
is updated by Simple ODF API yet.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - the list of allowed values.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="setInputHelpMessage(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setInputHelpMessage</h4>
<pre>public&nbsp;void&nbsp;setInputHelpMessage(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;text)</pre>
<div class="block">Sets the title and the text of the tip, which will then be displayed if
the cell is selected.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - the title of the tip.</dd><dd><code>text</code> - the text of the tip.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Cell.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/table/AbstractTableContainer.html" title="class in org.odftoolkit.simple.table"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/table/CellRange.html" title="class in org.odftoolkit.simple.table"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/table/Cell.html" target="_top">Frames</a></li>
<li><a href="Cell.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>