org.languagetool.openoffice

Class ViewCursorTools

java.lang.Object

org.languagetool.openoffice.ViewCursorTools

public class ViewCursorTools
extends Object

Information about Paragraphs of LibreOffice/OpenOffice documents on the basis of the LO/OO view cursor

Since:

4.9

Author:

Fred Kruse

Constructor Summary

Constructors

Constructor and Description
ViewCursorTools(com.sun.star.lang.XComponent xComponent)

Method Summary

Modifier and Type	Method and Description
com.sun.star.container.XIndexAccess	getIndexAccessOfAllTables() Returns the Index Access to all tables of a document
com.sun.star.text.XTextViewCursor	getViewCursor() Returns ViewCursor Returns null if it fails
DocumentCache.TextParagraph	getViewCursorParagraph() get the paragraph under the view cursor
static boolean	isBusy() Returns the status of view cursor tools true: If a cursor tool in one or more threads is active
static void	reset() Reset the busy flag
void	setDisposed() document is disposed: set all class variables to null
void	setDocumentTextViewCursor(int xChar, int paraNum) Set the view cursor to paragraph paraNum
void	setTextViewCursor(int xChar, DocumentCache.TextParagraph yPara) Set view cursor to paragraph paraNum
void	setViewCursorToHeaderFooter(int xChar, int numPara) set the view cursor to header or footer paragraph
void	setViewCursorToParagraphOfEndnote(int xChar, int numPara) Set the cursor to a paragraph of endnote
void	setViewCursorToParagraphOfFootnote(int xChar, int numPara) Set the cursor to a paragraph of footnote
void	setViewCursorToParagraphOfShape(int xChar, int numPara) Set the cursor to a paragraph of shape
void	setViewCursorToParagraphOfTable(int xChar, int numPara) Set the cursor to a paragraph inside a cell of a table

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewCursorTools

public ViewCursorTools(com.sun.star.lang.XComponent xComponent)

Method Detail

setDisposed

public void setDisposed()

document is disposed: set all class variables to null

getViewCursor

@Nullable
public com.sun.star.text.XTextViewCursor getViewCursor()

Returns ViewCursor Returns null if it fails

getViewCursorParagraph

public DocumentCache.TextParagraph getViewCursorParagraph()

get the paragraph under the view cursor

setViewCursorToHeaderFooter

public void setViewCursorToHeaderFooter(int xChar,
                                        int numPara)

set the view cursor to header or footer paragraph

getIndexAccessOfAllTables

public com.sun.star.container.XIndexAccess getIndexAccessOfAllTables()

Returns the Index Access to all tables of a document

setViewCursorToParagraphOfTable

public void setViewCursorToParagraphOfTable(int xChar,
                                            int numPara)

Set the cursor to a paragraph inside a cell of a table

setViewCursorToParagraphOfFootnote

public void setViewCursorToParagraphOfFootnote(int xChar,
                                               int numPara)

Set the cursor to a paragraph of footnote

setViewCursorToParagraphOfEndnote

public void setViewCursorToParagraphOfEndnote(int xChar,
                                              int numPara)

Set the cursor to a paragraph of endnote

setViewCursorToParagraphOfShape

public void setViewCursorToParagraphOfShape(int xChar,
                                            int numPara)

Set the cursor to a paragraph of shape

setDocumentTextViewCursor

public void setDocumentTextViewCursor(int xChar,
                                      int paraNum)

Set the view cursor to paragraph paraNum

setTextViewCursor

public void setTextViewCursor(int xChar,
                              DocumentCache.TextParagraph yPara)

Set view cursor to paragraph paraNum

isBusy

public static boolean isBusy()

Returns the status of view cursor tools true: If a cursor tool in one or more threads is active

reset

public static void reset()

Reset the busy flag