Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.interactive.measurement » [javadoc | source]
org.apache.pdfbox.pdmodel.interactive.measurement
public class: PDNumberFormatDictionary [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary

All Implemented Interfaces:
    COSObjectable

This class represents a number format dictionary.
Field Summary
public static final  String TYPE    The type of the dictionary. 
public static final  String LABEL_SUFFIX_TO_VALUE    Constant indicating that the label specified by U is a suffix to the value. 
public static final  String LABEL_PREFIX_TO_VALUE    Constant indicating that the label specified by U is a postfix to the value. 
public static final  String FRACTIONAL_DISPLAY_DECIMAL    Constant for showing a fractional value as decimal to the precision specified by the D entry. 
public static final  String FRACTIONAL_DISPLAY_FRACTION    Constant for showing a fractional value as a fraction with denominator specified by the D entry. 
public static final  String FRACTIONAL_DISPLAY_ROUND    Constant for showing a fractional value without fractional part; round to the nearest whole unit. 
public static final  String FRACTIONAL_DISPLAY_TRUNCATE    Constant for showing a fractional value without fractional part; truncate to achieve whole units. 
Constructor:
 public PDNumberFormatDictionary() 
 public PDNumberFormatDictionary(COSDictionary dictionary) 
    Constructor.
    Parameters:
    dictionary - the corresponding dictionary
Method from org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary Summary:
getCOSObject,   getConversionFactor,   getDecimalSeparator,   getDenominator,   getDictionary,   getFractionalDisplay,   getLabelPositionToValue,   getLabelPrefixString,   getLabelSuffixString,   getThousandsSeparator,   getType,   getUnits,   isFD,   setConversionFactor,   setDecimalSeparator,   setDenominator,   setFD,   setFractionalDisplay,   setLabelPositionToValue,   setLabelPrefixString,   setLabelSuffixString,   setThousandsSeparator,   setUnits
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary Detail:
 public COSBase getCOSObject() 
    {@inheritDoc}
 public float getConversionFactor() 
    This will return the conversion factor.
 public String getDecimalSeparator() 
    This will return the text to be used as the decimal point in displaying numerical values.
 public int getDenominator() 
    This will return the precision or denominator of a fractional amount.
 public COSDictionary getDictionary() 
    This will return the dictionary.
 public String getFractionalDisplay() 
    This will return the value for the manner to display a fractional value.
 public String getLabelPositionToValue() 
    This will return a value indicating the ordering of the label specified by U to the calculated unit value.
 public String getLabelPrefixString() 
    This will return the text to be concatenated to the left of the label specified by U.
 public String getLabelSuffixString() 
    This will return the text to be concatenated after the label specified by U.
 public String getThousandsSeparator() 
    This will return the text to be used between orders of thousands in display of numerical values.
 public String getType() 
    This will return the type of the number format dictionary. It must be "NumberFormat"
 public String getUnits() 
    This will return the label for the units.
 public boolean isFD() 
    This will return the value indication if the denominator of the fractional value is reduced/truncated .
 public  void setConversionFactor(float conversionFactor) 
    This will set the conversion factor.
 public  void setDecimalSeparator(String decimalSeparator) 
    This will set the text to be used as the decimal point in displaying numerical values.
 public  void setDenominator(int denominator) 
    This will set the precision or denominator of a fractional amount.
 public  void setFD(boolean fd) 
    This will set the value indication if the denominator of the fractional value is reduced/truncated . The denominator may not be reduced/truncated if true
 public  void setFractionalDisplay(String fractionalDisplay) 
    This will set the value for the manner to display a fractional value. Allowed values are "D", "F", "R" and "T"
 public  void setLabelPositionToValue(String labelPositionToValue) 
    This will set the value indicating the ordering of the label specified by U to the calculated unit value. Possible values are "S" and "P"
 public  void setLabelPrefixString(String labelPrefixString) 
    This will set the text to be concatenated to the left of the label specified by U.
 public  void setLabelSuffixString(String labelSuffixString) 
    This will set the text to be concatenated after the label specified by U.
 public  void setThousandsSeparator(String thousandsSeparator) 
    This will set the text to be used between orders of thousands in display of numerical values.
 public  void setUnits(String units) 
    This will set the label for the units.