org.languagetool.openoffice

Class OfficeDrawTools

java.lang.Object

org.languagetool.openoffice.OfficeDrawTools

public class OfficeDrawTools
extends Object

Some tools to get information of LibreOffice Impress context

Since:

5.4

Author:

Fred Kruse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OfficeDrawTools.ParagraphContainer
static class	OfficeDrawTools.UndoMarkupContainer

Constructor Summary

Constructors

Constructor and Description
OfficeDrawTools()

Method Summary

Modifier and Type	Method and Description
static void	changeTextOfParagraph(int nPara, int beginn, int length, String replace, com.sun.star.lang.XComponent xComponent) change the text of a paragraph
static OfficeDrawTools.ParagraphContainer	getAllParagraphs(com.sun.star.lang.XComponent xComponent) get all paragraphs of a impress document
static com.sun.star.lang.Locale	getDocumentLocale(com.sun.star.lang.XComponent xComponent)
static com.sun.star.drawing.XDrawPage	getDrawPageByIndex(com.sun.star.lang.XComponent xComponent, int nIndex) get draw page by index
static int	getDrawPageCount(com.sun.star.lang.XComponent xComponent) get the page count for standard pages
static com.sun.star.drawing.XDrawPage	getHandoutMasterPage(com.sun.star.lang.XComponent xComponent) in impress each documents has one handout page
static com.sun.star.drawing.XDrawPage	getMasterPageByIndex(com.sun.star.lang.XComponent xComponent, int nIndex) get master page by index
static int	getMasterPageCount(com.sun.star.lang.XComponent xComponent) get the page count for master pages
static com.sun.star.drawing.XDrawPage	getNotesPage(com.sun.star.drawing.XDrawPage xDrawPage) in impress documents each normal draw page has a corresponding notes page
static com.sun.star.awt.Size	getPageSize(com.sun.star.drawing.XDrawPage xDrawPage) get size of the given page
static int	getParagraphFromCurrentPage(com.sun.star.lang.XComponent xComponent) get the first paragraph of current draw page
static com.sun.star.drawing.XShapes	getShapes(com.sun.star.drawing.XDrawPage xPage) get shapes of a page
static com.sun.star.drawing.XDrawPage	insertNewDrawPageByIndex(com.sun.star.lang.XComponent xComponent, int nIndex) creates and inserts a draw page into the giving position, the method returns the new created page
static com.sun.star.drawing.XDrawPage	insertNewMasterPageByIndex(com.sun.star.lang.XComponent xComponent, int nIndex) creates and inserts a new master page into the giving position, the method returns the new created page
static boolean	isImpressDocument(com.sun.star.lang.XComponent xComponent) test if a Presentation Document is supported.
static boolean	isParagraphInNotesPage(int nPara, com.sun.star.lang.XComponent xComponent) true: if paragraph is in a notes page
static void	removeMarkup(OfficeDrawTools.UndoMarkupContainer undoMarkup, com.sun.star.lang.XComponent xComponent) remove the last mark up
static void	setCurrentPage(int nPara, com.sun.star.lang.XComponent xComponent) set the current draw page for a given paragraph
static void	setLanguageOfParagraph(int nPara, int beginn, int length, com.sun.star.lang.Locale locale, com.sun.star.lang.XComponent xComponent) change the language of a paragraph
static void	setMarkup(int nPara, com.sun.star.linguistic2.SingleProofreadingError error, OfficeDrawTools.UndoMarkupContainer undoMarkup, com.sun.star.lang.XComponent xComponent) mark up an error in a paragraph /remove last mark up if error == null
static void	setMasterPage(com.sun.star.drawing.XDrawPage xDrawPage, com.sun.star.drawing.XDrawPage xMasterPage) sets given masterpage at the drawpage

Methods inherited from class java.lang.Object

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

Constructor Detail

OfficeDrawTools

public OfficeDrawTools()

Method Detail

getDrawPageCount

public static int getDrawPageCount(com.sun.star.lang.XComponent xComponent)

get the page count for standard pages

getDrawPageByIndex

public static com.sun.star.drawing.XDrawPage getDrawPageByIndex(com.sun.star.lang.XComponent xComponent,
                                                                int nIndex)
                                                         throws com.sun.star.lang.IndexOutOfBoundsException,
                                                                com.sun.star.lang.WrappedTargetException

get draw page by index

