|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
public class PDNumberFormatDictionary
This class represents a number format dictionary.
Field Summary | |
---|---|
static java.lang.String |
FRACTIONAL_DISPLAY_DECIMAL
Constant for showing a fractional value as decimal to the precision specified by the D entry. |
static java.lang.String |
FRACTIONAL_DISPLAY_FRACTION
Constant for showing a fractional value as a fraction with denominator specified by the D entry. |
static java.lang.String |
FRACTIONAL_DISPLAY_ROUND
Constant for showing a fractional value without fractional part; round to the nearest whole unit. |
static java.lang.String |
FRACTIONAL_DISPLAY_TRUNCATE
Constant for showing a fractional value without fractional part; truncate to achieve whole units. |
static java.lang.String |
LABEL_PREFIX_TO_VALUE
Constant indicating that the label specified by U is a postfix to the value. |
static java.lang.String |
LABEL_SUFFIX_TO_VALUE
Constant indicating that the label specified by U is a suffix to the value. |
static java.lang.String |
TYPE
The type of the dictionary. |
Constructor Summary | |
---|---|
PDNumberFormatDictionary()
Constructor. |
|
PDNumberFormatDictionary(COSDictionary dictionary)
Constructor. |
Method Summary | |
---|---|
float |
getConversionFactor()
This will return the conversion factor. |
COSBase |
getCOSObject()
Convert this standard java object to a COS object. |
java.lang.String |
getDecimalSeparator()
This will return the text to be used as the decimal point in displaying numerical values. |
int |
getDenominator()
This will return the precision or denominator of a fractional amount. |
COSDictionary |
getDictionary()
This will return the dictionary. |
java.lang.String |
getFractionalDisplay()
This will return the value for the manner to display a fractional value. |
java.lang.String |
getLabelPositionToValue()
This will return a value indicating the ordering of the label specified by U to the calculated unit value. |
java.lang.String |
getLabelPrefixString()
This will return the text to be concatenated to the left of the label specified by U. |
java.lang.String |
getLabelSuffixString()
This will return the text to be concatenated after the label specified by U. |
java.lang.String |
getThousandsSeparator()
This will return the text to be used between orders of thousands in display of numerical values. |
java.lang.String |
getType()
This will return the type of the number format dictionary. |
java.lang.String |
getUnits()
This will return the label for the units. |
boolean |
isFD()
This will return the value indication if the denominator of the fractional value is reduced/truncated . |
void |
setConversionFactor(float conversionFactor)
This will set the conversion factor. |
void |
setDecimalSeparator(java.lang.String decimalSeparator)
This will set the text to be used as the decimal point in displaying numerical values. |
void |
setDenominator(int denominator)
This will set the precision or denominator of a fractional amount. |
void |
setFD(boolean fd)
This will set the value indication if the denominator of the fractional value is reduced/truncated . |
void |
setFractionalDisplay(java.lang.String fractionalDisplay)
This will set the value for the manner to display a fractional value. |
void |
setLabelPositionToValue(java.lang.String labelPositionToValue)
This will set the value indicating the ordering of the label specified by U to the calculated unit value. |
void |
setLabelPrefixString(java.lang.String labelPrefixString)
This will set the text to be concatenated to the left of the label specified by U. |
void |
setLabelSuffixString(java.lang.String labelSuffixString)
This will set the text to be concatenated after the label specified by U. |
void |
setThousandsSeparator(java.lang.String thousandsSeparator)
This will set the text to be used between orders of thousands in display of numerical values. |
void |
setUnits(java.lang.String units)
This will set the label for the units. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TYPE
public static final java.lang.String LABEL_SUFFIX_TO_VALUE
public static final java.lang.String LABEL_PREFIX_TO_VALUE
public static final java.lang.String FRACTIONAL_DISPLAY_DECIMAL
public static final java.lang.String FRACTIONAL_DISPLAY_FRACTION
public static final java.lang.String FRACTIONAL_DISPLAY_ROUND
public static final java.lang.String FRACTIONAL_DISPLAY_TRUNCATE
Constructor Detail |
---|
public PDNumberFormatDictionary()
public PDNumberFormatDictionary(COSDictionary dictionary)
dictionary
- the corresponding dictionaryMethod Detail |
---|
public COSBase getCOSObject()
getCOSObject
in interface COSObjectable
public COSDictionary getDictionary()
public java.lang.String getType()
public java.lang.String getUnits()
public void setUnits(java.lang.String units)
units
- the label for the unitspublic float getConversionFactor()
public void setConversionFactor(float conversionFactor)
conversionFactor
- the conversion factorpublic java.lang.String getFractionalDisplay()
public void setFractionalDisplay(java.lang.String fractionalDisplay)
fractionalDisplay
- the manner to display a fractional valuepublic int getDenominator()
public void setDenominator(int denominator)
denominator
- the precision or denominatorpublic boolean isFD()
public void setFD(boolean fd)
fd
- fdpublic java.lang.String getThousandsSeparator()
public void setThousandsSeparator(java.lang.String thousandsSeparator)
thousandsSeparator
- thousands separatorpublic java.lang.String getDecimalSeparator()
public void setDecimalSeparator(java.lang.String decimalSeparator)
decimalSeparator
- decimal separatorpublic java.lang.String getLabelPrefixString()
public void setLabelPrefixString(java.lang.String labelPrefixString)
labelPrefixString
- label prefixpublic java.lang.String getLabelSuffixString()
public void setLabelSuffixString(java.lang.String labelSuffixString)
labelSuffixString
- label suffixpublic java.lang.String getLabelPositionToValue()
public void setLabelPositionToValue(java.lang.String labelPositionToValue)
labelPositionToValue
- label position
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |