Package org.odftoolkit.odfdom.incubator.search

package org.odftoolkit.odfdom.incubator.search

Provide classes to operate the content and style of the selected text content. (Incubator Status)

Abstract class Navigation represent the navigate action on the specified document, and user can iterate all the results of this navigation operation. Abstract class Selection describes one result of navigation.

The instance of derived navigation class will give the match condition so that user can get the corresponding derived Selection class instance. e.g. TextNavigation class is used to search the specified text content in the document. and TextStyleNavigation class can select the text which match the specified style.

TextSelection class which inheriates Selection represents a snippet text of the paragraph/heading/header/footer, it can be represent by the belonged element and the text index of this element. User can get delete this result, or replace this text with other content, add href link for this selections, append the italic style for it and paste this selection at the front of or the end of other selction.

Class	Description
InvalidNavigationException	Thrown to indicate that the navigation operation can not be processed on selections
Navigation<T extends Selection>	Abstract class Navigation used to navigate the document and find the matched element by the user defined conditions
Selection	Abstract class Selection describe one of the matched results The selection can be recognized by the container mElement, the start mIndex of the text content of this mElement and the text content.
SelectionManager	The SelectionManager can manage all the selections that are returned to end users by a Navigation instance.
TextNavigation	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
TextSelection	A TextSelection can describe a sub element in a mParagraph element or a mHeading element. it is recognized by the container element(which type should be OdfTextParagraph or OdfTextHeadingt), the start index of the text content of the container element and the text content of this selection.
TextStyleNavigation	A derived Navigation class used for navigate the mText content it is used to search the document and find the matched style properties and would return TextSelection instance