ag.ion.bion.officelayer.internal.text
Class TextDocument

java.lang.Object
  ag.ion.bion.officelayer.document.AbstractDocument
      ag.ion.bion.officelayer.internal.text.TextDocument

All Implemented Interfaces:

IDocument, ITextDocument, ISearchableDocument, ISelectionProvider

Direct Known Subclasses:

GlobalTextDocument

public class TextDocument
extends AbstractDocument
implements ITextDocument

OpenOffice.org text document.

Field Summary

Fields inherited from class ag.ion.bion.officelayer.document.AbstractDocument

xComponent

Fields inherited from interface ag.ion.bion.officelayer.document.IDocument

BASE, CALC, DRAW, EVENT_ON_ALPHA_CHAR_INPUT, EVENT_ON_FOCUS, EVENT_ON_INSERT_DONE, EVENT_ON_INSERT_START, EVENT_ON_LOAD, EVENT_ON_LOAD_DONE, EVENT_ON_LOAD_FINISHED, EVENT_ON_MODIFY_CHANGED, EVENT_ON_MOUSE_OUT, EVENT_ON_MOUSE_OVER, EVENT_ON_NEW, EVENT_ON_NON_ALPHA_CHAR_INPUT, EVENT_ON_SAVE, EVENT_ON_SAVE_AS, EVENT_ON_SAVE_AS_DONE, EVENT_ON_SAVE_DONE, EVENT_ON_SAVE_FINISHED, EVENT_ON_UNLOAD, GLOBAL, IMPRESS, MATH, WEB, WRITER

Constructor Summary

TextDocument(com.sun.star.text.XTextDocument xTextDocument)
Constructs new OpenOffice.org swriter document.

Method Summary

java.lang.String	getDocumentType() Returns type of the document.
IDocumentIndexService	getIndexService() Returns index service of the document.
com.sun.star.lang.XMultiServiceFactory	getMultiServiceFactory() Returns the XMultiServiceFactory of the document.
INumberFormatService	getNumberFormatService() Returns number format service.
IPageService	getPageService() Returns page service of the document.
ISearchService	getSearchService() Returns search service of the searchable document.
ITextFieldService	getTextFieldService() Returns service for text fields.
ITextService	getTextService() Returns text service.
ITextTableService	getTextTableService() Returns text table service.
IViewCursorService	getViewCursorService() Returns view cursor service.
com.sun.star.text.XTextDocument	getXTextDocument() Returns OpenOffice.org XTextDocument interface.
void	reformat() Reformats the document.
void	zoom(short zoomType, short zoomValue) Sets the zoom of the document.

Methods inherited from class ag.ion.bion.officelayer.document.AbstractDocument

addCloseListener, addDocumentListener, addDocumentModifyListener, close, equalsTo, fireDocumentEvent, getFilterProvider, getFormService, getFrame, getLocationURL, getPersistenceService, getPrintService, getScriptingService, getServiceProvider, getXComponent, getXFrame, isModified, isOpen, print, removeCloseListener, removeCloseListeners, removeDocumentListener, removeDocumentListeners, removeDocumentModifyListener, removeModifyListeners, setModified, setSelection, setServiceProvider, setXInterfaceObjectSelection

Methods inherited from class java.lang.Object

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

Methods inherited from interface ag.ion.bion.officelayer.document.IDocument

addCloseListener, addDocumentListener, addDocumentModifyListener, close, equalsTo, fireDocumentEvent, getFilterProvider, getFormService, getFrame, getLocationURL, getPersistenceService, getPrintService, getScriptingService, getServiceProvider, getXComponent, isModified, isOpen, print, removeCloseListener, removeDocumentListener, removeDocumentModifyListener, setModified

Methods inherited from interface ag.ion.noa.view.ISelectionProvider

setSelection

Constructor Detail

TextDocument

public TextDocument(com.sun.star.text.XTextDocument xTextDocument)
             throws java.lang.IllegalArgumentException

Constructs new OpenOffice.org swriter document.

Parameters:

xTextDocument - OpenOffice.org XTextDocument interface

Throws:

java.lang.IllegalArgumentException - if the submitted OpenOffice.org XTextDocument is not valid

Method Detail

getXTextDocument

public com.sun.star.text.XTextDocument getXTextDocument()

Returns OpenOffice.org XTextDocument interface. This method is not intended to be called by clients.

Specified by:

getXTextDocument in interface ITextDocument

Returns:

OpenOffice.org XTextDocument interface

getDocumentType

public java.lang.String getDocumentType()

Returns type of the document.

Specified by:

getDocumentType in interface IDocument

Returns:

type of the document

getMultiServiceFactory

public com.sun.star.lang.XMultiServiceFactory getMultiServiceFactory()
                                                              throws java.lang.Exception

Returns the XMultiServiceFactory of the document.

Returns:

multiServiceFactory the XMultiServiceFactory of the document

Throws:

java.lang.Exception - if any error occurs

getPageService

public IPageService getPageService()

Returns page service of the document.

Specified by:

getPageService in interface ITextDocument

Returns:

page service of the document

getTextFieldService

public ITextFieldService getTextFieldService()

Returns service for text fields.

Specified by:

getTextFieldService in interface ITextDocument

Returns:

service for text fields

getTextService

public ITextService getTextService()

Returns text service.

Specified by:

getTextService in interface ITextDocument

Returns:

text service

getViewCursorService

public IViewCursorService getViewCursorService()

Returns view cursor service.

Specified by:

getViewCursorService in interface ITextDocument

Returns:

view cursor service

getTextTableService

public ITextTableService getTextTableService()

Returns text table service.

Specified by:

getTextTableService in interface ITextDocument

Returns:

text table service

getNumberFormatService

public INumberFormatService getNumberFormatService()

Returns number format service.

Specified by:

getNumberFormatService in interface ITextDocument

Returns:

number format service

reformat

public void reformat()

Reformats the document.

Specified by:

reformat in interface IDocument

Overrides:

reformat in class AbstractDocument

getSearchService

public ISearchService getSearchService()

Returns search service of the searchable document.

Specified by:

getSearchService in interface ISearchableDocument

Returns:

search service of the searchable document

getIndexService

public IDocumentIndexService getIndexService()

Returns index service of the document.

Specified by:

getIndexService in interface ITextDocument

Returns:

index service of the document

zoom

public void zoom(short zoomType,
                 short zoomValue)
          throws DocumentException

Sets the zoom of the document.

Specified by:

zoom in interface ITextDocument

Parameters:

zoomType - the type of the zoom as in class DocumentZoomType

zoomValue - the value of the zoom, does only take afect if zoom type is set to DocumentZoomType.BY_VALUE. Values between 20 and 600 are allowed.

Throws:

DocumentException - if zoom fails