org.dvb.dom.bootstrap

Interface DocumentFactory

public interface DocumentFactory

DocumentFactory contains bootstrap methods for applications embedded in a document to access the document object model of the document in which they are contained.

Since:

MHP 1.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOM The property string to use with XletContext.getXletProperty in order to obtain the DocumentFactory for this Xlet (if one exists).

Method Summary

Methods

Modifier and Type	Method and Description
void	performAction(DocumentAction act) Perform an action on the document that contains the Xlet controlled by the given XletContext.
void	performActionOnFrames(String[] names, MultipleDocumentsAction act) Perform an action on a set of documents, each contained in a frame that is a part of the same application as the Xlet controlled by the given XletContext.
void	performActionReadOnly(DocumentAction act) Perform an action on the document that contains the Xlet controlled by the given XletContext.

Field Detail

DOM

static final String DOM

The property string to use with XletContext.getXletProperty in order to obtain the DocumentFactory for this Xlet (if one exists).

See Also:

Constant Field Values

Method Detail

performAction

void performAction(DocumentAction act)

Perform an action on the document that contains the Xlet controlled by the given XletContext.

Parameters:

act - The action to perform. It will be called by the system either synchronously, or on a system thread.

performActionReadOnly

void performActionReadOnly(DocumentAction act)

Perform an action on the document that contains the Xlet controlled by the given XletContext. The action is called without any ability to modify the DOM.

Parameters:

act - The action to perform. It will be called by the system either synchronously, or on a system thread. Attempts by this action to modify the DOM shall fail.

performActionOnFrames

void performActionOnFrames(String[] names,
                         MultipleDocumentsAction act)

Perform an action on a set of documents, each contained in a frame that is a part of the same application as the Xlet controlled by the given XletContext.

Parameters:

names - The names of the desired frames.

act - The action to perform. It will be called by the system either synchronously, or on a system thread.