All Classes and Interfaces

Class
Description
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Common exporting behavior for both XLSX and XLS.
Contains common importing behavior for XLS.
Defines common behaviors for an exporter.
 
 
 
Handle formula caching for chart category data.
 
 
 
 
 
 
Handle formula caching for chart series data.
 
 
 
 
 
 
To help data filling.
 
The auto fitler implement
Keep the information of Table/Sheet filter change
 
 
 
Copy blank to destination
Helper for XSSF and HSSF book handling
 
A default implementation
 
 
 
Deprecated.
Deprecated.
 
 
 
 
 
 
 
 
see http://www.datypic.com/sc/ooxml/t-ssml_CT_Cell.html
Specify which attribute is to be updated.
a help class to hold cell data and apply to another
 
Use to check if a cell's value match the specified CustomFilter
Use to check if a cell's value match the specified condition (used in ConditionalFormatting)
An immutable object that represents a block of cells with 4 indexes which are first and last row index, first and last column index.
 
the style holder interface
Deprecated.
This class can be used to match a SCellStyle with a criteria.
 
An event handler for cell value change.
 
 
 
Helper on calculating SCFValueObject.
 
 
 
Fill SChartData with series according to a selection.
 
 
 
 
Helper for set cell, row, column style
Color filter associated with SAutoFilter
 
Colors responsible for manage colors in a workbook.
 
 
Precedent reference to ColumnRef.
Implementation of precedent reference to ColumnRefs.
 
 
 
 
 
Control the conditional formatting reference dependency
 
Used to pass style and format for SConditionalFormattingRule.
 
 
 
 
 
Copy from source to destination
 
 
 
To help search the data region
 
 
 
 
 
 
Store built-in date format patterns, parse a string into a Date object.
 
 
Step value by given steps by Calendar
 
NodeA --- depends on ---> NodeB.
 
 
Default implementation of dependency table.
 
A default dependency tracker.
 
 
 
 
DynamicFilter
 
 
 
An error result of a evaluated formula.
modified from org.apache.poi.xssf.usermodel.XSSFEvaluationWorkbook
 
 
 
 
 
To adapt model event -> listener
To adapt model event -> queue -> zk listener -> model listener
A model event listener that listen model event through event queue (not from model directly).
 
 
 
 
 
 
 
Thrown to indicate that exporter has been exported an illegal or unexpected content.
 
Fill in ExtraStyle is a bit different from in CellStyle.
 
Deprecated.
As if release 5.3.0, replaced by ImmutableFillImpl
 
 
 
 
 
 
Deprecated.
As if release 5.3.0, replaced by ImmutableFontImpl
This class can be used to match a SFont with a criteria.
 
 
 
 
 
 
 
 
Indicate that the object has formula content
 
A formula engine implemented by ZPOI
 
 
 
 
 
 
The parsed result of a formula.
 
the formula result cell value
Enumeration of various formula types.
 
 
 
Interface to glue POI function mechanism to zkoss xel function mechanism.
A factory of formula function resolver.
A default function resolver.
 
 
 
 
 
 
 
Step for growth sequence.
 
copied from zssex.
 
 
Utility methods that involve read or write POI model.
 
 
 
 
 
 
Thrown to indicate that importer has been imported an illegal or unexpected content.
Used to handle reference generated by INDIRECT(text) function.
 
Determine a cell's type and value by parsing editing text with predefined patterns.
smart input for numbers and dates.
 
 
 
A helper to perform insert/delete row/column/cells.
a range of row/column indicates insert/delete changes.
The exception is thrown when encountering invalid parameters.
The exception is thrown when encountering an invalid formula.
This exception is thrown when you perform an unreasonable operation on the model.
Aggregate FunctionMapper that join serveral FunctionMapper together.
Aggregate VariableResolver that join serveral VariableResolver together.
A JSON array.
Beans that support customized output of JSON text shall implement this interface.
Internal use to optimize the memory footprint.
A JSON object.
Utilities to encode and decode data in JSON format.
 
 
 
 
Linear incremental Step.
 
 
 
 
A pair of reference areas indicate the changes of the merge area.
The event will be sent when there is an operation performed on a book model.
A listener to handle ModelEvent.
A collection of factory method that help you create ModelEvent.
 
 
 
 
 
 
 
 
To help hold a non-serializable object as a serializable (usually for cache)
 
 
A helper class that encapsulate details of sending model events.
Responsible for number input mask.
 
 
return true if a number
The object Reef to represent a object, and is always a dependent ref.
 
 
Used to handle reference generated by OFFSET function.
a cell reference produced by OFFSET function.
 
