js.html.ObjectElement - Haxe 4.2.2 API

The HTMLObjectElement interface provides special properties and methods (beyond those on the HTMLElement interface it also has available to it by inheritance) for manipulating the layout and presentation of object element, representing external resources.

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

Variables

`align:String`

Is a DOMString representing an enumerated property indicating alignment of the element's contents with respect to the surrounding context. The possible values are "left", "right", "justify", and "center".

`archive:String`

Is a DOMString that reflects the archive HTML attribute, containing a list of archives for resources for this object.

`border:String`

Is a DOMString that reflects the border HTML attribute, specifying the width of a border around the object.

`code:String`

Is a DOMString representing the name of an applet class file, containing either the applet's subclass, or the path to get to the class, including the class file itself.

`codeBase:String`

Is a DOMString that reflects the codebase HTML attribute, specifying the base path to use to resolve relative URIs.

`codeType:String`

Is a DOMString that reflects the codetype HTML attribute, specifying the content type of the data.

`read onlycontentDocument:HTMLDocument`

Returns a Document representing the active document of the object element's nested browsing context, if any; otherwise null.

`read onlycontentWindow:Window`

Returns a WindowProxy representing the window proxy of the object element's nested browsing context, if any; otherwise null.

`data:String`

Is a DOMString that reflects the data HTML attribute, specifying the address of a resource's data.

`declare:Bool`

Is a Boolean that reflects the declare HTML attribute, indicating that this is a declaration, not an instantiation, of the object.

`read onlyform:FormElement`

Retuns a HTMLFormElement representing the object element's form owner, or null if there isn't one.

`height:String`

Is a DOMString that reflects the height HTML attribute, specifying the displayed height of the resource in CSS pixels.

`hspace:Int`

Is a long representing the horizontal space in pixels around the control.

`name:String`

Is a DOMString that reflects the name HTML attribute, specifying the name of the browsing context.

`standby:String`

Is a DOMString that reflects the standby HTML attribute, specifying a message to display while the object loads.

`type:String`

Is a DOMString that reflects the type HTML attribute, specifying the MIME type of the resource.

`typeMustMatch:Bool`

Is a Boolean that reflects the typeMustMatch HTML attribute, indicating if the resource specified by data must only be played if it matches the type attribute.

`useMap:String`

Is a DOMString that reflects the usemap HTML attribute, specifying a map element to use.

`read onlyvalidationMessage:String`

Returns a DOMString representing a localized message that describes the validation constraints that the control does not satisfy (if any). This is the empty string if the control is not a candidate for constraint validation (willValidate is false), or it satisfies its constraints.

`read onlyvalidity:ValidityState`

Returns a ValidityState with the validity states that this element is in.

`vspace:Int`

Is a long representing the horizontal space in pixels around the control.

`width:String`

Is a DOMString that reflects the width HTML attribute, specifying the displayed width of the resource in CSS pixels.

`read onlywillValidate:Bool`

Returns a Boolean that indicates whether the element is a candidate for constraint validation. Always false for HTMLObjectElement objects.

Methods

`checkValidity():Bool`

Retuns a Boolean that always is true, because object objects are never candidates for constraint validation.

`getSVGDocument():HTMLDocument`

`reportValidity():Bool`

`setCustomValidity(error:String):Void`

Sets a custom validity message for the element. If this message is not the empty string, then the element is suffering from a custom validity error, and does not validate.

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

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 ObjectElement

package js.html

extends Element › DOMElement › Node › EventTarget

Variables

align:String

archive:String

border:String

code:String

codeBase:String

codeType:String

read onlycontentDocument:HTMLDocument

read onlycontentWindow:Window

data:String

declare:Bool

read onlyform:FormElement

height:String

hspace:Int

name:String

standby:String

type:String

typeMustMatch:Bool

useMap:String

read onlyvalidationMessage:String

read onlyvalidity:ValidityState

vspace:Int

width:String

read onlywillValidate:Bool

Methods

checkValidity():Bool

getSVGDocument():HTMLDocument

reportValidity():Bool

setCustomValidity(error:String):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

`align:String`

`archive:String`

`border:String`

`code:String`

`codeBase:String`

`codeType:String`

`read onlycontentDocument:HTMLDocument`

`read onlycontentWindow:Window`

`data:String`

`declare:Bool`

`read onlyform:FormElement`

`height:String`

`hspace:Int`

`name:String`

`standby:String`

`type:String`

`typeMustMatch:Bool`

`useMap:String`

`read onlyvalidationMessage:String`

`read onlyvalidity:ValidityState`

`vspace:Int`

`width:String`

`read onlywillValidate:Bool`

`checkValidity():Bool`

`getSVGDocument():HTMLDocument`

`reportValidity():Bool`

`setCustomValidity(error:String):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`