js.html.FormElement - sengine API

The HTMLFormElement interface represents a form element in the DOM; it allows access to and in some cases modification of aspects of the form, as well as access to its component elements.

Documentation HTMLFormElement by Mozilla Contributors, licensed under CC-BY-SA 2.5.

Variables

`acceptCharset:String`

A DOMString reflecting the value of the form's accept-charset HTML attribute, representing the character encoding that the server accepts.

`action:String`

A DOMString reflecting the value of the form's action HTML attribute, containing the URI of a program that processes the information submitted by the form.

`autocomplete:String`

A DOMString reflecting the value of the form's autocomplete HTML attribute, indicating whether the controls in this form can have their values automatically populated by the browser.

`read onlyelements:HTMLCollection`

A HTMLFormControlsCollection holding all form controls belonging to this form element.

`encoding:String`

A DOMString reflecting the value of the form's enctype HTML attribute, indicating the type of content that is used to transmit the form to the server. Only specified values can be set. The two properties are synonyms.

`enctype:String`

`read onlylength:Int`

A long reflecting the number of controls in the form.

`method:String`

A DOMString reflecting the value of the form's method HTML attribute, indicating the HTTP method used to submit the form. Only specified values can be set.

`name:String`

A DOMString reflecting the value of the form's name HTML attribute, containing the name of the form.

`noValidate:Bool`

A Boolean reflecting the value of the form's novalidate HTML attribute, indicating whether the form should not be validated.

`target:String`

A DOMString reflecting the value of the form's target HTML attribute, indicating where to display the results received from submitting the form.

Methods

`checkValidity():Bool`

Returns true if the element's child controls are subject to constraint validation and satisfy those contraints; returns false if some controls do not satisfy their constraints. Fires an event named invalid at any control that does not satisfy its constraints; such controls are considered invalid if the event is not canceled. It is up to the programmer to decide how to respond to false.

`reportValidity():Bool`

Returns true if the element's child controls satisfy their validation constraints. When false is returned, cancelable invalid events are fired for each invalid child and validation problems are reported to the user.

`reset():Void`

Resets the form to its initial state.

`submit():Void`

Submits the form to the server.

Throws:

`null`	DOMError

Inherited Variables

Defined by DOMElement

Defined by Node

`read onlybaseURI:String`

Returns a DOMString representing the base URL. The concept of base URL changes from one language to another; in HTML, it corresponds to the protocol, the domain name and the directory structure, that is all until the last '/'.

`read onlychildNodes:NodeList`

Returns a live NodeList containing all the children of this node. NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.

`read onlyfirstChild:Node`

Returns a Node representing the first direct child node of the node, or null if the node has no child.

`read onlyisConnected:Bool`

Returns a boolean indicating whether or not the Node is connected (directly or indirectly) to the context object, e.g. the Document object in the case of the normal DOM, or the ShadowRoot in the case of a shadow DOM.

`read onlylastChild:Node`

Returns a Node representing the last direct child node of the node, or null if the node has no child.

`read onlynextSibling:Node`

Returns a Node representing the next node in the tree, or null if there isn't such node.

`read onlynodeName:String`

Returns a DOMString containing the name of the Node. The structure of the name will differ with the node type. E.g. An HTMLElement will contain the name of the corresponding tag, like 'audio' for an HTMLAudioElement, a Text node will have the '#text' string, or a Document node will have the '#document' string.

`read onlynodeType:Int`

Returns an unsigned short representing the type of the node. Possible values are:

Name Value

`ELEMENT_NODE`	`1`
`ATTRIBUTE_NODE` (deprecated)	`2`
`TEXT_NODE`	`3`
`CDATA_SECTION_NODE` (deprecated)	`4`
`ENTITY_REFERENCE_NODE` (deprecated)	`5`
`ENTITY_NODE` (deprecated)	`6`
`PROCESSING_INSTRUCTION_NODE`	`7`
`COMMENT_NODE`	`8`
`DOCUMENT_NODE`	`9`
`DOCUMENT_TYPE_NODE`	`10`
`DOCUMENT_FRAGMENT_NODE`	`11`
`NOTATION_NODE` (deprecated)	`12`

