org.apache.poi.hssf.usermodel
public class: HSSFDataFormat [javadoc |
source]
java.lang.Object
org.apache.poi.hssf.usermodel.HSSFDataFormat
Utility to identify builtin formats. Now can handle user defined data formats also. The following is a list of the formats as
returned by this class.
0, "General"
1, "0"
2, "0.00"
3, "#,##0"
4, "#,##0.00"
5, "($#,##0_);($#,##0)"
6, "($#,##0_);[Red]($#,##0)"
7, "($#,##0.00);($#,##0.00)"
8, "($#,##0.00_);[Red]($#,##0.00)"
9, "0%"
0xa, "0.00%"
0xb, "0.00E+00"
0xc, "# ?/?"
0xd, "# ??/??"
0xe, "m/d/yy"
0xf, "d-mmm-yy"
0x10, "d-mmm"
0x11, "mmm-yy"
0x12, "h:mm AM/PM"
0x13, "h:mm:ss AM/PM"
0x14, "h:mm"
0x15, "h:mm:ss"
0x16, "m/d/yy h:mm"
// 0x17 - 0x24 reserved for international and undocumented
0x25, "(#,##0_);(#,##0)"
0x26, "(#,##0_);[Red](#,##0)"
0x27, "(#,##0.00_);(#,##0.00)"
0x28, "(#,##0.00_);[Red](#,##0.00)"
0x29, "_(*#,##0_);_(*(#,##0);_(* \"-\"_);_(@_)"
0x2a, "_($*#,##0_);_($*(#,##0);_($* \"-\"_);_(@_)"
0x2b, "_(*#,##0.00_);_(*(#,##0.00);_(*\"-\"??_);_(@_)"
0x2c, "_($*#,##0.00_);_($*(#,##0.00);_($*\"-\"??_);_(@_)"
0x2d, "mm:ss"
0x2e, "[h]:mm:ss"
0x2f, "mm:ss.0"
0x30, "##0.0E+0"
0x31, "@" - This is text format.
0x31 "text" - Alias for "@"
- author:
Andrew - C. Oliver (acoliver at apache dot org)
- author:
Shawn - M. Laubach (slaubach at apache dot org)
| Constructor: |
|---|
 public HSSFDataFormat(Workbook workbook) {
// Flag to see if need to
// check the built in list
// or if the regular list
// has all entries.
this.workbook = workbook;
Iterator i = workbook.getFormats().iterator();
while ( i.hasNext() )
{
FormatRecord r = (FormatRecord) i.next();
if ( formats.size() < r.getIndexCode() + 1 )
{
formats.setSize( r.getIndexCode() + 1 );
}
formats.set( r.getIndexCode(), r.getFormatString() );
}
}
Construncts a new data formatter. It takes a workbook to have
access to the workbooks format records. Parameters:
workbook - the workbook the formats are tied to.
|
| Method from org.apache.poi.hssf.usermodel.HSSFDataFormat Detail: |
|---|
public static short getBuiltinFormat(String format) {
if (format.toUpperCase().equals("TEXT"))
format = "@";
short retval = -1;
for (short k = 0; k < = 0x31; k++)
{
String nformat = (String) builtinFormats.get( k );
if ( ( nformat != null ) && nformat.equals( format ) )
{
retval = k;
break;
}
}
return retval;
} |
public static String getBuiltinFormat(short index) {
return (String) builtinFormats.get( index );
} get the format string that matches the given format index |
public static List getBuiltinFormats() {
return builtinFormats;
} |
public short getFormat(String format) {
ListIterator i;
int ind;
if (format.toUpperCase().equals("TEXT"))
format = "@";
if ( !movedBuiltins )
{
i = builtinFormats.listIterator();
while ( i.hasNext() )
{
ind = i.nextIndex();
if ( formats.size() < ind + 1 )
{
formats.setSize( ind + 1 );
}
formats.set( ind, i.next() );
}
movedBuiltins = true;
}
i = formats.listIterator();
while ( i.hasNext() )
{
ind = i.nextIndex();
if ( format.equals( i.next() ) )
return (short) ind;
}
ind = workbook.getFormat( format, true );
if ( formats.size() < = ind )
formats.setSize( ind + 1 );
formats.set( ind, format );
return (short) ind;
} 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. |
public String getFormat(short index) {
if ( movedBuiltins )
return (String) formats.get( index );
else
return (String) ( builtinFormats.size() > index
&& builtinFormats.get( index ) != null
? builtinFormats.get( index ) : formats.get( index ) );
} get the format string that matches the given format index |
public static int getNumberOfBuiltinBuiltinFormats() {
return builtinFormats.size();
} get the number of builtin and reserved builtinFormats |
Save This Page