Package jxl.write
Class NumberFormat
java.lang.Object
jxl.biff.RecordData
jxl.biff.WritableRecordData
jxl.biff.FormatRecord
jxl.write.biff.NumberFormatRecord
jxl.write.NumberFormat
- All 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
FieldsModifier and TypeFieldDescriptionstatic final jxl.write.biff.NumberFormatRecord.NonValidatingFormat
Pass in to the constructor to bypass the format validationstatic final String
Constant format string for the US Dollar signstatic final String
Constant format string for the Euro currency symbol where it precedes the formatstatic final String
Constant format string for the Euro currency symbol where it precedes the formatstatic final String
Constant format string for the Japanese Yen signstatic final String
Constant format string for the UK pound signstatic final String
Constant format string for fractions as halvesstatic final String
Constant format string for fractions as hundredthsstatic final String
Constant format string for fractions as quarterstatic final String
Constant format string for fractions as sixteenthsstatic final String
Constant format string for fractions as tenthsstatic final String
Constant format string for three digit fractionsstatic final String
Constant format string for fractions as eighthsFields inherited from class jxl.biff.FormatRecord
biff7, biff8
-
Constructor Summary
ConstructorsConstructorDescriptionNumberFormat
(String format) Constructor, taking in the Java compliant number formatNumberFormat
(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
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jxl.biff.DisplayFormat
getFormatIndex, initialize, isBuiltIn, isInitialized
-
Field Details
-
COMPLEX_FORMAT
public static final jxl.write.biff.NumberFormatRecord.NonValidatingFormat COMPLEX_FORMATPass in to the constructor to bypass the format validation -
CURRENCY_EURO_PREFIX
Constant format string for the Euro currency symbol where it precedes the format- See Also:
-
CURRENCY_EURO_SUFFIX
Constant format string for the Euro currency symbol where it precedes the format- See Also:
-
CURRENCY_POUND
Constant format string for the UK pound sign- See Also:
-
CURRENCY_JAPANESE_YEN
Constant format string for the Japanese Yen sign- See Also:
-
CURRENCY_DOLLAR
Constant format string for the US Dollar sign- See Also:
-
FRACTION_THREE_DIGITS
Constant format string for three digit fractions- See Also:
-
FRACTION_HALVES
Constant format string for fractions as halves- See Also:
-
FRACTION_QUARTERS
Constant format string for fractions as quarter- See Also:
-
FRACTIONS_EIGHTHS
Constant format string for fractions as eighths- See Also:
-
FRACTION_SIXTEENTHS
Constant format string for fractions as sixteenths- See Also:
-
FRACTION_TENTHS
Constant format string for fractions as tenths- See Also:
-
FRACTION_HUNDREDTHS
Constant format string for fractions as hundredths- See Also:
-
-
Constructor Details
-
NumberFormat
Constructor, taking in the Java compliant number format- Parameters:
format
- the format string
-
NumberFormat
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 stringdummy
- dummy parameter
-