jxl.write

Class NumberFormat

Implemented Interfaces:
jxl.biff.ByteData, jxl.biff.DisplayFormat, Format

public class NumberFormat
extends jxl.write.biff.NumberFormatRecord
implements jxl.biff.DisplayFormat

A custom user defined number format, which may be instantiated within user applications in order to present numerical values to the appropriate level of accuracy. The string format used to create a number format adheres to the standard java specification, and JExcelAPI makes the necessary modifications so that it is rendered in Excel as the nearest possible equivalent. Once created, this may be used within a CellFormat object, which in turn is a parameter passed to the constructor of the Number cell

Field Summary

static jxl.write.biff.NumberFormatRecord.NonValidatingFormat
COMPLEX_FORMAT
Pass in to the constructor to bypass the format validation
static String
CURRENCY_DOLLAR
Constant format string for the US Dollar sign
static String
CURRENCY_EURO_PREFIX
Constant format string for the Euro currency symbol where it precedes the format
static String
CURRENCY_EURO_SUFFIX
Constant format string for the Euro currency symbol where it precedes the format
static String
CURRENCY_JAPANESE_YEN
Constant format string for the Japanese Yen sign
static String
CURRENCY_POUND
Constant format string for the UK pound sign
static String
FRACTIONS_EIGHTHS
Constant format string for fractions as eighths
static String
FRACTION_HALVES
Constant format string for fractions as halves
static String
FRACTION_HUNDREDTHS
Constant format string for fractions as hundredths
static String
FRACTION_QUARTERS
Constant format string for fractions as quarter
static String
FRACTION_SIXTEENTHS
Constant format string for fractions as sixteenths
static String
FRACTION_TENTHS
Constant format string for fractions as tenths
static String
FRACTION_THREE_DIGITS
Constant format string for three digit fractions

Fields inherited from class jxl.biff.FormatRecord

biff7, biff8, logger

Constructor Summary

NumberFormat(String format)
Constructor, taking in the Java compliant number format
NumberFormat(String format, jxl.write.biff.NumberFormatRecord.NonValidatingFormat dummy)
Constructor, taking in the non-Java compliant number format.

Method Summary

Methods inherited from class jxl.biff.FormatRecord

equals, getData, getDateFormat, getFormatIndex, getFormatString, getIndexCode, getNumberFormat, hashCode, initialize, isBuiltIn, isDate, isInitialized, isNumber

Methods inherited from class jxl.biff.WritableRecordData

getBytes

Field Details

COMPLEX_FORMAT

public static final jxl.write.biff.NumberFormatRecord.NonValidatingFormat COMPLEX_FORMAT
Pass in to the constructor to bypass the format validation

CURRENCY_DOLLAR

public static final String CURRENCY_DOLLAR
Constant format string for the US Dollar sign

CURRENCY_EURO_PREFIX

public static final String CURRENCY_EURO_PREFIX
Constant format string for the Euro currency symbol where it precedes the format

CURRENCY_EURO_SUFFIX

public static final String CURRENCY_EURO_SUFFIX
Constant format string for the Euro currency symbol where it precedes the format

CURRENCY_JAPANESE_YEN

public static final String CURRENCY_JAPANESE_YEN
Constant format string for the Japanese Yen sign

CURRENCY_POUND

public static final String CURRENCY_POUND
Constant format string for the UK pound sign

FRACTIONS_EIGHTHS

public static final String FRACTIONS_EIGHTHS
Constant format string for fractions as eighths

FRACTION_HALVES

public static final String FRACTION_HALVES
Constant format string for fractions as halves

FRACTION_HUNDREDTHS

public static final String FRACTION_HUNDREDTHS
Constant format string for fractions as hundredths

FRACTION_QUARTERS

public static final String FRACTION_QUARTERS
Constant format string for fractions as quarter

FRACTION_SIXTEENTHS

public static final String FRACTION_SIXTEENTHS
Constant format string for fractions as sixteenths

FRACTION_TENTHS

public static final String FRACTION_TENTHS
Constant format string for fractions as tenths

FRACTION_THREE_DIGITS

public static final String FRACTION_THREE_DIGITS
Constant format string for three digit fractions

Constructor Details

NumberFormat

public NumberFormat(String format)
Constructor, taking in the Java compliant number format
Parameters:
format - the format string

NumberFormat

public NumberFormat(String format,
                    jxl.write.biff.NumberFormatRecord.NonValidatingFormat dummy)
Constructor, taking in the non-Java compliant number format. This may be used for currencies and more complex custom formats, which will not be subject to the standard validation rules. As there is no validation, there is a resultant risk that the generated Excel file will be corrupt USE THIS CONSTRUCTOR ONLY IF YOU ARE CERTAIN THAT THE NUMBER FORMAT YOU ARE USING IS EXCEL COMPLIANT
Parameters:
format - the format string
dummy - dummy parameter