org.languagetool.openoffice

Class SingleDocument

java.lang.Object

org.languagetool.openoffice.SingleDocument

public class SingleDocument
extends Object

Class for checking text of one LO document

Since:

4.3

Author:

Fred Kruse, Marcin Miłkowski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SingleDocument.IgnoredMatches class for store and handle ignored matches
static class	SingleDocument.RuleDesc

Method Summary

Modifier and Type	Method and Description
void	addQueueEntry(int nFPara, int nCache, int nCheck, String docId, boolean overrideRunning) Add an new entry to text level queue nFPara is number of flat paragraph
void	addShapeQueueEntries()
SingleDocument.RuleDesc	deactivateRule() get back the rule ID to deactivate a rule
DocumentCache	getDocumentCache() Get document cache of the document
Language	getLanguage() get language of the document
MultiDocumentsHandler	getMultiDocumentsHandler() Get MultiDocumentsHandler
org.languagetool.openoffice.TextLevelCheckQueue.QueueEntry	getNextQueueEntry(DocumentCache.TextParagraph nPara) get the next queue entry which is the next empty cache entry
SingleDocument.IgnoredMatches	getPermanentIgnoredMatches()
org.languagetool.openoffice.TextLevelCheckQueue.QueueEntry	getQueueEntryForChangedParagraph() get the queue entry for the first changed paragraph in document cache
com.sun.star.lang.XComponent	getXComponent() Get xComponent of the document
String	ignoreOnce() add a ignore once entry to queue and remove the mark
String	ignorePermanent() add a ignore once entry to queue and remove the mark
boolean	isIgnoreOnce(int xFrom, int xTo, int y, String ruleId) is a ignore once entry in cache
void	removeAndShiftIgnoredMatch(int from, int to, int oldSize, int newSize) remove all ignore once entries for paragraph y from queue and set the mark
void	removeDokumentListener(com.sun.star.lang.XComponent xComponent)
void	removeIgnoredMatch(int y, boolean isIntern) remove all ignore once entries for paragraph y from queue and set the mark
void	removeIgnoredMatch(int x, int y, String ruleId, boolean isIntern) remove a ignore once entry for point x, y from queue and set the mark if x < 0 remove all ignore once entries for paragraph y
void	removePermanentIgnoredMatch(int x, int y, String ruleId, boolean isIntern) remove a ignore Permanent entry for point x, y from queue and set the mark if x < 0 remove all ignore once entries for paragraph y
void	removeResultCache(int nPara, boolean alsoParaLevel) remove all cached matches for one paragraph
void	removeRuleError(String ruleId) Remove a special Proofreading error from all caches of document
void	renewMarkups() Renew text markups for paragraphs under view cursor
void	resetIgnoreOnce() reset the ignore once cache
void	resetIgnorePermanent() reset the permanent ignore cache
void	runQueueEntry(DocumentCache.TextParagraph nStart, DocumentCache.TextParagraph nEnd, int cacheNum, int nCheck, boolean override, SwJLanguageTool lt) run a text level check from a queue entry (initiated by the queue)
FlatParagraphTools	setFlatParagraphTools() Open new flat paragraph tools or initialize them again
void	setIgnoredMatch(int x, int y, String ruleId, boolean isIntern) add a ignore once entry for point x, y to queue and remove the mark
void	setPermanentIgnoredMatch(int x, int y, String ruleId, boolean isIntern) add a ignore once entry for point x, y to queue and remove the mark
void	setPermanentIgnoredMatches(SingleDocument.IgnoredMatches ignoredMatches)

Methods inherited from class java.lang.Object

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

Method Detail

getLanguage

public Language getLanguage()

get language of the document

getXComponent

public com.sun.star.lang.XComponent getXComponent()

Get xComponent of the document

getMultiDocumentsHandler

public MultiDocumentsHandler getMultiDocumentsHandler()

