2008-01-16 11:08:22 -05:00
|
|
|
/* ====================================================================
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
==================================================================== */
|
|
|
|
|
|
|
|
package org.apache.poi.ss.usermodel;
|
|
|
|
|
|
|
|
import java.util.Calendar;
|
|
|
|
import java.util.Date;
|
|
|
|
|
2009-11-27 16:01:59 -05:00
|
|
|
import org.apache.poi.ss.formula.FormulaParseException;
|
2015-12-04 01:36:27 -05:00
|
|
|
import org.apache.poi.ss.util.CellAddress;
|
2009-12-25 10:15:55 -05:00
|
|
|
import org.apache.poi.ss.util.CellRangeAddress;
|
2016-07-04 07:54:20 -04:00
|
|
|
import org.apache.poi.util.Internal;
|
2016-08-22 14:25:45 -04:00
|
|
|
import org.apache.poi.util.Removal;
|
2009-11-27 16:01:59 -05:00
|
|
|
|
2008-11-14 15:29:42 -05:00
|
|
|
/**
|
|
|
|
* High level representation of a cell in a row of a spreadsheet.
|
|
|
|
* <p>
|
|
|
|
* Cells can be numeric, formula-based or string-based (text). The cell type
|
|
|
|
* specifies this. String cells cannot conatin numbers and numeric cells cannot
|
|
|
|
* contain strings (at least according to our model). Client apps should do the
|
|
|
|
* conversions themselves. Formula cells have the formula string, as well as
|
|
|
|
* the formula result, which can be numeric or string.
|
|
|
|
* </p>
|
|
|
|
* <p>
|
|
|
|
* Cells should have their number (0 based) before being added to a row.
|
|
|
|
* </p>
|
|
|
|
*/
|
2008-01-16 11:08:22 -05:00
|
|
|
public interface Cell {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Numeric Cell type (0)
|
|
|
|
* @see #setCellType(int)
|
|
|
|
* @see #getCellType()
|
2016-07-04 05:45:46 -04:00
|
|
|
* @deprecated POI 3.15 beta 3. Use {@link CellType#NUMERIC} instead.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
2016-08-22 14:25:45 -04:00
|
|
|
@Removal(version="4.0")
|
2016-08-22 13:57:45 -04:00
|
|
|
int CELL_TYPE_NUMERIC = 0; //CellType.NUMERIC.getCode();
|
2008-01-16 11:08:22 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* String Cell type (1)
|
|
|
|
* @see #setCellType(int)
|
|
|
|
* @see #getCellType()
|
2016-07-04 05:45:46 -04:00
|
|
|
* @deprecated POI 3.15 beta 3. Use {@link CellType#STRING} instead.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
2016-08-22 14:25:45 -04:00
|
|
|
@Removal(version="4.0")
|
2016-08-22 13:57:45 -04:00
|
|
|
int CELL_TYPE_STRING = 1; //CellType.STRING.getCode();
|
2008-01-16 11:08:22 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Formula Cell type (2)
|
|
|
|
* @see #setCellType(int)
|
|
|
|
* @see #getCellType()
|
2016-07-04 05:45:46 -04:00
|
|
|
* @deprecated POI 3.15 beta 3. Use {@link CellType#FORMULA} instead.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
2016-08-22 14:25:45 -04:00
|
|
|
@Removal(version="4.0")
|
2016-08-22 13:57:45 -04:00
|
|
|
int CELL_TYPE_FORMULA = 2; //CellType.FORMULA.getCode();
|
2008-01-16 11:08:22 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Blank Cell type (3)
|
|
|
|
* @see #setCellType(int)
|
|
|
|
* @see #getCellType()
|
2016-07-04 05:45:46 -04:00
|
|
|
* @deprecated POI 3.15 beta 3. Use {@link CellType#BLANK} instead.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
2016-08-22 14:25:45 -04:00
|
|
|
@Removal(version="4.0")
|
2016-08-22 13:57:45 -04:00
|
|
|
int CELL_TYPE_BLANK = 3; //CellType.BLANK.getCode();
|
2008-01-16 11:08:22 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Boolean Cell type (4)
|
|
|
|
* @see #setCellType(int)
|
|
|
|
* @see #getCellType()
|
2016-07-04 05:45:46 -04:00
|
|
|
* @deprecated POI 3.15 beta 3. Use {@link CellType#BOOLEAN} instead.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
2016-08-22 14:25:45 -04:00
|
|
|
@Removal(version="4.0")
|
2016-08-22 13:57:45 -04:00
|
|
|
int CELL_TYPE_BOOLEAN = 4; //CellType.BOOLEAN.getCode();
|
2008-01-16 11:08:22 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Error Cell type (5)
|
|
|
|
* @see #setCellType(int)
|
|
|
|
* @see #getCellType()
|
2016-07-04 05:45:46 -04:00
|
|
|
* @deprecated POI 3.15 beta 3. Use {@link CellType#ERROR} instead.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
2016-08-22 14:25:45 -04:00
|
|
|
@Removal(version="4.0")
|
2016-08-22 13:57:45 -04:00
|
|
|
int CELL_TYPE_ERROR = 5; //CellType.ERROR.getCode();
|
2009-11-27 16:01:59 -05:00
|
|
|
|
2008-01-16 11:08:22 -05:00
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Returns column index of this cell
|
|
|
|
*
|
|
|
|
* @return zero-based column index of a column in a sheet.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
2008-11-14 15:29:42 -05:00
|
|
|
int getColumnIndex();
|
2008-01-16 11:08:22 -05:00
|
|
|
|
2008-10-09 04:03:43 -04:00
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Returns row index of a row in the sheet that contains this cell
|
|
|
|
*
|
|
|
|
* @return zero-based row index of a row in the sheet that contains this cell
|
2008-10-09 04:03:43 -04:00
|
|
|
*/
|
Merged revisions 638786-638802,638805-638811,638813-638814,638816-639230,639233-639241,639243-639253,639255-639486,639488-639601,639603-639835,639837-639917,639919-640056,640058-640710,640712-641156,641158-641184,641186-641795,641797-641798,641800-641933,641935-641963,641965-641966,641968-641995,641997-642230,642232-642562,642564-642565,642568-642570,642572-642573,642576-642736,642739-642877,642879,642881-642890,642892-642903,642905-642945,642947-643624,643626-643653,643655-643669,643671,643673-643830,643832-643833,643835-644342,644344-644472,644474-644508,644510-645347,645349-645351,645353-645559,645561-645565,645568-645951,645953-646193,646195-646311,646313-646404,646406-646665,646667-646853,646855-646869,646871-647151,647153-647185,647187-647277,647279-647566,647568-647573,647575,647578-647711,647714-647737,647739-647823,647825-648155,648157-648202,648204-648273,648275,648277-648302,648304-648333,648335-648588,648590-648622,648625-648673,648675-649141,649144,649146-649556,649558-649795,649799,649801-649910,649912-649913,649915-650128,650131-650132,650134-650137,650140-650914,650916-651991,651993-652284,652286-652287,652289,652291,652293-652297,652299-652328,652330-652425,652427-652445,652447-652560,652562-652933,652935,652937-652993,652995-653116,653118-653124,653126-653483,653487-653519,653522-653550,653552-653607,653609-653667,653669-653674,653676-653814,653817-653830,653832-653891,653893-653944,653946-654055,654057-654355,654357-654365,654367-654648,654651-655215,655217-655277,655279-655281,655283-655911,655913-656212,656214,656216-656251,656253-656698,656700-656756,656758-656892,656894-657135,657137-657165,657168-657179,657181-657354,657356-657357,657359-657701,657703-657874,657876-658032,658034-658284,658286,658288-658301,658303-658307,658309-658321,658323-658335,658337-658348,658351,658353-658832,658834-658983,658985,658987-659066,659068-659402,659404-659428,659430-659451,659453-659454,659456-659461,659463-659477,659479-659524,659526-659571,659574,659576-660255,660257-660262,660264-660279,660281-660343,660345-660473,660475-660827,660829-660833,660835-660888,660890-663321,663323-663435,663437-663764,663766-663854,663856-664219,664221-664489,664494-664514,664516-668013,668015-668142,668144-668152,668154,668156-668256,668258,668260-669139,669141-669455,669457-669657,669659-669808,669810-670189,670191-671321,671323-672229,672231-672549,672551-672552,672554-672561,672563-672566,672568,672571-673049,673051-673852,673854-673862,673864-673986,673988-673996,673998-674347,674349-674890,674892-674910,674912-674936,674938-674952,674954-675078,675080-675085,675087-675217,675219-675660,675662-675670,675672-675716,675718-675726,675728-675733,675735-675775,675777-675782,675784,675786-675791,675794-675852,675854-676200,676202,676204,676206-676220,676222-676309,676311-676456,676458-676994,676996-677027,677030-677040,677042-677056,677058-677375,677377-677968,677970-677971,677973,677975-677994,677996-678286,678288-678538,678540-680393,680395-680469,680471-680529,680531-680852,680854-681529,681531-681571,681573-682224,682226,682228,682231-682281,682283-682335,682337-682507,682509,682512-682517,682519-682532,682534-682619,682622-682777,682779-682998,683000-683019,683021-683022,683024-683080,683082-683092,683094-683095,683097-683127,683129-683131,683133-683166,683168-683698,683700-683705,683707-683757,683759-683787,683789-683870,683872-683879,683881-683900,683902-684066,684068-684074,684076-684222,684224-684254,684257-684370 via svnmerge from
https://svn.apache.org/repos/asf/poi/trunk
........
r684282 | nick | 2008-08-09 16:58:24 +0100 (Sat, 09 Aug 2008) | 1 line
Prepare to change how we do ranges, to handle different kinds of text in the cp area
........
r684287 | nick | 2008-08-09 17:24:20 +0100 (Sat, 09 Aug 2008) | 1 line
Start to document the whole FIB stuff better
........
r684293 | nick | 2008-08-09 17:46:39 +0100 (Sat, 09 Aug 2008) | 1 line
Add lots more getters/setters for useful things to the FIB
........
r684299 | nick | 2008-08-09 18:23:42 +0100 (Sat, 09 Aug 2008) | 1 line
More tests to show that the range based stuff is working properly
........
r684302 | nick | 2008-08-09 18:33:29 +0100 (Sat, 09 Aug 2008) | 1 line
More header and footer files, this time with unicode in it too
........
r684309 | nick | 2008-08-09 18:58:35 +0100 (Sat, 09 Aug 2008) | 1 line
More range tests, which show that we do have a bug in the hwpf unicode support
........
r684318 | josh | 2008-08-09 20:29:23 +0100 (Sat, 09 Aug 2008) | 1 line
Converted rows map within HSSFSheet to use Integer keys
........
r684319 | nick | 2008-08-09 20:34:38 +0100 (Sat, 09 Aug 2008) | 1 line
Big big unicode rationalisation in text piece code
........
r684321 | josh | 2008-08-09 20:47:39 +0100 (Sat, 09 Aug 2008) | 1 line
added getRowIndex() to HSSFCell, deprecated HSSFFormulaEvaluator.setCurrentRow()
........
r684322 | nick | 2008-08-09 20:56:37 +0100 (Sat, 09 Aug 2008) | 1 line
Get most of the hwpf tests passing again
........
r684336 | nick | 2008-08-09 21:31:48 +0100 (Sat, 09 Aug 2008) | 1 line
Improve FIB updating on range changes, and add passing tests for non unicode paragraph properties
........
r684349 | nick | 2008-08-09 22:31:28 +0100 (Sat, 09 Aug 2008) | 1 line
Start on headers/footers support
........
r684355 | nick | 2008-08-09 22:46:14 +0100 (Sat, 09 Aug 2008) | 1 line
Tests to show that header stuff all works right
........
r684362 | nick | 2008-08-09 23:08:34 +0100 (Sat, 09 Aug 2008) | 1 line
Add header/footer support to HWPF WordExtractor
........
r684370 | nick | 2008-08-09 23:24:47 +0100 (Sat, 09 Aug 2008) | 1 line
Disable a few HWPF tests that aren't working while the unicode/paragraph bug is outstanding
........
git-svn-id: https://svn.apache.org/repos/asf/poi/branches/ooxml@684374 13f79535-47bb-0310-9956-ffa450edef68
2008-08-09 18:55:33 -04:00
|
|
|
int getRowIndex();
|
|
|
|
|
2008-11-14 15:29:42 -05:00
|
|
|
/**
|
|
|
|
* Returns the sheet this cell belongs to
|
|
|
|
*
|
|
|
|
* @return the sheet this cell belongs to
|
|
|
|
*/
|
Merged revisions 693591,693639,693658,693939,693941,693947,693990,694050,694065,694153,694534,694615,694619-694620,694631,694643,694877,694881 via svnmerge from
https://svn.apache.org/repos/asf/poi/trunk
........
r693591 | josh | 2008-09-09 21:25:16 +0100 (Tue, 09 Sep 2008) | 1 line
Added support for parsing array constants in formulas. (Helping investigation for bug 45752)
........
r693639 | josh | 2008-09-09 23:26:28 +0100 (Tue, 09 Sep 2008) | 1 line
removed debug code accidentally submitted with r693591
........
r693658 | josh | 2008-09-10 00:46:46 +0100 (Wed, 10 Sep 2008) | 2 lines
Fixed special cases of INDEX function (single columns / single rows, and errors)
........
r693939 | josh | 2008-09-10 20:23:43 +0100 (Wed, 10 Sep 2008) | 1 line
Fixing error value handling for numeric functions. Refactored hierarchy.
........
r693941 | josh | 2008-09-10 20:27:24 +0100 (Wed, 10 Sep 2008) | 1 line
(Should have been submitted with 693939) Fixing error value handling for numeric functions. Refactored hierarchy.
........
r693947 | josh | 2008-09-10 20:33:58 +0100 (Wed, 10 Sep 2008) | 1 line
(Should have been submitted with 693939) Fixing error value handling for numeric functions. Refactored hierarchy.
........
r693990 | josh | 2008-09-10 22:21:28 +0100 (Wed, 10 Sep 2008) | 1 line
Refactored hierarchy of MultiOperandNumericFunction. Fixed error value handling. Enabled error value check in TestFormulasFromSpreadsheet
........
r694050 | josh | 2008-09-10 23:43:30 +0100 (Wed, 10 Sep 2008) | 1 line
Refactored finance functions.
........
r694065 | josh | 2008-09-11 00:37:22 +0100 (Thu, 11 Sep 2008) | 1 line
fixed special cases of MODE function
........
r694153 | josh | 2008-09-11 08:16:20 +0100 (Thu, 11 Sep 2008) | 1 line
Refactoring MultiOperandNumericFunction - removed Ref2DEval.
........
r694534 | josh | 2008-09-12 00:18:50 +0100 (Fri, 12 Sep 2008) | 1 line
Fix for bug 45639 - cleaned up index logic inside ColumnInfoRecordsAggregate
........
r694615 | josh | 2008-09-12 07:14:07 +0100 (Fri, 12 Sep 2008) | 1 line
small tweak to unit test which was silently creating UnknownPtgs
........
r694619 | josh | 2008-09-12 07:58:52 +0100 (Fri, 12 Sep 2008) | 1 line
Removed trailing comma from output of HexDump.toHex()
........
r694620 | josh | 2008-09-12 08:03:00 +0100 (Fri, 12 Sep 2008) | 1 line
clarification of ArrayPtg size increment
........
r694631 | josh | 2008-09-12 08:43:20 +0100 (Fri, 12 Sep 2008) | 1 line
Extended support for cached results of formula cells
........
r694643 | josh | 2008-09-12 09:18:54 +0100 (Fri, 12 Sep 2008) | 2 lines
Made HSSFFormulaEvaluator no longer require initialisation with sheet or row.
........
r694877 | josh | 2008-09-13 06:14:26 +0100 (Sat, 13 Sep 2008) | 1 line
Refactored TextFunctions. Some minor fixes - test cases added.
........
r694881 | josh | 2008-09-13 06:43:41 +0100 (Sat, 13 Sep 2008) | 1 line
Added toString methods formatAsString to CellValue. Changed deprecation on CellValue.getRichTextStringValue
........
git-svn-id: https://svn.apache.org/repos/asf/poi/branches/ooxml@694947 13f79535-47bb-0310-9956-ffa450edef68
2008-09-13 09:48:27 -04:00
|
|
|
Sheet getSheet();
|
|
|
|
|
2008-12-17 13:55:07 -05:00
|
|
|
/**
|
|
|
|
* Returns the Row this cell belongs to
|
|
|
|
*
|
|
|
|
* @return the Row that owns this cell
|
|
|
|
*/
|
|
|
|
Row getRow();
|
|
|
|
|
2008-01-16 11:08:22 -05:00
|
|
|
/**
|
2013-12-12 00:22:26 -05:00
|
|
|
* Set the cells type (numeric, formula or string).
|
2014-10-16 17:41:11 -04:00
|
|
|
* <p>If the cell currently contains a value, the value will
|
|
|
|
* be converted to match the new type, if possible. Formatting
|
|
|
|
* is generally lost in the process however.</p>
|
|
|
|
* <p>If what you want to do is get a String value for your
|
|
|
|
* numeric cell, <i>stop!</i>. This is not the way to do it.
|
|
|
|
* Instead, for fetching the string value of a numeric or boolean
|
|
|
|
* or date cell, use {@link DataFormatter} instead.</p>
|
2008-11-14 15:29:42 -05:00
|
|
|
*
|
|
|
|
* @throws IllegalArgumentException if the specified cell type is invalid
|
2013-12-12 00:22:26 -05:00
|
|
|
* @throws IllegalStateException if the current value cannot be converted to the new type
|
2016-07-04 06:15:18 -04:00
|
|
|
* @see CellType#NUMERIC
|
|
|
|
* @see CellType#STRING
|
|
|
|
* @see CellType#FORMULA
|
|
|
|
* @see CellType#BLANK
|
|
|
|
* @see CellType#BOOLEAN
|
|
|
|
* @see CellType#ERROR
|
2016-07-04 05:45:46 -04:00
|
|
|
* @deprecated POI 3.15 beta 3. Use {@link #setCellType(CellType)} instead.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
2016-08-22 14:25:45 -04:00
|
|
|
@Removal(version="4.0")
|
2008-01-16 11:08:22 -05:00
|
|
|
void setCellType(int cellType);
|
2016-07-04 05:45:46 -04:00
|
|
|
/**
|
|
|
|
* Set the cells type (numeric, formula or string).
|
|
|
|
* <p>If the cell currently contains a value, the value will
|
|
|
|
* be converted to match the new type, if possible. Formatting
|
|
|
|
* is generally lost in the process however.</p>
|
|
|
|
* <p>If what you want to do is get a String value for your
|
|
|
|
* numeric cell, <i>stop!</i>. This is not the way to do it.
|
|
|
|
* Instead, for fetching the string value of a numeric or boolean
|
|
|
|
* or date cell, use {@link DataFormatter} instead.</p>
|
|
|
|
*
|
|
|
|
* @throws IllegalArgumentException if the specified cell type is invalid
|
|
|
|
* @throws IllegalStateException if the current value cannot be converted to the new type
|
|
|
|
*/
|
|
|
|
void setCellType(CellType cellType);
|
2008-01-16 11:08:22 -05:00
|
|
|
|
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Return the cell type.
|
2016-07-04 07:54:20 -04:00
|
|
|
*
|
2016-08-22 14:25:45 -04:00
|
|
|
* Will return {@link CellType} in version 4.0 of POI.
|
2016-07-04 07:54:20 -04:00
|
|
|
* For forwards compatibility, do not hard-code cell type literals in your code.
|
2008-11-14 15:29:42 -05:00
|
|
|
*
|
|
|
|
* @return the cell type
|
2016-09-14 02:22:38 -04:00
|
|
|
* @deprecated POI 3.15. Will return a {@link CellType} enum in the future.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
2016-07-04 07:54:20 -04:00
|
|
|
int getCellType();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return the cell type.
|
|
|
|
*
|
|
|
|
* @return the cell type
|
2016-07-04 08:35:49 -04:00
|
|
|
* @since POI 3.15 beta 3
|
2016-07-04 07:54:20 -04:00
|
|
|
* @deprecated POI 3.15 beta 3
|
2016-08-22 14:25:45 -04:00
|
|
|
* Will be renamed to <code>getCellType()</code> when we make the CellType enum transition in POI 4.0. See bug 59791.
|
2016-07-04 07:54:20 -04:00
|
|
|
*/
|
2016-08-22 14:25:45 -04:00
|
|
|
@Removal(version="4.2")
|
2016-07-04 07:54:20 -04:00
|
|
|
CellType getCellTypeEnum();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Only valid for formula cells
|
|
|
|
*
|
|
|
|
* Will return {@link CellType} in a future version of POI.
|
|
|
|
* For forwards compatibility, do not hard-code cell type literals in your code.
|
|
|
|
*
|
|
|
|
* @return one of ({@link CellType#NUMERIC}, {@link CellType#STRING},
|
|
|
|
* {@link CellType#BOOLEAN}, {@link CellType#ERROR}) depending
|
|
|
|
* on the cached value of the formula
|
2016-09-14 02:22:38 -04:00
|
|
|
* @deprecated 3.15. Will return a {@link CellType} enum in the future.
|
2016-07-04 07:54:20 -04:00
|
|
|
*/
|
|
|
|
int getCachedFormulaResultType();
|
2009-02-19 12:29:55 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Only valid for formula cells
|
2016-07-04 05:45:46 -04:00
|
|
|
* @return one of ({@link CellType#NUMERIC}, {@link CellType#STRING},
|
|
|
|
* {@link CellType#BOOLEAN}, {@link CellType#ERROR}) depending
|
2009-02-19 12:29:55 -05:00
|
|
|
* on the cached value of the formula
|
2016-07-04 08:35:49 -04:00
|
|
|
* @since POI 3.15 beta 3
|
2016-07-04 07:54:20 -04:00
|
|
|
* @deprecated POI 3.15 beta 3
|
2016-08-22 14:25:45 -04:00
|
|
|
* Will be renamed to <code>getCachedFormulaResultType()</code> when we make the CellType enum transition in POI 4.0. See bug 59791.
|
2009-02-19 12:29:55 -05:00
|
|
|
*/
|
2016-07-04 07:54:20 -04:00
|
|
|
CellType getCachedFormulaResultTypeEnum();
|
2008-01-16 11:08:22 -05:00
|
|
|
|
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Set a numeric value for the cell
|
2008-01-16 11:08:22 -05:00
|
|
|
*
|
|
|
|
* @param value the numeric value to set this cell to. For formulas we'll set the
|
|
|
|
* precalculated value, for numerics we'll set its value. For other types we
|
|
|
|
* will change the cell to a numeric cell and set its value.
|
|
|
|
*/
|
|
|
|
void setCellValue(double value);
|
|
|
|
|
|
|
|
/**
|
2016-01-01 22:40:22 -05:00
|
|
|
* <p>Converts the supplied date to its equivalent Excel numeric value and sets
|
|
|
|
* that into the cell.</p>
|
|
|
|
*
|
|
|
|
* <p><b>Note</b> - There is actually no 'DATE' cell type in Excel. In many
|
2009-06-03 20:08:33 -04:00
|
|
|
* cases (when entering date values), Excel automatically adjusts the
|
|
|
|
* <i>cell style</i> to some date format, creating the illusion that the cell
|
2016-07-04 05:45:46 -04:00
|
|
|
* data type is now something besides {@link CellType#NUMERIC}. POI
|
2009-06-03 20:08:33 -04:00
|
|
|
* does not attempt to replicate this behaviour. To make a numeric cell
|
2016-01-01 22:40:22 -05:00
|
|
|
* display as a date, use {@link #setCellStyle(CellStyle)} etc.</p>
|
2009-11-27 16:01:59 -05:00
|
|
|
*
|
2009-06-03 20:08:33 -04:00
|
|
|
* @param value the numeric value to set this cell to. For formulas we'll set the
|
|
|
|
* precalculated value, for numerics we'll set its value. For other types we
|
|
|
|
* will change the cell to a numerics cell and set its value.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
|
|
|
void setCellValue(Date value);
|
|
|
|
|
|
|
|
/**
|
2016-01-01 22:40:22 -05:00
|
|
|
* <p>Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as
|
|
|
|
* a date.</p>
|
2008-11-14 15:29:42 -05:00
|
|
|
* <p>
|
|
|
|
* This will set the cell value based on the Calendar's timezone. As Excel
|
|
|
|
* does not support timezones this means that both 20:00+03:00 and
|
|
|
|
* 20:00-03:00 will be reported as the same value (20:00) even that there
|
|
|
|
* are 6 hours difference between the two times. This difference can be
|
|
|
|
* preserved by using <code>setCellValue(value.getTime())</code> which will
|
|
|
|
* automatically shift the times to the default timezone.
|
|
|
|
* </p>
|
2008-01-16 11:08:22 -05:00
|
|
|
*
|
|
|
|
* @param value the date value to set this cell to. For formulas we'll set the
|
|
|
|
* precalculated value, for numerics we'll set its value. For othertypes we
|
|
|
|
* will change the cell to a numeric cell and set its value.
|
|
|
|
*/
|
|
|
|
void setCellValue(Calendar value);
|
|
|
|
|
|
|
|
/**
|
2008-11-14 06:56:41 -05:00
|
|
|
* Set a rich string value for the cell.
|
2008-01-16 11:08:22 -05:00
|
|
|
*
|
|
|
|
* @param value value to set the cell to. For formulas we'll set the formula
|
|
|
|
* string, for String cells we'll set its value. For other types we will
|
|
|
|
* change the cell to a string cell and set its value.
|
|
|
|
* If value is null then we will change the cell to a Blank cell.
|
|
|
|
*/
|
|
|
|
void setCellValue(RichTextString value);
|
|
|
|
|
2008-11-14 06:56:41 -05:00
|
|
|
/**
|
|
|
|
* Set a string value for the cell.
|
|
|
|
*
|
|
|
|
* @param value value to set the cell to. For formulas we'll set the formula
|
|
|
|
* string, for String cells we'll set its value. For other types we will
|
|
|
|
* change the cell to a string cell and set its value.
|
|
|
|
* If value is null then we will change the cell to a Blank cell.
|
|
|
|
*/
|
2008-09-18 03:42:40 -04:00
|
|
|
void setCellValue(String value);
|
|
|
|
|
2009-11-27 16:01:59 -05:00
|
|
|
|
2008-11-14 06:56:41 -05:00
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Sets formula for this cell.
|
|
|
|
* <p>
|
|
|
|
* Note, this method only sets the formula string and does not calculate the formula value.
|
|
|
|
* To set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)}
|
|
|
|
* </p>
|
|
|
|
*
|
2009-11-27 16:01:59 -05:00
|
|
|
* @param formula the formula to set, e.g. <code>"SUM(C4:E4)"</code>.
|
2008-11-14 15:29:42 -05:00
|
|
|
* If the argument is <code>null</code> then the current formula is removed.
|
2009-11-27 16:01:59 -05:00
|
|
|
* @throws FormulaParseException if the formula has incorrect syntax or is otherwise invalid
|
2008-11-14 06:56:41 -05:00
|
|
|
*/
|
2009-11-27 16:01:59 -05:00
|
|
|
void setCellFormula(String formula) throws FormulaParseException;
|
2008-01-16 11:08:22 -05:00
|
|
|
|
2008-11-14 06:56:41 -05:00
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Return a formula for the cell, for example, <code>SUM(C4:E4)</code>
|
|
|
|
*
|
|
|
|
* @return a formula for the cell
|
2016-07-04 07:54:20 -04:00
|
|
|
* @throws IllegalStateException if the cell type returned by {@link #getCellTypeEnum()} is not {@link CellType#FORMULA}
|
2008-11-14 06:56:41 -05:00
|
|
|
*/
|
2008-01-16 11:08:22 -05:00
|
|
|
String getCellFormula();
|
|
|
|
|
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Get the value of the cell as a number.
|
|
|
|
* <p>
|
|
|
|
* For strings we throw an exception. For blank cells we return a 0.
|
|
|
|
* For formulas or error cells we return the precalculated value;
|
|
|
|
* </p>
|
|
|
|
* @return the value of the cell as a number
|
2016-07-04 07:54:20 -04:00
|
|
|
* @throws IllegalStateException if the cell type returned by {@link #getCellTypeEnum()} is {@link CellType#STRING}
|
2008-11-14 15:29:42 -05:00
|
|
|
* @exception NumberFormatException if the cell value isn't a parsable <code>double</code>.
|
|
|
|
* @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
|
|
|
double getNumericCellValue();
|
|
|
|
|
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Get the value of the cell as a date.
|
|
|
|
* <p>
|
|
|
|
* For strings we throw an exception. For blank cells we return a null.
|
|
|
|
* </p>
|
|
|
|
* @return the value of the cell as a date
|
2016-07-04 07:54:20 -04:00
|
|
|
* @throws IllegalStateException if the cell type returned by {@link #getCellTypeEnum()} is {@link CellType#STRING}
|
2008-11-14 15:29:42 -05:00
|
|
|
* @exception NumberFormatException if the cell value isn't a parsable <code>double</code>.
|
|
|
|
* @see DataFormatter for formatting this date into a string similar to how excel does.
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
|
|
|
Date getDateCellValue();
|
|
|
|
|
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Get the value of the cell as a XSSFRichTextString
|
|
|
|
* <p>
|
|
|
|
* For numeric cells we throw an exception. For blank cells we return an empty string.
|
2010-06-04 11:58:02 -04:00
|
|
|
* For formula cells we return the pre-calculated value if a string, otherwise an exception.
|
2008-11-14 15:29:42 -05:00
|
|
|
* </p>
|
|
|
|
* @return the value of the cell as a XSSFRichTextString
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
|
|
|
RichTextString getRichStringCellValue();
|
|
|
|
|
2008-11-11 06:43:20 -05:00
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Get the value of the cell as a string
|
2008-11-11 06:43:20 -05:00
|
|
|
* <p>
|
2008-11-14 15:29:42 -05:00
|
|
|
* For numeric cells we throw an exception. For blank cells we return an empty string.
|
2010-06-04 11:58:02 -04:00
|
|
|
* For formulaCells that are not string Formulas, we throw an exception.
|
2008-11-11 06:43:20 -05:00
|
|
|
* </p>
|
2008-11-14 15:29:42 -05:00
|
|
|
* @return the value of the cell as a string
|
2008-11-11 06:43:20 -05:00
|
|
|
*/
|
|
|
|
String getStringCellValue();
|
|
|
|
|
2008-01-16 11:08:22 -05:00
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Set a boolean value for the cell
|
2008-01-16 11:08:22 -05:00
|
|
|
*
|
|
|
|
* @param value the boolean value to set this cell to. For formulas we'll set the
|
|
|
|
* precalculated value, for booleans we'll set its value. For other types we
|
|
|
|
* will change the cell to a boolean cell and set its value.
|
|
|
|
*/
|
2008-11-14 15:29:42 -05:00
|
|
|
void setCellValue(boolean value);
|
2008-01-16 11:08:22 -05:00
|
|
|
|
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Set a error value for the cell
|
2008-01-16 11:08:22 -05:00
|
|
|
*
|
|
|
|
* @param value the error value to set this cell to. For formulas we'll set the
|
2008-11-14 15:29:42 -05:00
|
|
|
* precalculated value , for errors we'll set
|
2008-01-16 11:08:22 -05:00
|
|
|
* its value. For other types we will change the cell to an error
|
|
|
|
* cell and set its value.
|
2008-11-14 15:29:42 -05:00
|
|
|
* @see FormulaError
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
|
|
|
void setCellErrorValue(byte value);
|
|
|
|
|
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Get the value of the cell as a boolean.
|
|
|
|
* <p>
|
|
|
|
* For strings, numbers, and errors, we throw an exception. For blank cells we return a false.
|
|
|
|
* </p>
|
|
|
|
* @return the value of the cell as a boolean
|
2016-07-04 07:54:20 -04:00
|
|
|
* @throws IllegalStateException if the cell type returned by {@link #getCellTypeEnum()}
|
2016-07-04 05:45:46 -04:00
|
|
|
* is not {@link CellType#BOOLEAN}, {@link CellType#BLANK} or {@link CellType#FORMULA}
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
|
|
|
boolean getBooleanCellValue();
|
|
|
|
|
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Get the value of the cell as an error code.
|
|
|
|
* <p>
|
|
|
|
* For strings, numbers, and booleans, we throw an exception.
|
2008-01-16 11:08:22 -05:00
|
|
|
* For blank cells we return a 0.
|
2008-11-14 15:29:42 -05:00
|
|
|
* </p>
|
|
|
|
*
|
|
|
|
* @return the value of the cell as an error code
|
2016-07-04 07:54:20 -04:00
|
|
|
* @throws IllegalStateException if the cell type returned by {@link #getCellTypeEnum()} isn't {@link CellType#ERROR}
|
2008-11-14 15:29:42 -05:00
|
|
|
* @see FormulaError for error codes
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
|
|
|
byte getErrorCellValue();
|
|
|
|
|
|
|
|
/**
|
2016-07-04 05:45:46 -04:00
|
|
|
* <p>Set the style for the cell. The style should be an CellStyle created/retrieved from
|
2016-01-01 23:29:34 -05:00
|
|
|
* the Workbook.</p>
|
|
|
|
*
|
|
|
|
* <p>To change the style of a cell without affecting other cells that use the same style,
|
2016-01-02 01:23:05 -05:00
|
|
|
* use {@link org.apache.poi.ss.util.CellUtil#setCellStyleProperties(Cell, Map)}</p>
|
2008-01-16 11:08:22 -05:00
|
|
|
*
|
2008-11-14 15:29:42 -05:00
|
|
|
* @param style reference contained in the workbook.
|
|
|
|
* If the value is null then the style information is removed causing the cell to used the default workbook style.
|
|
|
|
* @see org.apache.poi.ss.usermodel.Workbook#createCellStyle()
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
|
|
|
void setCellStyle(CellStyle style);
|
|
|
|
|
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* Return the cell's style.
|
|
|
|
*
|
|
|
|
* @return the cell's style. Always not-null. Default cell style has zero index and can be obtained as
|
|
|
|
* <code>workbook.getCellStyleAt(0)</code>
|
2015-12-28 21:57:58 -05:00
|
|
|
* @see Workbook#getCellStyleAt(int)
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
|
|
|
CellStyle getCellStyle();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets this cell as the active cell for the worksheet
|
|
|
|
*/
|
|
|
|
void setAsActiveCell();
|
|
|
|
|
2015-12-04 01:36:27 -05:00
|
|
|
/**
|
|
|
|
* Gets the address of this cell
|
|
|
|
*
|
|
|
|
* @return <code>A1</code> style address of this cell
|
2015-12-04 02:20:36 -05:00
|
|
|
* @since 3.14beta1
|
2015-12-04 01:36:27 -05:00
|
|
|
*/
|
|
|
|
CellAddress getAddress();
|
|
|
|
|
2008-01-16 11:08:22 -05:00
|
|
|
/**
|
|
|
|
* Assign a comment to this cell
|
|
|
|
*
|
|
|
|
* @param comment comment associated with this cell
|
|
|
|
*/
|
|
|
|
void setCellComment(Comment comment);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns comment associated with this cell
|
|
|
|
*
|
2008-11-14 15:29:42 -05:00
|
|
|
* @return comment associated with this cell or <code>null</code> if not found
|
2008-01-16 11:08:22 -05:00
|
|
|
*/
|
|
|
|
Comment getCellComment();
|
|
|
|
|
2009-11-27 12:39:17 -05:00
|
|
|
/**
|
|
|
|
* Removes the comment for this cell, if there is one.
|
|
|
|
*/
|
|
|
|
void removeCellComment();
|
|
|
|
|
2008-04-05 17:43:53 -04:00
|
|
|
/**
|
2008-11-14 15:29:42 -05:00
|
|
|
* @return hyperlink associated with this cell or <code>null</code> if not found
|
2008-04-05 17:43:53 -04:00
|
|
|
*/
|
2008-10-23 14:57:28 -04:00
|
|
|
Hyperlink getHyperlink();
|
2008-04-05 17:43:53 -04:00
|
|
|
|
|
|
|
/**
|
2009-12-25 18:04:04 -05:00
|
|
|
* Assign a hyperlink to this cell
|
2008-04-05 17:43:53 -04:00
|
|
|
*
|
2009-12-25 18:04:04 -05:00
|
|
|
* @param link hyperlink associated with this cell
|
2008-04-05 17:43:53 -04:00
|
|
|
*/
|
2008-10-23 14:57:28 -04:00
|
|
|
void setHyperlink(Hyperlink link);
|
2009-12-25 10:15:55 -05:00
|
|
|
|
2014-11-08 08:46:30 -05:00
|
|
|
/**
|
|
|
|
* Removes the hyperlink for this cell, if there is one.
|
|
|
|
*/
|
|
|
|
void removeHyperlink();
|
|
|
|
|
2009-12-25 10:15:55 -05:00
|
|
|
/**
|
|
|
|
* Only valid for array formula cells
|
|
|
|
*
|
|
|
|
* @return range of the array formula group that the cell belongs to.
|
|
|
|
*/
|
|
|
|
CellRangeAddress getArrayFormulaRange();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return <code>true</code> if this cell is part of group of cells having a common array formula.
|
|
|
|
*/
|
|
|
|
boolean isPartOfArrayFormulaGroup();
|
Merged revisions 638786-638802,638805-638811,638813-638814,638816-639230,639233-639241,639243-639253,639255-639486,639488-639601,639603-639835,639837-639917,639919-640056,640058-640710,640712-641156,641158-641184,641186-641795,641797-641798,641800-641933,641935-641963,641965-641966,641968-641995,641997-642230,642232-642562,642564-642565,642568-642570,642572-642573,642576-642736,642739-642877,642879,642881-642890,642892-642903,642905-642945,642947-643624,643626-643653,643655-643669,643671,643673-643830,643832-643833,643835-644342,644344-644472,644474-644508,644510-645347,645349-645351,645353-645559,645561-645565,645568-645951,645953-646193,646195-646311,646313-646404,646406-646665,646667-646853,646855-646869,646871-647151,647153-647185,647187-647277,647279-647566,647568-647573,647575,647578-647711,647714-647737,647739-647823,647825-648155,648157-648202,648204-648273,648275,648277-648302,648304-648333,648335-648588,648590-648622,648625-648673,648675-649141,649144,649146-649556,649558-649795,649799,649801-649910,649912-649913,649915-650128,650131-650132,650134-650137,650140-650914,650916-651991,651993-652284,652286-652287,652289,652291,652293-652297,652299-652328,652330-652425,652427-652445,652447-652560,652562-652933,652935,652937-652993,652995-653116,653118-653124,653126-653483,653487-653519,653522-653550,653552-653607,653609-653667,653669-653674,653676-653814,653817-653830,653832-653891,653893-653944,653946-654055,654057-654355,654357-654365,654367-654648,654651-655215,655217-655277,655279-655281,655283-655911,655913-656212,656214,656216-656251,656253-656698,656700-656756,656758-656892,656894-657135,657137-657165,657168-657179,657181-657354,657356-657357,657359-657701,657703-657874,657876-658032,658034-658284,658286,658288-658301,658303-658307,658309-658321,658323-658335,658337-658348,658351,658353-658832,658834-658983,658985,658987-659066,659068-659402,659404-659428,659430-659451,659453-659454,659456-659461,659463-659477,659479-659524,659526-659571,659574,659576-660255,660257-660262,660264-660279,660281-660343,660345-660473,660475-660827,660829-660833,660835-660888,660890-663321,663323-663435,663437-663764,663766-663854,663856-664219,664221-664489,664494-664514,664516-668013,668015-668142,668144-668152,668154,668156-668256,668258,668260-669139,669141-669455,669457-669657,669659-669808,669810-670189,670191-671321,671323-672229,672231-672549,672551-672552,672554-672561,672563-672566,672568,672571-673049,673051-673852,673854-673862,673864-673986,673988-673996,673998-674347,674349-674890,674892-674910,674912-674936,674938-674952,674954-675078,675080-675085,675087-675217,675219-675660,675662-675670,675672-675716,675718-675726,675728-675733,675735-675775,675777-675782,675784,675786-675791,675794-675852,675854-676200,676202,676204,676206-676220,676222-676309,676311-676456,676458-676994,676996-677027,677030-677040,677042-677056,677058-677375,677377-677968,677970-677971,677973,677975-677994,677996-678286,678288-678538,678540-680393,680395-680469,680471-680529,680531-680852,680854-681529,681531-681571,681573-682224,682226,682228,682231-682281,682283-682335,682337-682507,682509,682512-682517,682519-682532,682534-682619,682622-682777,682779-682998,683000-683019,683021-683022,683024-683080,683082-683092,683094-683095,683097-683127,683129-683131,683133-683166,683168-683698,683700-683705,683707-683757,683759-683787,683789-683870,683872-683879,683881-683900,683902-684066,684068-684074,684076-684222,684224-684254,684257-684370 via svnmerge from
https://svn.apache.org/repos/asf/poi/trunk
........
r684282 | nick | 2008-08-09 16:58:24 +0100 (Sat, 09 Aug 2008) | 1 line
Prepare to change how we do ranges, to handle different kinds of text in the cp area
........
r684287 | nick | 2008-08-09 17:24:20 +0100 (Sat, 09 Aug 2008) | 1 line
Start to document the whole FIB stuff better
........
r684293 | nick | 2008-08-09 17:46:39 +0100 (Sat, 09 Aug 2008) | 1 line
Add lots more getters/setters for useful things to the FIB
........
r684299 | nick | 2008-08-09 18:23:42 +0100 (Sat, 09 Aug 2008) | 1 line
More tests to show that the range based stuff is working properly
........
r684302 | nick | 2008-08-09 18:33:29 +0100 (Sat, 09 Aug 2008) | 1 line
More header and footer files, this time with unicode in it too
........
r684309 | nick | 2008-08-09 18:58:35 +0100 (Sat, 09 Aug 2008) | 1 line
More range tests, which show that we do have a bug in the hwpf unicode support
........
r684318 | josh | 2008-08-09 20:29:23 +0100 (Sat, 09 Aug 2008) | 1 line
Converted rows map within HSSFSheet to use Integer keys
........
r684319 | nick | 2008-08-09 20:34:38 +0100 (Sat, 09 Aug 2008) | 1 line
Big big unicode rationalisation in text piece code
........
r684321 | josh | 2008-08-09 20:47:39 +0100 (Sat, 09 Aug 2008) | 1 line
added getRowIndex() to HSSFCell, deprecated HSSFFormulaEvaluator.setCurrentRow()
........
r684322 | nick | 2008-08-09 20:56:37 +0100 (Sat, 09 Aug 2008) | 1 line
Get most of the hwpf tests passing again
........
r684336 | nick | 2008-08-09 21:31:48 +0100 (Sat, 09 Aug 2008) | 1 line
Improve FIB updating on range changes, and add passing tests for non unicode paragraph properties
........
r684349 | nick | 2008-08-09 22:31:28 +0100 (Sat, 09 Aug 2008) | 1 line
Start on headers/footers support
........
r684355 | nick | 2008-08-09 22:46:14 +0100 (Sat, 09 Aug 2008) | 1 line
Tests to show that header stuff all works right
........
r684362 | nick | 2008-08-09 23:08:34 +0100 (Sat, 09 Aug 2008) | 1 line
Add header/footer support to HWPF WordExtractor
........
r684370 | nick | 2008-08-09 23:24:47 +0100 (Sat, 09 Aug 2008) | 1 line
Disable a few HWPF tests that aren't working while the unicode/paragraph bug is outstanding
........
git-svn-id: https://svn.apache.org/repos/asf/poi/branches/ooxml@684374 13f79535-47bb-0310-9956-ffa450edef68
2008-08-09 18:55:33 -04:00
|
|
|
}
|