ag.ion.bion.officelayer.document
Interface IDocument

All Superinterfaces:

ISelectionProvider

All Known Subinterfaces:

IDatabaseDocument, IDrawingDocument, IGlobalTextDocument, IPresentationDocument, ISpreadsheetDocument, ITextDocument, IWebDocument

All Known Implementing Classes:

AbstractDocument, DatabaseDocument, DrawingDocument, FormulaDocument, GlobalTextDocument, PresentationDocument, SpreadsheetDocument, TextDocument, WebDocument

public interface IDocument
extends ISelectionProvider

Office document.

Field Summary

static java.lang.String	BASE Identifier of a OpenOffice.org Base document.
static java.lang.String	CALC Identifier of a OpenOffice.org Calc document.
static java.lang.String	DRAW Identifier of a OpenOffice.org Draw document.
static java.lang.String	EVENT_ON_ALPHA_CHAR_INPUT Event constant for document alpha char input.
static java.lang.String	EVENT_ON_FOCUS Event constant for document focus.
static java.lang.String	EVENT_ON_INSERT_DONE Event constant for document insert done.
static java.lang.String	EVENT_ON_INSERT_START Event constant for document insert start.
static java.lang.String	EVENT_ON_LOAD Event constant for document about to load.
static java.lang.String	EVENT_ON_LOAD_DONE Event constant for document load done.
static java.lang.String	EVENT_ON_LOAD_FINISHED Event constant for document load finished.
static java.lang.String	EVENT_ON_MODIFY_CHANGED Event constant for document modify changed.
static java.lang.String	EVENT_ON_MOUSE_OUT Event constant for document mouse out.
static java.lang.String	EVENT_ON_MOUSE_OVER Event constant for document mouse over.
static java.lang.String	EVENT_ON_NEW Event constant for new document.
static java.lang.String	EVENT_ON_NON_ALPHA_CHAR_INPUT Event constant for document non alpha char input.
static java.lang.String	EVENT_ON_SAVE Event constant for document about to save.
static java.lang.String	EVENT_ON_SAVE_AS Event constant for document about to save as.
static java.lang.String	EVENT_ON_SAVE_AS_DONE Event constant for document save as done.
static java.lang.String	EVENT_ON_SAVE_DONE Event constant for document save done.
static java.lang.String	EVENT_ON_SAVE_FINISHED Event constant for document save finished.
static java.lang.String	EVENT_ON_UNLOAD Event constant for document unload.
static java.lang.String	GLOBAL Identifier of a OpenOffice.org Global document.
static java.lang.String	IMPRESS Identifier of a OpenOffice.org Impress document.
static java.lang.String	MATH Identifier of a OpenOffice.org Math document.
static java.lang.String	WEB Identifier of a OpenOffice.org Web document.
static java.lang.String	WRITER Identifier of a OpenOffice.org Writer document.

Method Summary

void	addCloseListener(ICloseListener closeListener) Adds listener for closing events to the document.
void	addDocumentListener(IDocumentListener documentListener) Adds new document listener.
void	addDocumentModifyListener(IDocumentModifyListener documentModifyListener) Adds new document modify listener.
void	close() Closes the document.
boolean	equalsTo(IDocument compareDocument) Checks if the document equals another document.
void	fireDocumentEvent(java.lang.String documentEventName) Fires the document event for the submitted document event constant.
java.lang.String	getDocumentType() Returns type of the document.
IFilterProvider	getFilterProvider() Returns filter provider.
IFormService	getFormService() Returns form service, or null if not available.
IFrame	getFrame() Returns Frame of the document.
java.net.URL	getLocationURL() Deprecated. Use the IPersistenceService instead.
IPersistenceService	getPersistenceService() Returns persistence service.
IPrintService	getPrintService() Returns the print service of the document.
IScriptingService	getScriptingService() Returns scripting service of the document.
IServiceProvider	getServiceProvider() Returns the applications service provider, or null if not available.
com.sun.star.lang.XComponent	getXComponent() Returns OpenOffice.org XComponent interface.
boolean	isModified() Returns information whether the document was modified.
boolean	isOpen() Returns information whether the document is open.
void	print() Prints the document.
void	reformat() Reformats the document.
void	removeCloseListener(ICloseListener closeListener) Removes listener for closing events to the document.
void	removeDocumentListener(IDocumentListener documentListener) Removes document listener.
void	removeDocumentModifyListener(IDocumentModifyListener documentModifyListener) Removes the specified modify listener.
void	setModified(boolean modified) Sets modified flag.

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