An outline level tree structure.
 
A pseudo formula parsing workbook for parsing only.
 
 
This class contains various paste options used for SSheet.pasteCell(SheetRegion, CellRegion, PasteOption).
 
 
To avoid paste too many rows; ZSS copy column only copy to sheetMaxVisibleRows.
 
 
 
 
An utility to convert enumeration constant between ZSS model and POI model.
 
 
 
Only those methods that set cell data, cell style, row (column) style, width, height, and hidden consider 3-D references.
 
Use this class to help you concurrently access book model safely.
 
Ref is a reference for cell or range with 4 value : top(top row), left(left column), bottom(last row) and right(last column).
 
 
 
 
see http://www.datypic.com/sc/ooxml/t-ssml_CT_Row.html
 
 
Contains autofilter's setting.
 
A filter column contains information for filtering, e.g. criteria.
The root of Spreadsheet's data model which contains sheets.
Contains factory methods to create a SBook.
It contains multiple SBook objects so that formulas in them can reference to cells of another book.
A utility class that build a book series that allow external book references can work.
Border object
The border type
 
 
 
Represent a cell of a sheet in a Spreadsheet.
 
Represent style information e.g. alignment, border, format pattern, font, color, fill pattern, wrap text, and hidden status.
The horizontal alignment
The vertical alignment
 
Mixed-group (aka. custom) IconSet information in ConditionalFormatting.
Conditional Formatting value object.
 
Represents a chart in a sheet.
 
 
 
 
Represent an axis in SChart.
 
An object that can be used to get SChart.
A color which might relate to a text or a border.
Color filter
 
A column of a sheet.
It stores first and last column index of a group of column that has same width and cell style.
A comment is some texts written by a user which is separated from text of a cell.
Conditional Formatting
 
 
 
 
Extra embedded style for SConditonalFormatting.
 
 
Condiditional Formatting of "dataBar" type.
This class stores the restrictions on what data can or should be entered in a cell.
 
 
 
This interface stores the region of the current dependent precedent tracing.
 
 
A Consumer that can be serialized.
Assists with the serialization process and performs additional functionality based on serialization.
 
Helper for set cell, row, column style
An exporter can export a book model to a output stream or file.
The interface defines factory methods for exporters.
A class that you can get an exporter by registered name and register an exporter.
Extra embedded style for STable and SConditonalFormatting.
Fill pattern and colors
The fill pattern
 
Represents a font used in cells.
 
 
 
 
The text in the footer.
The main object to access the data in a chart including series and categories.
The text in the header.
see http://www.datypic.com/sc/ooxml/e-ssml_sheetData-1.html
 
 
Indicates a immutable region of cells in a sheet.
 
 
 
A hyperlink of a cell.
 
 
 
the default and one-book book-series
An importer to import a input stream, file..etc to a new book
The interface defines factory methods for importers.
This class contains utility methods to register the importer factory and get a importer by registered name.
A named range (or defined name) which refer to a region.
Cell Style referred via a name.
Manipulate cells according to sorting criteria and options.
 
 
 
A picture in a sheet.
 
Picture data in a picture.
Store various setting for printing.
 
The main API to manipulate Spreadsheet's book model.
 
 
Shift direction of delete api
 
Copy origin format/style of insert
Shift direction of insert api
 
 
 
 
A collection of factory methods to create a SRange object.
A rich text can have multiple segments which have different fonts for each one in a cell.
 
A row of a sheet.
A series of chart data.
A sheet of a book.
 
 
Store those visual statuses of a sheet, e.g. freeze status of row (column), or grid-line display.
Table
Table column
 
Table Style.
Table style element.
Table style info.
Step for handling incremental auto fill
 
The class contains methods for checking a string.
 
 
 
 
This is a marking class to control whether to update cell's style or just update cell's text.
A utility class to help spreadsheet set style of a cell
Workbook protection options
Table column.
 
 
Mark interface for SName that is associated with Table.
Precedent reference to ColumnRef.
Implementation of precedent reference to ColumnRefs.
 
 
Table style
Builtin TableStyleNone
 
 
Always return true or false
Various unit conversion methods.
 
This class contains methods for validating arguments of a method.
 
 
Represent a anchor position by its left-top cell index, width, height, x and y offset within the cell, or a right-bottom anchor position by its right-bottom cell index with 0 width and height.
AnchorType
 
 
A utility class to help spreadsheet set style of a row, column and cell
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
An excel xlsx importer
Xlsx Json Helper
A StAX parser to convert Xlsx to JSON format.