|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.odftoolkit.odfdom.incubator.search.Selection
org.odftoolkit.odfdom.incubator.search.TextSelection
org.odftoolkit.simple.common.navigation.TextSelection
in Simple API.
public class 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.
Method Summary | |
---|---|
void |
addHref(URL url)
Deprecated. Add a hypertext reference to the selection |
void |
applyStyle(OdfStyleBase style)
Deprecated. Apply a style to the selection so that the text style of this selection will append the specified style |
void |
cut()
Deprecated. Delete the selection from the document the other matched selection in the same container element will be updated automatically because the start index of the following selections will be changed when the previous selection has been deleted |
OdfElement |
getContainerElement()
Deprecated. Get the mParagraph element or mHeading element that contain this text |
OdfElement |
getElement()
Deprecated. Get the mParagraph element or mHeading element that contain this TextSelection |
int |
getIndex()
Deprecated. Get the start index of the text content of its container element |
String |
getText()
Deprecated. Get the text content of this TextSelection |
void |
pasteAtEndOf(Selection positionItem)
Deprecated. Paste this selection just after a specific selection. |
void |
pasteAtFrontOf(Selection positionItem)
Deprecated. Paste this selection just before a specific selection. |
protected void |
refresh(int offset)
Deprecated. A quick method to update the mIndex of this selection |
protected void |
refreshAfterFrontalDelete(Selection deleteItem)
Deprecated. when a selected item has been delete, the selections after this deleted selection should be refresh because these selections mIndex will be changed |
protected void |
refreshAfterFrontalInsert(Selection pasteItem)
Deprecated. when a selected item has been inserted, the selection after the inserted item should be refresh because these selections mIndex will be changed |
void |
replaceWith(String newText)
Deprecated. Replace the text content of selection with a new string |
String |
toString()
Deprecated. return a String Object representing this selection value the text content of the selection, start index in the container element and the text content of the container element will be provided |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public OdfElement getElement()
getElement
in class Selection
public OdfElement getContainerElement()
public int getIndex()
getIndex
in class Selection
public String getText()
public void cut() throws InvalidNavigationException
cut
in class Selection
InvalidNavigationException
- if the selection is unavailable.public void applyStyle(OdfStyleBase style) throws InvalidNavigationException
style
- the style can be from the current document or user defined
InvalidNavigationException
- if the selection is unavailable.public void replaceWith(String newText) throws InvalidNavigationException
newText
- the replace text String
InvalidNavigationException
- if the selection is unavailable.public void pasteAtFrontOf(Selection positionItem) throws InvalidNavigationException
pasteAtFrontOf
in class Selection
positionItem
- a selection that is used to point out the position
InvalidNavigationException
- if the selection is unavailable.public void pasteAtEndOf(Selection positionItem) throws InvalidNavigationException
pasteAtEndOf
in class Selection
positionItem
- a selection that is used to point out the position
InvalidNavigationException
- if the selection is unavailable.public void addHref(URL url) throws InvalidNavigationException
url
- the url of the hypertext reference
InvalidNavigationException
- if the selection is unavailable.protected void refreshAfterFrontalDelete(Selection deleteItem)
Selection
refreshAfterFrontalDelete
in class Selection
deleteItem
- the deleted selectionprotected void refreshAfterFrontalInsert(Selection pasteItem)
Selection
refreshAfterFrontalInsert
in class Selection
pasteItem
- the inserted selectionprotected void refresh(int offset)
Selection
refresh
in class Selection
offset
- the offset that the mIndex should be addedpublic String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |