| Package | Description |
|---|---|
| org.apache.poi | |
| org.apache.poi.ddf |
This package contains classes for decoding the Microsoft Office Drawing format otherwise
known as escher henceforth known in POI as the Dreadful Drawing Format.
|
| org.apache.poi.hpsf |
Processes streams in the Horrible Property Set Format (HPSF) in POI filesystems.
|
| org.apache.poi.hssf.model |
Provides low level API structures for reading, writing, modifying XLS files.
|
| org.apache.poi.hssf.record |
Record package contains class representations for XLS binary strutures.
|
| org.apache.poi.hssf.record.common | |
| org.apache.poi.hssf.record.crypto | |
| org.apache.poi.hssf.usermodel |
The usermodel package maps HSSF low level structures to familiar workbook/sheet model
|
| org.apache.poi.hssf.usermodel.helpers | |
| org.apache.poi.poifs.crypt |
Implementation of the ECMA-376 and MS-propritary document encryptions
|
| org.apache.poi.poifs.filesystem |
filesystem package maps OLE 2 Compound document files to a more familiar filesystem interface.
|
| org.apache.poi.sl.draw | |
| org.apache.poi.sl.draw.geom | |
| org.apache.poi.sl.extractor | |
| org.apache.poi.sl.image | |
| org.apache.poi.sl.usermodel | |
| org.apache.poi.ss.format |
This package contains classes that implement cell formatting
|
| org.apache.poi.ss.formula |
This package contains common internal POI code for manipulating formulas.
|
| org.apache.poi.ss.formula.functions | |
| org.apache.poi.ss.formula.udf | |
| org.apache.poi.ss.usermodel | |
| org.apache.poi.ss.usermodel.helpers | |
| org.apache.poi.ss.util | |
| org.apache.poi.util |
Top-level util package are classes that are useful throughout the project.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
POIDocument.clearDirectory()
Clear/unlink the attached directory entry
|
DirectoryNode |
POIDocument.getDirectory() |
protected boolean |
POIDocument.initDirectory()
check if we were created by POIFS otherwise create a new dummy POIFS
for storing the package data
|
void |
POIDocument.readProperties()
Find, and create objects for, the standard
Document Information Properties (HPSF).
|
void |
POIDocument.readProperties(boolean warnIfNull)
Find, and create objects for, the standard Document Information Properties (HPSF).
|
protected void |
POIDocument.replaceDirectory(DirectoryNode newDirectory)
Replaces the attached directory, e.g.
|
void |
POIDocument.writeProperties(POIFSFileSystem outFS)
Writes out the standard Document Information Properties (HPSF)
|
| Modifier and Type | Class and Description |
|---|---|
class |
EscherPropertyTypesHolder |
| Modifier and Type | Method and Description |
|---|---|
short |
EscherOptRecord.getOptions()
Automatically recalculate the correct option
|
short |
EscherRecord.getOptions()
Note that
options is an internal field. |
void |
EscherRecord.setOptions(short options)
Set the options this record.
|
| Constructor and Description |
|---|
EscherArrayProperty(short id,
int complexSize)
Create an instance of an escher array property.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Array |
class |
Blob |
class |
ClipboardData |
class |
CodePageString |
class |
Currency |
class |
Date |
class |
Decimal |
class |
Filetime
The Windows FILETIME structure holds a date and time associated with a
file.
|
class |
GUID |
class |
IndirectPropertyName |
class |
TypedPropertyValue |
class |
UnicodeString |
class |
VariantBool |
class |
Vector
Holder for vector-type properties
|
class |
VersionedStream |
| Modifier and Type | Class and Description |
|---|---|
class |
HSSFFormulaParser
HSSF wrapper for the
FormulaParser and FormulaRenderer |
class |
InternalSheet
Low level model implementation of a Sheet (one workbook contains many sheets)
This file contains the low level binary records starting at the sheets BOF and
ending with the sheets EOF.
|
class |
InternalWorkbook
Low level model implementation of a Workbook.
|
| Modifier and Type | Method and Description |
|---|---|
WorkbookRecordList |
InternalWorkbook.getWorkbookRecordList()
Only for internal calls - code based on this is not supported ...
|
| Modifier and Type | Class and Description |
|---|---|
class |
FormulaSpecialCachedValue
Manages the cached formula result values of other types besides numeric.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
RecordInputStream.isEncrypted() |
void |
RecordInputStream.mark(int readlimit)
Mark the stream position - experimental function
|
void |
RecordInputStream.reset()
Resets the stream position to the previously marked position.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ExtRst |
class |
FormatRun |
class |
PhRun |
| Modifier and Type | Method and Description |
|---|---|
boolean |
Biff8DecryptingStream.isCurrentRecordEncrypted() |
| Modifier and Type | Class and Description |
|---|---|
class |
HSSFEvaluationWorkbook
Internal POI use only
|
class |
HSSFWorkbookFactory
Helper class which is instantiated by reflection from
WorkbookFactory.create(java.io.File) and similar |
| Modifier and Type | Method and Description |
|---|---|
void |
HSSFPatriarch.addShape(HSSFShape shape)
add a shape to this drawing
|
EscherAggregate |
HSSFPatriarch.getBoundAggregate()
Returns the aggregate escher record we're bound to
|
InternalWorkbook |
HSSFWorkbook.getInternalWorkbook() |
InternalSheet |
HSSFSheet.getSheet()
used internally in the API to get the low level Sheet record represented by this
Object.
|
InternalWorkbook |
HSSFWorkbook.getWorkbook() |
| Constructor and Description |
|---|
HSSFHyperlink(HyperlinkType type)
Construct a new hyperlink
This method is internal to be used only by
HSSFCreationHelper.createHyperlink(HyperlinkType). |
| Modifier and Type | Method and Description |
|---|---|
void |
HSSFRowShifter.updateRowFormulas(HSSFRow row,
FormulaShifter formulaShifter)
Update the formulas in specified row using the formula shifting policy specified by shifter
|
| Modifier and Type | Class and Description |
|---|---|
class |
ChunkedCipherInputStream |
class |
ChunkedCipherOutputStream |
class |
CryptoFunctions
Helper functions used for standard and agile encryption
|
| Modifier and Type | Method and Description |
|---|---|
protected Cipher |
ChunkedCipherOutputStream.initCipherForBlockNoFlush(Cipher existing,
int block,
boolean lastChunk) |
| Modifier and Type | Class and Description |
|---|---|
class |
DocumentFactoryHelper
A small base class for the various factories, e.g.
|
class |
EntryUtils |
| Modifier and Type | Method and Description |
|---|---|
static void |
EntryUtils.copyNodeRecursively(Entry entry,
DirectoryEntry target)
Copies an Entry into a target POIFS directory, recursively
|
HeaderBlock |
POIFSFileSystem.getHeaderBlock() |
PropertyTable |
POIFSFileSystem.getPropertyTable() |
| Modifier and Type | Class and Description |
|---|---|
interface |
DrawNotImplemented
This is a marker annotation for classes which don't have a defined
draw implementation.
|
class |
DrawTexturePaint |
class |
PathGradientPaint |
| Modifier and Type | Field and Description |
|---|---|
static int |
DrawTableShape.borderSize
Additional spacing between cells
|
static Drawable.DrawableHint |
Drawable.GROUP_TRANSFORM
Key will be internally used to store affine transformation temporarily within group shapes
|
| Modifier and Type | Method and Description |
|---|---|
String |
DrawTextParagraph.getRenderableText(TextRun tr) |
| Modifier and Type | Method and Description |
|---|---|
static double |
ArcToCommand.convertOoxml2AwtAngle(double ooAngle,
double width,
double height)
Arc2D angles are skewed, OOXML aren't ...
|
| Modifier and Type | Method and Description |
|---|---|
com.zaxxer.sparsebits.SparseBitSet |
SlideShowExtractor.getCodepointsInSparseBitSet(String typeface,
Boolean italic,
Boolean bold)
Extract the used codepoints for font embedding / subsetting.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ImageHeaderBitmap |
class |
ImageHeaderEMF |
class |
ImageHeaderPICT |
class |
ImageHeaderWMF
Aldus Placeable Metafile header - 22 byte structure before WMF data.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractColorStyle
Helper class for ColorStyle - not part of the API / implementation may change any time
|
interface |
Line<S extends Shape<S,P>,P extends TextParagraph<S,P,? extends TextRun>>
Interface for Lines ...
|
interface |
MetroShapeProvider
Experimental provider / loader for metro shapes.
|
| Modifier and Type | Method and Description |
|---|---|
TextRun.FieldType |
TextRun.getFieldType()
Experimental method to determine the field type, e.g.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CellNumberPartHandler
Internal helper class for CellNumberFormatter
|
class |
CellNumberStringMod
Internal helper class for CellNumberFormatter
This class represents a single modification to a result string.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CollaboratingWorkbooksEnvironment
Manages a collection of
WorkbookEvaluators, in order to support
evaluation of formulas across spreadsheets. |
interface |
EvaluationCell
Abstracts a cell for the purpose of formula evaluation.
|
interface |
EvaluationName
Abstracts a name record for formula evaluation.
|
interface |
EvaluationSheet
Abstracts a sheet for the purpose of formula evaluation.
|
interface |
EvaluationWorkbook
Abstracts a workbook for the purpose of formula evaluation.
|
class |
FormulaParser
This class parses a formula string into a List of tokens in RPN order.
|
class |
FormulaRenderer
Common logic for rendering formulas.
|
interface |
FormulaRenderingWorkbook
Abstracts a workbook for the purpose of converting formula to text.
|
class |
FormulaType
Enumeration of various formula types.
|
interface |
WorkbookDependentFormula
Should be implemented by any
Ptg subclass that needs a workbook to render its formula. |
class |
WorkbookEvaluator
Evaluates formula cells.
|
interface |
WorkbookEvaluatorProvider
Provides access to a
WorkbookEvaluator, eg for use with
CollaboratingWorkbooksEnvironment |
| Modifier and Type | Class and Description |
|---|---|
class |
DStarRunner
This class performs a D* calculation.
|
class |
LookupUtils
Common functionality used by VLOOKUP, HLOOKUP, LOOKUP and MATCH
|
| Modifier and Type | Method and Description |
|---|---|
static List<ValueEval> |
PercentRank.getValues(ValueEval eval,
int srcRowIndex,
int srcColumnIndex) |
static NumberEval |
PercentRank.interpolate(double x,
double closestMatchBelow,
double closestMatchAbove,
NumberEval belowRank,
NumberEval aboveRank,
int significance) |
static double |
PercentRank.round(BigDecimal bd,
int significance) |
| Modifier and Type | Class and Description |
|---|---|
class |
IndexedUDFFinder
A UDFFinder that can retrieve functions both by name and by fake index.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
Date1904Support |
| Modifier and Type | Method and Description |
|---|---|
static ClientAnchor.AnchorType |
ClientAnchor.AnchorType.byId(int value)
return the AnchorType corresponding to the code
|
| Modifier and Type | Class and Description |
|---|---|
class |
BaseRowColShifter
Class for code common to
RowShifter and ColumnShifter
Helper for shifting rows up or down and columns left and right |
| Modifier and Type | Class and Description |
|---|---|
class |
SSCellRange<K extends Cell>
For POI internal use only
|
| Modifier and Type | Method and Description |
|---|---|
static int |
SheetUtil.getDefaultCharWidth(Workbook wb)
Deprecated.
since POI 5.2.5, it is recommended to switch to
SheetUtil.getDefaultCharWidthAsFloat(Workbook). |
static float |
SheetUtil.getDefaultCharWidthAsFloat(Workbook wb)
Get default character width using the Workbook's default font.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ArrayUtil
Utility classes for dealing with arrays.
|
class |
BitField
Manage operations dealing with bit-mapped fields.
|
class |
CodepointsUtil |
class |
GenericRecordUtil |
class |
HexDump
dump data in hexadecimal format
|
class |
IOUtils |
class |
LittleEndian
a utility class for handling little-endian numbers, which the 80x86 world is
replete with.
|
class |
ReplacingInputStream
Simple FilterInputStream that can replace occurrences of bytes with something else.
|
class |
StringUtil
Collection of string handling utilities
|
class |
XMLHelper
Helper methods for working with javax.xml classes.
|
| Modifier and Type | Method and Description |
|---|---|
static boolean |
StringUtil.isUpperCase(char c) |
static String |
StringUtil.join(Object[] array) |
static String |
StringUtil.join(Object[] array,
String separator) |
static String |
StringUtil.join(String separator,
Object... array) |
static void |
ThreadLocalUtil.registerCleaner(Runnable cleaner)
Intended for internal use only so other modules of Apache POi
can add cleaners.
|
static String |
StringUtil.toLowerCase(char c) |
static String |
StringUtil.toUpperCase(char c) |