    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class java.text.FieldPosition

    java.lang.Object
       |
       +----java.text.FieldPosition

public class FieldPosition
extends Object

`FieldPosition` is a simple class used by `Format` and its subclasses to identify fields in formatted output. Fields are identified by constants, whose names typically end with `_FIELD`, defined in the various subclasses of `Format`. See `ERA_FIELD` and its friends in `DateFormat` for an example.

`FieldPosition` keeps track of the position of the field within the formatted output with two indices: the index of the first character of the field and the index of the last character of the field.

One version of the `format` method in the various `Format` classes requires a `FieldPosition` object as an argument. You use this `format` method to perform partial formatting or to get information about the formatted output (such as the position of a field).

See Also:
  Format

##

FieldPosition(int)
  Creates a FieldPosition object for the given field.

##

getBeginIndex()
  Retrieve the index of the first character in the requested field.
getEndIndex()
  Retrieve the index of the character following the last character in the requested field.
getField()
  Retrieve the field identifier.

##

FieldPosition

     public FieldPosition(int field)

  Creates a FieldPosition object for the given field. Fields are identified by constants, whose names typically end with _FIELD, in the various subclasses of Format.

  See Also:
    INTEGER_FIELD, FRACTION_FIELD, YEAR_FIELD, MONTH_FIELD

##

getField

     public int getField()

  Retrieve the field identifier.

getBeginIndex

     public int getBeginIndex()

  Retrieve the index of the first character in the requested field.

getEndIndex

     public int getEndIndex()

  Retrieve the index of the character following the last character in the requested field.

    All Packages  Class Hierarchy  This Package  Previous  Next  Index

Submit a bug or feature - Version 1.1.8 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1995-1999 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.