All Classes and Interfaces
Class
Description
Abstract class for use with the HSSFRequest and HSSFEventFactory, which
allows for the halting of processing.
Helper class for ColorStyle - not part of the API / implementation may change any time
The escher container record is used to hold escher records.
Common abstract class for
EscherOptRecord and
EscherTertiaryOptRecordCommon class for
ExcelToFoConverter and ExcelToHtmlConverterThis class provides the base functionality for Excel sheet functions
There are two kinds of function Ptgs - tFunc and tFuncVar
Therefore, this class will have ONLY two subclasses
Represents an ActiveX control in a PowerPoint document.
Addition operator PTG the "+" binomial operator.
Creates a text reference as text, given specified row and column numbers.
Java class for CT_AdjPoint2D complex type.
Represents a shape adjust values (see section 20.1.9.5 in the spec)
An example
ZipEntrySource that has encrypted temp files to ensure that
sensitive data is not stored in raw format on disk.Collects add-in libraries and VB macro functions together into one UDF finder
Decryptor implementation for Agile Encryption
Used when checking if a key is valid for a document
Analysis Toolpack Function Definitions
A container record that specifies information about animation information for a shape.
An atom record that specifies the animation information for a shape.
ArcTo command within a shape path in DrawingML:
<arcTo wR="wr" hR="hr" stAng="stAng" swAng="swAng"/>Common superclass of 2-D area refs
Area 3D Ptg - 3D reference (Sheet + Area)
XSSF Area 3D Reference (Sheet + Area)
AreaErr - handles deleted cell area references.
Evaluation of 2D (Row+Column) and 3D (Sheet+Row+Column) areas
The area format record is used to define the colours and patterns for an area.
Common interface for AreaPtg and Area3DPtg, and their child classes.
Specifies a rectangular area of cells A1:A4 for instance.
Specifies a rectangular area of cells A1:A4 for instance.
Specifies a rectangular area of cells A1:A4 for instance.
The area record is used to define an area chart.
Returns the number of areas in a reference.
Common Interface for any excel built-in function that has implemented array formula functionality.
Interface for those functions that evaluate arguments in array mode depending on context.
ArrayPtg - handles arrays
The ArrayPtg is a little weird, the size of the Ptg when parsing initially only
includes the Ptg sid and the reserved bytes.
ARRAY (0x0221)
Utility classes for dealing with arrays.
An attachment within a
HMEFMessage.Collection of convenience chunks for standard parts of the MSG file
attachment.
Orders by the attachment number.
"Special Attributes"
Represents autofiltering for the specified worksheet.
The AutoFilterInfo record specifies the number of columns that have AutoFilter enabled
and indicates the beginning of the collection of AutoFilter records.
Handler for singular AverageIf which has different operand handling than
the generic AverageIfs version.
Implementation for the Excel function AVERAGEIFS
The axis line format record defines the axis type details.
The axis options record provides unit information and other various tidbits about the axis.
The axis size and location
The axis record defines the type of an axis.
The number of axes used on a chart.
Boolean specifying whether the GUI should store a backup of the file.
The bar record is used to define a bar chart.
Common functionality across file formats for evaluating formula cells.
Some utils for converting from and to any base
Class for code common to
RowShifter and ColumnShifter
Helper for shifting rows up or down and columns left and rightInternal POI use only - parent of XSSF and SXSSF evaluation workbooks
Internal POI use only - parent of XSSF and SXSSF formula evaluators
A block of block allocation table entries.
This interface defines behaviors for objects managed by the Block
Allocation Table (BAT).
The begin record defines the start of a block of records for a (graphing
data object.
Implementation for Excel BESSELJ() function.
Signifies that a public API (public class, method or field) is subject to
incompatible changes, or even removal, in a future release.
Implementation for Excel Bin2Dec() function.
If we come across a record we know has children of (potential)
interest, but where the record itself is boring, but where other
records may care about where this one lives, we create one
of these.
Manage operations dealing with bit-mapped fields.
Returns immutable Bitfield instances.
Represents a bitmap picture data: JPEG or PNG.
For now this class renders only images supported by the javax.imageio.ImageIO framework.
Definition of a special kind of property of some text, or its
paragraph.
BooKmark First descriptor (BKF).
This class is a marker class.
Represents a column in a row with no value but with styling.
This abstract class describes a way to read, store, chain
and free a series of blocks (be they Big or Small ones)
An interface for persisting block storage of POIFS components.
The different kinds of
IBody that existSomewhat of a misnomer, its used for the beginning of a set of records that
have a particular purpose or subject.
Contains a flag specifying whether the Gui should save externally linked values from other workbooks.
User friendly interface to access information about document bookmarks
User-friendly interface to access document bookmarks
Implementation of user-friendly interface for document bookmarks
Here are the general rules concerning Boolean functions:
Blanks are ignored (not either true or false)
Strings are ignored if part of an area ref or cell ref, otherwise they must be 'true' or 'false'
Numbers: 0 is false.
Creates new BoolErrRecord.
Boolean (boolean) Stores a (java) boolean value in a formula.
Mapping class for BRC80 structure (Border Code for Word 97)
The enumeration value indicating which borders to draw in a Property Template
Border Formatting Block of the Conditional Formatting Rule Record.
High level representation for Border Formatting component
of Conditional Formatting settings
Specifies all types of borders which can be specified for WordprocessingML
objects which have a border.
The enumeration value indicating the line style of a border in a cell,
i.e., whether it is bordered dash dot, dash dot dot, dashed, dotted, double, hair, medium,
medium dash dot, medium dash dot dot, medium dashed, none, slant dash dot, thick or thin.
Record for the bottom margin.
Defines a sheet within a workbook.
Specifies the set of possible restart locations which may be used as to
determine the next available line when a break's type attribute has a value
of textWrapping.
Specifies the possible types of break characters in a WordprocessingML
document.
Utility to identify built-in formats.
A POIFS
DataSource backed by a byte array.A Chunk that holds binary data, normally unparsed.
A Chunk that either acts as
ByteChunk (if not initialized with a node) or
lazy loads its binary data from the document (if linked with a node via ByteChunkDeferred.readValue(DocumentNode)).representation of a byte (8-bit) field at a fixed location within a
byte array
Deprecated.
byte positions shall not be saved in memory
Provides holding structure for temporary values in arrays during the evaluation process.
Specifies the maximum times the gui should perform a formula recalculation.
Tells the gui whether to calculate formulas automatically, manually or automatically except for tables.
The cells in a workbook can be calculated in different orders depending on various optimizations and
dependencies.
Implementation of Excel functions Date parsing functions:
Date - DAY, MONTH and YEAR
Time - HOUR, MINUTE and SECOND
This record refers to a category or series axis and is used to specify label/tickmark frequency.
CATLAB - Category Labels (0x0856)
Implementation for Excel CEILING.MATH() function.
Implementation for Excel CEILING.PRECISE() function.
High level representation of a cell in a row of a spreadsheet.
This class is a container for POI usermodel row=0 column=0 cell references.
Common implementation-independent logic shared by all implementations of
Cell.Used when the cells are being copied from one workbook to another.
Formats a date value.
This class implements printing out an elapsed time format.
Format a value according to the standard Excel behavior.
This object represents a condition in a cell format.
Objects of this class represent a single part of a cell format expression.
This object contains the result of applying a cell format or cell format part
to a value.
This is the abstract supertype for the various cell formatters.
The different kinds of formats that the formatter understands.
A formatter for the default "General" cell format.
Represents callback for CellWalk traverse method.
This class implements printing out a value using a number format.
Internal helper class for CellNumberFormatter
Internal helper class for CellNumberFormatter
This class represents a single modification to a result string.
The CellPropertyCategory enum represents the different categories of cell properties.
The CellPropertyType enum represents the different types of cell properties that can be applied to a cell.
Represents a rectangular region of a
SheetSee OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'
See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'
See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'
Indicates a cell or range is in the given relative position in a range.
Implementation of the cell range address lists,like is described
in OpenOffice.org's Excel Documentation: excelfileformat.pdf sec 2.5.14 -
'Cell Range Address List'
In BIFF8 there is a common way to store absolute cell range address lists in
several records (not formulas).
Utility class that builds on
CellRangeAddress
Portions of this class may be moved to CellRangeAddressBaseBase class for all cell value records (implementors of
CellValueRecordInterface).Common conversion functions between Excel style A1, C27 style
cell references, and POI usermodel style row=0, column=0
style references.
Used to classify identifiers found in formulas as cell references or not.
Types of cell references.
This class implements printing out text.
Various utility functions that make working with a cells and rows easier.
Mimics the 'data view' of a cell.
The cell value record interface is implemented by all classes of type Record that
contain cell values.
Traverse cell range.
Specifies the location where the X.509 certificate that is used in signing is stored.
Conditional Formatting Header v12 record CFHEADER12 (0x0879),
for conditional formattings introduced in Excel 2007 and newer.
Parent of Conditional Formatting Header records,
CFHeaderRecord and CFHeader12Record.Conditional Formatting Header record CFHEADER (0x01B0).
CFRecordsAggregate - aggregates Conditional Formatting records CFHeaderRecord
and number of up CFRuleRecord records together to simplify access to them.
Conditional Formatting v12 Rule Record (0x087A).
Conditional Formatting Rules.
Conditional Formatting Rule Record (0x01B1).
This class represents a run of text that share common properties.
This class represents a run of text that share common properties.
Definition for the common character text property bitset, which
handles bold/italic/underline etc.
ENDBLOCK - Chart Future Record Type End Block (0x0853)
ENDOBJECT - Chart Future Record Type End Object (0x0855)
Class ChartFormatRecord (0x1014)
CHARTFRTINFO - Chart Future Record Type Info (0x0850)
CHART (0x1002)
STARTBLOCK - Chart Future Record Type Start Block (0x0852)
STARTOBJECT - Chart Future Record Type Start Object (0x0854)
Manages the all the records associated with a chart sub-stream.
CHARTTITLEFORMAT (0x1050)
This interface defines methods for finding and setting sibling
Property instances
Common interface for anchors.
Character Properties.
This class holds all of the character formatting properties.
Represents a CHP fkp.
DANGER - works in bytes!
Base of all chunks, which hold data, flags etc
A command in the visio file.
A variable length
PropertyValue that is backed by a Chunk
TODO Provide a way to link these up with the chunksFactor class to create the appropriate chunks, which
needs the version of the file to process the chunk header
and trailer areas.
The definition of a Command, which a chunk may hold.
A group of chunks, that are at the same point in the file structure.
A group of chunks which is indexable by
MAPIProperty entries.A chunk header
A chunk header from v11+
A chunk header from v4 or v5
A chunk header from v6
Collection of convenience chunks for standard parts of the MSG file.
A separator between the trailer of one chunk, and the
header of the next one
A trailer that follows a chunk
Represents a class ID (16 bytes).
This is taken from Hadoop at https://issues.apache.org/jira/browse/HADOOP-12760 and
https://github.com/apache/hadoop/blob/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/CleanerUtil.java
Unfortunately this is not available in some general utility library yet, but hopefully will be at some point.
Pass in an implementation of this interface to cleanup ByteBuffers.
A client anchor is attached to an excel worksheet.
Java class for CT_Path2DClose complex type.
Implementation for Excel CODE () function.
The default characterset.
Utilities for working with Microsoft CodePages.
Manages a collection of
WorkbookEvaluators, in order to support
evaluation of formulas across spreadsheets.Color Gradient / Color Scale Conditional Formatting Rule Record.
Color Gradient / Color Scale specific Threshold / value (CFVO),
for changes in Conditional Formatting
24-bit color structure
High level representation for the Color Scale / Colour Scale /
Color Gradient Formatting component of Conditional Formatting settings
A ColorSchemeAtom (type 2032).
Helper class for dealing with the Column settings on
a CTWorksheet (the data part of a sheet).
Defines with width and formatting for a range of columns
Implementation for Excel COLUMNS function.
Helper for shifting columns up or down
A command line wrapper around
ExtractorFactory, useful
for when debugging.Common interface for comments
This class represents a comment on a slide, in the format used by
PPT 2000/XP/etc.
An atomic record containing information about a comment.
An interface exposing useful functions for dealing with Excel Workbook Comments.
The common object data record is used to store all common preferences for an excel object.
The conditional format operators used for "Highlight Cells That Contain..." rules.
Implementation for Excel COMPLEX () function.
Within a
HMEFMessage, the content is often
stored in as RTF, but LZW compressed.A StreamStore where the data on-disk is compressed,
using the crazy Visio LZW
Implementation of Excel formula token '&'.
The ConditionalFormatting class encapsulates all settings of Conditional Formatting.
Evaluates Conditional Formatting constraints.
Represents a description of a conditional formatting rule
Holds all the conditional formatting for a workbook sheet.
The Threshold / CFVO / Conditional Formatting Value Object.
These values are needed by various conditional formatting evaluation filter types
Used primarily for XSSF conditions, which defines a multitude of additional "filter" types
for conditional formatting.
Represents a type of a conditional formatting rule
Helper for fetching int values from system properties
Java class for CT_ConnectionSite complex type.
To support Constant Values (2.5.7) as required by the CRN record.
Represents an immutable MIME ContentType value (RFC 2616 §3.7)
Manage package content types ([Content_Types].xml part).
Open Packaging Convention content types (see Annex F : Standard Namespaces
and Content Types).
Common superclass of all records that can produce
ContinueRecords while being serialized.A decorated
RecordInputStream that can read primitive data types
(short, int, long, etc.) spanned across a ContinueRecord boundary.An augmented
LittleEndianOutput used for serialization of ContinuableRecords.Helper class used primarily for SST Records
Implementation for Excel CORREL() function.
This exception is thrown when we try to open a PowerPoint file, and
something is fundamentally broken about it.
Counts the number of cells that contain numeric data within
the list of arguments.
Counts the number of cells that contain data within the list of arguments.
Implementation for the function COUNTBLANK
Implementation for the function COUNTIF
Implementation for the function COUNTIFS
Country Record (aka WIN.INI country) - used for localization
Implementation for Excel COVAR() and COVARIANCE.P() functions.
An object that handles instantiating concrete
classes of the various instances one needs for
HSSF and XSSF.
XCT - CRN Count
This record stores the contents of an external cell or cell range
Helper functions used for standard and agile encryption
A CString (type 4026).
This is a special kind of Atom, because it doesn't live inside the
PowerPoint document.
Java class for CT_Path2DCubicBezierTo complex type.
Definition of a custom geometric shape
custom index color map, i.e.
Maintains the instances of
CustomProperty that belong to a
DocumentSummaryInformation.This class represents custom properties in the document summary
information stream.
Manages the all the records associated with a 'Custom View Settings' sub-stream.
Data Bar Conditional Formatting Rule Record.
High level representation for the DataBar Formatting
component of Conditional Formatting settings
Data Bar specific Threshold / value (CFVO),
for changes in Conditional Formatting
Enum mapping the values of STDataConsolidateFunction
The data format record is used to index into a series.
DataFormatter contains methods for formatting the value stored in a
Cell.
A complex type that specifies data used to verify whether the encrypted data passes an integrity check.
SXDI - Data Item (0x00C5)
DATALABEXT - Chart Data Label Extension (0x086A)
Common definition of how we read and write bytes
Error style constants for error box
Condition operator enum
ValidationType enum
Evaluates Data Validation constraints.
This class organizes and encapsulates all the pieces of information related to a single
data validation configuration for a single cell.
Not calling it OperatorType to avoid confusion for now with DataValidationConstraint.OperatorType.
Not calling it ValidationType to avoid confusion for now with DataValidationConstraint.ValidationType.
Manages the DVALRecord and DVRecords for a single sheet
This class is used to represent a date and time in a Word document.
Convert java DateFormat patterns into Excel custom number formats.
Implementation for the Excel function DATE
Parser for java dates.
Contains methods for dealing with Excel dates.
Implementation for the DATEVALUE() Excel function.
Flag specifying whether 1904 date windowing is used.
The dat record is used to store options for the chart.
Implementation of the DAverage function:
Gets the average value of a column in an area with given conditions.
Calculates the number of days between two dates based on a real year,
which is used in some accounting calculations.
Calculates the number of days between two dates based on a 360-day year
(twelve 30-day months), which is used in some accounting calculations.
Used by Excel and other MS apps to quickly find rows in the sheets.
DConRef records specify a range in a workbook (internal or external) that serves as a data source
for pivot tables or data consolidation.
Implementation of the DCount function:
Counts the number of numeric cells in a column in an area with given conditions.
Implementation of the DCountA function:
Counts the number of non-blank cells in a column in an area with given conditions.
Implementation for Excel DEC2BIN() function.
Implementation for Excel DEC2HEX() function.
Specifies the default width for columns that have no specific width set.
The default data label text properties record identifies the text characteristics of the preceding text record.
Generates escher records when provided the byte array containing those records.
Uses the legacy colors defined in HSSF for index lookups
Default marshaller that specified that the part is responsible to marshall its content.
Row height for rows with undefined or not explicitly defined heights.
Default implementation of the
TempFileCreationStrategy used by TempFile:
Files are collected into one directory.Default UDF finder - for adding your own user defined functions.
A variant of SXSSFSheet that uses a
RowGeneratorFunction to lazily create rows.A variant of SXSSFWorkbook that avoids generating a temporary file and writes data directly to
the provided OutputStream.
Implementors of this interface allow client code to 'delay' writing to a certain section of a
data output stream.
A typical application is for writing BIFF records when the size is not known until well after the header has been written.
A typical application is for writing BIFF records when the size is not known until well after the header has been written.
An XSSF only representation of a reference to a deleted area
Deleted Area 3D Ptg - 3D referecnce (Sheet + Area)
Deleted Reference 3D Ptg
Implementation for Excel DELTA() function.
Controls the accuracy of the calculations
Implementation of the DGet function:
Finds the value of a column in an area with given conditions.
Represents a DIB picture data in a PPT file
Interface for classes providing differential style definitions, such as conditional format rules
and table/pivot table styles.
Provides the minumum and maximum bounds of a sheet.
A Chunk that is just a placeholder in the MAPIMessage directory structure,
which contains children.
This interface defines methods specific to Directory objects
managed by a Filesystem instance.
Simple implementation of DirectoryEntry
Directory property
This PTG implements the standard binomial divide "/"
Implementation of the DMax function:
Finds the maximum value of a column in an area with given conditions.
Implementation of the DMin function:
Finds the minimum value of a column in an area with given conditions.
A container record that specifies information about the document and document display settings.
Master container for Document.
A Document Atom (type 1001).
Holds the different Slide Size values
Class DocumentDescriptor
A Document Encryption Atom (type 12052).
This interface defines methods specific to Document objects
managed by a Filesystem instance.
A small base class for the various factories, e.g.
This is similar to
RecordFormatException, except this is thrown
when there's a higher order problem with parsing a document beyond individual records.This class provides methods to read a DocumentEntry managed by a
POIFSFileSystem instance.Simple implementation of DocumentEntry for OPOIFS
This class provides methods to write a DocumentEntry managed by a
POIFSFileSystem instance.Trivial extension of Property for POIFSDocuments
Convenience class representing a DocumentSummary Information stream in a
Microsoft Office document.
Implementation for Excel DOLLARDE() function.
Implementation for Excel DOLLARFR() function.
Document Properties.
Utilities for working with double byte CodePages.
Implementation of the DProduct function:
Gets the product value of a column in an area with given conditions.
Manages fonts when rendering slides.
Manages fonts when rendering slides.
High level representation of spreadsheet drawing.
Dump out the aggregated escher records
Specifies a group of drawing objects.
Provides utilities to manage drawing groups.
This is purely for the biff viewer.
MsoDrawingSelection (0x00ED)
This is a marker annotation for classes which don't have a defined
draw implementation.
This class handles color transformations.
This data structure is used by a paragraph to determine how it should drop
its first letter.
Tells if this is a double stream file.
This class performs a D* calculation.
Enum for convenience to identify and source implementations of the D* functions
Implementation of the DStdev function:
Gets the standard deviation value of a column in an area with given conditions.
Implementation of the DStdevp function:
Gets the standard deviation value of a column in an area with given conditions.
Implementation of the DSum function:
Finds the total value of matching values in a column in an area with given conditions.
If we come across a record we know has children of (potential)
interest, but where the record itself is boring, but where other
records may care about where this one lives, we create one
of these.
If we come across a record we know has children of (potential)
interest, but where the record itself is boring, we create one
of these.
This is an alternative to the
Cloneable interface without its side-effects.This record is the list header of all data validation records (0x01BE) in the current sheet.
Implementation of the DVar function:
Gets the variance value of a column in an area with given conditions.
Implementation of the DVarp function:
Gets the variance value of a column in an area with given conditions.
Data Validation Constraint
This record stores data validation settings and a list of cell ranges which contain these settings.
Implementation for Excel EDATE () function.
A collection of embedded object informations and content
This extractor class tries to identify various embedded documents within Excel files
and provide them via a common interface, i.e.
ftPictFmla (0x0009)
Represents EMF (Windows Enhanced Metafile) picture data.
Exception thrown if an Empty (zero byte) file is supplied
This exception is thrown when we try to open a PowerPoint file, and
discover that it is encrypted
EncryptedTempData can be used to buffer binary data in a secure way, by using encrypted temp files.
(Experimental) Encrypted Temp File version of a package part.
Reads and processes OOXML Encryption Headers
The constants are largely based on ZIP constants.
Wrapper for the EncryptionInfo node of encrypted documents
Office supports various encryption modes.
Used when checking if a key is valid for a document
The end record defines the end of a block of records for a (Graphing)
data object.
ftEnd (0x0000)
This interface provides access to an object managed by a Filesystem
instance.
Abstract implementation of Entry
Extending classes should override isDocument() or isDirectory(), as
appropriate
Extending classes must override isDeleteOK()
Signature Facet implementation to create enveloped signatures.
Environment, which contains lots of settings for the document.
Marks the end of records belonging to a particular object in the HSSF File
Implementation for the Excel EOMONTH() function.
An ERFListener is registered with the EventRecordFactory.
Represents a constant error code value as encoded in a constant values array.
Evaluations for formula errors
Implementation for the ERROR.TYPE() Excel function.
This class is used to aggregate the MSODRAWING and OBJ record
combinations.
Escher array properties are the most weird construction ever invented
with all sorts of special cases.
Represents a boolean property.
The BSE record is related closely to the
EscherBlipRecord and stores
extra information about the blip.The escher child anchor record is used to specify the position of a shape under an
existing group.
The escher client anchor specifies which rows and cells the shape is bound to as well as
the offsets within those cells.
The EscherClientDataRecord is used to store client specific data about the position of a
shape within a container.
An OfficeArtCOLORREF structure entry which also handles color extension opid data
The following enum specifies values that indicate special procedural properties that
are used to modify the color components of another color.
A complex property differs from a simple property in that the data can not fit inside a 32 bit
integer.
Escher container records store other escher records as children.
This record defines the drawing groups used for a particular sheet.
This record simply holds the number of shapes in the drawing group and the
last shape id used for this drawing group.
Used to dump the contents of escher records to a PrintStream.
Translates Graphics calls into escher calls.
Translates Graphics2d calls into escher calls.
The opt record is used to store property values for a shape.
Parent class of all Escher parts
An atom record that specifies whether a shape is a placeholder shape.
This is the abstract base class for all escher properties.
Generates a property given a reference into the byte array storing that property.
This class stores the type and description of an escher property.
Provides a list of all known escher properties including the description and type.
The base abstract record from which all escher records are defined.
The escher record factory interface allows for the creation of escher
records from a pointer into a data array.
A color property.
Interface for listening to escher serialization events.
Defines the constants for the various possible shape paths.
A simple property is of fixed length and as a property number in addition
to a 32-bit value.
The spgr record defines information about a shape group.
A list of the most recently used colours for the drawings contained in
this document.
Together the EscherOptRecord this record defines some of the basic
properties of a shape.
"The OfficeArtTertiaryFOPT record specifies a table of OfficeArtRGFOPTE properties, as defined in section 2.3.1."
-- [MS-ODRAW] -- v20110608; Office Drawing Binary File Format
Holds data from the parent application.
A wrapper around a DDF (Escher) EscherTextbox Record.
Abstracts a cell for the purpose of formula evaluation.
Abstracted and cached version of a Conditional Format rule for use with a
ConditionalFormattingEvaluator.Note: this class has a natural ordering that is inconsistent with equals.
This class is used to simplify error handling logic within operator and function
implementations.
Abstracts a name record for formula evaluation.
Abstracts a sheet for the purpose of formula evaluation.
Abstracts a workbook for the purpose of formula evaluation.
A text extractor for Excel files, that is based
on the HSSF EventUserModel API.
Event-based record factory.
When working with the EventUserModel, if you want to
process formulas, you need an instance of
InternalWorkbook to pass to a HSSFWorkbook,
to finally give to HSSFFormulaParser,
and this will build you stub ones.A wrapping HSSFListener which will collect
BoundSheetRecords and ExternSheetRecords as
they go past, so you can create a Stub InternalWorkbook from
them once required.A container record that specifies information about a movie stored externally.
Instances of this class are used to evaluate a single cell.
A simple class that encapsulates information about a cell evaluation
from POI.
This is the class that backs the
<handler> tag in the Ant task.Class for use in an Ant build script that sets the value of an Excel
sheet cell using the cell id ('Sheet Name'!cellId).
Class for use in an Ant build script that sets the formula of an Excel
sheet cell using the cell id ('Sheet Name'!cellId).
Class for use in an Ant build script that sets the value of an Excel
sheet cell using the cell id ('Sheet Name'!cellId).
Ant task class for testing Excel workbook cells.
This class represents a single test.
This class encapsulates the Strings necessary to create the User Defined
Function instances that will be passed to POI's Evaluator instance.
A general utility class that abstracts the POI details of loading the
workbook, accessing and updating cells.
This is a factory class maps file names to WorkbookUtil instances.
Arithmetic helpers that reproduce how Excel computes with IEEE 754 doubles.
A text extractor for Excel files.
Common interface for Excel text extractors, covering
HSSF and XSSF
A format that formats a double as Excel would, ignoring FieldPosition.
Object to hold a number format index and string, for various formatting evaluations
A wrapper around a
SimpleDateFormat instance,
which handles a few Excel-style extensions that
are not supported by SimpleDateFormat.Converts xls files (97-2007) to XSL FO.
Converts xls files (97-2007) to HTML file.
Utility methods for dealing with exceptions/throwables
A container record that specifies information about an ActiveX control.
An atom record that specifies an ActiveX control.
This data represents an embedded object in the document.
The atom that holds metadata on a specific embedded object in the document.
This class represents the data of a link in the document.
The atom that holds metadata on a specific Link in the document.
A container record that specifies information about a movie stored externally.
An atom record that specifies information about external audio or video data.
This class holds the links to external objects referenced from the document.
The atom that holds the seed info used by a ExObjList
ExObjRefAtom (3009).
Atom storing information for an OLE object.
Storage for embedded OLE objects.
Title: CTColor (Extended Color) record part
Represents a XSSF-style color (based on either a
org.apache.poi.xssf.usermodel.XSSFColor or a
ExtendedColorProbably one of the more complex records.
SXVDEX - Extended PivotTable View Fields (0x0100)
Holds details of links to parts of other workbooks (eg named ranges),
along with the most recently seen values for what they point to.
Evaluation of a Name defined in a Sheet or Workbook scope
EXTERNALNAME (0x0023)
EXTERNSHEET (0x0017)
Should be implemented by any
For POI internal use only
Ptg subclass that needs has an extern sheet index For POI internal use only
Figures out the correct POIOLE2TextExtractor for your supplied
document, and returns it.
Extended Static String Table (0x00FF)
A container record that specifies information about external video data.
Implementation for Excel FACTDOUBLE() function.
Title: FeatFormulaErr2 (Formula Evaluation Shared Feature) common record part
Title: FeatHdr (Feature Header) Record
Title: FeatProtection (Protection Shared Feature) common record part
Title: Feat (Feature) Record
Title: FeatSmartTag (Smart Tag Shared Feature) common record part
The FFData structure specifies form field data for a text box, check box, or
drop-down list box.
The FFData structure specifies form field data for a text box, check box, or
drop-down list box.
The FFData structure specifies form field data for a text box, check box, or drop-down list box.
FFN - Font Family Name.
Base part of the File information Block (FibBase).
Base part of the File information Block (FibBase).
The FibRgLw95 structure is the third section of the FIB for Word95.
The FibRgLw97 structure is the third section of the FIB.
The FibRgLw97 structure is the third section of the FIB.
The FibRgW97 structure is a variable-length portion of the Fib.
The FibRgW97 structure is a variable-length portion of the Fib.
Class for the FLD structure.
For iterating through our fields.
User-friendly interface to access document
FieldsDefault implementation of
FieldThis class provides access to all the fields Plex.
A POIFS
DataSource backed by a FileProvide useful method to manage file.
The File Information Block (FIB).
The file magic number, i.e.
File Pass Record (0x002F)
Stores the encrypted readonly for a workbook (write protect).
The Windows FILETIME structure holds a date and time associated with a
file.
The enumeration value indicating the style of fill pattern being used for a cell format.
This interface is the counterpart to
StrokeStyle - it specifies the filling of a shapeA DirectoryEntry filter, which exposes another
DirectoryEntry less certain parts.
Implementation of the financial functions pmt, fv, ppmt, ipmt.
This class is a function library for common fiscal functions.
Convenience base class for functions that must take exactly one argument.
Convenience base class for functions that must take exactly two arguments.
Convenience base class for functions that must take exactly three arguments.
Convenience base class for functions that must take exactly four arguments.
behavior of a field at a fixed location within a byte array
Field Descriptor (FLD).
Implementation for Excel FLOOR.MATH() function.
Implementation for Excel FLOOR.PRECISE() function.
umber of built in function groups in the current version of the Spreadsheet (probably only used on Windows)
Definition for the font alignment property.
The font basis record stores various font metrics.
Charset represents the basic set of characters associated with a font (that it can display), and
corresponds to the ANSI codepage (8-bit or DBCS) of that character set used by a given language.
FontCollection ia a container that holds information
about all the fonts in the presentation.Stores width and height details about a font.
This atom corresponds exactly to a Windows Logical Font (LOGFONT) structure.
A FontFacet holds the font data for a shape of a font, i.e.
A property of a font that describes its general appearance.
The font family this font belongs to.
Font Formatting Block of the Conditional Formatting Rule Record.
High level representation for Font Formatting component
of Conditional Formatting settings
Text runs can contain characters which will be handled (if configured) by a different font,
because the default font (latin) doesn't contain corresponding glyphs.
The header data of an EOT font.
The font index record indexes into the font table for the text record.
A FontInfo object holds information about a font configuration.
A property of a font that describes the pitch, of the characters.
Describes a font in the workbook
Defines the font scheme to which this font belongs.
FontTable or in MS terminology sttbfffn is a common data structure written in all
Word files.
the different types of possible underline formatting
Common definition of a HSSF or XSSF page footer.
Specifies the footer for a sheet
Manages IDs for footnotes and endnotes.
Implementation for Excel FORECAST() and FORECAST.LINEAR() functions.
An alternative workbook evaluator that saves memory in situations where a single workbook is
concurrently and independently evaluated many times.
Describes a number format -- those goofy strings like $(#,###)
Represents an FKP data structure.
A proxy HSSFListener that keeps track of the document formatting records, and
provides an easy way to look up the format strings used by cells from their
ids.
A guide formula in DrawingML.
Encapsulates an encoded formula token array.
Enumerates error values in SpreadsheetML formula calculations.
Evaluates formula cells.
This exception thrown when a supplied formula has incorrect syntax (or syntax currently not
supported by POI).
This class parses a formula string into a List of tokens in RPN order.
Abstracts a workbook for the purpose of formula parsing.
For POI internal use only
For POI internal use only
Formula Record (0x0006).
The formula record aggregate is used to join together the formula record and it's
(optional) string record and (optional) Shared Formula Record (template reads, excel optimization).
Common logic for rendering formulas.
Abstracts a workbook for the purpose of converting formula to text.
Updates Formulas as rows or sheets are shifted
Manages the cached formula result values of other types besides numeric.
Enumeration of various formula types.
Format class that handles Excel style fractions, such as "# #/#" and "#/###"
The frame record indicates whether there is a border around the displayed text of a chart.
Footnote Reference Descriptor (FRD).
For most Excel functions, involving references ((cell, area), (2d, 3d)), the references are
passed in as arguments, and the exact location remains fixed.
Implementation of Excel 'Analysis ToolPak' function FREQUENCY()
Returns a frequency distribution as a vertical array
Returns a frequency distribution as a vertical array
File Shape Address structure
File Shape Address (FSPA).
This class holds all the FSPA (File Shape Address) structures.
This structure appears as part of an Obj record that represents a checkbox or radio button.
The FtCf structure specifies the clipboard format of the picture-type Obj record containing this FtCf.
This structure appears as part of an Obj record that represents image display properties.
Title: FtrHeader (Future Record Header) common record part
Common interface for all implementations of Excel built-in functions.
Implemented by all functions that can be called with one argument
Implemented by all functions that can be called with two arguments
Implemented by all functions that can be called with three arguments
Implemented by all functions that can be called with four arguments
Mappings from the Excel functions to our evaluation implementations
(where available)
Holds information about Excel built-in functions.
Allows clients to get
FunctionMetadata instances for any built-in function of Excel.Title: Future Record, a newer (largely Excel 2007+) record
which contains a Future Record Header (
FtrHeader)Implementation for Excel GCD() function.
PTG class to implement greater or equal to
Greater than operator PTG ">"
The grfhic structure is a set of HTML incompatibility flags that specify the
HTML incompatibilities of a list structure.
The grfhic structure is a set of HTML incompatibility flags that specify the HTML
incompatibilities of a list structure.
Flag denoting whether the user specified that gridlines are used when printing.
ftGmo (0x0006)
Java class for CT_GeomGuide complex type.
Row/column gutter sizes
Sheet writer that supports gzip compression of the temp files.
Whether to center between horizontal margins
See
http://www.redferni.uklinux.net/visio/
http://www.gnome.ru/projects/docs/vsdocs.html
http://www.gnome.ru/projects/docs/slide1.png
http://www.gnome.ru/projects/docs/slide2.png
The superclass of all HDGF exceptions
A decoder for the crazy LZW implementation used
in Visio.
Common definition of a HSSF or XSSF page header.
The block containing the archive header
Constants used in reading/writing the Header block
Common class for
HSSFHeader and HSSFFooter.Common header/footer base class
The HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers.
Specifies a header for a sheet
Header / Footer settings.
An atom record that specifies options for displaying headers and footers
on a presentation slide or notes slide.
A container record that specifies information about the footers on a presentation slide.
A HeaderStory is a Header, a Footer, or footnote/endnote
separator.
Contains arbitrary data
Private data is unknown to EMF; it is meaningful only to applications that know the format of the
data and how to use it.
The EMR_COMMENT_EMFPLUS record contains embedded EMF+ records.
This record aborts a path bracket or discards the path from a closed path bracket.
The EMR_ARC record specifies an elliptical arc.
The EMR_ARCTO record specifies an elliptical arc.
This record opens a path bracket in the current playback device context.
The EMR_CHORD record specifies a chord, which is a region bounded by the intersection of an
ellipse and a line segment, called a secant.
This record closes an open figure in a path.
The EMR_ELLIPSE record specifies an ellipse.
This record closes a path bracket and selects the path defined by the bracket into
the playback device context.
The EMR_FILLPATH record closes any open figures in the current path and fills the path's interior by
using the current brush and polygon-filling mode.
This record transforms any curves in the selected path into the playback device
context; each curve MUST be turned into a sequence of lines.
The EMR_LINETO record specifies a line from the current position up to, but not including, the
specified point.
The EMR_PIE record specifies a pie-shaped wedge bounded by the intersection of an ellipse and two
radials.
The EMR_POLYBEZIER record specifies one or more Bezier curves.
The EMR_POLYBEZIER16 record specifies one or more Bezier curves.
The EMR_POLYBEZIERTO record specifies one or more Bezier curves based upon the current
position.
The EMR_POLYBEZIERTO16 record specifies one or more Bezier curves based on the current
position.
The EMR_POLYDRAW record specifies a set of line segments and Bezier curves.
The EMR_POLYGON record specifies a polygon consisting of two or more vertexes connected by
straight lines.
The EMR_POLYGON16 record specifies a polygon consisting of two or more vertexes connected by straight lines.
The EMR_POLYLINE record specifies a series of line segments by connecting the points in the
specified array.
The EMR_POLYLINE16 record specifies a series of line segments by connecting the points in the
specified array.
The EMR_POLYLINETO record specifies one or more straight lines based upon the current position.
The EMR_POLYLINETO16 record specifies one or more straight lines based upon the current position.
The EMR_POLYPOLYGON record specifies a series of closed polygons.
The EMR_POLYPOLYGON16 record specifies a series of closed polygons.
The EMR_POLYPOLYLINE record specifies multiple series of connected line segments.
The EMR_POLYPOLYLINE16 record specifies multiple series of connected line segments.
The EMR_RECTANGLE record draws a rectangle.
The EMR_ROUNDRECT record specifies a rectangle with rounded corners.
The EMR_SELECTOBJECT record adds a graphics object to the current metafile playback device
context.
The EMR_MOVETOEX record specifies coordinates of the new current position, in logical units.
The EMR_SETPIXELV record defines the color of the pixel at the specified logical coordinates.
The EMR_STROKEANDFILLPATH record closes any open figures in a path, strokes the outline of the
path by using the current pen, and fills its interior by using the current brush.
The EMR_STROKEPATH record renders the specified path by using the current pen.
This record redefines the current path as the area that would be painted if the path
were drawn using the pen currently selected into the playback device context.
The EMR_BITBLT record specifies a block transfer of pixels from a source bitmap to a destination rectangle,
optionally in combination with a brush pattern, according to a specified raster operation.
The EMR_FILLRGN record fills the specified region by using the specified brush.
The EMR_FRAMERGN record draws a border around the specified region using the specified brush.
The EMR_INVERTRGN record inverts the colors in the specified region.
The EMR_PAINTRGN record paints the specified region by using the brush currently selected into the
playback device context.
The EMR_SETDIBITSTODEVICE record specifies a block transfer of pixels from specified scanlines of
a source bitmap to a destination rectangle.
The EMR_SETPOLYFILLMODE record defines polygon fill mode.
The EMR_STRETCHBLT record specifies a block transfer of pixels from a source bitmap to a destination rectangle,
optionally in combination with a brush pattern, according to a specified raster operation, stretching or
compressing the output to fit the dimensions of the destination, if necessary.
The EMR_STRETCHDIBITS record specifies a block transfer of pixels from a source bitmap to a
destination rectangle, optionally in combination with a brush pattern, according to a specified raster
operation, stretching or compressing the output to fit the dimensions of the destination, if necessary.
Extracts the full header from EMF files.
The EMR_CREATEBRUSHINDIRECT record defines a logical brush for graphics operations.
The EMR_CREATEDIBPATTERNBRUSHPT record defines a pattern brush for graphics operations.
The EMR_CREATEPEN record defines a logical pen for graphics operations.
The EMR_DELETEOBJECT record deletes a graphics object, which is specified by its index
in the EMF Object Table
The EMF_RESTOREDC record restores the playback device context from a previously saved device
context.
The EMF_SAVEDC record saves the playback device context for later retrieval.
The META_SETBKCOLOR record sets the background color in the playback device context to a
specified color, or to the nearest physical color if the device cannot represent the specified color.
The EMR_SETBKMODE record specifies the background mix mode of the playback device context.
The EMR_SETMAPMODE record specifies the mapping mode of the playback device context.
The EMR_SETMAPPERFLAGS record specifies parameters of the process of matching logical fonts to
physical fonts, which is performed by the font mapper.
The EMR_SETMITERLIMIT record specifies the limit for the length of miter joins for the playback
device context.
The EMR_SETROP2 record defines a binary raster operation mode.
The EMR_SETSTRETCHBLTMODE record specifies bitmap stretch mode.
The EMR_CREATEPALETTE record defines a logical palette for graphics operations.
This record maps palette entries from the current LogPalette object to the system_palette.
The EMR_RESIZEPALETTE record increases or decreases the size of an existing LogPalette object
The EMR_SELECTPALETTE record specifies a logical palette for the playback device context.
The EMR_SETICMMODE record specifies the mode of Image Color Management (ICM) for graphics operations.
The ICMMode enumeration defines values that specify when to turn on and off ICM.
The EMR_SETPALETTEENTRIES record defines RGB color values in a range of entries for an existing
LogPalette object.
Read-only EMF extractor.
The EmfPlusBrush object specifies a graphics brush for filling regions.
The BrushType enumeration defines types of graphics brushes, which are used to fill graphics regions.
The EmfPlusHatchBrushData object specifies a hatch pattern for a graphics brush.
The EmfPlusLinearGradientBrushData object specifies a linear gradient for a graphics brush.
The EmfPlusPathGradientBrushData object specifies a path gradient for a graphics brush.
The EmfPlusSolidBrushData object specifies a solid color for a graphics brush.
The EmfPlusTextureBrushData object specifies a texture image for a graphics brush.
The EmfPlusDrawDriverString record specifies text output with character positions.
The EmfPlusDrawImage record specifies drawing a scaled image.
The EmfPlusDrawImagePoints record specifies drawing a scaled image inside a parallelogram.
The EmfPlusDrawPath record specifies drawing a graphics path
The EmfPlusDrawRects record specifies drawing a series of rectangles.
The EmfPlusFillPath record specifies filling the interior of a graphics path.
The EmfPlusFillRects record specifies filling the interiors of a series of rectangles.
The EmfPlusFillRegion record specifies filling the interior of a graphics region.
The GraphicsVersion enumeration defines versions of operating system graphics that are used to
create EMF+ metafiles.
The ImageDataType enumeration defines types of image data formats.
The WrapMode enumeration defines how the pattern from a texture or gradient brush is tiled
across a shape or at shape boundaries, when it is smaller than the area being filled.
The EmfPlusGetDC record specifies that subsequent EMF records encountered in the metafile
SHOULD be processed.
The EmfPlusMultiplyWorldTransform record multiplies the current world space transform by a
specified transform matrix.
The EmfPlusResetClip record resets the current clipping region for the world space to infinity.
The EmfPlusResetWorldTransform record resets the current world space transform to the identify matrix.
The EmfPlusRestore record restores the graphics state, identified by a specified index, from a stack
of saved graphics states.
The EmfPlusSave record saves the graphics state, identified by a specified index, on a stack of saved
graphics states.
The EmfPlusSetAntiAliasMode record specifies the anti-aliasing mode for text output.
The EmfPlusSetClipPath record combines the current clipping region with a graphics path.
The EmfPlusSetClipRect record combines the current clipping region with a rectangle.
The EmfPlusSetClipRegion record combines the current clipping region with another graphics region.
The EmfPlusSetCompositingMode record specifies how source colors are combined with background colors.
The EmfPlusSetCompositingQuality record specifies the desired level of quality for creating
composite images from multiple objects.
The EmfPlusSetInterpolationMode record specifies how image scaling, including stretching and
shrinking, is performed.
The EmfPlusSetPageTransform record specifies scaling factors and units for converting page space
coordinates to device space coordinates.
The EmfPlusSetPixelOffsetMode record specifies how pixels are centered with respect to the
coordinates of the drawing surface.
The EmfPlusSetRenderingOrigin record specifies the rendering origin for graphics output.
The EmfPlusSetTextRenderingHint record specifies the quality of text rendering, including the type
of anti-aliasing.
The EmfPlusSetWorldTransform record sets the world transform according to the values in a
specified transform matrix.
The EmfPlusObject record specifies an object for use in graphics operations.
The ObjectType enumeration defines types of graphics objects that can be created and used in graphics operations.
The PathPointType enumeration defines types of points on a graphics path.
The DashedLineCapType enumeration defines types of line caps to use at the ends of dashed lines
that are drawn with graphics pens.
The LineCapType enumeration defines types of line caps to use at the ends of lines that are drawn
with graphics pens.
The LineJoinType enumeration defines ways to join two lines that are drawn by the same graphics
pen and whose ends meet.
The LineStyle enumeration defines styles of lines that are drawn with graphics pens.
The PenAlignment enumeration defines the distribution of the width of the pen with respect to the
line being drawn.
The EmfPlusRegion object specifies line and curve segments that define a nonrectilinear shape.
The EmfPlusRegionNode object specifies nodes of a graphics region.
Container class to gather all text-related commands
This is starting out as read only, and very little is actually
implemented at this point!
The EMR_SETTEXTALIGN record specifies text alignment.
The EMR_SETTEXTCOLOR record defines the current text color.
Needs to be implemented.
Needs to be implemented.
The EMR_SCALEVIEWPORTEXTEX record respecifies the viewport for a device context by using the
ratios formed by the specified multiplicands and divisors.
The EMR_SCALEWINDOWEXTEX record respecifies the window for a playback device context by
using the ratios formed by the specified multiplicands and divisors.
The EMR_SELECTCLIPPATH record specifies the current path as a clipping region for a playback
device context, combining the new region with any existing clipping region using the specified mode.
The EMR_EXCLUDECLIPRECT record specifies a new clipping region that consists of the existing
clipping region minus the specified rectangle.
The EMR_INTERSECTCLIPRECT record specifies a new clipping region from the intersection of the
current clipping region and the specified rectangle.
The EMR_OFFSETCLIPRGN record moves the current clipping region in the playback device context
by the specified offsets.
The EMR_SETVIEWPORTEXTEX record defines the viewport extent.
The EMR_SETVIEWPORTORGEX record defines the viewport origin.
The EMR_SETWINDOWEXTEX record defines the window extent.
The EMR_SETWINDOWORGEX record defines the window origin.
Implementation for Excel HEX2DEC() function.
dump data in hexadecimal format
Utilities to read hex from files.
Flag defines whether to hide placeholders and object
Debugging tool useful when trying to figure out the hierarchy of the
shapes in a Visio diagram
An interface to provide support for get/set of highlight color in
XLSFTextRuns instances.Implementation of the HLOOKUP() function.
A utility for extracting out the message body, and all attachments
from a HMEF/TNEF/winmail.dat file
Developer focused raw dumper
HMEF - Implementation of the Microsoft TNEF message
encoding format (aka winmail.dat)
See:
http://support.microsoft.com/kb/241538
http://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format
http://search.cpan.org/dist/Convert-TNEF/
The enumeration value indicating horizontal alignment of a cell,
i.e., whether it is aligned general, left, right, horizontally centered, filled (replicated),
justified, centered across multiple cells, or distributed.
HorizontalPageBreak (0x001B) record that stores page breaks at rows
This class provides the basic functionality
for HPBF, our implementation of the publisher
file format.
For dumping out the contents of HPBF (Publisher)
files, while we try to figure out how they're
constructed.
Parent class of all HPBF sub-parts, handling
the fiddly reading in / writing out bits
for all of them.
This exception is the superclass of all other checked exceptions thrown
in this package.
Extracts all of the HPSF properties, both
build in and custom, returning them in
textual form.
A version of
POIDocument which allows access to the
HPSF Properties, but no other document contents.This exception is the superclass of all other unchecked
exceptions thrown in this package.
Hyphenation (HRESI).
Represents an AutoShape.
Background shape
Specifies a connection shape.
An atom record that specifies whether a shape is a placeholder shape.
Generates escher records when provided the byte array containing those records.
A generic exception that can be thrown by HSLF classes
Represents functionality provided by the 'Fill Effects' dialog in PowerPoint.
Represents a Font used in a presentation.
Predefined fonts
A "Freeform" shape.
Represents a group of shapes.
Represents a hyperlink in a PowerPoint document
Represents a line in a PowerPoint drawing
The superclass of all master sheets - Slide masters, Notes masters, etc.
Experimental class for metro blobs, i.e.
This class represents a slide's notes in a PowerPoint Document.
A class that represents object data embedded in a slide show.
A shape representing embedded OLE object.
Methods that wrap
HSLFSlideShow parsing functionality.A class that represents image data contained in a slide show.
Represents a picture in a PowerPoint document.
Represents a Placeholder in PowerPoint.
Extended placeholder details for HSLF sheets - mainly for headers and footers
An exception that indicates a problem reading a ppt file.
Represents a Shape which is the elemental object that composes a drawing.
Common interface for shape containers, e.g.
Create a
Shape object depending on its typeExtended placeholder details for HSLF shapes
This class defines the common format of "Sheets" in a powerpoint
document.
An abstract simple (non-group) shape.
This class represents a slide in a PowerPoint Document.
SlideMaster determines the graphics, layout, and formatting for all the slides in a given presentation.
This class is a friendly wrapper on top of the more scary HSLFSlideShow.
This class provides helper functions for encrypted PowerPoint documents.
Helper class which is instantiated by reflection from
SlideShowFactory.create(java.io.File) and similarThis class contains the main functionality for the Powerpoint file
"reader".
A class that represents sound data embedded in a slide show.
Represents a table in a PowerPoint presentation
Represents a cell in a ppt table
Container for tabstop lists
Represents a TextFrame shape in PowerPoint.
This class represents a run of text in a powerpoint document.
Represents a run of text, all with the same style
A common superclass of all shapes that can hold text.
Title masters define the design template for slides with a Title Slide layout.
Dumps out the chunk details, and where possible contents
An anchor is what specifics the position of a shape within a client object
or within another containing shape.
Represents autofiltering for the specified worksheet.
High level representation for Border Formatting component
of Conditional Formatting settings
High level representation of a cell in a row of a spreadsheet.
High level representation of the style of a cell in a sheet of a workbook.
Has methods for construction of a chart object.
A series in a chart
A client anchor is attached to an excel worksheet.
Intends to provide support for the very evil index to triplet issue and
will likely replace the color constants interface for HSSF 2.0.
Predefined HSSFColors with their given palette index (and an optional 2nd index)
High level representation for Color Scale / Color Gradient
Formatting component of Conditional Formatting settings
Helper for shifting columns up or down
Represents a cell comment - a sticky note associated with a cell.
HSSFConditionalFormatting class encapsulates all settings of Conditional Formatting.
High level representation of Conditional Formatting Rule.
High level representation for Icon / Multi-State / Databar /
Colour Scale change thresholds
High level representation for DataBar / Data-Bar Formatting
component of Conditional Formatting settings
Identifies both built-in and user defined formats within a workbook.
HSSFDataFormatter contains methods for formatting the value stored in an
HSSFCell.
Utility class for creating data validation cells
Helper for working with Data Validation
Internal POI use only
Low level event based HSSF reader.
The HSSF file format normally stores Color information in the
Palette (see PaletteRecord), but for a few cases (eg Conditional
Formatting, Sheet Extensions), this XSSF-style color record
can be used.
Represents a Font used in a workbook.
High level representation for Font Formatting component
of Conditional Formatting settings
Class to read and manipulate the footer.
Evaluates formula cells.
HSSF wrapper for the
FormulaParser and FormulaRendererClass to read and manipulate the header.
Represents an Excel hyperlink.
High level representation for Icon / Multi-State Formatting
component of Conditional Formatting settings
Interface for use with the HSSFRequest and HSSFEventFactory.
High Level Representation of a 'defined name' which could be a 'built-in' name,
'named range' or name of a user defined function.
Represents binary object (i.e.
Excel can get cranky if you give it files containing too
many (especially duplicate) objects, and this class can
help to avoid those.
Represents a workbook color palette.
Methods that wrap
HSSFWorkbook parsing functionality.The patriarch is the toplevel container for shapes in a sheet.
High level representation for Conditional Formatting settings
Represents an escher picture.
Represents binary data stored in the file.
Used to modify the print setup.
An exception that indicates a problem reading an xls file.
An HSSFRequest object should be constructed registering an instance or multiple
instances of HSSFListener with each Record.sid you wish to listen for.
Rich text unicode string.
High level representation of a row of a spreadsheet.
Helper for shifting rows up or down
An abstract shape.
An interface that indicates whether a class can contain children.
Factory class for producing Excel Shapes from Escher records
A shape group may contain other shapes.
High level representation of a worksheet.
The 'Conditional Formatting' facet of
HSSFSheetRepresents a simple shape such as a line, rectangle or oval.
A textbox is a shape that may hold a rich text string.
This exception is provided as a way for API users to throw
exceptions from their event handling code.
High level representation of a workbook.
Helper class which is instantiated by reflection from
WorkbookFactory.create(java.io.File) and similarThe BinaryRasterOperation Enumeration section lists the binary raster-operation codes.
The DeviceIndependentBitmap Object defines an image in device-independent bitmap (DIB) format.
A 16-bit unsigned integer that defines the brush style.
Helper interface to provide a default charset to records which would depend on a system charset
A 32-bit ColorRef Object that defines the color value.
The META_ARC record draws an elliptical arc.
The META_CHORD record draws a chord, which is defined by a region bounded by the intersection of
an ellipse with a line segment.
The META_ELLIPSE record draws an ellipse.
The META_FRAMEREGION record draws a border around a specified region using a specified brush.
The META_LINETO record draws a line from the drawing position that is defined in the playback
device context up to, but not including, the specified point.
The META_MOVETO record sets the output position in the playback device context to a specified
point.
The META_PIE record draws a pie-shaped wedge bounded by the intersection of an ellipse and two
radials.
The META_POLYGON record paints a polygon consisting of two or more vertices connected by
straight lines.
The META_POLYLINE record draws a series of line segments by connecting the points in the
specified array.
The META_POLYPOLYGON record paints a series of closed polygons.
The META_RECTANGLE record paints a rectangle.
The META_ROUNDRECT record paints a rectangle with rounded corners.
The META_SELECTOBJECT record specifies a graphics object for the playback device context.
The META_SETPIXEL record sets the pixel at the specified coordinates to the specified color.
An embedded resource - this class hides the logic of chained emf+ object records and other internals.
The MetafileEscapes specifies printer driver functionality that
might not be directly accessible through WMF records
The ColorUsage Enumeration (a 16-bit unsigned integer) specifies whether a color table
exists in a device-independent bitmap (DIB) and how to interpret its values,
i.e.
A record which contains an image (to be extracted)
The META_DIBSTRETCHBLT record specifies the transfer of a block of pixels in device-independent format
according to a raster operation, with possible expansion or contraction.
The META_EXTFLOODFILL record fills an area with the brush that is defined in
the playback device context.
The META_FILLREGION record fills a region using a specified brush.
The META_FLOODFILL record fills an area of the output surface with the brush that
is defined in the playback device context.
The META_INVERTREGION record draws a region in which the colors are inverted.
The META_PAINTREGION record paints the specified region by using the brush that is
defined in the playback device context.
The META_PATBLT record paints a specified rectangle using the brush that is defined in the playback
device context.
The META_SETDIBTODEV record sets a block of pixels in the playback device context
using deviceindependent color data.
The META_SETPOLYFILLMODE record sets polygon fill mode in the playback device context for
graphics operations that fill polygons.
A 16-bit unsigned integer that defines polygon fill mode.
The META_STRETCHBLT record specifies the transfer of a block of pixels according to a raster
operation, with possible expansion or contraction.
The META_STRETCHDIB record specifies the transfer of color data from a
block of pixels in device independent format according to a raster operation,
with possible expansion or contraction.
The Font object specifies the attributes of a logical font
ClipPrecision Flags specify clipping precision, which defines how to clip characters that are
partially outside a clipping region.
The output quality defines how carefully to attempt to match the logical font attributes to those of an actual
physical font.
The output precision defines how closely the output must match the requested font's height,
width, character orientation, escapement, pitch, and font type.
An util class for saving the state of a
Graphics2D objectThe HatchStyle Enumeration specifies the hatch pattern.
Helper class which is instantiated by
DrawPictureShape
via reflectionA 16-bit unsigned integer that defines the mapping mode.
The META_CREATEBRUSHINDIRECT record creates a Brush Object
from a LogBrush Object.
The META_DELETEOBJECT record deletes an object, including Bitmap16, Brush,
DeviceIndependentBitmap, Font, Palette, Pen, and Region.
The META_DIBCREATEPATTERNBRUSH record creates a Brush Object with a
pattern specified by a DeviceIndependentBitmap (DIB) Object
The META_RESTOREDC record restores the playback device context from a previously saved device
context.
The META_SAVEDC record saves the playback device context for later retrieval.
The META_SETBKCOLOR record sets the background color in the playback device context to a
specified color, or to the nearest physical color if the device cannot represent the specified color.
The META_SETBKMODE record defines the background raster operation mix mode in the playback
device context.
A 16-bit unsigned integer that defines background mix mode.
The META_SETLAYOUT record defines the layout orientation in the playback device context.
The META_SETMAPMODE record defines the mapping mode in the playback device context.
The META_SETMAPPERFLAGS record defines the algorithm that the font mapper uses when it maps
logical fonts to physical fonts.
The META_SETRELABS record is reserved and not supported.
The META_SETROP2 record defines the foreground raster operation mix mode in the playback device
context.
The META_SETSTRETCHBLTMODE record defines the bitmap stretching mode in the playback device
context.
Marker interface for Records, which should be added to the
WMF object table for further selection
The META_ANIMATEPALETTE record redefines entries in the logical palette that
is defined in the playback device context with the specified Palette object
The logical palette that is specified by the Palette object in this record is the
source of the palette changes, and the logical palette that is currently selected
into the playback device context is the destination.
The META_CREATEPALETTE record creates a Palette Object
The META_REALIZEPALETTE record maps entries from the logical palette that
is defined in the playback device context to the system palette.
The META_RESIZEPALETTE record redefines the size of the logical palette that is defined in the
playback device context.
The META_SELECTPALETTE record defines the current logical palette with a specified Palette Object.
The META_SETPALENTRIES record defines RGB color values in a range of entries in the logical
palette that is defined in the playback device context.
The 16-bit PenStyle Enumeration is used to specify different types of pens
that can be used in graphics operations.
Available record types for WMF
HWMFs Raster Operation for Binary arguments (Source / Destination)
HWMFs Raster Operation for Ternary arguments (Source / Destination / Pattern)
Each ternary raster operation code represents a Boolean operation in which the values of the pixels in
the source, the selected brush, and the destination are combined.
The META_EXTTEXTOUT record outputs text by using the font, background color, and text color that
are defined in the playback device context.
The META_SETTEXTALIGN record defines text-alignment values in the playback device context.
The META_SETTEXTCHAREXTRA record defines inter-character spacing for text justification in the
playback device context.
The META_SETTEXTCOLOR record defines the text foreground color in the playback device context.
The META_SETTEXTJUSTIFICATION record defines the amount of space to add to break characters
in a string of justified text.
The META_TEXTOUT record outputs a character string at the specified location by using the font,
background color, and text color that are defined in the playback device context.
The META_EXCLUDECLIPRECT record sets the clipping region in the playback device context to the
existing clipping region minus the specified rectangle.
The META_INTERSECTCLIPRECT record sets the clipping region in the playback device context to the
intersection of the existing clipping region and the specified rectangle.
The META_OFFSETCLIPRGN record moves the clipping region in the playback device context by the
specified offsets.
The META_OFFSETVIEWPORTORG record moves the viewport origin in the playback device context
by specified horizontal and vertical offsets.
The META_OFFSETWINDOWORG record moves the output window origin in the
playback device context by specified horizontal and vertical offsets.
The META_SCALEVIEWPORTEXT record scales the horizontal and vertical extents of the viewport
that is defined in the playback device context by using the ratios formed by the specified
multiplicands and divisors.
The META_OFFSETWINDOWORG record moves the output window origin in the
playback device context by specified horizontal and vertical offsets.
The META_SELECTCLIPREGION record specifies a Region Object to be the current clipping region.
The META_SETVIEWPORTEXT record sets the horizontal and vertical extents
of the viewport in the playback device context.
The META_SETVIEWPORTORG record defines the viewport origin in the playback device context.
The META_SETWINDOWEXT record defines the horizontal and vertical extents
of the output window in the playback device context.
The META_SETWINDOWORG record defines the output window origin in the playback device context.
This class acts as the bucket that we throw all of the Word data structures
into.
This class holds much of the core of a Word document, but
without some of the table structure information.
This class is used to create a list in a Word document.
Used by developers to list out key information on a HWPF file.
Provides very simple support for old (Word 6 / Word 95) files.
Methods that wrap
HWPFDocument parsing functionality.An exception that indicates a problem reading a doc file.
Represents a hyperlink.
A PowerPoint hyperlink
Implementation of Excel HYPERLINK function.
Represents an Excel hyperlink.
The
HyperlinkRecord (0x01B8) wraps an HLINK-record
from the Excel-97 format.Represents a hyperlink relationship.
Hyphenation.
A bridge to the consumer application.
An IBody represents the different parts of the document which
can contain collections of Paragraphs and Tables.
9 Jan 2010
Interface for anything that can be at a table cell level:
XWPFTableCell, XWPFSDTCellIcon / Multi-State Conditional Formatting Rule Record.
High level representation for the Icon / Multi-State Formatting
component of Conditional Formatting settings
Icon / Multi-State specific Threshold / value (CFVO),
for changes in Conditional Formatting
Interface specifying how an algorithm to be used by
DStarRunner should look like.In Excel there are many ways to handle manipulating a workbook based
on some arbitrary user action (onChange, etc).
Implementation for the Excel function IF
Implementation of 'Analysis Toolpak' the Excel function IFNA()
Syntax:
IFNA(test_value, default_value)
IFNA(test_value, default_value)
Types of ignored workbook and worksheet error.
This exception is thrown when there is an illegal value set in a
PropertySet.This exception is thrown if HPSF encounters a variant type that is illegal
in the current context.
Utility to extract pictures from a PowerPoint file.
Aldus Placeable Metafile header - 22 byte structure before WMF data.
Classes can implement this interfaces to support other formats, for
example, use Apache Batik to render WMF (since POI 4.0, there's an internal WMF/EMF/EMF+ renderer in POI),
PICT can be rendered using Apple QuickTime API for Java:
Implementation for Excel IMAGINARY() function.
Implementation for Excel ImReal() function.
Definition of the indent level of some text.
Implementation for the Excel function INDEX
Interface for color index to RGB mappings.
A deprecated indexing scheme for colours that is still required for some records, and for backwards
compatibility with OLE2 formats.
A UDFFinder that can retrieve functions both by name and by fake index.
Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells
Implementation for Excel function INDIRECT
Contains the x- and y-coordinates of two points on an infinite line.
This is a replacement for
Insets which works on doubles
instead of intsrepresentation of an integer (32-bit) field at a fixed location
within a byte array
This class represents the metadata of a link in a slide/notes/etc.
The atom that holds metadata on Links in the document.
Implementation of Excel function INTERCEPT()
Shows where the Interface Records ends (MMS)
Defines the beginning of Interface records (MMS)
Program elements annotated @Internal are intended for
POI internal use only.
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.
Low level model implementation of a Workbook.
A List of `int`s; as full an implementation of the java.util.List
interface as possible, with an eye toward minimal creation of
objects.
A List of objects that are indexed AND keyed by an int; also allows for getting
the index of a value in the list
Integer (unsigned short integer) Stores an unsigned short value (java int) in a formula
Throw when an invalid operation is done.
Thrown if the zip file is invalid.
Calculates the internal rate of return.
Simple interface describing both
XWPFParagraph
and XWPFSDTExperimental interface to offer rudimentary read-only processing of
of the contentblock of an SDT/ContentControl.
Used to help optimise cell evaluation result caching by allowing applications to specify which
parts of a workbook are final.
The term final is introduced here to denote immutability or 'having constant definition'.
The term final is introduced here to denote immutability or 'having constant definition'.
Tells whether to iterate over formula calculations or not.
Represents a JPEG picture data in a PPT file
A complex type that specifies the encryption used within this element.
A sequence of KeyEncryptor elements.
JSR105 key selector implementation using the ds:KeyInfo data of the signature
itself.
Signature Facet implementation that adds ds:KeyInfo to the XML signature.
Label Record (0x0204) - read only support for strings stored directly in the cell...
Refers to a string in the shared string table and is a column value.
A dummy record to indicate that we've now had the last
cell record for this row.
Utility for delaying the concatenation of multiple byte arrays.
Provides Lazy Evaluation to a 3D Reference
This structure specifies the properties of a list or drop-down list embedded object in a sheet.
This structure specifies properties of the dropdown list control
Implementation for Excel LCM() function.
Record for the left margin.
Defines a legend for a chart.
Ptg class to implement less than or equal
Less than operator PTG "<".
"The LFO structure specifies the LSTF element that corresponds to a list that
contains a paragraph.
List Format Override (LFO).
The LFOData structure contains the Main Document CP of the corresponding LFO,
as well as an array of LVL override data.
The LFOLVL structure contains information that is used to override the formatting information of a corresponding LVL.
Interface for Lines ...
Base class for linear regression functions.
Represents the shape decoration that appears at the ends of lines.
Describes a line format record.
This class is used to determine line spacing for a paragraph.
Specifies the logic which shall be used to calculate the line spacing of the
parent object when it is displayed in the document.
Java class for CT_Path2DLineTo complex type.
Describes a linked data record.
Specifies type of automatic numbered bullet points that should be applied to a paragraph.
The LFOLVL structure contains information that is used to override the
formatting information of a corresponding LVL.
"The LVL structure contains formatting information about a specific level in
a list.
a utility class for handling little-endian numbers, which the 80x86 world is
replete with.
Exception to handle buffer underruns
Adapts a plain byte array to
LittleEndianInputAdapts a plain byte array to
LittleEndianOutputa repository for constants shared by classes within this package
Stream that converts CP950 (MSOffice's dialect of Big5), with
zero-byte padding for ASCII and in LittleEndianOrder.
Wraps an
InputStream providing LittleEndianInputEnum to specify initial remapping of the FormatID based on thd LCID
Locale Collection
This utility class is used to set locale and time zone settings beside
of the JDK internal
Locale.setDefault(Locale) and
TimeZone.setDefault(TimeZone) methods, because
the locale/time zone specific handling of certain office documents -
maybe for different time zones / locales ...Implementation of the various ISxxx Logical Functions, which
take a single expression argument, and return True or False.
representation of a long (16-bit) field at a fixed location within
a byte array
Implementation of Excel function LOOKUP.
Common functionality used by VLOOKUP, HLOOKUP, LOOKUP and MATCH
Enumeration to support 4 valued comparison results.
Represents a single row or column within an
AreaEval.The LSTF structure contains formatting properties that apply to an entire list.
The LVLF structure contains formatting properties for an individual level in a list.
This class provides common functionality for the
various LZW implementations in the different file
formats.
The main Contents.
ExtractorFactory for HSSF and Old Excel format
Master slide
A pure-MAPI attribute which applies to a
HMEFMessage
or one of its Attachments.A pure-MAPI attribute holding a Date, which applies
to a
HMEFMessage or one of its Attachments.Reads an Outlook MSG File in and provides hooks into its data structure.
A MAPI file can be an email (NOTE) or a number of other types
This class implements the Custom XML Mapping Part (Open Office XML Part 1:
chapter 12.3.6)
An instance of this part type contains a schema for an XML file, and
information on the behavior that is used when allowing this custom XML schema
to be mapped into the spreadsheet.
Holds the list of MAPI Attributes, and allows lookup by friendly name, ID and
MAPI Property Name.
A pure-MAPI attribute holding RTF (compressed or not), which applies
to a
HMEFMessage or one of its Attachments.A pure-MAPI attribute holding a String, which applies
to a
HMEFMessage or one of its Attachments.The margin interface is a parent used to define left, right, top and bottom margins.
Specifies the Indent Level for the text
Implementation for the MATCH() Excel function.
Utility methods for dealing with conversions
Implementation for the Excel function MAXIFS
Memory version of a package part.
Build an output stream for MemoryPackagePart.
Optional record defining a square area of cells to "merged" into one cell.
A
PropertiesChunk for a Message or Embedded-Message.A Chunk that holds the details given back by the server at submission time.
Represents a metafile picture which can be one of the following types: EMF, WMF, or PICT.
A structure which represents a 34-byte header preceding the compressed metafile data
Experimental provider / loader for metro shapes.
Implementation for the Excel function MINIFS
Calculates Modified internal rate of return.
Represents the (intermediate) evaluated result of a missing function argument.
Missing Function Arguments
A dummy record for when we're missing a cell in a row,
but still want to trigger something
A HSSFListener which tracks rows and columns, and will
trigger your HSSFListener for all rows and cells,
even the ones that aren't actually stored in the file.
A dummy record for when we're missing a row, but still
want to trigger something
This exception is thrown if one of the
PropertySet's
convenience methods does not find a required Section.defines how many add menu and del menu options are stored in the file.
Representation of Macro module in office file.
Type of macro module
Contains the x- and y-coordinates of the first vertex of a shape or the x-
and y-coordinates of the first vertex after a break in a path, relative to
the height and width of the shape.
Java class for CT_Path2DMoveTo complex type.
Represents a movie in a PowerPoint document.
Represents a set of columns in a row with no value but with styling.
Used to store multiple RK numbers on a row.
This is the super class for all excel function evaluator
classes that take variable number of operands, and
where the order of operands does not matter
Implements the standard mathematical multiplication "*"
Implementation of Excel function NA()
Represents a defined name for a range of cells.
Defines a comment associated with a specified name.
Collection of convenience chunks for the NameID part of an outlook file
See the spec at 2.5.198.76 PtgName
Defines a named range within a workbook.
A Name, be that a Named Range or a Function / User Defined
Function, addressed in the HSSF External Sheet style.
A Name, be that a Named Range or a Function / User Defined
Function, addressed in the HSSF External Sheet style.
This exception is thrown if a
PropertySet is to be written
but does not have a formatID set (see Section.setFormatID(ClassID) or
Section.setFormatID(byte[]).This exception is thrown if a format error in a property set stream is
detected or when the input data do not constitute a property set stream.
Implementation for Excel NORMDIST() and NORM.DIST() functions.
Implementation for Excel NORMINV() and NORM.INV() functions.
Implementation for Excel NORMSDIST() and NORM.S.DIST functions.
Implementation for Excel NORMSINV() and NORM.S.INV() functions.
This exception is thrown if one of the
PropertySet's
convenience methods that require a single Section is called
and the PropertySet does not contain exactly one Section.Ptg class to implement not equal
NOTE: Comment Associated with a Cell (0x001C)
Master container for Notes.
User-friendly interface to access document notes information
A Notes Atom (type 1009).
Default implementation of
Notes interfaceHolds information about document notes (footnotes or ending notes)
ftNts (0x000D)
Word document notes types (and their FIB field indices)
This feature has not been implemented yet.
An exception thrown by implementors of
FormulaEvaluator,
when attempting to evaluate a formula which requires features
that POI does not (yet) support.This is the default implementation of a Function class.
An exception thrown by implementors of
FormulaEvaluator when
attempting to evaluate a formula which requires a function that POI
does not (yet) support.This exception is thrown when we try to open a file that doesn't
seem to actually be an OOXML (Office Open XML) file after all
This exception is thrown when we try to open a file that doesn't
seem to actually be an OLE2 file after all
Implementation of Excel NOW() Function
Calculates the net present value of an investment by using a discount rate
and a series of future payments (negative values) and income (positive
values).
Ignores all serialization events.
Excel compares numbers using different rules to those of java, so
Double.compare(double, double) won't do.The number format index record indexes format table.
Utility class to translate numbers in letters, usually for lists.
Helper class for number related operations.
Number Stores a floating point value in a formula value stored in a 8 byte
field using IEEE notation
NUMBER (0x0203) Contains a numeric cell value.
Excel converts numbers to text with different rules to those of java, so
Double.toString(value) won't do./**
Implementation for the NUMBERVALUE() Excel function.
Common interface for OLE shapes, i.e.
Common interface for OLE shapes, i.e.
Links text to an object on the chart or identifies it as the title.
Protect embedded object with the lamest "security" ever invented.
An shape which references an embedded OLE object
OBJRECORD (0x005D)
Implementation for Excel Oct2Dec() function.
This exception is thrown when we are given an ODF-based file
(eg OpenOffice .ods) instead of an actually OOXML (Office Open XML) file
OEPlaceholderAtom (3011).
Work-around for Office2010 to accept the XAdES-BES/EPES signature.
Information about drawings in the document.
User-friendly interface to office drawing objects.
User-friendly interface to access document part's office drawings
This exception is thrown when we try to open a file that's actually
an Office 2007+ XML file, rather than an OLE2 file (which is what
POIFS works with)
Implementation for Excel function OFFSET()
Base class for all old (Biff 2 - Biff 4) cell value records
(implementors of
CellValueRecordInterface).This class holds all of the character formatting
properties from Old (Word 6 / Word 95) documents.
A text extractor for old Excel files, which are too old for
HSSFWorkbook to handle.
Word 6.0 Font information
Base class of all the exceptions that POI throws in the event
that it's given a file that's older than currently supported.
Font table for Word 6.0
Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in
encoded form, along with the value if a number
Biff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for
strings stored directly in the cell, from the older file formats that
didn't use
LabelSSTRecordThis class holds all of the paragraph formatting
properties from Old (Word 6 / Word 95) documents.
This exception is thrown when we try to open a PowerPoint file, and
it's too old for us.
This class holds all of the section formatting
properties from Old (Word 6 / Word 95) documents.
Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5
Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for
formula string results.
Lightweight representation of a text piece.
Represents an Ole10Native record which is wrapped around certain binary
files being embedded in OLE2 documents.
This exception is thrown when we are given an OLE2-based file
(eg Excel .xls) instead of an actually OOXML (Office Open XML) file
Scratchpad-specific logic for
ExtractorFactory and
ExtractorFactory, which permit the other two to run with
no Scratchpad jar (though without functionality!)Prints out the contents of a OOXML container.
Reads a zipped OOXML file and produces a copy with the included
pretty-printed XML files.
Methods exposed by XSSF, SXSSF and related sheets - that are additional to the ones on the
Sheet interface.Office OpenXML Signature Facet implementation.
JSR105 URI dereferencer for Office Open XML documents.
Allows disabling specific OPC compliance rules.
Represents a container that can store multiple data objects.
Global exception throws when a critical error occurs.
Global exception throws when a critical error occurs (this exception is
set as Runtime in order not to force the user to manage the exception in a
try/catch).
Provides functionality for evaluating arguments to functions and operators.
Contains all the contextual information required to evaluate an operation
within a formula
defines a Ptg that is an operation instead of an operand
OEPlaceholderAtom (3998).
A text extractor for HSMF (Outlook) .msg files.
Specifies package access.
Provides handy methods to work with OOXML packages
Open Packaging Convention namespaces URI.
Provides a base class for parts stored in a Package.
A package part collection.
An immutable Open Packaging Convention compliant part name.
Represents the core properties of an OPC package.
Package properties marshaller.
Represents the core properties part of a package.
Package properties unmarshaller.
A part relationship.
Represents a collection of PackageRelationship elements that are owned by a
given PackagePart or the Package.
Relationship types.
Helper for part and pack URI.
Record that contains the functionality page breaks (horizontal and vertical)
Since both records store 2byte integers (short), no point in
differentiating it in the records.
SXPI - Page Item (0x00B6)
Enumeration which represents the various margins which are present within an
Excel worksheet
Specifies printed page order.
Groups the page settings records for a worksheet.
The PaintStyle can be modified by secondary sources, e.g.
Supports custom palettes.
Holds information regarding a split plane or freeze plane for a sheet.
Describes the frozen and unfrozen panes.
Type of pane used in sheet.
Paragraph Properties.
This class represents the bin table of Word document but it also serves as a
holder for all of the paragraphs of document that have been loaded into
memory.
The enumeration value indicating the possible paper size for a sheet
Represents a PAP FKP.
DANGER - works in bytes!
Make sure you call getStart() / getEnd() when you want characters
(normal use), but getStartByte() / getEndByte() when you're
reading in / writing out!
This class represents a paragraph, made up of one or more
runs of text.
Specifies all types of alignment which are available to be applied to objects in a
WordprocessingML document
Definition for the common paragraph text property bitset.
Used internally to navigate the paragraph text style hierarchy within a shape and fetch properties
Behavior for parent (directory) properties
Interface to define how a record can indicate it cares about what its
parent is, and how it wants to be told which record is its parent.
While formula tokens are stored in RPN order and thus do not need parenthesis
for precedence reasons, Parenthesis tokens ARE written to ensure that user
entered parenthesis are displayed as-is on reading back
Throw when trying to create a
PackagePart but one
already exists with that name.Object implemented this interface are considered as part marshaller.
Classes implementing this interface are considered as part unmarshaller.
Stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)
Protection Revision 4 password Record (0x01BC)
Specifies a creation path consisting of a series of moves, lines and curves
that when combined forms a geometric shape
A path command in DrawingML.
Pattern Formatting Block of the Conditional Formatting Rule Record.
Implementation of Excel formula token '%'.
Percent PTG.
Implementation of 'the Excel function PERCENTRANK()
Syntax:
PERCENTRANK(array, X, [significance])
PERCENTRANK(array, X, [significance])
General holder for PersistPtrFullBlock and PersistPtrIncrementalBlock
records.
A record that can be referenced in PersistPtr storage.
The PICF structure specifies the type of a picture, as well as the size of
the picture and information about its border.
The PICF structure specifies the type of a picture, as well as the size of the
picture and information about its border.
Represents Macintosh PICT picture data.
Represents embedded picture extracted from Word Document
Repersents a picture in a SpreadsheetML document
Helper class for mapping Pictures to Runs within
a document.
User-implemented pictures manager to store images on-disk
Holds information about all pictures embedded in Word Document either via "Insert -> Picture -> From File" or via
clipboard.
General enum class to define a picture format/type
Picture types supported by MS Word format
Extended details about placholders
For dumping out the PLC contents of QC Bits of a
HPBF (Publisher) file, while we try to figure out
what the format of them is.
Plex of CPs stored in File (PLCF)
Structure describing the Plex for fields (contained plclfd* in the spec).
The PlfLfo structure contains the list format override data for the document.
precedes and identifies a frame as belonging to the plot area.
The plot growth record specifies the scaling factors used when a font is scaled.
Represents a PNG picture data in a PPT file
This holds the common functionality for all POI
Document classes.
Indicates a generic POI exception.
A class describing attributes of the Big Block Size
Processes a POIFS of a .msg file into groups of Chunks, such as
core data, attachment #1 data, attachment #2 data, recipient
data and so on.
A repository for constants shared by POI classes.
This class manages a document in the NIO POIFS filesystem.
Class POIFSDocumentPath
Dump internal structure of a OLE2 file into file system
This is the main class of the POIFS system; it manages the entire
life cycle of the filesystem.
A lister of the entries in POIFS files.
This class handles the MiniStream (small block store)
in the NIO case for
POIFSFileSystemAn event-driven reader for POIFS file systems.
Class POIFSReaderEvent
Interface POIFSReaderListener
This handles reading and writing a stream within a
POIFSFileSystem.Interface for a drill-down viewable object.
This class contains methods used to inspect POIFSViewable objects
A simple viewer for POIFS files
Class POIFSWriterEvent
Interface POIFSWriterListener
This class is used to get a log4j logger for the Apache POI project.
Base class of pointers, which hold metadata and offsets about
blocks elsewhere in the file
A stream that holds pointers, possibly in addition to some
other data too.
Factor class to create the appropriate pointers, based on the version
of the file
A Pointer from v5
A Pointer from v6+
Common Parent for OLE2 based Text Extractors
of POI Documents, such as .doc, .xls
You will typically find the implementation of
a given format's text extractor under
org.apache.poi.[format].extractor .
This holds the common functionality for all read-only
POI Document classes, i.e.
Common Parent for Text Extractors
of POI Documents.
This holds the common functionality for all POI OOXML Document classes.
Represents an entry of a OOXML package.
The RelationPart is a cached relationship between the document, which contains the RelationPart,
and one of its referenced child document parts.
Indicates a generic OOXML error.
Figures out the correct POITextExtractor for your supplied
document, and returns it.
Defines a factory API that enables sub-classes to create instances of
POIXMLDocumentPartWrapper around the three different kinds of OOXML properties
and metadata a document can have (Core, Extended and Custom),
as well Thumbnails.
The core document properties
Custom document properties
Extended document properties
A
POITextExtractor for returning the textual
content of the OOXML file properties, eg author
and title.Represents a descriptor of a OOXML relation.
Java class for CT_PolarAdjustHandle complex type.
A simple closed polygon shape
Represents a polyline vertex in a shape's geometry.
Records which either care about where they are on disk, or have other
records who care about where they are, will implement this interface.
A special (and dangerous) kind of Record Atom that cares about where
it lives on the disk, or who has other Atoms that care about where
this is on the disk.
A special (and dangerous) kind of Record Container, for which other
Atoms care about where this one lives on disk.
postion of a character in a paragrapho
1st RunPositon
2nd TextPosition
3rd CharacterPosition
These are actually wrappers onto Escher drawings.
Container records which always exists inside Document.
Uses record level code to locate PPDrawing entries.
Compute the interest portion of a payment.
An utility to convert slides of a .pptx slide show to a PNG image
Utility class which dumps raw contents of a ppt file into XML format
Defines whether to store with full precision or what's displayed by the gui
(meaning have really screwed up and skewed figures or only think you do!)
Preset colors defined in DrawingML aka known/system colors
These enumerations specify how cell comments shall be displayed for paper printing purposes.
Whether to print the gridlines when you enjoy the spreadsheet on paper.
Whether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.
The enumeration value indicating the print orientation for a sheet.
Stores print setup options -- bogus for HSSF (and marked as such)
A Chunk which holds (single) fixed-length properties, and pointer to the
variable length ones / multi-valued ones (which get their own chunk).
A property in a
Section of a PropertySet.This abstract base class is the ancestor of all classes
implementing POIFS Property behavior.
Interface PropertyConstants
Used internally to navigate the PresentationML text style hierarchy and fetch properties
This is a dictionary which maps property ID values to property
ID strings.
Represents a lightweight node in the Trees used to store content
properties.
Represents a property set in the Horrible Property Set Format
(HPSF).
Factory class to create instances of
SummaryInformation,
DocumentSummaryInformation and PropertySet.This class embodies the Property Table for a
POIFSFileSystem;
this is basically the directory for all of the documents in the
filesystem and looks up entries in the filesystem to their
chain of blocks.
A PropertyTemplate is a template that can be applied to any sheet in
a project.
An instance of a
MAPIProperty inside a PropertiesChunk.signed 64-bit integer that represents a base ten decimal, with four
digits to the right of the decimal point
64-bit integer specifying the number of 100ns periods since Jan 1, 1601
Describes whether this is a protected shared/tracked workbook
Defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)
Ptg represents a syntactic token in a formula.Extract text from HPBF Publisher files
An XSSF only special kind of Ptg, which stores the sheet / book
reference in string form.
An XSSF only special kind of Ptg, which stores a range of
sheet / book references in string form.
Parent of all Quill CONTENTS bits
A "PLC " (PLC) based bit of Quill Contents.
Type 0 seem to be somewhat rare.
Type 12 holds hyperlinks, and is very complex.
Type 4 is quite common.
Type 8 is quite common.
A Text based bit of Quill Contents
Java class for CT_Path2DQuadBezierTo complex type.
This class will get all the text from a Powerpoint Document, including
all the bits you didn't want, and in a somewhat random order, but will
do it very fast.
Read Quill Contents (/Quill/QuillSub/CONTENTS) from an HPBF (Publisher .pub) document
Implementation for Excel QUOTIENT () function.
This class is the central class of the HWPF object model.
Returns the rank of a number in a list of numbers.
Implements the Excel Rate function
This exception is thrown when HPSF tries to read a (yet) unsupported
variant type.
The enumeration value indicating reading order of a cell,
i.e., whether the reading order is Context(Default), Left To Right or Right To Left
This is a lightweight way to process the Shared Strings
table.
This record contains an ID that marks when a worksheet was last recalculated.
Collection of convenience chunks for the Recip(ient) part of an outlook file.
Orders by the recipient number.
This abstract class represents a record in the PowerPoint document.
All HSSF Records inherit from this class.
RecordAggregates are groups of of BIFF Records that are typically stored
together and/or updated together.A wrapper for
RecordAggregate.RecordVisitor which accumulates the sizes of all
records visited.Abstract class which all atom records will extend.
Common base class of
Record and RecordAggregateAbstract class which all container records will extend.
Title: Record Factory
A stream based way to get at complete records, with
as low a memory footprint as possible.
A common exception thrown by our binary format parsers
(especially HSSF and DDF), when they hit invalid
format or data when processing a record.
Title: Record Input Stream
Description: Wraps a stream and provides helper methods for the construction of records.
For use in BiffViewer which may construct
Records that don't completely
read all available data.Simplifies iteration over a sequence of
Record objects.List of all known record types in a PowerPoint document, and the
classes that handle them.
Helper functions for the record transformations.
Specifies possible rectangle alignment types.
Reference 3D Ptg
XSSF 3D Reference
Defines a reference relationship.
RefError - handles deleted cell reference
RefEval is the super interface for Ref2D and Ref3DEval.
Common base class for implementors of
RefEvalHandling of a list of values, e.g.
Describes which reference mode to use
ReferencePtg - handles references (such as A1, A2, IA4)
ReferencePtgBase - handles references (such as A1, A2, IA4)
Flag whether to refresh all external data when loading a sheet.
Various utility functions that make working with a region of cells easier.
Base class for all comparison operator evaluators
JSR105 implementation of the RelationshipTransform transformation.
Relationship Transform parameter specification class.
Contains x-and y-coordinates of the ending vertex of a straight line segment
relative to a shape's width and height.
Contains the x- and y-coordinates of the endpoint of a quadratic Bezier curve
relative to the shape's width and height and the x- and y-coordinates of the
control point of the curve relative shape's width and height.
Program elements annotated @Removal track the earliest final release
when a deprecated feature will be removed.
An implementation of the Excel REPLACE() function:
Simple FilterInputStream that can replace occurrences of bytes with something else.
Helper class for allowing to produce so called
"reproducible" output.
Implementation for Excel REPT () function.
String table containing the names of authors of revision marks, e-mails and
comments in this document.
Container class for PKI revocation data.
Interface for a service that retrieves revocation data about some given
certificate chain.
Rich text unicode string.
Record for the right margin.
An internal 32 bit number with the two most significant bits storing the type.
Utility class for helping convert RK numbers.
Wrapper of InputStream which provides Run Length Encoding (RLE)
decompression on the fly.
Implementation for Excel Roman() function.
Root property
An atom record that specifies that a shape is a header or footer placeholder shape
High level representation of a row of a spreadsheet.
Used to specify the different possible policies
if for the case of null and blank cells
Segregates the 'Row Blocks' section of a single sheet into plain row/cell records and
shared formula records.
Implementation for the Excel function ROW
RowGeneratorFunction for Deferred SXSSF sheets
Stores the row information for the sheet.
Implementation for Excel ROWS function.
Helper for shifting rows up or down
A single entry in the
SavedByTable.String table containing the history of the last few revisions ("saves") of
the document.
Defines whether to recalculate before saving (set to true)
Common superclass of all
Ptgs that represent simple constant values.I have no idea what a Scenario is or why on would want to protect it with the lamest "security" ever invented.
Specifies the window's zoom magnification.
Represents a section in a
PropertySet.Section Descriptor (SED)
See page 186 for details.
Shows the user's selection on the sheet for write set num refs to 0
Section Properties.
The series chart group index record stores the index to the CHARTFORMAT record (0 based).
links a series to its position in the series list.
The series label record defines the type of label associated with the data format record.
SERIESLIST (0x1016)
The series record describes the overall data for a series.
SERIESTEXT (0x100D)
The SHD is a substructure of the CHP, PAP, and TC for Word 2000.
The SHD80 is a substructure of the CHP and PAP, and TC for Word 97.
Common interface for all drawing shapes
A common interface for shape groups.
This acceptor only allows traversal to shapes that have useful data
associated with them, and tries to elide details that aren't useful when
analyzing the content of a document.
To use this to render only particular shapes, override it and provide an
appropriate implementation of getAcceptor() or accept()
Only visits text nodes, accumulates text content into a string
The text is returned in arbitrary order, with no regards to
the location of the text on the page.
known preset shape geometries in PresentationML
All known types of automatic shapes in DrawingML
Used to iterate through shapes
To change the behavior of a particular visitor, you can override either
accept() or getAcceptor() [preferred]
If accept() or visit() throw StopVisitingThisBranch, the iteration will not
visit subshapes of the shape.
Common Interface for all Shared Features
Encapsulates logic to convert shared formula into non shared equivalent
Primarily used as an excel optimization so that multiple similar formulas are not
written out too many times.
Table of strings shared across all sheets in a workbook.
Table of strings shared across all sheets in a workbook.
Manages various auxiliary records while constructing a
RowRecordsAggregate:
SharedFormulaRecords
ArrayRecords
TableRecords
The Shd80 structure specifies the colors and pattern that are used for background shading.
The Shd structure specifies the colors and pattern that are used for background shading.
Common parent of Slides, Notes and Masters
Implementation for Excel SHEET() function.
High level representation of a Excel worksheet.
Class
SheetBuilder provides an easy way of building workbook sheets
from 2D array of Objects.The 'Conditional Formatting' facet of
SheetThe superclass of all sheet container records - Slide, Notes, MainMaster, etc.
Initially copied from BigGridDemo "SpreadsheetWriter".
Formats sheet names for use in formula expressions.
Describes a chart sheet properties record.
Helper methods for when working with Usermodel sheets
A function with 5 inputs and a return value.
Specifies sheet visibility
representation of a short (16-bit) field at a fixed location within
a byte array
This class bundles the configuration options used for the existing
signature facets.
JSR105 Signature Facet base class.
This class is the default entry point for XML signatures and can be used for
validating an existing signed office document and signing an office document.
Base class for SignatureLines (XSSF,XWPF only)
This listener class is used, to modify the to be digested xml document,
e.g.
This listener interface is used, to modify the to be digested xml document,
e.g.
Interface for the signature policy service.
A common interface for simple shapes.
Implementation of the SINGLE function, used by Dynamic Arrays, which is
now largely replaced by the @ character.
This class implements the Single Cell Tables Part (Open Office XML Part 4:
chapter 3.5.2)
Translates Graphics2D calls into PowerPoint.
Master container for Slides.
Uses record level code to locate Notes and Slide records.
A Slide Atom (type 1007).
Holds the geometry of the Slide, and the ID of the placeholders on the slide.
Gets all the different things that have Slide IDs (of sorts)
in them, and displays them, so you can try to guess what they
all mean
Date: 11/5/11
These are tricky beasts.
Inner class to wrap up a matching set of records that hold the
text for a given sheet.
A SlidePersist Atom (type 1011).
This class provides a way to "peek" inside a powerpoint file.
Common SlideShow extractor
This class provides a way to view the contents of a powerpoint file.
Implementation of Excel function SLOPE()
Uses record level code to Documents.
Uses record level code to locate SlideListWithText entries.
A container holding information about a sound.
Is a container for all sound related atoms and containers.
Storage for embedded sounds.
Contains x- and y-coordinates for a spline's control point and a spline's
knot.
Contains x- and y-coordinates for a spline's second control point, its second
knot, its first knot, the last knot, and the degree of the spline.
This enum allows spreadsheets from multiple Excel versions to be handled by the common code.
This class is used to iterate through a list of sprms from a Word 97/2000/XP
document.
This class is used to represent a sprm operation from a Word 97/2000/XP
document.
Implementation for Excel SQRTPI() function.
For POI internal use only
A SlideShowSlideInfo Atom (type 1017).
An atom record that specifies which transition effects to perform during a slide show, and how to advance to the next presentation slide.
Combination of effectType and effectDirection: Combination of effectType and effectDirection typedescriptiondirection 0cut0x00 = no transition, 0x01 = black transition 1random0x00 2blinds0x00 = vertical, 0x01 = horizontal 3checkerlike blinds 4cover0x00 = left, 0x01 = up, 0x02 = right, 0x03 = down, 0x04 = left/up, 0x05 = right/up, 0x06 left/down, 0x07 = left/down 5dissolve0x00 6fade0x00 7uncoverlike cover 8random barslike blinds 9stripslike 0x04 - 0x07 of cover 10wipelike 0x00 - 0x03 of cover 11box in/out0x00 = out, 0x01 = in 13split0x00 = horizontally out, 0x01 = horizontally in, 0x02 = vertically out, 0x03 = vertically in 17diamond0x00 18plus0x00 19wedge0x00 20pushlike 0x00 - 0x03 of cover 21comblike blinds 22newsflash0x00 23alphafade0x00 26wheelnumber of radial divisions (0x01,0x02,0x03,0x04,0x08) 27circle0x00 255undefined0x00
An atom record that specifies which transition effects to perform during a slide show, and how to advance to the next presentation slide.
Combination of effectType and effectDirection: Combination of effectType and effectDirection typedescriptiondirection 0cut0x00 = no transition, 0x01 = black transition 1random0x00 2blinds0x00 = vertical, 0x01 = horizontal 3checkerlike blinds 4cover0x00 = left, 0x01 = up, 0x02 = right, 0x03 = down, 0x04 = left/up, 0x05 = right/up, 0x06 left/down, 0x07 = left/down 5dissolve0x00 6fade0x00 7uncoverlike cover 8random barslike blinds 9stripslike 0x04 - 0x07 of cover 10wipelike 0x00 - 0x03 of cover 11box in/out0x00 = out, 0x01 = in 13split0x00 = horizontally out, 0x01 = horizontally in, 0x02 = vertically out, 0x03 = vertically in 17diamond0x00 18plus0x00 19wedge0x00 20pushlike 0x00 - 0x03 of cover 21comblike blinds 22newsflash0x00 23alphafade0x00 26wheelnumber of radial divisions (0x01,0x02,0x03,0x04,0x08) 27circle0x00 255undefined0x00
Static String Table Record (0x00FC)
Used when checking if a key is valid for a document
Implementation for Excel STANDARDIZE() function.
Subclasses of this class (the majority of BIFF records) are non-continuable.
The StdfBase structure specifies general information about a style.
The StdfPost2000 structure specifies general information about a style.
A
PropertiesChunk for a Storage Properties, such as Attachments and
Recipients.Base of all Streams within a HDGF document.
SXIDSTM - Stream ID (0x00D5)
Unlike SheetDataWriter, this writer does not create a temporary file, it writes data directly
to the provided OutputStream.
Holds the representation of the stream on-disk, and
handles de-compressing it as required.
A Chunk made up of a single string.
String Stores a String value in a formula value stored in the format
<length 2 bytes>char[]
STRING (0x0207)
A Stream which holds Strings.
Collection of string handling utilities
This interface specifies the line style of a shape
The line dash with pattern.
The Stshif structure specifies general stylesheet information.
The STTB is a string table that is made up of a header that is followed by an
array of elements.
Describes a builtin to the gui or user defined style
Represents a document's stylesheet.
Table of styles shared across all sheets in a workbook.
The atom record that specifies additional text formatting.
A StyleTextPropAtom (type 4001).
Document text parts that can have text pieces (CPs)
Subrecords are part of the OBJ class.
An implementation of the SUBSTITUTE function:
Implementation for the Excel function SUBTOTAL
Implementation for the Excel function SUMIF
Implementation for the Excel function SUMIFS
Convenience class representing a Summary Information stream in a
Microsoft Office document.
Implementation for the Excel function SUMPRODUCT
Implementation of Excel function SUMX2MY2()
Implementation of Excel function SUMX2PY2()
Implementation of Excel function SUMXMY2()
A External Workbook Description (Supplemental Book).
Marking class for elements to be ignored by the forbidden apis check
Wrapper class to pass changes to rendering hints down to the svg graphics context defaults
which can be read by the extension handlers
Extension of Batik's DefaultExtensionHandler which handles different kinds of Paint objects
Helper class to base image calculation on actual viewbox instead of the base box (1,1)
Implementation of 'Analysis Toolpak' Excel function SWITCH()
Streaming version of XSSFCell implementing the "BigGridDemo" strategy.
Streaming Creation Helper, which performs some actions
based on the Streaming Workbook, and some on the related
regular XSSF Workbook
Streaming version of Drawing.
SXSSF wrapper around the SXSSF and XSSF workbooks
Streaming-specific Formula Evaluator, which is able to
lookup cells within the current Window.
Streaming version of Picture.
Streaming version of XSSFRow implementing the "BigGridDemo" strategy.
Streaming version of XSSFSheet implementing the "BigGridDemo" strategy.
Streaming version of XSSFWorkbook implementing the "BigGridDemo" strategy.
A helper class for dealing with SystemTime Structs, as defined at
http://msdn.microsoft.com/library/en-us/sysinfo/base/systemtime_str.asp .
Implementation of Excel T() function
Tab descriptor.
Contains an array of sheet id's.
XSSF Only!
High level abstraction of table in a workbook.
The record specifies a data table.
Sets alignment values allowed for Tables and Table Rows
Sets height rule values allowed for Table Rows
Data table style definition.
style information for a specific table instance, referencing the document style
and indicating which optional portions of the style to apply.
TABLESTYLES (0x088E)
Ordered list of table style elements, for both data tables and pivot tables.
The width types for tables and table cells.
Table Properties
Specifies whether the target of a PackageRelationship is inside or outside a Package.
The TBD is a substructure of the PAP.
This ptg indicates a data table.
Table Cell Descriptor.
Implementation for Excel TDIST() function.
Implementation for Excel T.DIST.2T() function.
Implementation for Excel T.DIST() function.
Implementation for Excel T.DIST.RT() function.
Interface for creating temporary files.
Interface used by the
TempFile utility class to create temporary files.(Experimental) Temp File version of a package part.
An experimental POIFSFileSystem to support the encryption of large files
Specified a list of text alignment types
Specifies all types of vertical alignment which are available to be applied to of all text
on each line displayed within a paragraph.
Definition for the text alignment property.
Specifies a list of auto-fit types.
Represents a TextFrame shape in PowerPoint.
A TextBytesAtom (type 4008).
Text Capitalization that is to be applied to the text run.
A TextCharsAtom (type 4000).
Vertical Text Types
Specified a list of text font alignment types
A TextHeaderAtom (type 3999).
Text Horizontal Overflow
The TXO record (0x01B6) is used to define the properties of a text box.
Specifies a list of text alignment types
This structure store text autonumber scheme and start number.
Lightweight representation of a text piece.
The piece table for matching up character positions to bits of text.
Definition of a property of some text, or its paragraph.
For a given run of characters, holds the properties (which could
be paragraph properties or character properties).
The text record is used to define text stored on a chart.
Ruler of a text as it differs from the style's ruler settings.
Some text.
Type of placeholder fields
Type of text capitals
saves the begin and end position of a text in a Paragraph
Specifies alist of auto-fit types.
Vertical Text Types
This enum represents a compromise for the handling of
HSLF run types (see org.apache.poi.hslf.record.TextHeaderAtom) and
XSLF placeholders (see org.apache.poi.xslf.usermodel.Placeholder).
The special info runs contained in this text.
A enum that specifies the spelling status of a run of text.
Uses record level code to locate StyleTextPropAtom entries.
Text Vertical Overflow
Class that represents theme of XLSX document.
Small utility to allow to remove references held in ThreadLocals.
Optional Extension to the likes of
AreaEval and
AreaEvalBase,
which allows for looking up 3D (sheet+row+column) evaluationsThreshold / value (CFVO) for changes in Conditional Formatting
Class to manipulate data in the Clipboard Variant (
VT_CF) format.The Tick record defines how tick marks and label positioning/formatting
Implementation for the Excel function TIME
This interface is used to decouple the timestamp service logic from
the actual downloading code and to provide an interface for user code
using a different http client implementation.
Interface for a time-stamp service.
Interface for trust validator of a TSP.
This default implementation is used to decouple the timestamp service logic from
the actual downloading code and to provide a base for user code
using a different http client implementation
Implementation for the TIMEVALUE() Excel function.
Table Autoformat Look sPecifier (TLP).
An attribute which applies to a
HMEFMessage
or one of its Attachments.A Date attribute which applies to a
HMEFMessage
or one of its Attachments.A TNEF Attribute holding MAPI Attributes, which applies to a
HMEFMessage or one of its Attachments.Holds the list of TNEF Attributes, and allows lookup
by friendly name, ID and MAPI Property Name.
A String attribute which applies to a
HMEFMessage
or one of its Attachments.Implementation of Excel TODAY() Function
Record for the top margin.
The TrailerStream is a special kind of Stream containing pointers,
and some core document settings.
Implementation for the Excel function TREND
A TSP time-stamp service implementation.
Common interface of
AreaEval and AreaEvalBase,
for 2D (row+column) evaluationsThe atom that holds starting and ending character positions of a hyperlink
TxMasterStyleAtom atom (4003).
The types list and details are available from
http://msdn.microsoft.com/en-us/library/microsoft.exchange.data.contenttypes.tnef.tnefpropertytype%28v=EXCHG.140%29.aspx
Lists the different MAPI types
Common interface for "Add-in" libraries and user defined function libraries.
Unary Plus operator - does not have any effect on the operand
Unary Plus operator - does not have any effect on the operand
If this record occurs in the Worksheet Substream, it indicates that the formulas have not
been recalculated before the document was saved.
Specifies the types of patterns which may be used to create the underline
applied beneath the text in a run.
This exception is thrown if a certain type of property set is
expected (e.g.
A data structure used to hold some data we don't
understand / can't handle, so we have it available
for when we come to write back out again
Unicode String - just standard fields that are in several records.
The units record describes units.
This record is used whenever an escher record is encountered that
we do not explicitly support.
Any Quill Contents bits we don't know
how to handle explicitly
Unknown record just tells you the sid so you can figure out what records you are missing.
If we come across a record we don't know about, we create one of
these.
A placeholder for a stream where we don't known anything
about how to process / handle it
Context needed for the unmarshall process of a part.
Base class of all the exceptions that POI throws in the event
that it's given a file that isn't supported
This exception is thrown if HPSF encounters a variant type that isn't
supported yet.
Uses record level code to locate UserEditAtom records, and other
persistence related atoms.
A UserEdit Atom (type 4085).
Username-aware subclass of
DefaultTempFileCreationStrategy
that avoids permission issues when deploying applications with multiple users on the same server.The UserSViewBegin record specifies settings for a custom view associated with the sheet.
The UserSViewEnd record marks the end of the settings for a custom view associated with the sheet
Tells the GUI if this was written by something that can use "natural language" formulas.
Implementation for Excel VALUE() function.
Common superclass of all value operators.
The value range record defines the range of the value axis.
Aggregate value records together.
The
Variant types as defined by Microsoft's COM.Supports reading and writing of variant data.
This exception is thrown if HPSF encounters a problem with a variant type.
An atom record that specifies a reference to the VBA project storage.
A container record that specifies VBA information for the document.
This tool extracts out the source of all VBA Modules of an office file,
both OOXML (eg XLSM) and OLE2/POIFS (eg DOC), to STDOUT or a directory.
Finds all VBA Macros in an office file (OLE2/POIFS and OOXML/OPC),
and returns them.
Tells whether to center the sheet between vertical margins
Holder for vector-type properties
Administrative class to keep track of the version number of the
POI release.
Specifies possible values for the alignment of the contents of this run in
relation to the default appearance of the run's text.
Specifies a list of available anchoring types for text
This enumeration value indicates the type of vertical alignment for a cell, i.e.,
whether it is aligned top, bottom, vertically centered, justified or distributed.
VerticalPageBreak (0x001A) record that stores page breaks at columns
SXVIEW - View Definition (0x00B0)
SXVD - View Fields (0x00B1)
SXVS - View Source (0x00E3)
Class to find all the text in a Visio file, and return it.
Implementation of the VLOOKUP() function.
Developer helper class to dump out the pointer+stream structure
of a Visio file
Converts a Visio diagram to a PNG file.
Implementation for the Excel function WEEKDAY
Implementation for Excel WeekNum() function.
Stores the attributes of the workbook window.
Flags whether workbook windows are protected
Sheet window settings
Represents a WMF (Windows Metafile) picture data.
Class to extract the text from old (Word 6 / Word 95) Word Documents.
Class to extract the text from a Word Document.
Converts Word files (95-2007) into HTML files.
High level representation of a Excel workbook.
Should be implemented by any
Ptg subclass that needs a workbook to render its formula.Evaluates formula cells.
Provides access to a
WorkbookEvaluator, eg for use with
CollaboratingWorkbooksEnvironmentFactory for creating the appropriate kind of Workbook
(be it
HSSFWorkbook or XSSFWorkbook),
by auto-detecting from the supplied input.Helper methods for when working with Usermodel Workbooks
A calculator for workdays, considering dates as excel representations.
Groups the sheet protection records for a worksheet.
Title: Write Access Record (0x005C)
Indicated that the sheet/workbook is write protected.
This exception is thrown when trying to write a (yet) unsupported variant
type.
Stores workbook settings (aka its a big "everything we didn't put somewhere else")
XAdES Signature Facet.
XAdES-X-L v1.4.1 signature facet.
Base class for all axis types.
Base of all XDDF Chart Data
Represents a DrawingML chart legend
Class
XDDFDataSourcesFactory is a factory for XDDFDataSource
instances.Date axis type.
Represents a DrawingML manual layout.
Represents a paragraph of text within the containing text body.
Container of shapes for a page in a Visio diagram.
There are a lot of different cell types.
Represents connections in a Visio diagram.
Represents the root document: /visio/document.xml
You're probably actually looking for
XmlVisioDocument, this
only contains metadata about the root document in the OOXML package.Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
Provides the API to work with an underlying master.
Contains the actual contents of the master/stencil
A collection of masters (typically stencils) in a Visio document
Provides the API to work with an underlying page
Contains a list of Page objects (not page content!)
A shape is a collection of Geometry Visualization, Format, Text, Images, and
Shape Data in a Drawing Page.
A sheet is a collection of properties that specify information for a shape,
master, drawing page, style, or web drawing.
Helper class to extract text from an OOXML Visio File
We don't support .xlsb for read and write via
XSSFWorkbook.Helper methods for working with javax.xml classes.
High level representation of an ooxml slideshow.
This is your high-level starting point for working with Visio XML
documents (.vsdx).
Wrapper / delegate for XmlBeans custom geometry
Wrapper / delegate for XmlBeans custom geometry
Wrapper / delegate for XmlBeans custom geometry
Represents a shape with a preset geometry.
Background shape
Represents a Chart in a .pptx presentation
Encapsulates logic to read color definitions from DrawingML and convert them to java.awt.Color
XSLF Comment
Wrapper / delegate for XmlBeans custom geometry
Specifies a connection shape.
Wrapper / delegate for XmlBeans custom geometry
Wrapper / delegate for XmlBeans custom geometry
Representation of a DrawingML Diagram
Simple wrapper around XSLFGroupShape to enable accessing underlying diagram relations correctly.
Drawing representation of a SmartArt diagram.
Helper class to extract text from an OOXML Powerpoint file
Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
A container for fontdata files, i.e.
Represents a custom geometric shape.
Represents a group shape that consists of many shapes grouped together.
Wrapper / delegate for XmlBeans custom geometry
Wrapper / delegate for XmlBeans custom geometry
Experimental class for metro blobs, i.e.
Wrapper / delegate for XmlBeans custom geometry
Notes master object associated with this layout.
An XSLFOleData instance holds the ole binary stream/object
Methods that wrap
XMLSlideShow parsing functionality.Wrapper / delegate for XmlBeans custom geometry
Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
Represents a picture shape
XSLF Placeholder Details
Wrapper / delegate for XmlBeans custom geometry
Wrapper / delegate for XmlBeans custom geometry
An exception that indicates a problem reading a pptx file.
Represents a shadow of a shape.
Base super-class class for all shapes in PresentationML
XSLFShape.ReparseFactory<T extends org.apache.xmlbeans.XmlObject>
Common interface for shape containers, e.g.
Represents a single (non-group) shape in a .pptx slide show
Slide master object associated with this layout.
Experimental class to do low level processing of pptx files.
Represents a table in a .pptx presentation
Represents a cell of a table in a .pptx presentation
Represents a table in a .pptx presentation
Represents a table style in a .pptx presentation
Represents a paragraph of text within the containing text body.
Represents a run of text within the containing text body.
Represents a shape that can hold text.
A shared style sheet in a .pptx slide show
Wrapper / delegate for XmlBeans custom geometry
An anchor is what specifics the position of a shape within a client object
or within another containing shape.
Represents autofiltering for the specified worksheet.
Implementation of a text extractor or xlsb Excel
files that uses SAX-like binary parsing.
XSSF high level representation for Border Formatting component
of Conditional Formatting settings
Parse exception while reading an xssfb.
Experimental parser for Microsoft's ooxml xlsb format.
Reader for xlsb files.
Need to have this mirror class of
XSSFRelation
because of conflicts with regular ooxml relations.Wrapper class around String so that we can use it in Comment.
You need to implement this to handle the results
of the sheet parsing.
Receives streaming callbacks while
XSSFBSheetHandler parses an XLSB sheet.This is a very thin shim to gather number formats from styles.bin
files.
Table style names defined in the OOXML spec.
implementation for built-in styles
High level representation of a cell in a row of a spreadsheet.
Cell settings available in the Format/Alignment tab
This element contains border formatting information, specifying border definition formats (left, right, top, bottom, diagonal)
for cells in the workbook.
The enumeration value indicating the side being used for a cell border.
This element specifies fill formatting.
High level representation of the possible formatting information for the contents of the cells on a sheet in a
SpreadsheetML document.
Represents a SpreadsheetML Chart
High level representation of Sheet Parts that are of type 'chartsheet'.
A client anchor is attached to an excel worksheet.
Represents a color in SpreadsheetML
High level representation for Color Scale / Color Gradient Formatting
component of Conditional Formatting settings
Helper for shifting columns up or down
XSSF support for Conditional Formatting rules
High level representation for Icon / Multi-State / Databar /
Colour Scale change thresholds
A connection shape drawing element.
High level representation for DataBar / Data Bar Formatting
component of Conditional Formatting settings
Handles data formats for XSSF.
Represents a SpreadsheetML drawing
Style based on a dxf record - e.g.
Internal POI use only
Even page footer value.
Even page header value.
Implementation of a text extractor from OOXML Excel
files that uses SAX event based parsing.
Helper class to extract text from an OOXML Excel file
Maps an XLSX to an XML according to one of the mapping defined.
Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
First page footer content.
First page header content.
Represents a font used in a workbook.
Evaluates formula cells.
Utility to update formulas and named ranges when a sheet name was changed
Represents DrawingML GraphicalObjectFrame.
Parent class of all XSSF headers and footers.
All Header/Footer properties for a sheet are scoped to the sheet.
XSSF Implementation of a Hyperlink.
This is a read only record that maintains information about
a hyperlink.
High level representation for Icon / Multi-State Formatting
component of Conditional Formatting settings
XSSF-specific code for working with ignored errors
Imports data from an external XML to an XLSX according to one of the mappings
defined.The output XML Schema must respect this limitations:
the input XML must be valid according to the XML Schema used in the mapping
denormalized table mapping is not supported (see OpenOffice part 4: chapter 3.5.1.7)
all the namespaces used in the document must be declared in the root node
This class implements the Map element (Open Office XML Part 4:
chapter 3.16.2)
Represents a defined named range in a SpreadsheetML workbook.
Represents binary object (i.e.
Odd page footer value.
Odd page header value.
XSSF equivalent of HSSFOptimiser.
Methods that wrap
XSSFWorkbook parsing functionality.Represents a picture shape in a SpreadsheetML drawing.
Raw picture data, normally attached to a SpreadsheetML Drawing.
Page setup and page margins settings for the worksheet.
This class makes it easy to get at individual parts
of an OOXML .xlsx file, suitable for low memory sax
parsing or similar.
Iterator over sheet data.
An exception that indicates a problem reading an xlsx file.
Defines namespaces, content types and normal file names / naming
patterns, for the well-known XSSF format parts.
Rich text unicode string.
High level representation of a row of a spreadsheet.
Helper for shifting rows up or down
Represents a shape in a SpreadsheetML drawing.
This object specifies a group shape that represents many shapes grouped together.
High level representation of a SpreadsheetML worksheet.
XSSF Conditional Formattings
This class handles the streaming processing of a sheet#.xml
sheet part of a XSSF .xlsx file, and generates
row and cell events for it.
This interface allows to provide callbacks when reading
a sheet in streaming mode.
Represents a shape with a predefined geometry in a SpreadsheetML drawing.
This class is a wrapper around the CTSingleXmlCell (Open Office XML Part 4:
chapter 3.5.2.1)
This class implements the Table Part (Open Office XML Part 4: chapter 3.5.1)
Columns of this table may contains mappings to a subtree of an XML.
A table column of an
XSSFTable.TableStyle implementation for styles defined in the OOXML styles.xml.Wrapper for the CT class, to cache values and add style lookup
Represents a text box in a SpreadsheetML drawing.
Represents a paragraph of text within the containing text body.
Represents a run of text within the containing text body.
Represents a SpreadsheetML VML drawing.
High level representation of a SpreadsheetML workbook.
Represents the two different kinds of XML-based OOXML document.
This class is a wrapper around the CTXmlColumnPr (Open Office XML Part 4:
chapter 3.5.1.7)
The Xst structure is a string.
Base class for both bottom-of-the-page footnotes
XWPFFootnote and end
notes XWPFEndnote).Base class for the Footnotes and Endnotes part implementations.
Experimental abstract class that is a base for XWPFSDT and XWPFSDTCell
Represents a Chart in a .docx file
Sketch of XWPF comment class
specifies all of the comments defined in the current document
Decorator class for XWPFParagraph allowing to add comments
found in paragraph to its text
Default Paragraph style, from which other styles will override
TODO Share logic with
XWPFParagraph which also uses CTPPrDefault Character Run style, from which other styles will override
TODO Share logic with
XWPFRun which also uses CTRPrHigh(ish) level class for working with .docx files.
Represents an end note footnote.
Looks after the collection of end notes for a document.
Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
A run of text which is part of a field, such as Title
of Page number or Author.
Sketch of XWPF footer class
Represents a bottom-of-the-page footnote.
Looks after the collection of Footnotes for a document.
Sketch of XWPF header class
Parent of XWPF headers and footers
A .docx file can have no headers/footers, the same header/footer
on each page, odd/even page footers, and optionally also
a different header/footer on the first page.
Sketch of XWPF hyperlink class
A run of text with a Hyperlink applied to it.
TODO Bring more of the logic over from XWPFParagraph
A Paragraph within a Document, Table, Header etc.
Base decorator class for XWPFParagraph
Methods that wrap
XWPFDocument parsing functionality.Raw picture data, normally attached to a WordprocessingML Drawing.
An exception that indicates a problem reading a docx file.
XWPFRun object defines a region of text with a common set of properties
Experimental class to offer rudimentary read-only processing of
of StructuredDocumentTags/ContentControl
Experimental class to offer rudimentary read-only processing of
of StructuredDocumentTags/ContentControl that can appear
in a table row as if a table cell.
Experimental class to offer rudimentary read-only processing of
of the contentblock of an SDT/ContentControl.
Experimental class to offer rudimentary read-only processing of
of the XWPFSDTCellContent.
Holds details of built-in, default and user styles, which
apply to tables / paragraphs / lists etc.
Sketch of XWPFTable class.
Represents a Cell within a
XWPFTable.A row within an
XWPFTable.A shared style sheet in a .docx document
Helper class to extract text from an OOXML Word file
Java class for CT_XYAdjustHandle complex type.
So we can close the real zip entry and still
effectively work with it.
Zip implementation of the ContentTypeManager.
Minimal processor callback used by
ZipStreamUtil.streamEntries(org.apache.poi.openxml4j.util.ZipArchiveThresholdInputStream, org.apache.poi.openxml4j.util.ZipEntryProcessor).An Interface to make getting the different bits
of a Zip File easy.
A ZipEntrySource wrapper around a ZipFile.
Provides a way to get at all the ZipEntries
from a ZipInputStream, as many times as required.
Physical zip package.
Zip implementation of a PackagePart.
Package core properties marshaller specialized for zipped package.
Zip part marshaller.
This class wraps a
ZipFile in order to check the
entries for zip bombs
while reading the archive.Small utility to iterate a
ZipArchiveThresholdInputStream and
execute a ZipEntryProcessor for every entry.