ag.ion.bion.officelayer.document
Interface IDocumentService

All Superinterfaces:

IDisposeable

All Known Implementing Classes:

DocumentService

public interface IDocumentService
extends IDisposeable

Service for documents.

Method Summary

IDocument	constructNewDocument(IFrame frame, java.lang.String documentType, IDocumentDescriptor documentDescriptor) Constructs new document in the submitted frame.
IDocument	constructNewDocument(java.lang.String documentType, IDocumentDescriptor documentDescriptor) Constructs new document.
IDocument	constructNewHiddenDocument(java.lang.String documentType) Constructs new hidden document of the submitted type.
IDocument[]	getCurrentDocuments() Returns current documents of an application.
IDocument	loadDocument(IFrame frame, java.io.InputStream inputStream, IDocumentDescriptor documentDescriptor) Loads document on the basis of the submitted stream.
IDocument	loadDocument(IFrame frame, java.lang.String url) Loads document into the submitted frame.
IDocument	loadDocument(IFrame frame, java.lang.String url, IDocumentDescriptor documentDescriptor) Loads document into the submitted frame.
IDocument	loadDocument(java.io.InputStream inputStream, IDocumentDescriptor documentDescriptor) Loads document on the basis of the submitted stream.
IDocument	loadDocument(IOfficeProgressMonitor officeProgressMonitor, IFrame frame, java.io.InputStream inputStream, IDocumentDescriptor documentDescriptor) Loads document on the basis of the submitted stream.
IDocument	loadDocument(IOfficeProgressMonitor officeProgressMonitor, java.io.InputStream inputStream, IDocumentDescriptor documentDescriptor) Loads document on the basis of the submitted stream.
IDocument	loadDocument(java.lang.String url) Loads document on the basis of the submitted URL.
IDocument	loadDocument(java.lang.String url, IDocumentDescriptor documentDescriptor) Loads document on the basis of the submitted URL.

Methods inherited from interface ag.ion.bion.officelayer.IDisposeable

dispose

Method Detail

constructNewDocument

IDocument constructNewDocument(java.lang.String documentType,
                               IDocumentDescriptor documentDescriptor)
                               throws NOAException

Constructs new document.

Use one of the types:

IDocument.WRITER
IDocument.CALC
IDocument.IMPRESS
IDocument.DRAW
IDocument.MATH
IDocument.WEB
IDocument.BASE
IDocument.GLOBAL

Parameters:

documentType - document type to be used

documentDescriptor - document descriptor to be used

Returns:

new constructed document

Throws:

NOAException - if the new document can not be constructed

constructNewDocument

IDocument constructNewDocument(IFrame frame,
                               java.lang.String documentType,
                               IDocumentDescriptor documentDescriptor)
                               throws NOAException

Constructs new document in the submitted frame.

Use one of the types:

IDocument.WRITER
IDocument.CALC
IDocument.IMPRESS
IDocument.DRAW
IDocument.MATH
IDocument.WEB
IDocument.BASE
IDocument.GLOBAL

Parameters:

frame - frame to be used

documentType - document type to be used

documentDescriptor - document descriptor to be used

Returns:

new constructed document

Throws:

NOAException - if the new document can not be constructed

constructNewHiddenDocument

IDocument constructNewHiddenDocument(java.lang.String documentType)
                                     throws NOAException

Constructs new hidden document of the submitted type.

Use one of the types:

IDocument.WRITER
IDocument.CALC
IDocument.IMPRESS
IDocument.DRAW
IDocument.MATH
IDocument.WEB
IDocument.BASE
IDocument.GLOBAL

Parameters:

documentType - document type to be constructed

Returns:

new constructed document of the submitted type

Throws:

NOAException - if the document can not be contructed

loadDocument

IDocument loadDocument(java.lang.String url)
                       throws DocumentException

Loads document on the basis of the submitted URL.

Parameters:

url - URL of the document

Returns:

loaded document

Throws:

DocumentException - if the document can not be loaded or the URL does not locate an OpenOffice.org document

loadDocument

IDocument loadDocument(java.lang.String url,
                       IDocumentDescriptor documentDescriptor)
                       throws NOAException

Loads document on the basis of the submitted URL.

Parameters:

url - URL of the document

documentDescriptor - document descriptor to be used

Returns:

loaded document

Throws:

NOAException - if the document can not be loaded or the URL does not locate an OpenOffice.org document

loadDocument

IDocument loadDocument(java.io.InputStream inputStream,
                       IDocumentDescriptor documentDescriptor)
                       throws DocumentException

Loads document on the basis of the submitted stream.

Parameters:

inputStream - input stream to be used

documentDescriptor - document descriptor to be used

Returns:

loaded document

Throws:

DocumentException - if the document can not be loaded

loadDocument

IDocument loadDocument(IOfficeProgressMonitor officeProgressMonitor,
                       java.io.InputStream inputStream,
                       IDocumentDescriptor documentDescriptor)
                       throws DocumentException

Loads document on the basis of the submitted stream.

Parameters:

officeProgressMonitor - office progress monitor to be used

inputStream - input stream to be used

documentDescriptor - document descriptor to be used

Returns:

loaded document

Throws:

DocumentException - if the document can not be loaded

loadDocument

IDocument loadDocument(IFrame frame,
                       java.io.InputStream inputStream,
                       IDocumentDescriptor documentDescriptor)
                       throws DocumentException

Loads document on the basis of the submitted stream. The document has no location and can not be stored with the store() method of the IPersistenceService. Furthermore OpenOffice.org can not recognize if the document is already open - therefore the document will be never opened in ReadOnly mode.

Parameters:

frame - frame to be used for the document

inputStream - input stream to be used

documentDescriptor - document descriptor to be used

Returns:

loaded document

Throws:

DocumentException - if the document can not be loaded

loadDocument

IDocument loadDocument(IOfficeProgressMonitor officeProgressMonitor,
                       IFrame frame,
                       java.io.InputStream inputStream,
                       IDocumentDescriptor documentDescriptor)
                       throws DocumentException

Loads document on the basis of the submitted stream. The document has no location and can not be stored with the store() method of the IPersistenceService. Furthermore OpenOffice.org can not recognize if the document is already open - therefore the document will be never opened in ReadOnly mode.

Parameters:

officeProgressMonitor - office progress monitor to be used

frame - frame to be used for the document

inputStream - input stream to be used

documentDescriptor - document descriptor to be used

Returns:

loaded document

Throws:

DocumentException - if the document can not be loaded

loadDocument

IDocument loadDocument(IFrame frame,
                       java.lang.String url)
                       throws DocumentException

Loads document into the submitted frame.

Parameters:

frame - frame to be used for the document

url - URL of the document (must start with file:///)

Returns:

loaded document

Throws:

DocumentException - if the document can not be loaded, the URL does not locate an OpenOffice.org document or the submitted frame is not valid

loadDocument

IDocument loadDocument(IFrame frame,
                       java.lang.String url,
                       IDocumentDescriptor documentDescriptor)
                       throws DocumentException

Loads document into the submitted frame.

Parameters:

frame - frame to be used for the document

url - URL of the document (must start with file:///)

documentDescriptor - document descriptor to be used

Returns:

loaded document

Throws:

DocumentException - if the document can not be loaded, the URL does not locate an OpenOffice.org document or the submitted frame is not valid

getCurrentDocuments

IDocument[] getCurrentDocuments()
                                throws DocumentException

Returns current documents of an application.

Returns:

documents of an application

Throws:

DocumentException - if the documents cannot be provided