Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: awt ::

interface XTextComponent
Description
gives access to the text of a component and makes it possible to register event listeners.

Methods' Summary
addTextListener registers a text event listener.  
removeTextListener unregisters a text event listener.  
setText sets the text of the component.  
insertText inserts text at the specified position.  
getText returns the text of the component.  
getSelectedText returns the currently selected text.  
setSelection sets the user selection.  
getSelection returns the current user selection.  
isEditable returns if the text is editable by the user.  
setEditable makes the text editable for the user or read-only.  
setMaxTextLen sets the maximum text length.  
getMaxTextLen returns the currently set maximum text length.  
Methods' Details
addTextListener
[oneway] void
addTextListener( [in] XTextListener  l );

Description
registers a text event listener.
removeTextListener
[oneway] void
removeTextListener( [in] XTextListener  l );

Description
unregisters a text event listener.
setText
[oneway] void
setText( [in] string  aText );

Description
sets the text of the component.
insertText
[oneway] void
insertText( [in] Selection  Sel,
[in] string  Text );

Description
inserts text at the specified position.
getText
string
getText();

Description
returns the text of the component.
getSelectedText
string
getSelectedText();

Description
returns the currently selected text.
setSelection
[oneway] void
setSelection( [in] Selection  aSelection );

Description
sets the user selection.
getSelection
Selection
getSelection();

Description
returns the current user selection.
isEditable
boolean
isEditable();

Description
returns if the text is editable by the user.
setEditable
[oneway] void
setEditable( [in] boolean  bEditable );

Description
makes the text editable for the user or read-only.
setMaxTextLen
[oneway] void
setMaxTextLen( [in] short  nLen );

Description
sets the maximum text length.
getMaxTextLen
short
getMaxTextLen();

Description
returns the currently set maximum text length.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.