`nodeValue:String`

Returns / Sets the value of the current node

`read onlyownerDocument:HTMLDocument`

Returns the Document that this node belongs to. If the node is itself a document, returns null.

`read onlyparentElement:Element`

Returns an Element that is the parent of this node. If the node has no parent, or if that parent is not an Element, this property returns null.

`read onlyparentNode:Node`

Returns a Node that is the parent of this node. If there is no such node, like if this node is the top of the tree or if doesn't participate in a tree, this property returns null.

`read onlypreviousSibling:Node`

Returns a Node representing the previous node in the tree, or null if there isn't such node.

`textContent:String`

Returns / Sets the textual content of an element and all its descendants.

Inherited Methods

Defined by Element

Defined by DOMElement

`after(nodes:Rest<Node>):Void`

`after(nodes:Rest<String>):Void`

Throws:

`null`	DOMError

`animate(keyframes:Dynamic, ?options:Float):Animation`

`animate(keyframes:Dynamic, ?options:Null<KeyframeAnimationOptions>):Animation`

A shortcut method to create and run an animation on an element. Returns the created Animation object instance.

Throws:

`null`	DOMError

`append(nodes:Rest<Node>):Void`

`append(nodes:Rest<String>):Void`

Throws:

`null`	DOMError

`attachShadow(shadowRootInitDict:ShadowRootInit):ShadowRoot`

Attatches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.

Throws:

`null`	DOMError

`before(nodes:Rest<Node>):Void`

`before(nodes:Rest<String>):Void`

Throws:

`null`	DOMError

`closest(selector:String):Element`

Returns the Element which is the closest ancestor of the current element (or the current element itself) which matches the selectors given in parameter.

Throws:

`null`	DOMError

`convertPointFromNode(point:DOMPointInit, from:Text, ?options:Null<ConvertCoordinateOptions>):DOMPoint`

`convertPointFromNode(point:DOMPointInit, from:Element, ?options:Null<ConvertCoordinateOptions>):DOMPoint`

`convertPointFromNode(point:DOMPointInit, from:HTMLDocument, ?options:Null<ConvertCoordinateOptions>):DOMPoint`

Throws:

`null`	DOMError

`convertQuadFromNode(quad:DOMQuad, from:Text, ?options:Null<ConvertCoordinateOptions>):DOMQuad`

`convertQuadFromNode(quad:DOMQuad, from:Element, ?options:Null<ConvertCoordinateOptions>):DOMQuad`

`convertQuadFromNode(quad:DOMQuad, from:HTMLDocument, ?options:Null<ConvertCoordinateOptions>):DOMQuad`

Throws:

`null`	DOMError

`convertRectFromNode(rect:DOMRectReadOnly, from:Text, ?options:Null<ConvertCoordinateOptions>):DOMQuad`

`convertRectFromNode(rect:DOMRectReadOnly, from:Element, ?options:Null<ConvertCoordinateOptions>):DOMQuad`

`convertRectFromNode(rect:DOMRectReadOnly, from:HTMLDocument, ?options:Null<ConvertCoordinateOptions>):DOMQuad`

Throws:

`null`	DOMError

`getAnimations(?filter:Null<AnimationFilter>):Array<Animation>`

Returns an array of Animation objects currently active on the element.

`getAttribute(name:String):String`

Retrieves the value of the named attribute from the current node and returns it as an Object.

`getAttributeNS(namespace:String, localName:String):String`

Retrieves the value of the attribute with the specified name and namespace, from the current node and returns it as an Object.

`getAttributeNames():Array<String>`

Returns an array of attribute names from the current element.

`getAttributeNode(name:String):Attr`

Retrieves the node representation of the named attribute from the current node and returns it as an Attr.

