Package com.arbortext.epic

Interface ADocumentEvent

All Superinterfaces:

Event

All Known Implementing Classes:

ADocumentEventImpl

public interface ADocumentEvent
extends Event

The ADocumentEvent interface provides specific contextual information associated with the ADocumentEvent extension. Use these event types to notify programmers about important document operations that are not covered by DOM events.

Since:

Epic 4.4.1

Field Summary

Fields inherited from interface org.w3c.dom.events.Event

AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE

Method Summary

Modifier and Type	Method	Description
int	getDetail()	Specifies detail information about the ADocumentEvent, depending on the type of event.
Document	getRelatedDocument()	The relatedDocument attribute identifies a document related to the event.
Window	getRelatedWindow()	The relatedWindow attribute identifies a window related to the event.
String	getTargetEncoding()	Specifies the encoding in which the document is saved in a DocumentSaving event.
String	getTargetURI()	Specifies the URI in which the document is saved in a DocumentSaving event.
void	initADocumentEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, Window relatedWindowArg, String targetURIArg, String targetEncodingArg, int detailArg)	Method overload which omits the last parameter.
void	initADocumentEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, Window relatedWindowArg, String targetURIArg, String targetEncodingArg, int detailArg, Document relatedDocumentArg)	Initializes the value of an ADocumentEvent created through the DocumentEvent interface.

Methods inherited from interface org.w3c.dom.events.Event

getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagation

Method Details

getRelatedWindow

Window getRelatedWindow()

The relatedWindow attribute identifies a window related to the event. For the DocumentLoad event, relatedWindow is the window that the document loads to. For the DocumentUnload event, relatedWindow is the window that the document unloads from, as long as the window still exists. If the window is destroyed along with the document, then relatedWindow is null.

getTargetURI

String getTargetURI()

Specifies the URI in which the document is saved in a DocumentSaving event.

getTargetEncoding

String getTargetEncoding()

Specifies the encoding in which the document is saved in a DocumentSaving event.

getDetail

int getDetail()

Specifies detail information about the ADocumentEvent, depending on the type of event.

getRelatedDocument

Document getRelatedDocument()

The relatedDocument attribute identifies a document related to the event. For DocumentCreate event, if the new document is cloned from another document, the relatedDocument is the source document that the new document is cloned from.

Since:

Epic 5.2

initADocumentEvent

void initADocumentEvent(String typeArg,
 boolean canBubbleArg,
 boolean cancelableArg,
 Window relatedWindowArg,
 String targetURIArg,
 String targetEncodingArg,
 int detailArg,
 Document relatedDocumentArg)

Initializes the value of an ADocumentEvent created through the DocumentEvent interface. You should only call this method before the ADocumentEvent has been dispatched using the dispatchEvent method, though it can be called multiple times during that phase if necessary. If the initADocumentEvent is called multiple times, the final call takes precedence.

Parameters:

typeArg - Specifies the event type.

canBubbleArg - Indicates whether or not the event can bubble.

cancelableArg - Indicates whether or not the event's default action can be prevented.

relatedWindowArg - Specifies the Window related to the Event.

targetURIArg - Specifies the target URI. This value may be null.

targetEncodingArg - Specifies the target encoding. This value may be null.

detailArg - Specifies the Event detail.

relatedDocumentArg - Specifies the Document related to the Event.

initADocumentEvent

void initADocumentEvent(String typeArg,
 boolean canBubbleArg,
 boolean cancelableArg,
 Window relatedWindowArg,
 String targetURIArg,
 String targetEncodingArg,
 int detailArg)

Method overload which omits the last parameter.