TextPaneComponent (adams-pom 24.11.0-SNAPSHOT API)

All Known Implementing Classes:

BaseTextPane, BaseTextPaneWithButtons, BaseTextPaneWithWordWrap, DiffTextPane
```
public interface TextPaneComponent
```
TODO: What class does.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getCaretPosition()`	Returns the current position of the cursor.
`Document`	`getDocument()`	Returns the underlying document.
`String`	`getSelectedText()`	Returns the selected text.
`String`	`getText()`	Returns the text to display.
`boolean`	`isEditable()`	Returns whether the text pane is editable or not.
`void`	`setCaretPosition(int value)`	Sets the position of the cursor.
`void`	`setCaretPositionLast()`	Sets the position of the cursor at the end.
`void`	`setEditable(boolean value)`	Sets whether the text pane is editable or not.
`void`	`setText(String value)`	Sets the text to display.

- Method Detail
  - setText
```
void setText(String value)
```
    Sets the text to display.
    
    Parameters:
    
    value - the text
  - getText
```
String getText()
```
    Returns the text to display.
    
    Returns:
    
    the text
  - getSelectedText
```
String getSelectedText()
```
    Returns the selected text.
    
    Returns:
    
    the selected text
  - setEditable
```
void setEditable(boolean value)
```
    Sets whether the text pane is editable or not.
    
    Parameters:
    
    value - if true the text pane is editable
  - isEditable
```
boolean isEditable()
```
    Returns whether the text pane is editable or not.
    
    Returns:
    
    true if the text pane is editable
  - getDocument
```
Document getDocument()
```
    Returns the underlying document.
    
    Returns:
    
    the document
  - setCaretPosition
```
void setCaretPosition(int value)
```
    Sets the position of the cursor.
    
    Parameters:
    
    value - the position
  - getCaretPosition
```
int getCaretPosition()
```
    Returns the current position of the cursor.
    
    Returns:
    
    the cursor position
  - setCaretPositionLast
```
void setCaretPositionLast()
```
    Sets the position of the cursor at the end.