`getAttributeNodeNS(namespaceURI:String, localName:String):Attr`

Retrieves the node representation of the attribute with the specified name and namespace, from the current node and returns it as an Attr.

`getBoundingClientRect():DOMRect`

Returns the size of an element and its position relative to the viewport.

`getClientRects():DOMRectList`

Returns a collection of rectangles that indicate the bounding rectangles for each line of text in a client.

`getElementsByClassName(classNames:String):HTMLCollection`

Returns a live HTMLCollection that contains all descendants of the current element that possess the list of classes given in the parameter.

`getElementsByTagName(localName:String):HTMLCollection`

Returns a live HTMLCollection containing all descendant elements, of a particular tag name, from the current element.

`getElementsByTagNameNS(namespace:String, localName:String):HTMLCollection`

Returns a live HTMLCollection containing all descendant elements, of a particular tag name and namespace, from the current element.

Throws:

`null`	DOMError

`hasAttribute(name:String):Bool`

Returns a Boolean indicating if the element has the specified attribute or not.

`hasAttributeNS(namespace:String, localName:String):Bool`

Returns a Boolean indicating if the element has the specified attribute, in the specified namespace, or not.

`hasAttributes():Bool`

Returns a Boolean indicating if the element has one or more HTML attributes present.

`hasPointerCapture(pointerId:Int):Bool`

`insertAdjacentElement(where:String, element:Element):Element`

Inserts a given element node at a given position relative to the element it is invoked upon.

Throws:

`null`	DOMError

`insertAdjacentHTML(position:String, text:String):Void`

Parses the text as HTML or XML and inserts the resulting nodes into the tree in the position given.

Throws:

`null`	DOMError

`insertAdjacentText(where:String, data:String):Void`

Inserts a given text node at a given position relative to the element it is invoked upon.

Throws:

`null`	DOMError

`matches(selector:String):Bool`

Returns a Boolean indicating whether or not the element would be selected by the specified selector string.

Throws:

`null`	DOMError

`prepend(nodes:Rest<Node>):Void`

`prepend(nodes:Rest<String>):Void`

Throws:

`null`	DOMError

`querySelector(selectors:String):Element`

Returns the first Node which matches the specified selector string relative to the element.

Throws:

`null`	DOMError

`querySelectorAll(selectors:String):NodeList`

Returns a NodeList of nodes which match the specified selector string relative to the element.

Throws:

`null`	DOMError

`releaseCapture():Void`

`releasePointerCapture(pointerId:Int):Void`

Releases (stops) pointer capture that was previously set for a specific PointerEvent.

Throws:

`null`	DOMError

`remove():Void`

`removeAttribute(name:String):Void`

Removes the named attribute from the current node.

Throws:

`null`	DOMError

`removeAttributeNS(namespace:String, localName:String):Void`

Removes the attribute with the specified name and namespace, from the current node.

Throws:

`null`	DOMError

`removeAttributeNode(oldAttr:Attr):Attr`

Removes the node representation of the named attribute from the current node.

Throws:

`null`	DOMError

`replaceWith(nodes:Rest<Node>):Void`

`replaceWith(nodes:Rest<String>):Void`

Throws:

`null`	DOMError

`requestFullscreen(?options:Null<FullscreenOptions>):Promise<Void>`

Asynchronously asks the browser to make the element full-screen.

Throws:

`null`	DOMError

`requestPointerLock():Void`

Allows to asynchronously ask for the pointer to be locked on the given element.

`scroll(?options:Null<ScrollToOptions>):Void`

`scroll(x:Float, y:Float):Void`

`scrollBy(?options:Null<ScrollToOptions>):Void`

`scrollBy(x:Float, y:Float):Void`

`scrollIntoView(?arg:Bool):Void`

`scrollIntoView(?arg:Null<ScrollIntoViewOptions>):Void`

Scrolls the page until the element gets into the view.

