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
Constructor Summary
|
FieldPosition(int field)
Creates a FieldPosition object for the given field.
|
Method Summary
|
int
|
getBeginIndex()
Retrieves the index of the first character in the requested field.
|
int
|
getEndIndex()
Retrieves the index of the character following the last character in the
requested field.
|
int
|
getField()
Retrieves the field identifier.
|
void
|
setBeginIndex(int bi)
Sets the begin index.
|
void
|
setEndIndex(int ei)
Sets the end index.
|
Methods inherited from class java.lang.Object
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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()
- Retrieves the field identifier.
getBeginIndex
public int getBeginIndex()
- Retrieves the index of the first character in the requested field.
getEndIndex
public int getEndIndex()
- Retrieves the index of the character following the last character in the
requested field.
setBeginIndex
public void setBeginIndex(int bi)
- Sets the begin index. For use by subclasses of Format.
setEndIndex
public void setEndIndex(int ei)
- Sets the end index. For use by subclasses of Format.
Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.