setSelection

Field Detail

WRITER

static final java.lang.String WRITER

Identifier of a OpenOffice.org Writer document.

See Also:

Constant Field Values

CALC

static final java.lang.String CALC

Identifier of a OpenOffice.org Calc document.

See Also:

Constant Field Values

IMPRESS

static final java.lang.String IMPRESS

Identifier of a OpenOffice.org Impress document.

See Also:

Constant Field Values

DRAW

static final java.lang.String DRAW

Identifier of a OpenOffice.org Draw document.

See Also:

Constant Field Values

MATH

static final java.lang.String MATH

Identifier of a OpenOffice.org Math document.

See Also:

Constant Field Values

WEB

static final java.lang.String WEB

Identifier of a OpenOffice.org Web document.

See Also:

Constant Field Values

BASE

static final java.lang.String BASE

Identifier of a OpenOffice.org Base document.

See Also:

Constant Field Values

GLOBAL

static final java.lang.String GLOBAL

Identifier of a OpenOffice.org Global document.

See Also:

Constant Field Values

EVENT_ON_NEW

static final java.lang.String EVENT_ON_NEW

Event constant for new document.

See Also:

Constant Field Values

EVENT_ON_LOAD

static final java.lang.String EVENT_ON_LOAD

Event constant for document about to load.

See Also:

Constant Field Values

EVENT_ON_LOAD_DONE

static final java.lang.String EVENT_ON_LOAD_DONE

Event constant for document load done.

See Also:

Constant Field Values

EVENT_ON_LOAD_FINISHED

static final java.lang.String EVENT_ON_LOAD_FINISHED

Event constant for document load finished.

See Also:

Constant Field Values

EVENT_ON_SAVE_DONE

static final java.lang.String EVENT_ON_SAVE_DONE

Event constant for document save done.

See Also:

Constant Field Values

EVENT_ON_SAVE_FINISHED

static final java.lang.String EVENT_ON_SAVE_FINISHED

Event constant for document save finished.

See Also:

Constant Field Values

EVENT_ON_SAVE

static final java.lang.String EVENT_ON_SAVE

Event constant for document about to save.

See Also:

Constant Field Values

EVENT_ON_SAVE_AS

static final java.lang.String EVENT_ON_SAVE_AS

Event constant for document about to save as.

See Also:

Constant Field Values

EVENT_ON_SAVE_AS_DONE

static final java.lang.String EVENT_ON_SAVE_AS_DONE

Event constant for document save as done.

See Also:

Constant Field Values

EVENT_ON_MODIFY_CHANGED

static final java.lang.String EVENT_ON_MODIFY_CHANGED

Event constant for document modify changed.

See Also:

Constant Field Values

EVENT_ON_MOUSE_OVER

static final java.lang.String EVENT_ON_MOUSE_OVER

Event constant for document mouse over.

See Also:

Constant Field Values

EVENT_ON_MOUSE_OUT

static final java.lang.String EVENT_ON_MOUSE_OUT

Event constant for document mouse out.

See Also:

Constant Field Values

EVENT_ON_FOCUS

static final java.lang.String EVENT_ON_FOCUS

Event constant for document focus.

See Also:

Constant Field Values

EVENT_ON_ALPHA_CHAR_INPUT

static final java.lang.String EVENT_ON_ALPHA_CHAR_INPUT

Event constant for document alpha char input.

See Also:

Constant Field Values

EVENT_ON_NON_ALPHA_CHAR_INPUT

static final java.lang.String EVENT_ON_NON_ALPHA_CHAR_INPUT

Event constant for document non alpha char input.

See Also:

Constant Field Values

EVENT_ON_INSERT_DONE

static final java.lang.String EVENT_ON_INSERT_DONE

Event constant for document insert done.

See Also:

Constant Field Values

EVENT_ON_INSERT_START

static final java.lang.String EVENT_ON_INSERT_START

Event constant for document insert start.

See Also:

Constant Field Values

EVENT_ON_UNLOAD

static final java.lang.String EVENT_ON_UNLOAD

