org.itsnat.comp.iframe

Interface ItsNatHTMLIFrame

All Superinterfaces:

ItsNatComponent, ItsNatElementComponent, ItsNatHTMLElementComponent, ItsNatUserData

public interface ItsNatHTMLIFrame
extends ItsNatHTMLElementComponent

Is the interface of HTML <iframe> based components.

This component alongside an <input type=file> element can be used for file uploading.

When this component is disposed, any pending file upload process is disposed and not executed.

ItsNat provides a default implementation of this interface.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatHTMLComponentManager.createItsNatHTMLIFrame(org.w3c.dom.html.HTMLIFrameElement,org.itsnat.core.NameValue[])

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.html.HTMLIFrameElement	getHTMLIFrameElement() Returns the associated DOM element to this component.
HTMLIFrameFileUpload	getHTMLIFrameFileUpload(ClientDocument clientDoc, org.w3c.dom.html.HTMLInputElement elem) Creates a file upload task associated to this iframe component and to the specified <input type=file> element.
HTMLIFrameFileUpload	getHTMLIFrameFileUpload(org.w3c.dom.html.HTMLInputElement elem) Creates a file upload task associated to this iframe component and to the specified <input type=file> element.

Methods inherited from interface org.itsnat.comp.ItsNatHTMLElementComponent

getHTMLElement, getItsNatHTMLComponentManager, getItsNatHTMLElementComponentUI

Methods inherited from interface org.itsnat.comp.ItsNatElementComponent

getElement, getItsNatElementComponentUI

Methods inherited from interface org.itsnat.comp.ItsNatComponent

addEventListener, addEventListener, addEventListener, addEventListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, disableEventListener, disableEventListener, dispose, enableEventListener, enableEventListener, getArtifact, getArtifact, getItsNatComponentManager, getItsNatComponentUI, getItsNatDocument, getNode, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, isDisposed, isEnabled, registerArtifact, removeArtifact, removeEventListener, removeEventListener, removeEventListener, removeEventListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, setEnabled, setEventListenerParams, setEventListenerParams, setNode

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getHTMLIFrameElement

org.w3c.dom.html.HTMLIFrameElement getHTMLIFrameElement()

Returns the associated DOM element to this component.

Returns:

the associated DOM element.

getHTMLIFrameFileUpload

HTMLIFrameFileUpload getHTMLIFrameFileUpload(ClientDocument clientDoc,
                                           org.w3c.dom.html.HTMLInputElement elem)

Creates a file upload task associated to this iframe component and to the specified <input type=file> element.

Parameters:

elem - the input file element, cannot be null.

clientDoc - the client to send the file upload request.

Returns:

a file upload task instance to initiate and process the file upload request.

getHTMLIFrameFileUpload

HTMLIFrameFileUpload getHTMLIFrameFileUpload(org.w3c.dom.html.HTMLInputElement elem)

Creates a file upload task associated to this iframe component and to the specified <input type=file> element.

The ClientDocument to send the file upload request is the client associated to the current web request or, if this call is not executed into a web request, the client which loaded the document (the first client).

Parameters:

elem - the input file element, cannot be null.

Returns:

a file upload task instance to initiate and process the file upload request.

See Also:

getHTMLIFrameFileUpload(ClientDocument,HTMLInputElement)