Java Doc for TextPanel.java in  » Internationalization-Localization » icu4j » com » ibm » richtext » textpanel » 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 » Internationalization Localization » icu4j » com.ibm.richtext.textpanel 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.awt.Panel
   com.ibm.richtext.textpanel.TextPanel

TextPanel
final public class TextPanel extends Panel implements MTextPanel(Code)
TextPanel is an implementation of MTextPanel in an AWT Panel.
See Also:   MTextPanel



Constructor Summary
public  TextPanel(MConstText initialText, Clipboard clipboard)
     Create a new TextPanel with the default settings.
Parameters:
  initialText - the text document.
public  TextPanel(TextPanelSettings settings, MConstText initialText, Clipboard clipboard)
     Create a new TextPanel.
Parameters:
  settings - the settings for this TextPanel
Parameters:
  initialText - the text document.

Method Summary
public  voidaddListener(TextPanelListener listener)
     Add the given TextPanelListener to the listeners which will receive update notifications from this TextPanel.
public  voidappend(MConstText newText)
     Append the given text to the end of the document.
public  booleancanRedo()
     Return true if there is a change which can be redone.
public  booleancanUndo()
     Return true if there is a change which can be undone.
public  voidclear()
     Remove selected text from the document, without altering the clipboard.
public  voidclearCommandLog()
     Remove all commands from the command log.
public  booleanclipboardNotEmpty()
     Return true if the clipboard contains contents which could be transfered into the text.
public  voidcopy()
     Place the selected text on the clipboard.
public  voidcut()
     Remove the selected text from the document and place it on the clipboard.
public  ObjectgetCharacterStyleOverSelection(Object key)
     This method inspects the character style runs in the selection range (or the typing style at the insertion point).
public  intgetCommandLogSize()
     Return the number of commands the command log can hold.
public static  TextPanelSettingsgetDefaultSettings()
     Return a TextPanelSettings instance with all settings set to the default values.
public  AttributeMapgetDefaultValues()
     Return an AttributeMap of keys with default values.
public  intgetFormatWidth()
     Return the total format width, in pixels.
 ATextPanelImplgetImpl()
    
public  KeyRemapgetKeyRemap()
     Return the KeyRemap used to process key events.
public  ObjectgetParagraphStyleOverSelection(Object key)
     This method inspects the paragraph style runs in the selection range (or the typing style at the insertion point).
public  intgetSelectionEnd()
     Return the offset of the end of the selection.
public  intgetSelectionStart()
     Return the offset of the start of the selection.
public  MConstTextgetText()
     Return the text document in the TextPanel.
public  intgetTextLength()
     Return the length of the text document in the TextPanel.
public  voidinsert(MConstText newText, int position)
     Insert the given text into the document at the given position.
public  booleanisModified()
     Return the modification flag of the current text change.
public  voidmodifyCharacterStyleOnSelection(StyleModifier modifier)
     Modify the character styles on the selected characters.
public  voidmodifyParagraphStyleOnSelection(StyleModifier modifier)
     Modify the paragraph styles in paragraphs containing selected characters, or the paragraph containing the insertion point.
public  booleanparagraphIsLeftToRight(int offset)
     Return true if the paragraph at the given offset is left-to-right.
public  voidpaste()
     Replace the currently selected text with the text on the clipboard.
public  voidredo()
     Redo the most recent text change.
public  voidremoveListener(TextPanelListener listener)
     Remove the given TextPanelListener from the listeners which will receive update notifications from this TextPanel.
public  voidreplaceRange(MConstText newText, int start, int end)
     Replace the given range with newText.
public  voidselect(int selectionStart, int selectionEnd)
     Set the selection range to the given range.
public  voidselectAll()
     Select all of the text in the document.
public  voidsetCaretPosition(int position)
     Set the selection range to an insertion point at the given offset.
public  voidsetCommandLogSize(int size)
     Set the number of commands the command log can hold.
public  voidsetKeyRemap(KeyRemap remap)
     Use the given KeyRemap to map key events to characters. Only key events are affected by the remap; other text entering the control (via the clipboard, for example) is not affected by the KeyRemap.

Do not pass null to this method to leave key events unmapped.

public  voidsetModified(boolean modified)
     Set the modification flag of the current text change.
public  voidsetSelectionEnd(int selectionEnd)
     Set the end of the selection range.
public  voidsetSelectionStart(int selectionStart)
     Set the beginning of the selection range.
public  voidsetText(MConstText newText)
     Set the document to newText.
public  voidundo()
     Undo the most recent text change.