Event constant for document unload.

See Also:

Constant Field Values

Method Detail

getXComponent

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

Returns OpenOffice.org XComponent interface. This method is not part of the public API.

Returns:

OpenOffice.org XComponent interface

getFrame

IFrame getFrame()

Returns Frame of the document.

Returns:

Frame of the document

getPersistenceService

IPersistenceService getPersistenceService()

Returns persistence service.

Returns:

persistence service

getScriptingService

IScriptingService getScriptingService()

Returns scripting service of the document.

Returns:

scripting service of the document

getFilterProvider

IFilterProvider getFilterProvider()

Returns filter provider.

Returns:

filter provider

getFormService

IFormService getFormService()

Returns form service, or null if not available.

Returns:

form service, or null

addDocumentListener

void addDocumentListener(IDocumentListener documentListener)

Adds new document listener.

Parameters:

documentListener - new document listener

removeDocumentListener

void removeDocumentListener(IDocumentListener documentListener)

Removes document listener.

Parameters:

documentListener - document listener

getDocumentType

java.lang.String getDocumentType()

Returns type of the document.

Returns:

type of the document

isModified

boolean isModified()

Returns information whether the document was modified.

Returns:

information whether the document was modified

setModified

void setModified(boolean modified)
                 throws DocumentException

Sets modified flag.

Parameters:

modified - flag value

Throws:

DocumentException - if the status of the document can not be set

addCloseListener

void addCloseListener(ICloseListener closeListener)

Adds listener for closing events to the document.

Parameters:

closeListener - close listener

removeCloseListener

void removeCloseListener(ICloseListener closeListener)

Removes listener for closing events to the document.

Parameters:

closeListener - close listener

getLocationURL

java.net.URL getLocationURL()
                            throws DocumentException

Deprecated. Use the IPersistenceService instead.

Returns location of the document. Returns null if the URL is not available.

Returns:

location of the document

Throws:

DocumentException - if the URL is not valid

isOpen

boolean isOpen()

Returns information whether the document is open.

Returns:

information whether the document is open

close

void close()

Closes the document.

equalsTo

boolean equalsTo(IDocument compareDocument)

Checks if the document equals another document.

Parameters:

compareDocument - document to be compared

Returns:

true if they are equal, flase if they are different

reformat

void reformat()

Reformats the document.

print

void print()
           throws DocumentException

Prints the document.

Throws:

DocumentException - if printing fails

getPrintService

IPrintService getPrintService()

Returns the print service of the document.

Returns:

the print service of the document

addDocumentModifyListener

void addDocumentModifyListener(IDocumentModifyListener documentModifyListener)

Adds new document modify listener.

Parameters:

documentModifyListener - new document modify listener

removeDocumentModifyListener

void removeDocumentModifyListener(IDocumentModifyListener documentModifyListener)

Removes the specified modify listener.

Parameters:

documentModifyListener - the modify listener to be removed

fireDocumentEvent

void fireDocumentEvent(java.lang.String documentEventName)

Fires the document event for the submitted document event constant.

Parameters:

documentEventName - string constant for document event

See Also:

IDocument.EVENT_ON_NEW, IDocument.EVENT_ON_LOAD, IDocument.EVENT_ON_LOAD_DONE, IDocument.EVENT_ON_LOAD_FINISHED, IDocument.EVENT_ON_SAVE_DONE, IDocument.EVENT_ON_SAVE_FINISHED, IDocument.EVENT_ON_SAVE, IDocument.EVENT_ON_SAVE_AS, IDocument.EVENT_ON_SAVE_AS_DONE, IDocument.EVENT_ON_MODIFY_CHANGED, IDocument.EVENT_ON_MOUSE_OVER, IDocument.EVENT_ON_MOUSE_OUT, IDocument.EVENT_ON_FOCUS, IDocument.EVENT_ON_ALPHA_CHAR_INPUT, IDocument.EVENT_ON_NON_ALPHA_CHAR_INPUT, IDocument.EVENT_ON_INSERT_DONE, IDocument.EVENT_ON_INSERT_START, IDocument.EVENT_ON_UNLOAD

getServiceProvider

IServiceProvider getServiceProvider()

Returns the applications service provider, or null if not available.

Returns:

the applications service provider, or null