Package org.odftoolkit.odfdom.incubator.search

Class TextNavigation

java.lang.Object
org.odftoolkit.odfdom.incubator.search.Navigation<TextSelection>
org.odftoolkit.odfdom.incubator.search.TextNavigation
All Implemented Interfaces:
Iterator<TextSelection>
public class TextNavigation extends Navigation<TextSelection>
A derived Navigation class used for navigate the text content it is used to search the document and find the matched text and would return TextSelection instance

  • Constructor Details

    • TextNavigation

      public TextNavigation(String pattern, OdfTextDocument doc)
      Construct TextNavigation with matched condition and navigation scope
      Parameters:
      pattern - the matched pattern String
      doc - the navigation scope

    • TextNavigation

      public TextNavigation(Pattern pattern, OdfTextDocument doc)
      Construct TextNavigation with matched condition and navigation scope
      Parameters:
      pattern - the Pattern object to search with
      doc - the navigation scope

  • Method Details

    • getSelectionManager

      public SelectionManager getSelectionManager()
      Returns the selectionManager instance.
      Returns:

    • next

      public TextSelection next()
      Returns the next matching element in the document.
      Specified by:
      next in interface Iterator<TextSelection>
      Specified by:
      next in class Navigation<TextSelection>
      Returns:
      the next element
      Throws:
      NoSuchElementException - if the iteration has no more matching elements

    • hasNext

      public boolean hasNext()
      Returns true if the Document has more matching elements. (In other words, returns true if next() would return an element rather than throwing an exception.)
      Specified by:
      hasNext in interface Iterator<TextSelection>
      Specified by:
      hasNext in class Navigation<TextSelection>
      Returns:
      true if document still has more matched Selection, and vice versa

    • getElement

      public OdfElement getElement()
      Specified by:
      getElement in class Navigation<TextSelection>

    • match

      public boolean match(Node element)
      check if the text content of element match the specified pattern string
      Specified by:
      match in class Navigation<TextSelection>
      Parameters:
      element - navigate this element
      Returns:
      true if the text content of this element match this pattern; false if not match