`scrollTo(?options:Null<ScrollToOptions>):Void`

`scrollTo(x:Float, y:Float):Void`

`setAttribute(name:String, value:String):Void`

Sets the value of a named attribute of the current node.

Throws:

`null`	DOMError

`setAttributeNS(namespace:String, name:String, value:String):Void`

Sets the value of the attribute with the specified name and namespace, from the current node.

Throws:

`null`	DOMError

`setAttributeNode(newAttr:Attr):Attr`

Sets the node representation of the named attribute from the current node.

Throws:

`null`	DOMError

`setAttributeNodeNS(newAttr:Attr):Attr`

Sets the node representation of the attribute with the specified name and namespace, from the current node.

Throws:

`null`	DOMError

`@:value({ retargetToElement : false })setCapture(retargetToElement:Bool = false):Void`

Sets up mouse event capture, redirecting all mouse events to this element.

`setPointerCapture(pointerId:Int):Void`

Designates a specific element as the capture target of future pointer events.

Throws:

`null`	DOMError

`toggleAttribute(name:String, ?force:Bool):Bool`

Toggles a boolean attribute, removing it if it is present and adding it if it is not present, on the specified element.

Throws:

`null`	DOMError

`webkitMatchesSelector(selector:String):Bool`

Throws:

`null`	DOMError

Defined by Node

`appendChild(node:Node):Node`

Adds the specified childNode argument as the last child to the current node.

If the argument referenced an existing node on the DOM tree, the node will be detached from its current position and attached at the new position.

	@throws DOMError

`@:value({ deep : false })cloneNode(deep:Bool = false):Node`

Clone a Node, and optionally, all of its contents. By default, it clones the content of the node.

Throws:

`null`	DOMError

`compareDocumentPosition(other:Node):Int`

Compares the position of the current node against another node in any other document.

`contains(other:Node):Bool`

Returns a Boolean value indicating whether a node is a descendant of a given node or not.

`getRootNode(?options:Null<GetRootNodeOptions>):Node`

Returns the context object's root which optionally includes the shadow root if it is available.

`hasChildNodes():Bool`

Returns a Boolean indicating if the element has any child nodes, or not.

`insertBefore(node:Node, child:Node):Node`

Inserts a Node before the reference node as a child of a specified parent node.

Throws:

`null`	DOMError

`isDefaultNamespace(namespace:String):Bool`

Accepts a namespace URI as an argument and returns a Boolean with a value of true if the namespace is the default namespace on the given node or false if not.

`isEqualNode(node:Node):Bool`

Returns a Boolean which indicates whether or not two nodes are of the same type and all their defining data points match.

`isSameNode(node:Node):Bool`

Returns a Boolean value indicating whether or not the two nodes are the same (that is, they reference the same object).

`lookupNamespaceURI(prefix:String):String`

Accepts a prefix and returns the namespace URI associated with it on the given node if found (and null if not). Supplying null for the prefix will return the default namespace.

`lookupPrefix(namespace:String):String`

Returns a DOMString containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the result is implementation-dependent.

`normalize():Void`

Clean up all the text nodes under this element (merge adjacent, remove empty).

`removeChild(child:Node):Node`

Removes a child node from the current element, which must be a child of the current node.

Throws:

`null`	DOMError

`replaceChild(node:Node, child:Node):Node`

Replaces one child Node of the current one with the second one given in parameter.

Throws:

`null`	DOMError

class FormElement

package js.html

extends Element › DOMElement › Node › EventTarget

Variables

acceptCharset:String

action:String

autocomplete:String

read onlyelements:HTMLCollection

encoding:String

enctype:String

read onlylength:Int

method:String

name:String

noValidate:Bool

target:String

Methods

checkValidity():Bool

reportValidity():Bool

reset():Void

submit():Void

Inherited Variables

Defined by DOMElement

accessKey:String

read onlyaccessKeyLabel:String

read onlyassignedSlot:SlotElement

