com.pcauto.util
Class DimensionFormat

java.lang.Object
  extended byjava.text.Format
      extended bycom.pcauto.util.QuantityFormat
          extended bycom.pcauto.util.DimensionFormat
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class DimensionFormat
extends QuantityFormat

DimensionFormat provides several mechanisms to use Dimension objects:

  • to display dimension values in dynamically selected units
  • to create and load values into Dimension objects

    Locale based constructors use a default scale of 2. The parse and format methods are used to generate and format Dimension objects respectively.

    See Also:
    Serialized Form

    Nested Class Summary
     
    Nested classes inherited from class java.text.Format
    java.text.Format.Field
     
    Field Summary
     
    Fields inherited from class com.pcauto.util.QuantityFormat
    groupingUsed, scale, units
     
    Constructor Summary
    DimensionFormat()
              Creates new DimensionFormat instance based on default Locale.
    DimensionFormat(DimensionUnits units, int scale)
              Constructs new DimensionFormat with units set to int units and scale set to int scale.
    DimensionFormat(java.util.Locale loc)
              Creates new DimensionFormat instance based on supplied Locale
     
    Method Summary
     java.lang.Object clone()
              Creates new DimensionFormat object based on this DimensionFormat.
     java.lang.StringBuffer format(java.lang.Object obj, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
              Returns StringBuffer with supplied Dimension quantity formatted in units.
     java.lang.String formatDimension(Dimension dim)
              Returns String with supplied Dimension quantity formatted in units.
     DimensionUnits getUnits()
              Gets value for measurement unit.
     Dimension parseDimension(java.lang.String value)
              Parses String based on units to return a Dimension object.
     java.lang.Object parseObject(java.lang.String source, java.text.ParsePosition pos)
              Parses String based on units to return a Dimension object.
     void setUnits(DimensionUnits units)
              Sets value for measurement units.
     
    Methods inherited from class com.pcauto.util.QuantityFormat
    getScale, isGroupingUsed, setGroupingUsed, setScale
     
    Methods inherited from class java.text.Format
    format, formatToCharacterIterator, parseObject
     
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    Constructor Detail

    DimensionFormat

    public DimensionFormat()
    Creates new DimensionFormat instance based on default Locale.


    DimensionFormat

    public DimensionFormat(java.util.Locale loc)
    Creates new DimensionFormat instance based on supplied Locale

    Parameters:
    loc - Locale to set correct dimension units

    DimensionFormat

    public DimensionFormat(DimensionUnits units,
                           int scale)
    Constructs new DimensionFormat with units set to int units and scale set to int scale.

    Method Detail

    getUnits

    public DimensionUnits getUnits()
    Gets value for measurement unit.

    Returns:
    DimensionUnits value of current measurement units

    setUnits

    public void setUnits(DimensionUnits units)
    Sets value for measurement units.


    formatDimension

    public java.lang.String formatDimension(Dimension dim)
    Returns String with supplied Dimension quantity formatted in units.

    Parameters:
    dim - Dimension object from which to format value
    Returns:
    String dimension in current units

    format

    public java.lang.StringBuffer format(java.lang.Object obj,
                                         java.lang.StringBuffer toAppendTo,
                                         java.text.FieldPosition pos)
    Returns StringBuffer with supplied Dimension quantity formatted in units.

    Parameters:
    obj - Dimension object from which to format value
    Returns:
    StringBuffer dimension in current units

    parseDimension

    public Dimension parseDimension(java.lang.String value)
    Parses String based on units to return a Dimension object.

    Parameters:
    value - String to be converted to Dimension object
    Returns:
    Dimension holding a value specified in input String

    parseObject

    public java.lang.Object parseObject(java.lang.String source,
                                        java.text.ParsePosition pos)
    Parses String based on units to return a Dimension object.

    Parameters:
    pos - ParsePosition ignored in this implementation
    Returns:
    Dimension holding a value specified in input String
    Throws:
    NumberFormatException - on non-numeric String input

    clone

    public java.lang.Object clone()
    Creates new DimensionFormat object based on this DimensionFormat.

    Returns:
    new DimensionFormat object