org.zkoss.poi.hssf.usermodel

Class HSSFDataFormat

java.lang.Object

org.zkoss.poi.hssf.usermodel.HSSFDataFormat

All Implemented Interfaces:

DataFormat

public final class HSSFDataFormat
extends Object
implements DataFormat

Identifies both built-in and user defined formats within a workbook.

See BuiltinFormats for a list of supported built-in formats.

International Formats
Since version 2003 Excel has supported international formats. These are denoted with a prefix "[$-xxx]" (where xxx is a 1-7 digit hexadecimal number). See the Microsoft article Creating international number formats for more details on these codes.

Author:

Andrew C. Oliver (acoliver at apache dot org), Shawn M. Laubach (slaubach at apache dot org)

Method Summary

Modifier and Type	Method and Description
static String	getBuiltinFormat(short index) get the format string that matches the given format index
static short	getBuiltinFormat(String format) get the format index that matches the given format string
static List<String>	getBuiltinFormats()
String	getFormat(short index) get the format string that matches the given format index
short	getFormat(String pFormat) Get the format index that matches the given format string, creating a new format entry if required.
static int	getNumberOfBuiltinBuiltinFormats() get the number of built-in and reserved builtinFormats
String	getRawFormat(short index) get the format string that matches the given format index
boolean	isBuiltinFormat(short index)
short	newFormat(String format) create a new data format and return its index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBuiltinFormats

public static List<String> getBuiltinFormats()

getBuiltinFormat

public static short getBuiltinFormat(String format)

get the format index that matches the given format string

Automatically converts "text" to excel's format string to represent text.

Parameters:

format - string matching a built in format

Returns:

index of format or -1 if undefined.

getFormat

public short getFormat(String pFormat)

Get the format index that matches the given format string, creating a new format entry if required. Aliases text to the proper format as required.

Specified by:

getFormat in interface DataFormat

Parameters:

pFormat - string matching a built in format

Returns:

index of format.

getFormat

public String getFormat(short index)

get the format string that matches the given format index

Specified by:

getFormat in interface DataFormat

Parameters:

index - of a format

Returns:

string represented at index of format or null if there is not a format at that index

getRawFormat

public String getRawFormat(short index)

get the format string that matches the given format index

Specified by:

getRawFormat in interface DataFormat

Parameters:

index - of a format

Returns:

string represented at index of format or null if there is not a format at that index

isBuiltinFormat

public boolean isBuiltinFormat(short index)

getBuiltinFormat

public static String getBuiltinFormat(short index)

get the format string that matches the given format index

Parameters:

index - of a built in format

Returns:

string represented at index of format or null if there is not a builtin format at that index

getNumberOfBuiltinBuiltinFormats

public static int getNumberOfBuiltinBuiltinFormats()

get the number of built-in and reserved builtinFormats

Returns:

number of built-in and reserved builtinFormats

newFormat

public short newFormat(String format)

Description copied from interface: DataFormat

create a new data format and return its index. Although some format codes exist built-in (implied) formats but still need to create a record of numFmt in the style sheet e.g. "$"#,##0.00_);[Red]\("$"#,##0.00\)

Specified by:

newFormat in interface DataFormat

Parameters:

format - number format code

Returns:

index of format.