read onlyattributes:NamedNodeMap

read onlychildElementCount:Int

read onlychildren:HTMLCollection

read onlyclassList:DOMTokenList

className:String

read onlyclientHeight:Int

read onlyclientLeft:Int

read onlyclientTop:Int

read onlyclientWidth:Int

contentEditable:String

read onlycontextMenu:MenuElement

read onlydataset:DOMStringMap

dir:String

draggable:Bool

read onlyfirstElementChild:Element

hidden:Bool

id:String

innerHTML:String

innerText:String

read onlyisContentEditable:Bool

itemId:String

read onlyitemProp:DOMTokenList

read onlyitemRef:DOMTokenList

itemScope:Bool

read onlyitemType:DOMTokenList

itemValue:Dynamic

lang:String

read onlylastElementChild:Element

read onlylocalName:String

read onlynamespaceURI:String

read onlynextElementSibling:Element

read onlyoffsetHeight:Int

read onlyoffsetLeft:Int

read onlyoffsetParent:Element

read onlyoffsetTop:Int

read onlyoffsetWidth:Int

onabort:Function

onanimationcancel:Function

onanimationend:Function

onanimationiteration:Function

onanimationstart:Function

onauxclick:Function

onblur:Function

oncanplay:Function

oncanplaythrough:Function

onchange:Function

onclick:Function

onclose:Function

oncontextmenu:Function

oncopy:Function

oncut:Function

ondblclick:Function

ondrag:Function

ondragend:Function

ondragenter:Function

`acceptCharset:String`

`action:String`

`autocomplete:String`

`read onlyelements:HTMLCollection`

`encoding:String`

`enctype:String`

`read onlylength:Int`

`method:String`

`name:String`

`noValidate:Bool`

`target:String`

`checkValidity():Bool`

`reportValidity():Bool`

`reset():Void`

`submit():Void`

`accessKey:String`

`read onlyaccessKeyLabel:String`

`read onlyassignedSlot:SlotElement`

`read onlyattributes:NamedNodeMap`

`read onlychildElementCount:Int`

`read onlychildren:HTMLCollection`

`read onlyclassList:DOMTokenList`

`className:String`

`read onlyclientHeight:Int`

`read onlyclientLeft:Int`

`read onlyclientTop:Int`

`read onlyclientWidth:Int`

`contentEditable:String`

`read onlycontextMenu:MenuElement`

`read onlydataset:DOMStringMap`

`dir:String`

`draggable:Bool`

`read onlyfirstElementChild:Element`

`hidden:Bool`

`id:String`

`innerHTML:String`

`innerText:String`

`read onlyisContentEditable:Bool`

`itemId:String`

`read onlyitemProp:DOMTokenList`

`read onlyitemRef:DOMTokenList`

`itemScope:Bool`

`read onlyitemType:DOMTokenList`

`itemValue:Dynamic`

`lang:String`

`read onlylastElementChild:Element`

`read onlylocalName:String`

`read onlynamespaceURI:String`

`read onlynextElementSibling:Element`

`read onlyoffsetHeight:Int`

`read onlyoffsetLeft:Int`

`read onlyoffsetParent:Element`

`read onlyoffsetTop:Int`

`read onlyoffsetWidth:Int`

`onabort:Function`

`onanimationcancel:Function`

`onanimationend:Function`

`onanimationiteration:Function`

`onanimationstart:Function`

`onauxclick:Function`

`onblur:Function`

`oncanplay:Function`

`oncanplaythrough:Function`

`onchange:Function`

`onclick:Function`

`onclose:Function`

`oncontextmenu:Function`

`oncopy:Function`

`oncut:Function`

`ondblclick:Function`

`ondrag:Function`

`ondragend:Function`

`ondragenter:Function`

`ondragexit:Function`

`ondragleave:Function`

`ondragover:Function`

`ondragstart:Function`

`ondrop:Function`

`ondurationchange:Function`

`onemptied:Function`