if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FieldPosition (Java Platform SE 7 )";
}
//-->
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
Class FieldPosition
- java.lang.Object
-
- java.text.FieldPosition
-
public class FieldPositionextends Object
FieldPositionis a simple class used byFormatand its subclasses to identify fields in formatted output. Fields can
be identified in two ways:
- By an integer constant, whose names typically end with
_FIELD. The constants are defined in the varioussubclasses of
Format. - By a
Format.Fieldconstant, seeERA_FIELDand its friends in
DateFormatfor an example.
FieldPositionkeeps track of the position of thefield 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
formatmethod in the variousFormatclasses requires aFieldPositionobject as an argument. You use this
formatmethodto perform partial formatting or to get information about the
formatted output (such as the position of a field).
If you are interested in the positions of all attributes in the
formatted string use the
FormatmethodformatToCharacterIterator.-
See Also:
-
Format
- By an integer constant, whose names typically end with
-
Constructor Summary
Constructors Constructor and Description FieldPosition(Format.Field attribute)Creates a FieldPosition object for the given field constant.FieldPosition(Format.Field attribute,int fieldID)Creates aFieldPositionobject for the given field.FieldPosition(int field)Creates a FieldPosition object for the given field.
Method Summary
Methods Modifier and Type Method and Description booleanequals(Object obj)Overrides equalsintgetBeginIndex()Retrieves the index of the first character in the requested field.intgetEndIndex()Retrieves the index of the character following the last character in therequested field.
intgetField()Retrieves the field identifier.Format.FieldgetFieldAttribute()Returns the field identifier as an attribute constantfrom one of the
Fieldsubclasses.inthashCode()Returns a hash code for this FieldPosition.voidsetBeginIndex(int bi)Sets the begin index.voidsetEndIndex(int ei)Sets the end index.StringtoString()Return a string representation of this FieldPosition.
-
Constructor Detail
FieldPosition
public FieldPosition(int field)
Creates a FieldPosition object for the given field. Fields areidentified by constants, whose names typically end with _FIELD,
in the various subclasses of Format.
FieldPosition
public FieldPosition(Format.Field attribute)
Creates a FieldPosition object for the given field constant. Fields areidentified by constants defined in the various
Formatsubclasses. This is equivalent to calling
new FieldPosition(attribute, -1).-
Parameters:
-
attribute- Format.Field constant identifying a field
Since:
- 1.4
-
FieldPosition
public FieldPosition(Format.Field attribute,
int fieldID)
Creates aFieldPositionobject for the given field.The field is identified by an attribute constant from one of the
Fieldsubclasses as well as an integer field IDdefined by the
Formatsubclasses.Formatsubclasses that are aware of
Fieldshould give precedenceto
attributeand ignorefieldIDifattributeis not null. However, olderFormatsubclasses may not be aware of
Fieldand rely onfieldID. If the field has no corresponding integerconstant,
fieldIDshould be -1.-
Parameters:
-
attribute- Format.Field constant identifying a field -
fieldID- integer constantce identifying a field
Since:
- 1.4
-
Method Detail
getFieldAttribute
public Format.Field getFieldAttribute()
Returns the field identifier as an attribute constantfrom one of the
Fieldsubclasses. May return null ifthe field is specified only by an integer field ID.
-
Returns:
- Identifier for the field Since:
- 1.4
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 therequested field.
setBeginIndex
public void setBeginIndex(int bi)
Sets the begin index. For use by subclasses of Format.-
Since:
- 1.2
setEndIndex
public void setEndIndex(int ei)
Sets the end index. For use by subclasses of Format.-
Since:
- 1.2
equals
public boolean equals(Object obj)
Overrides equals-
Overrides:
-
equalsin classObject
Parameters:
-
obj- the reference object with which to compare.
Returns:
-
trueif this object is the same as the objargument;
falseotherwise.
See Also:
-
Object.hashCode(),
-
hashCode
public int hashCode()
Returns a hash code for this FieldPosition.-
Overrides:
-
hashCodein classObject
Returns:
- a hash code value for this object See Also:
-
Object.equals(java.lang.Object),
-
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.
一键复制
编辑
Web IDE
原始数据
按行查看
历史
230
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
