| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
The interface to a HelpModel that manipulates text. It provides additional text operations.
| Nested Class Summary | |
| static interface | TextHelpModel.HighlightThis is very similar to javax.swing.text.Highlighter.Highlight except that it does not use the notion of HighlightPainter. | 
| Method Summary | |
|  void | addHighlight(int pos0,
             int pos1)Adds a highlight to a range of positions in a document. | 
|  void | addTextHelpModelListener(TextHelpModelListener l)Adds a listener for a TextHelpModel. | 
|  java.lang.String | getDocumentTitle()Gets the title of the document. | 
|  TextHelpModel.Highlight[] | getHighlights()Gets all highlights. | 
|  void | removeAllHighlights()Removes all highlights on the current document. | 
|  void | removeTextHelpModelListener(TextHelpModelListener l)Removes a listener for a TextHelpModel. | 
|  void | setDocumentTitle(java.lang.String title)Sets the title of the document. | 
|  void | setHighlights(TextHelpModel.Highlight[] h)Sets the highlights to be a range of positions in a document. | 
| Methods inherited from interface javax.help.HelpModel | 
| addHelpModelListener, addPropertyChangeListener, getCurrentID, getCurrentURL, getHelpSet, removeHelpModelListener, removePropertyChangeListener, setCurrentID, setCurrentID, setCurrentURL, setCurrentURL, setHelpSet | 
| Method Detail | 
public java.lang.String getDocumentTitle()
public void setDocumentTitle(java.lang.String title)
title - The title currently shown.public void removeAllHighlights()
public void addHighlight(int pos0,
                         int pos1)
pos0 - Start position.pos1 - End position.public void setHighlights(TextHelpModel.Highlight[] h)
h - The array of highlight objects.public TextHelpModel.Highlight[] getHighlights()
public void addTextHelpModelListener(TextHelpModelListener l)
public void removeTextHelpModelListener(TextHelpModelListener l)
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||