Java Doc for InputMethodHighlight.java in  » 6.0-JDK-Modules » j2me » java » awt » im » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » java.awt.im 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.awt.im.InputMethodHighlight

InputMethodHighlight
public class InputMethodHighlight (Code)
An InputMethodHighlight is used to describe the highlight attributes of text being composed. The description can be at two levels: at the abstract level it specifies the conversion state and whether the text is selected; at the concrete level it specifies style attributes used to render the highlight. An InputMethodHighlight must provide the description at the abstract level; it may or may not provide the description at the concrete level. If no concrete style is provided, a renderer should use java.awt.Toolkit.mapInputMethodHighlight to map to a concrete style.

The abstract description consists of three fields: selected, state, and variation. selected indicates whether the text range is the one that the input method is currently working on, for example, the segment for which conversion candidates are currently shown in a menu. state represents the conversion state. State values are defined by the input method framework and should be distinguished in all mappings from abstract to concrete styles. Currently defined state values are raw (unconverted) and converted. These state values are recommended for use before and after the main conversion step of text composition, say, before and after kana->kanji or pinyin->hanzi conversion. The variation field allows input methods to express additional information about the conversion results.

InputMethodHighlight instances are typically used as attribute values returned from AttributedCharacterIterator for the INPUT_METHOD_HIGHLIGHT attribute. They may be wrapped into java.text.Annotation Annotation instances to indicate separate text segments.
version:
   1.19, 01/23/03
See Also:   java.text.AttributedCharacterIterator
since:
   1.2



Field Summary
final public static  intCONVERTED_TEXT
     Constant for the converted text state.
final public static  intRAW_TEXT
     Constant for the raw text state.
final public static  InputMethodHighlightSELECTED_CONVERTED_TEXT_HIGHLIGHT
     Constant for the default highlight for selected converted text.
final public static  InputMethodHighlightSELECTED_RAW_TEXT_HIGHLIGHT
     Constant for the default highlight for selected raw text.
final public static  InputMethodHighlightUNSELECTED_CONVERTED_TEXT_HIGHLIGHT
     Constant for the default highlight for unselected converted text.
final public static  InputMethodHighlightUNSELECTED_RAW_TEXT_HIGHLIGHT
     Constant for the default highlight for unselected raw text.

Constructor Summary
public  InputMethodHighlight(boolean selected, int state)
     Constructs an input method highlight record.
public  InputMethodHighlight(boolean selected, int state, int variation)
     Constructs an input method highlight record.

Method Summary
public  intgetState()
     Returns the conversion state of the text range.
public  intgetVariation()
     Returns the variation of the text range.
public  booleanisSelected()
     Returns whether the text range is selected.

Field Detail
CONVERTED_TEXT
final public static int CONVERTED_TEXT(Code)
Constant for the converted text state.



RAW_TEXT
final public static int RAW_TEXT(Code)
Constant for the raw text state.



SELECTED_CONVERTED_TEXT_HIGHLIGHT
final public static InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT(Code)
Constant for the default highlight for selected converted text.



SELECTED_RAW_TEXT_HIGHLIGHT
final public static InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT(Code)
Constant for the default highlight for selected raw text.



UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
final public static InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT(Code)
Constant for the default highlight for unselected converted text.



UNSELECTED_RAW_TEXT_HIGHLIGHT
final public static InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT(Code)
Constant for the default highlight for unselected raw text.




Constructor Detail
InputMethodHighlight
public InputMethodHighlight(boolean selected, int state)(Code)
Constructs an input method highlight record. The variation is set to 0, the style to null.
Parameters:
  selected - Whether the text range is selected
Parameters:
  state - The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT
See Also:   InputMethodHighlight.RAW_TEXT
See Also:   InputMethodHighlight.CONVERTED_TEXT
exception:
  IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given



InputMethodHighlight
public InputMethodHighlight(boolean selected, int state, int variation)(Code)
Constructs an input method highlight record. The style is set to null.
Parameters:
  selected - Whether the text range is selected
Parameters:
  state - The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT
Parameters:
  variation - The style variation for the text range
See Also:   InputMethodHighlight.RAW_TEXT
See Also:   InputMethodHighlight.CONVERTED_TEXT
exception:
  IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given




Method Detail
getState
public int getState()(Code)
Returns the conversion state of the text range. The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT.
See Also:   InputMethodHighlight.RAW_TEXT
See Also:   InputMethodHighlight.CONVERTED_TEXT



getVariation
public int getVariation()(Code)
Returns the variation of the text range.



isSelected
public boolean isSelected()(Code)
Returns whether the text range is selected.



Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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