org.odftoolkit.odfdom.incubator.search

Class TextStyleNavigation

java.lang.Object

org.odftoolkit.odfdom.incubator.search.Navigation

org.odftoolkit.odfdom.incubator.search.TextStyleNavigation

public class TextStyleNavigation
extends Navigation

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

Constructor Summary

Constructors

Constructor and Description
TextStyleNavigation(Map<OdfStyleProperty,String> props, OdfTextDocument doc) Construct TextStyleNavigation with style properties condition and navigation scope

Method Summary

Modifier and Type	Method and Description
Selection	getCurrentItem() get the current Selection result
boolean	hasNext() Return true if document still has more matched Selection when traversing the document(In other words return true if getNextMatchElement() would return an element instance rather than return null)
boolean	match(Node element) check if the element has the specified style properties

Methods inherited from class org.odftoolkit.odfdom.incubator.search.Navigation

getNextMatchElement, getNextMatchElementInTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextStyleNavigation

public TextStyleNavigation(Map<OdfStyleProperty,String> props,
                           OdfTextDocument doc)

Construct TextStyleNavigation with style properties condition and navigation scope

Parameters:

props - the matched style properties conditions

doc - the navigation search scope

Method Detail

getCurrentItem

public Selection getCurrentItem()

Description copied from class: Navigation

get the current Selection result

Specified by:

getCurrentItem in class Navigation

Returns:

the current Selection result

hasNext

public boolean hasNext()

Description copied from class: Navigation

Return true if document still has more matched Selection when traversing the document(In other words return true if getNextMatchElement() would return an element instance rather than return null)

Specified by:

hasNext in class Navigation

Returns:

true if document still has more matched Selection, and vice versa

match

public boolean match(Node element)

check if the element has the specified style properties

Specified by:

match in class Navigation

Parameters:

element - navigate this element

Returns:

true if this element has the specified style properties false if not match