AttributedCharacterIterator.Attribute (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.text
class AttributedCharacterIterator.Attribute

java.lang.Object
  java.text.AttributedCharacterIterator.Attribute

All Implemented Interfaces:: Serializable

Direct Known Subclasses:: Format.Field, TextAttribute

Enclosing class:: AttributedCharacterIterator

public static class AttributedCharacterIterator.Attribute
extends Object
implements Serializable

Defines attribute keys that are used to identify text attributes. These keys are used in AttributedCharacterIterator and AttributedString.

Field Summary
`static AttributedCharacterIterator.Attribute`	`INPUT_METHOD_SEGMENT` Attribute key for input method segments.
`static AttributedCharacterIterator.Attribute`	`LANGUAGE` Attribute key for the language of some text.
`static AttributedCharacterIterator.Attribute`	`READING` Attribute key for the reading of some text.

Constructor Summary
`protected`	`AttributedCharacterIterator.Attribute(String name)` Constructs an Attribute with the given name.

Method Summary
`boolean`	`equals(Object obj)` Compares two objects for equality.
`protected String`	`getName()` Returns the name of the attribute.
`int`	`hashCode()` Returns a hash code value for the object.
`protected Object`	`readResolve()` Resolves instances being deserialized to the predefined constants.
`String`	`toString()` Returns a string representation of the object.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

INPUT_METHOD_SEGMENT

public static final AttributedCharacterIterator.Attribute INPUT_METHOD_SEGMENT

Attribute key for input method segments. Input methods often break up text into segments, which usually correspond to words.

Values are instances of Annotation holding a null reference.

LANGUAGE

public static final AttributedCharacterIterator.Attribute LANGUAGE

Attribute key for the language of some text.

Values are instances of Locale.

READING

public static final AttributedCharacterIterator.Attribute READING

Attribute key for the reading of some text. In languages where the written form and the pronunciation of a word are only loosely related (such as Japanese), it is often necessary to store the reading (pronunciation) along with the written form.

Values are instances of Annotation holding instances of String.

Constructor Detail

AttributedCharacterIterator.Attribute

protected AttributedCharacterIterator.Attribute(String name)

Constructs an Attribute with the given name.

Parameters:: name

Method Detail

equals

public final boolean equals(Object obj)

Compares two objects for equality. This version only returns true for x.equals(y) if x and y refer to the same object, and guarantees this for all subclasses.

Overrides:: equals in class Object
Parameters:: obj

getName

protected String getName()

Returns the name of the attribute.

hashCode

public final int hashCode()

Returns a hash code value for the object. This version is identical to the one in Object, but is also final.

Overrides:: hashCode in class Object

readResolve

protected Object readResolve()
                      throws InvalidObjectException

Resolves instances being deserialized to the predefined constants.

Throws:: InvalidObjectException

toString

public String toString()

Returns a string representation of the object. This version returns the concatenation of class name, "(", a name identifying the attribute and ")".

Overrides:: toString in class Object