Package org.odftoolkit.simple.common.navigation

Provide classes to operate the content and style of the selected text content.

See:
          Description

Class Summary
CellSelection Based on TextSelection, CellSelection updates table cell value and value type when the cell text is replaced by other content.
FieldSelection This is a decorator class of TextSelection, which help user replace a text content with field.
ImageSelection This is a decorator class of TextSelection, which help user replace a text content with a Image from Document or from URI.
Navigation Navigation is used to navigate the document and find the matched element by user defined conditions.
ParagraphSelection This is a decorator class of TextSelection, which help user replace a text content with a Paragraph.
Selection Selection describes one of the matched results, which is recognized by the container element, the start index of the text content in this element and the text content.
TableSelection This is a decorator class of TextSelection, which help user replace a text content with a Table.
TextDocumentSelection This is a decorator class of TextSelection, which help user replace a text content with a TextDocument, all Styles be included.
TextNavigation A derived Navigation class used to navigate the text content, which can search the document and find the matched text and return TextSelection instance.
TextSelection TextSelection describes a sub element in a paragraph element or a heading element.
TextStyleNavigation A derived Navigation class used to navigate the text content, which can search the document and find matched style properties and return TextSelection instance(s).
 

Exception Summary
InvalidNavigationException Thrown to indicate that the navigation operation can not be processed on selections
 

Package org.odftoolkit.simple.common.navigation Description

Provide classes to operate the content and style of the selected text content.

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 inherits 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.

CellSelection inherits TextSelection. It provides a new function to not only replace text but also reset the cell values.



Copyright © 2010-2017 The Apache Software Foundation. All Rights Reserved.