Throws:

com.sun.star.lang.IndexOutOfBoundsException

com.sun.star.lang.WrappedTargetException

insertNewDrawPageByIndex

public static com.sun.star.drawing.XDrawPage insertNewDrawPageByIndex(com.sun.star.lang.XComponent xComponent,
                                                                      int nIndex)
                                                               throws Exception

creates and inserts a draw page into the giving position, the method returns the new created page

Throws:

Exception

getPageSize

public static com.sun.star.awt.Size getPageSize(com.sun.star.drawing.XDrawPage xDrawPage)
                                         throws com.sun.star.beans.UnknownPropertyException,
                                                com.sun.star.lang.WrappedTargetException

get size of the given page

Throws:

com.sun.star.beans.UnknownPropertyException

com.sun.star.lang.WrappedTargetException

getMasterPageCount

public static int getMasterPageCount(com.sun.star.lang.XComponent xComponent)

get the page count for master pages

getMasterPageByIndex

public static com.sun.star.drawing.XDrawPage getMasterPageByIndex(com.sun.star.lang.XComponent xComponent,
                                                                  int nIndex)
                                                           throws com.sun.star.lang.IndexOutOfBoundsException,
                                                                  com.sun.star.lang.WrappedTargetException

get master page by index

Throws:

com.sun.star.lang.IndexOutOfBoundsException

com.sun.star.lang.WrappedTargetException

insertNewMasterPageByIndex

public static com.sun.star.drawing.XDrawPage insertNewMasterPageByIndex(com.sun.star.lang.XComponent xComponent,
                                                                        int nIndex)

creates and inserts a new master page into the giving position, the method returns the new created page

setMasterPage

public static void setMasterPage(com.sun.star.drawing.XDrawPage xDrawPage,
                                 com.sun.star.drawing.XDrawPage xMasterPage)

sets given masterpage at the drawpage

isImpressDocument

public static boolean isImpressDocument(com.sun.star.lang.XComponent xComponent)

test if a Presentation Document is supported. This is important, because only presentation documents have notes and handout pages

getNotesPage

public static com.sun.star.drawing.XDrawPage getNotesPage(com.sun.star.drawing.XDrawPage xDrawPage)

in impress documents each normal draw page has a corresponding notes page

getHandoutMasterPage

public static com.sun.star.drawing.XDrawPage getHandoutMasterPage(com.sun.star.lang.XComponent xComponent)

in impress each documents has one handout page

getShapes

public static com.sun.star.drawing.XShapes getShapes(com.sun.star.drawing.XDrawPage xPage)

get shapes of a page

getAllParagraphs

public static OfficeDrawTools.ParagraphContainer getAllParagraphs(com.sun.star.lang.XComponent xComponent)

get all paragraphs of a impress document

changeTextOfParagraph

public static void changeTextOfParagraph(int nPara,
                                         int beginn,
                                         int length,
                                         String replace,
                                         com.sun.star.lang.XComponent xComponent)

change the text of a paragraph

setLanguageOfParagraph

public static void setLanguageOfParagraph(int nPara,
                                          int beginn,
                                          int length,
                                          com.sun.star.lang.Locale locale,
                                          com.sun.star.lang.XComponent xComponent)

change the language of a paragraph

setCurrentPage

public static void setCurrentPage(int nPara,
                                  com.sun.star.lang.XComponent xComponent)

set the current draw page for a given paragraph

getParagraphFromCurrentPage

public static int getParagraphFromCurrentPage(com.sun.star.lang.XComponent xComponent)

get the first paragraph of current draw page

isParagraphInNotesPage

public static boolean isParagraphInNotesPage(int nPara,
                                             com.sun.star.lang.XComponent xComponent)

true: if paragraph is in a notes page

getDocumentLocale

public static com.sun.star.lang.Locale getDocumentLocale(com.sun.star.lang.XComponent xComponent)

removeMarkup

public static void removeMarkup(OfficeDrawTools.UndoMarkupContainer undoMarkup,
                                com.sun.star.lang.XComponent xComponent)

remove the last mark up

setMarkup

public static void setMarkup(int nPara,
                             com.sun.star.linguistic2.SingleProofreadingError error,
                             OfficeDrawTools.UndoMarkupContainer undoMarkup,
                             com.sun.star.lang.XComponent xComponent)

mark up an error in a paragraph /remove last mark up if error == null