Constructor Detail
TextPanel
public TextPanel(MConstText initialText, Clipboard clipboard)(Code)
Create a new TextPanel with the default settings.
Parameters:
  initialText - the text document. If null document text is empty.
Parameters:
  clipboard - the clipboard to use for cut, copy, and pasteoperations. If null this panel will use a private clipboard.



TextPanel
public TextPanel(TextPanelSettings settings, MConstText initialText, Clipboard clipboard)(Code)
Create a new TextPanel.
Parameters:
  settings - the settings for this TextPanel
Parameters:
  initialText - the text document. If null document text is empty.
Parameters:
  clipboard - the clipboard to use for cut, copy, and pasteoperations. If null this panel will use a private clipboard.
See Also:   TextPanelSettings




Method Detail
addListener
public void addListener(TextPanelListener listener)(Code)
Add the given TextPanelListener to the listeners which will receive update notifications from this TextPanel.
Parameters:
  listener - the listener to add



append
public void append(MConstText newText)(Code)
Append the given text to the end of the document. Equivalent to insert(newText, getTextLength()).
Parameters:
  newText - the text to append to the document



canRedo
public boolean canRedo()(Code)
Return true if there is a change which can be redone. true if there is a change which can be redone.



canUndo
public boolean canUndo()(Code)
Return true if there is a change which can be undone. true if there is a change which can be undone.



clear
public void clear()(Code)
Remove selected text from the document, without altering the clipboard. This method has no effect if the text is not editable.



clearCommandLog
public void clearCommandLog()(Code)
Remove all commands from the command log.



clipboardNotEmpty
public boolean clipboardNotEmpty()(Code)
Return true if the clipboard contains contents which could be transfered into the text. true if the clipboard has text content.



copy
public void copy()(Code)
Place the selected text on the clipboard. This method has no effect if no text is selected.



cut
public void cut()(Code)
Remove the selected text from the document and place it on the clipboard. This method has no effect if the text is not editable, or if no text is selected.



getCharacterStyleOverSelection
public Object getCharacterStyleOverSelection(Object key)(Code)
This method inspects the character style runs in the selection range (or the typing style at the insertion point). It returns:
  • The value of key, if the value of key is the same in all of the style runs in the selection, or
  • MULTIPLE_VALUES, if two or more style runs have different values for key.
If a style run does not contain key, its value is considered to be the default style for key, as defined by the default values AttributeMap. Note that if key does not have a default value this method may return null. This method is useful for configuring style menus.
Parameters:
  key - the key used to retrieve values for comparison
See Also:   MTextPanel.MULTIPLE_VALUES



getCommandLogSize
public int getCommandLogSize()(Code)
Return the number of commands the command log can hold. the number of commands the command log can hold



getDefaultSettings
public static TextPanelSettings getDefaultSettings()(Code)
Return a TextPanelSettings instance with all settings set to the default values. Clients can modify this object; modifications will not affect the default values. a TextPanelSettings instance set to default values
See Also:   TextPanelSettings



getDefaultValues
public AttributeMap getDefaultValues()(Code)
Return an AttributeMap of keys with default values. The default values are used when displaying text for values which are not specified in the text. an AttributeMap of default key-value pairs



getFormatWidth
public int getFormatWidth()(Code)
Return the total format width, in pixels. The format width is the width to which text is wrapped. the format width



getImpl
ATextPanelImpl getImpl()(Code)
This method is for KeyEventForwarder's use only!



getKeyRemap
public KeyRemap getKeyRemap()(Code)
Return the KeyRemap used to process key events. the key remap used to process key events
See Also:   TextPanel.setKeyRemap



getParagraphStyleOverSelection
public Object getParagraphStyleOverSelection(Object key)(Code)
This method inspects the paragraph style runs in the selection range (or the typing style at the insertion point). It returns:
  • The value of key, if the value of key is the same in all of the style runs in the selection, or
  • MULTIPLE_VALUES, if two or more style runs have different values for key.
If a style run does not contain key, its value is considered to be the default style for key, as defined by the default values AttributeMap. Note that if key does not have a default value this method may return null. This method is useful for configuring style menus.
Parameters:
  key - the key used to retrieve values for comparison
See Also:   MTextPanel.MULTIPLE_VALUES



getSelectionEnd
public int getSelectionEnd()(Code)
Return the offset of the end of the selection.



getSelectionStart
public int getSelectionStart()(Code)
Return the offset of the start of the selection.



