FieldPosition
is a simple class used by Format
and its subclasses to identify fields in formatted output.
More...
#include <fieldpos.h>
Inheritance diagram for FieldPosition::
Public Types | |
enum | { DONT_CARE = -1 } |
DONT_CARE may be specified as the field to indicate that the caller doesn't need to specify a field. More... | |
Public Methods | |
FieldPosition () | |
Creates a FieldPosition object with a non-specified field. More... | |
FieldPosition (int32_t field) | |
Creates a FieldPosition object for the given field. More... | |
FieldPosition (const FieldPosition ©) | |
Copy constructor. More... | |
~FieldPosition () | |
Destructor. More... | |
FieldPosition & | operator= (const FieldPosition ©) |
Assignment operator. More... | |
UBool | operator== (const FieldPosition &that) const |
Equality operator. More... | |
UBool | operator!= (const FieldPosition &that) const |
Equality operator. More... | |
FieldPosition * | clone () const |
Clone this object. More... | |
int32_t | getField (void) const |
Retrieve the field identifier. More... | |
int32_t | getBeginIndex (void) const |
Retrieve the index of the first character in the requested field. More... | |
int32_t | getEndIndex (void) const |
Retrieve the index of the character following the last character in the requested field. More... | |
void | setField (int32_t f) |
Set the field. More... | |
void | setBeginIndex (int32_t bi) |
Set the begin index. More... | |
void | setEndIndex (int32_t ei) |
Set the end index. More... | |
virtual UClassID | getDynamicClassID () const |
ICU "poor man's RTTI", returns a UClassID for the actual class. More... | |
Static Public Methods | |
UClassID | getStaticClassID () |
ICU "poor man's RTTI", returns a UClassID for this class. More... | |
Private Attributes | |
int32_t | fField |
Input: Desired field to determine start and end offsets for. More... | |
int32_t | fBeginIndex |
Output: Start offset of field in text. More... | |
int32_t | fEndIndex |
Output: End offset of field in text. More... |
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).
The FieldPosition class is not suitable for subclassing.
Below is an example of using FieldPosition
to aid alignment of an array of formatted floating-point numbers on their decimal points:
double doubleNum[] = {123456789.0, -12345678.9, 1234567.89, -123456.789, 12345.6789, -1234.56789, 123.456789, -12.3456789, 1.23456789}; int dNumSize = (int)(sizeof(doubleNum)/sizeof(double)); UErrorCode status = U_ZERO_ERROR; DecimalFormat* fmt = (DecimalFormat*) NumberFormat::createInstance(status); fmt->setDecimalSeparatorAlwaysShown(true); const int tempLen = 20; char temp[tempLen]; for (int i=0; i<dNumSize; i++) { FieldPosition pos(NumberFormat::INTEGER_FIELD); UnicodeString buf; char fmtText[tempLen]; ToCharString(fmt->format(doubleNum[i], buf, pos), fmtText); for (int j=0; j<tempLen; j++) temp[j] = ' '; // clear with spaces temp[__min(tempLen, tempLen-pos.getEndIndex())] = '\0'; cout << temp << fmtText << endl; } delete fmt;
The code will generate the following output:
123,456,789.000 -12,345,678.900 1,234,567.880 -123,456.789 12,345.678 -1,234.567 123.456 -12.345 1.234
Definition at line 100 of file fieldpos.h.
|
DONT_CARE may be specified as the field to indicate that the caller doesn't need to specify a field. Do not subclass. Definition at line 106 of file fieldpos.h. |
|
Creates a FieldPosition object with a non-specified field.
Definition at line 112 of file fieldpos.h. |
|
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.
Definition at line 126 of file fieldpos.h. |
|
Copy constructor.
Definition at line 134 of file fieldpos.h. |
|
Destructor.
|
|
Clone this object. Clones can be used concurrently in multiple threads. If an error occurs, then NULL is returned. The caller must delete the clone.
|
|
Retrieve the index of the first character in the requested field.
Definition at line 191 of file fieldpos.h. |
|
ICU "poor man's RTTI", returns a UClassID for the actual class.
Reimplemented from UObject. |
|
Retrieve the index of the character following the last character in the requested field.
Definition at line 200 of file fieldpos.h. |
|
Retrieve the field identifier.
Definition at line 184 of file fieldpos.h. |
|
ICU "poor man's RTTI", returns a UClassID for this class.
|
|
Equality operator.
Definition at line 278 of file fieldpos.h. |
|
Assignment operator.
Definition at line 258 of file fieldpos.h. |
|
Equality operator.
Definition at line 267 of file fieldpos.h. Referenced by operator!=().
|
|
Set the begin index. For use by subclasses of Format.
Definition at line 214 of file fieldpos.h. |
|
Set the end index. For use by subclasses of Format.
Definition at line 221 of file fieldpos.h. |
|
Set the field.
Definition at line 207 of file fieldpos.h. |
|
Output: Start offset of field in text. If the field does not occur in the text, 0 is returned. Definition at line 248 of file fieldpos.h. Referenced by operator=(), and operator==().
|
|
Output: End offset of field in text. If the field does not occur in the text, 0 is returned. Definition at line 254 of file fieldpos.h. Referenced by operator=(), and operator==().
|
|
Input: Desired field to determine start and end offsets for. The meaning depends on the subclass of Format. Definition at line 242 of file fieldpos.h. Referenced by operator=(), and operator==().
|