org.zkoss.poi.ss.usermodel

Interface DataFormat

All Known Implementing Classes:

HSSFDataFormat, XSSFDataFormat

public interface DataFormat

Method Summary

Modifier and Type	Method and Description
String	getFormat(short index) get the format string that matches the given format index
short	getFormat(String format) get the format index that matches the given format string.
String	getRawFormat(short index) get the format string that matches the given format index, but it doesn't transfer the format by ZSS Context Locale
short	newFormat(String format) create a new data format and return its index.

Method Detail

getFormat

short getFormat(String format)

get the format index that matches the given format string. Creates a new format if one is not found. Aliases text to the proper format.

Parameters:

format - string matching a built in format

Returns:

index of format.

newFormat

short newFormat(String format)

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\)

Parameters:

format - number format code

Returns:

index of format.

getFormat

String getFormat(short index)

get the format string that matches the given format index

Parameters:

index - of a format

Returns:

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

getRawFormat

String getRawFormat(short index)

get the format string that matches the given format index, but it doesn't transfer the format by ZSS Context Locale

Parameters:

index - of a format

Returns:

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