getText
public MConstText getText()(Code)
Return the text document in the TextPanel. the text document in the TextPanel.



getTextLength
public int getTextLength()(Code)
Return the length of the text document in the TextPanel. the length of the text document in the TextPanel



insert
public void insert(MConstText newText, int position)(Code)
Insert the given text into the document at the given position. Equivalent to replaceRange(newText, position, position).
Parameters:
  newText - the text to insert into the document.
Parameters:
  position - the position in the document where thetext will be inserted



isModified
public boolean isModified()(Code)
Return the modification flag of the current text change.
See Also:   TextPanel.setModified



modifyCharacterStyleOnSelection
public void modifyCharacterStyleOnSelection(StyleModifier modifier)(Code)
Modify the character styles on the selected characters. If no characters are selected, modify the typing style.
Parameters:
  modifier - the StyleModifier with which to modify the styles



modifyParagraphStyleOnSelection
public void modifyParagraphStyleOnSelection(StyleModifier modifier)(Code)
Modify the paragraph styles in paragraphs containing selected characters, or the paragraph containing the insertion point.
Parameters:
  modifier - the StyleModifier with which to modify the styles



paragraphIsLeftToRight
public boolean paragraphIsLeftToRight(int offset)(Code)
Return true if the paragraph at the given offset is left-to-right.
Parameters:
  offset - an offset in the text true if the paragraph at the given offset is left-to-right



paste
public void paste()(Code)
Replace the currently selected text with the text on the clipboard. This method has no effect if the text is not editable, or if no text is on the clipboard.



redo
public void redo()(Code)
Redo the most recent text change. This method has no effect if there is no change to redo.



removeListener
public void removeListener(TextPanelListener listener)(Code)
Remove the given TextPanelListener from the listeners which will receive update notifications from this TextPanel.
Parameters:
  listener - the listener to remove



replaceRange
public void replaceRange(MConstText newText, int start, int end)(Code)
Replace the given range with newText. After this operation the selection range is an insertion point at the end of the new text.
Parameters:
  newText - the text with which to replace the range
Parameters:
  start - the beginning of the range to replace
Parameters:
  end - the end of the range to replace



select
public void select(int selectionStart, int selectionEnd)(Code)
Set the selection range to the given range. The range start is pinned between 0 and the text length; the range end is pinned between the range start and the end of the text. These semantics are identical to those of java.awt.TextComponent. This method has no effect if the text is not selectable.
Parameters:
  selectionStart - the beginning of the selection range
Parameters:
  selectionEnd - the end of the selection range



selectAll
public void selectAll()(Code)
Select all of the text in the document. This method has no effect if the text is not selectable.



setCaretPosition
public void setCaretPosition(int position)(Code)
Set the selection range to an insertion point at the given offset. This is equivalent to select(position, position).
Parameters:
  position - the offset of the new insertion point



setCommandLogSize
public void setCommandLogSize(int size)(Code)
Set the number of commands the command log can hold. All redoable commands are removed when this method is called.
Parameters:
  size - the number of commands kept in the command log



setKeyRemap
public void setKeyRemap(KeyRemap remap)(Code)
Use the given KeyRemap to map key events to characters. Only key events are affected by the remap; other text entering the control (via the clipboard, for example) is not affected by the KeyRemap.

Do not pass null to this method to leave key events unmapped. Instead, use KeyRemap.getIdentityRemap()
Parameters:
  remap - the KeyRemap to use for mapping key events to characters
exception:
  java.lang.NullPointerException - if parameter is null
See Also:   KeyRemap




setModified
public void setModified(boolean modified)(Code)
Set the modification flag of the current text change.



setSelectionEnd
public void setSelectionEnd(int selectionEnd)(Code)
Set the end of the selection range. This is equivalent to select(getSelectionStart(), selectionEnd).
Parameters:
  selectionEnd - the end of the new selection range



setSelectionStart
public void setSelectionStart(int selectionStart)(Code)
Set the beginning of the selection range. This is equivalent to select(selectionStart, getSelectionEnd()).
Parameters:
  selectionStart - the start of the new selection range



setText
public void setText(MConstText newText)(Code)
Set the document to newText. This operation modifies the text in the TextPanel. It does not modify or adopt newText. This method sets the selection an insertion point at the end of the text.
Parameters:
  newText - the text which will replace the current text.



undo
public void undo()(Code)
Undo the most recent text change. This method has no effect if there is no change to undo.



Methods inherited from java.awt.Panel
public void addNotify()(Code)(Java Doc)
public AccessibleContext getAccessibleContext()(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.