Interface javax.help.TextHelpModel
- Implementing Classes:
- DefaultHelpModel
- public interface TextHelpModel
- extends HelpModel
The interface to a HelpModel that manipulates text.
It provides additional text operations.
getDocumentTitle
public java.lang.String getDocumentTitle()
- Gets the title of the document.
- Returns:
- The title of document visited.
setDocumentTitle
public void setDocumentTitle(java.lang.String title)
- Sets the title of the document.
A property change event is generated.
- Parameters:
title
- The title currently shown.
removeAllHighlights
public void removeAllHighlights()
- Removes all highlights on the current document.
addHighlight
public void addHighlight(int pos0,
int pos1)
- Adds a highlight to a range of positions in a document.
- Parameters:
pos0
- Start position.
pos1
- End position.
setHighlights
public void setHighlights(TextHelpModel.Highlight[] h)
- Sets the highlights to be a range of positions in a document.
- Parameters:
h
- The array of highlight objects.
getHighlights
public TextHelpModel.Highlight[] getHighlights()
- Gets all highlights.
addTextHelpModelListener
public void addTextHelpModelListener(TextHelpModelListener l)
- Adds a listener for a TextHelpModel.
removeTextHelpModelListener
public void removeTextHelpModelListener(TextHelpModelListener l)
- Removes a listener for a TextHelpModel.