org.languagetool.openoffice

Class FlatParagraphTools

java.lang.Object

org.languagetool.openoffice.FlatParagraphTools

public class FlatParagraphTools
extends Object

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

Since:

4.0

Author:

Fred Kruse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlatParagraphTools.FlatParagraphContainer

Method Summary

Modifier and Type	Method and Description
void	changeTextOfParagraph(int nPara, int nStart, int nLen, String newText) Change text of flat paragraph nPara delete characters between nStart and nStart + nLen, insert newText at nStart
FlatParagraphTools.FlatParagraphContainer	getAllFlatParagraphs(com.sun.star.lang.Locale fixedLocale) Returns Text of all FlatParagraphs of Document Returns null if it fails
int	getCurNumFlatParagraph() Returns Current Paragraph Number from FlatParagaph Returns -1 if it fails
String	getCurrentParaText() return text of current paragraph return null if it fails
com.sun.star.text.XFlatParagraph	getFlatParagraphAt(int nPara) Change text of flat paragraph nPara delete characters between nStart and nStart + nLen, insert newText at nStart
List<String>	getFlatParagraphs(List<Integer> nParas) Returns Text of some FlatParagraphs defined in a List Returns null if it fails
int	getNumberOfAllFlatPara() Returns Number of all FlatParagraphs of Document from current FlatParagraph Returns negative value if it fails
com.sun.star.lang.Locale	getPrimaryLanguageOfPartOfParagraph(int nPara, int start, int len, com.sun.star.lang.Locale lastLocale) Get the main language of paragraph
static com.sun.star.lang.Locale	getPrimaryParagraphLanguage(com.sun.star.text.XFlatParagraph flatPara, int start, int len, com.sun.star.lang.Locale fixedLocale, com.sun.star.lang.Locale lastLocale, boolean onlyPrimary) Get the main language of paragraph
void	init() Initialize XFlatParagraphIterator Set the new iterator only if it is not null
static boolean	isBusy() Returns the status of cursor tools true: If a cursor tool in one or more threads is active
List<Boolean>	isChecked(List<Integer> changedParas, int nDiv) Get information of checked status of all paragraphs
boolean	isFlatParaFromIter() is true if FlatParagraph is from Automatic Iteration
void	markCurrentParagraph(List<SingleCheck.SentenceErrors> errorList) add marks to existing marks of current paragraph
void	markParagraphs(Map<Integer,List<SingleCheck.SentenceErrors>> changedParas) Set marks to changed paragraphs if override is true existing marks are removed and marks are new set else the marks are added to the existing marks
static void	reset() Reset the busy flag
void	setDisposed() document is disposed: set all class variables to null
void	setFlatParasAsChecked() Marks all paragraphs as checked
void	setFlatParasAsChecked(int from, int to, List<Boolean> isChecked) Marks all paragraphs as checked with exception of the paragraphs "from" to "to"
void	setLanguageOfParagraph(int nPara, int nStart, int nLen, com.sun.star.lang.Locale locale) Change text of flat paragraph nPara delete characters between nStart and nStart + nLen, insert newText at nStart

Methods inherited from class java.lang.Object

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

Method Detail

setDisposed

public void setDisposed()

document is disposed: set all class variables to null

init

public void init()

Initialize XFlatParagraphIterator Set the new iterator only if it is not null

isFlatParaFromIter

public boolean isFlatParaFromIter()

is true if FlatParagraph is from Automatic Iteration

getFlatParagraphAt

public com.sun.star.text.XFlatParagraph getFlatParagraphAt(int nPara)

Change text of flat paragraph nPara delete characters between nStart and nStart + nLen, insert newText at nStart

getCurrentParaText

public String getCurrentParaText()

return text of current paragraph return null if it fails

getCurNumFlatParagraph

public int getCurNumFlatParagraph()

Returns Current Paragraph Number from FlatParagaph Returns -1 if it fails

getAllFlatParagraphs

@Nullable
public FlatParagraphTools.FlatParagraphContainer getAllFlatParagraphs(com.sun.star.lang.Locale fixedLocale)

Returns Text of all FlatParagraphs of Document Returns null if it fails

getFlatParagraphs

@Nullable
public List<String> getFlatParagraphs(List<Integer> nParas)

Returns Text of some FlatParagraphs defined in a List Returns null if it fails

getPrimaryParagraphLanguage

public static com.sun.star.lang.Locale getPrimaryParagraphLanguage(com.sun.star.text.XFlatParagraph flatPara,
                                                                   int start,
                                                                   int len,
                                                                   com.sun.star.lang.Locale fixedLocale,
                                                                   com.sun.star.lang.Locale lastLocale,
                                                                   boolean onlyPrimary)
                                                            throws com.sun.star.lang.IllegalArgumentException

Get the main language of paragraph

Throws:

com.sun.star.lang.IllegalArgumentException

getPrimaryLanguageOfPartOfParagraph

public com.sun.star.lang.Locale getPrimaryLanguageOfPartOfParagraph(int nPara,
                                                                    int start,
                                                                    int len,
                                                                    com.sun.star.lang.Locale lastLocale)
                                                             throws com.sun.star.lang.IllegalArgumentException

Get the main language of paragraph

Throws:

com.sun.star.lang.IllegalArgumentException

getNumberOfAllFlatPara

public int getNumberOfAllFlatPara()

Returns Number of all FlatParagraphs of Document from current FlatParagraph Returns negative value if it fails

setFlatParasAsChecked

public void setFlatParasAsChecked(int from,
                                  int to,
                                  List<Boolean> isChecked)

Marks all paragraphs as checked with exception of the paragraphs "from" to "to"

setFlatParasAsChecked

public void setFlatParasAsChecked()

Marks all paragraphs as checked

isChecked

public List<Boolean> isChecked(List<Integer> changedParas,
                               int nDiv)

Get information of checked status of all paragraphs

markParagraphs

public void markParagraphs(Map<Integer,List<SingleCheck.SentenceErrors>> changedParas)

Set marks to changed paragraphs if override is true existing marks are removed and marks are new set else the marks are added to the existing marks

markCurrentParagraph

public void markCurrentParagraph(List<SingleCheck.SentenceErrors> errorList)

add marks to existing marks of current paragraph

changeTextOfParagraph

public void changeTextOfParagraph(int nPara,
                                  int nStart,
                                  int nLen,
                                  String newText)

Change text of flat paragraph nPara delete characters between nStart and nStart + nLen, insert newText at nStart

setLanguageOfParagraph

public void setLanguageOfParagraph(int nPara,
                                   int nStart,
                                   int nLen,
                                   com.sun.star.lang.Locale locale)

Change text of flat paragraph nPara delete characters between nStart and nStart + nLen, insert newText at nStart

isBusy

public static boolean isBusy()

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

reset

public static void reset()

Reset the busy flag