Get MultiDocumentsHandler

getDocumentCache

public DocumentCache getDocumentCache()

Get document cache of the document

removeResultCache

public void removeResultCache(int nPara,
                              boolean alsoParaLevel)

remove all cached matches for one paragraph

removeRuleError

public void removeRuleError(String ruleId)

Remove a special Proofreading error from all caches of document

setFlatParagraphTools

public FlatParagraphTools setFlatParagraphTools()

Open new flat paragraph tools or initialize them again

addQueueEntry

public void addQueueEntry(int nFPara,
                          int nCache,
                          int nCheck,
                          String docId,
                          boolean overrideRunning)

Add an new entry to text level queue nFPara is number of flat paragraph

getNextQueueEntry

public org.languagetool.openoffice.TextLevelCheckQueue.QueueEntry getNextQueueEntry(DocumentCache.TextParagraph nPara)

get the next queue entry which is the next empty cache entry

getQueueEntryForChangedParagraph

public org.languagetool.openoffice.TextLevelCheckQueue.QueueEntry getQueueEntryForChangedParagraph()

get the queue entry for the first changed paragraph in document cache

addShapeQueueEntries

public void addShapeQueueEntries()

runQueueEntry

public void runQueueEntry(DocumentCache.TextParagraph nStart,
                          DocumentCache.TextParagraph nEnd,
                          int cacheNum,
                          int nCheck,
                          boolean override,
                          SwJLanguageTool lt)

run a text level check from a queue entry (initiated by the queue)

renewMarkups

public void renewMarkups()

Renew text markups for paragraphs under view cursor

isIgnoreOnce

public boolean isIgnoreOnce(int xFrom,
                            int xTo,
                            int y,
                            String ruleId)

is a ignore once entry in cache

resetIgnoreOnce

public void resetIgnoreOnce()

reset the ignore once cache

ignoreOnce

public String ignoreOnce()

add a ignore once entry to queue and remove the mark

setIgnoredMatch

public void setIgnoredMatch(int x,
                            int y,
                            String ruleId,
                            boolean isIntern)

add a ignore once entry for point x, y to queue and remove the mark

resetIgnorePermanent

public void resetIgnorePermanent()

reset the permanent ignore cache

ignorePermanent

public String ignorePermanent()

add a ignore once entry to queue and remove the mark

setPermanentIgnoredMatch

public void setPermanentIgnoredMatch(int x,
                                     int y,
                                     String ruleId,
                                     boolean isIntern)

add a ignore once entry for point x, y to queue and remove the mark

setPermanentIgnoredMatches

public void setPermanentIgnoredMatches(SingleDocument.IgnoredMatches ignoredMatches)

getPermanentIgnoredMatches

public SingleDocument.IgnoredMatches getPermanentIgnoredMatches()

removeAndShiftIgnoredMatch

public void removeAndShiftIgnoredMatch(int from,
                                       int to,
                                       int oldSize,
                                       int newSize)

remove all ignore once entries for paragraph y from queue and set the mark

removeIgnoredMatch

public void removeIgnoredMatch(int y,
                               boolean isIntern)

remove all ignore once entries for paragraph y from queue and set the mark

removeIgnoredMatch

public void removeIgnoredMatch(int x,
                               int y,
                               String ruleId,
                               boolean isIntern)

remove a ignore once entry for point x, y from queue and set the mark if x < 0 remove all ignore once entries for paragraph y

removePermanentIgnoredMatch

public void removePermanentIgnoredMatch(int x,
                                        int y,
                                        String ruleId,
                                        boolean isIntern)

remove a ignore Permanent entry for point x, y from queue and set the mark if x < 0 remove all ignore once entries for paragraph y

deactivateRule

public SingleDocument.RuleDesc deactivateRule()

get back the rule ID to deactivate a rule

removeDokumentListener

public void removeDokumentListener(com.sun.star.lang.XComponent xComponent)