Package javax.help

Interface TextHelpModel

All Superinterfaces:
HelpModel
All Known Implementing Classes:
DefaultHelpModel

public interface TextHelpModel extends HelpModel
The interface to a HelpModel that manipulates text. It provides additional text operations.
  • Method Details

    • getDocumentTitle

      String getDocumentTitle()
      Gets the title of the document.
      Returns:
      The title of document visited.
    • setDocumentTitle

      void setDocumentTitle(String title)
      Sets the title of the document. A property change event is generated.
      Parameters:
      title - The title currently shown.
    • removeAllHighlights

      void removeAllHighlights()
      Removes all highlights on the current document.
    • addHighlight

      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

      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

      TextHelpModel.Highlight[] getHighlights()
      Gets all highlights.
    • addTextHelpModelListener

      void addTextHelpModelListener(TextHelpModelListener l)
      Adds a listener for a TextHelpModel.
    • removeTextHelpModelListener

      void removeTextHelpModelListener(TextHelpModelListener l)
      Removes a listener for a TextHelpModel.