Top Interfaces Classes Enums
[default module]

Package org.apache.poi.ss.usermodel


Interface Summary

Modifier and TypeInterface and Description
public interface
AutoFilter

Represents autofiltering for the specified worksheet.

public interface
BorderFormatting

High level representation for Border Formatting component of Conditional Formatting settings

public interface
Cell

High level representation of a cell in a row of a spreadsheet.

public interface
CellRange<C extends Cell>

Represents a rectangular region of a Sheet

public interface
public interface
ChildAnchor

Common interface for anchors.

public interface
ClientAnchor

A client anchor is attached to an excel worksheet.

public interface
public interface
ColorScaleFormatting

High level representation for the Color Scale / Colour Scale / Color Gradient Formatting component of Conditional Formatting settings

public interface
public interface
ConditionalFormatting

The ConditionalFormatting class encapsulates all settings of Conditional Formatting.

public interface
ConditionalFormattingRule

Represents a description of a conditional formatting rule

public interface
ConditionalFormattingThreshold

The Threshold / CFVO / Conditional Formatting Value Object.

public interface
ConditionFilterData

These values are needed by various conditional formatting evaluation filter types

public interface
CreationHelper

An object that handles instantiating concrete classes of the various instances one needs for HSSF and XSSF.

public interface
DataBarFormatting

High level representation for the DataBar Formatting component of Conditional Formatting settings

public interface
public interface
public interface
public interface
public interface
public interface
DifferentialStyleProvider

Interface for classes providing differential style definitions, such as conditional format rules and table/pivot table styles.

public interface
Drawing<T extends Shape>

High level representation of spreadsheet drawing.

public interface
public interface
FontFormatting

High level representation for Font Formatting component of Conditional Formatting settings

public interface
Footer

Common definition of a HSSF or XSSF page footer.

public interface
FormulaEvaluator

Evaluates formula cells.

public interface
Header

Common definition of a HSSF or XSSF page header.

public interface
public interface
Hyperlink

Represents an Excel hyperlink.

public interface
IconMultiStateFormatting

High level representation for the Icon / Multi-State Formatting component of Conditional Formatting settings

public interface
Name

Represents a defined name for a range of cells.

public interface
ObjectData

Common interface for OLE shapes, i.e. shapes linked to embedded documents

public interface
public interface
Picture

Repersents a picture in a SpreadsheetML document

public interface
public interface
public interface
RichTextString

Rich text unicode string.

public interface
Row

High level representation of a row of a spreadsheet.

public interface
Shape

Common interface for all drawing shapes

public interface
ShapeContainer<T extends Shape>

A common interface for shape groups.

public interface
Sheet

High level representation of a Excel worksheet.

public interface
SheetConditionalFormatting

The 'Conditional Formatting' facet of Sheet

public interface
SimpleShape

A common interface for simple shapes.

public interface
Table

XSSF Only!

public interface
TableStyle

Data table style definition.

public interface
TableStyleInfo

style information for a specific table instance, referencing the document style and indicating which optional portions of the style to apply.

public interface
Workbook

High level representation of a Excel workbook.

public interface

Class Summary

Modifier and TypeClass and Description
public class
BuiltinFormats

Utility to identify built-in formats.

public abstract class
CellBase

Common implementation-independent logic shared by all implementations of Cell.

public class
CellCopyContext

Used when the cells are being copied from one workbook to another.

public class
public class
CellValue

Mimics the 'data view' of a cell.

public class
ComparisonOperator

The conditional format operators used for "Highlight Cells That Contain..." rules.

public class
ConditionType

Represents a type of a conditional formatting rule

public class
DataFormatter

DataFormatter contains methods for formatting the value stored in a Cell.

public class
DateUtil

Contains methods for dealing with Excel dates.

public class
ExcelGeneralNumberFormat

A format that formats a double as Excel would, ignoring FieldPosition.

public class
ExcelNumberFormat

Object to hold a number format index and string, for various formatting evaluations

public class
ExcelStyleDateFormatter

A wrapper around a SimpleDateFormat instance, which handles a few Excel-style extensions that are not supported by SimpleDateFormat.

public abstract class
public class
FractionFormat

Format class that handles Excel style fractions, such as "# #/#" and "#/###"

As of this writing, this is still not 100% accurate, but it does a reasonable job of trying to mimic Excel's fraction calculations.

public abstract class
public class
ShapeTypes

All known types of automatic shapes in DrawingML

public class
WorkbookFactory

Factory for creating the appropriate kind of Workbook (be it HSSFWorkbook or XSSFWorkbook), by auto-detecting from the supplied input.

Enum Summary

Modifier and TypeEnum and Description
public enum
BorderExtent

The enumeration value indicating which borders to draw in a Property Template

public enum
BorderStyle

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.

public enum
CellReferenceType

Types of cell references.

public enum
public enum
ConditionFilterType

Used primarily for XSSF conditions, which defines a multitude of additional "filter" types for conditional formatting.

public enum
DataConsolidateFunction

Enum mapping the values of STDataConsolidateFunction

public enum
FillPatternType

The enumeration value indicating the style of fill pattern being used for a cell format.

public enum
FontCharset

Deprecated enum will be replaced by common version org.apache.poi.common.usermodel.FontCharset
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.
public enum
FontFamily

The font family this font belongs to.

public enum
FontScheme

Defines the font scheme to which this font belongs.

public enum
FontUnderline

the different types of possible underline formatting

public enum
FormulaError

Enumerates error values in SpreadsheetML formula calculations.

public enum
HorizontalAlignment

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.

public enum
IgnoredErrorType

Types of ignored workbook and worksheet error.

public enum
IndexedColors

A deprecated indexing scheme for colours that is still required for some records, and for backwards compatibility with OLE2 formats.

public enum
PageMargin

Enumeration which represents the various margins which are present within an Excel worksheet

Page margins are relevant when printing worksheets, and define the amount of empty space on the edges of each printed page

public enum
PageOrder

Specifies printed page order.

public enum
PaneType

Type of pane used in sheet.

public enum
PaperSize

The enumeration value indicating the possible paper size for a sheet

public enum
PrintCellComments

These enumerations specify how cell comments shall be displayed for paper printing purposes.

public enum
PrintOrientation

The enumeration value indicating the print orientation for a sheet.

public enum
ReadingOrder

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

public enum
SheetVisibility

Specifies sheet visibility

public enum
TableStyleType

Ordered list of table style elements, for both data tables and pivot tables.

public enum
VerticalAlignment

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.