Java Doc for AttributedCharacterIterator.java in  » 6.0-JDK-Core » text » java » text » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » text » java.text 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.text.AttributedCharacterIterator

AttributedCharacterIterator
public interface AttributedCharacterIterator extends CharacterIterator(Code)
An AttributedCharacterIterator allows iteration through both text and related attribute information.

An attribute is a key/value pair, identified by the key. No two attributes on a given character can have the same key.

The values for an attribute are immutable, or must not be mutated by clients or storage. They are always passed by reference, and not cloned.

A run with respect to an attribute is a maximum text range for which:

  • the attribute is undefined or null for the entire range, or
  • the attribute value is defined and has the same non-null value for the entire range.

A run with respect to a set of attributes is a maximum text range for which this condition is met for each member attribute.

The returned indexes are limited to the range of the iterator.

The returned attribute information is limited to runs that contain the current character.

Attribute keys are instances of AttributedCharacterIterator.Attribute and its subclasses, such as java.awt.font.TextAttribute.
See Also:   AttributedCharacterIterator.Attribute
See Also:   java.awt.font.TextAttribute
See Also:   AttributedString
See Also:   Annotation
since:
   1.2


Inner Class :public static class Attribute implements Serializable



Method Summary
public  Set<Attribute>getAllAttributeKeys()
     Returns the keys of all attributes defined on the iterator's text range.
public  ObjectgetAttribute(Attribute attribute)
     Returns the value of the named attribute for the current character.
public  Map<Attribute, Object>getAttributes()
     Returns a map with the attributes defined on the current character.
public  intgetRunLimit()
     Returns the index of the first character following the run with respect to all attributes containing the current character.
public  intgetRunLimit(Attribute attribute)
     Returns the index of the first character following the run with respect to the given attribute containing the current character.
public  intgetRunLimit(Set<? extends Attribute> attributes)
     Returns the index of the first character following the run with respect to the given attributes containing the current character.
public  intgetRunStart()
     Returns the index of the first character of the run with respect to all attributes containing the current character.
public  intgetRunStart(Attribute attribute)
     Returns the index of the first character of the run with respect to the given attribute containing the current character.
public  intgetRunStart(Set<? extends Attribute> attributes)
     Returns the index of the first character of the run with respect to the given attributes containing the current character.



Method Detail
getAllAttributeKeys
public Set<Attribute> getAllAttributeKeys()(Code)
Returns the keys of all attributes defined on the iterator's text range. The set is empty if no attributes are defined.


getAttribute
public Object getAttribute(Attribute attribute)(Code)
Returns the value of the named attribute for the current character. Returns null if the attribute is not defined.
Parameters:
  attribute - the key of the attribute whose value is requested.


getAttributes
public Map<Attribute, Object> getAttributes()(Code)
Returns a map with the attributes defined on the current character.


getRunLimit
public int getRunLimit()(Code)
Returns the index of the first character following the run with respect to all attributes containing the current character.


getRunLimit
public int getRunLimit(Attribute attribute)(Code)
Returns the index of the first character following the run with respect to the given attribute containing the current character.


getRunLimit
public int getRunLimit(Set<? extends Attribute> attributes)(Code)
Returns the index of the first character following the run with respect to the given attributes containing the current character.


getRunStart
public int getRunStart()(Code)
Returns the index of the first character of the run with respect to all attributes containing the current character.


getRunStart
public int getRunStart(Attribute attribute)(Code)
Returns the index of the first character of the run with respect to the given attribute containing the current character.


getRunStart
public int getRunStart(Set<? extends Attribute> attributes)(Code)
Returns the index of the first character of the run with respect to the given attributes containing the current character.


www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.