File: SelectElement.hx

package info (click to toggle)
haxe 1%3A4.3.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 44,520 kB
  • sloc: ml: 137,268; ansic: 2,491; makefile: 456; java: 386; cs: 336; cpp: 318; python: 318; sh: 75; objc: 64; php: 50; xml: 31; javascript: 11
file content (156 lines) | stat: -rw-r--r-- 6,712 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/*
 * Copyright (C)2005-2019 Haxe Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

// This file is generated from mozilla\HTMLSelectElement.webidl. Do not edit!

package js.html;

/**
	The `HTMLSelectElement` interface represents a `select` HTML Element. These elements also share all of the properties and methods of other HTML elements via the `HTMLElement` interface.

	Documentation [HTMLSelectElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSelectElement) by [Mozilla Contributors](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSelectElement$history), licensed under [CC-BY-SA 2.5](https://creativecommons.org/licenses/by-sa/2.5/).

	@see <https://developer.mozilla.org/en-US/docs/Web/API/HTMLSelectElement>
**/
@:native("HTMLSelectElement")
extern class SelectElement extends Element implements ArrayAccess<Element> {
	
	/**
		A `Boolean` reflecting the `autofocus` HTML attribute, which indicates whether the control should have input focus when the page loads, unless the user overrides it, for example by typing in a different control. Only one form-associated element in a document can have this attribute specified. `2.0`
	**/
	var autofocus : Bool;
	var autocomplete : String;
	
	/**
		A `Boolean` reflecting the `disabled` HTML attribute, which indicates whether the control is disabled. If it is disabled, it does not accept clicks.
	**/
	var disabled : Bool;
	
	/**
		An `HTMLFormElement` referencing the form that this element is associated with. If the element is not associated with of a `form` element, then it returns `null`.
	**/
	var form(default,null) : FormElement;
	
	/**
		A `Boolean` reflecting the `multiple` HTML attribute, which indicates whether multiple items can be selected.
	**/
	var multiple : Bool;
	
	/**
		A `DOMString` reflecting the `name` HTML attribute, containing the name of this control used by servers and DOM search functions.
	**/
	var name : String;
	
	/**
		A `Boolean` reflecting the `required` HTML attribute, which indicates whether the user is required to select a value before submitting the form. `2.0`
	**/
	var required : Bool;
	
	/**
		A `long` reflecting the `size` HTML attribute, which contains the number of visible items in the control. The default is 1, unless `multiple` is true, in which case it is 4.
	**/
	var size : Int;
	
	/**
		A `DOMString` represeting the form control's type. When `multiple` is `true`, it returns `"select-multiple"`; otherwise, it returns `"select-one"`.
	**/
	var type(default,null) : String;
	
	/**
		An `HTMLOptionsCollection` representing the set of `option` elements contained by this element.
	**/
	var options(default,null) : HTMLOptionsCollection;
	
	/**
		An `unsigned long `The number of `option` elements in this `select` element.
	**/
	var length : Int;
	
	/**
		An `HTMLCollection` representing the set of `option` elements that are selected.
	**/
	var selectedOptions(default,null) : HTMLCollection;
	
	/**
		A `long` reflecting the index of the first selected `option` element. The value `-1` indicates no element is selected.
	**/
	var selectedIndex : Int;
	
	/**
		A `DOMString` reflecting the value of the form control (the first selected option). Returns the value attribute of the option element or if it is missing, the text attribute.
	**/
	var value : String;
	
	/**
		A `Boolean` that indicates whether the button is a candidate for constraint validation. It is false if any conditions bar it from constraint validation.
	**/
	var willValidate(default,null) : Bool;
	
	/**
		A `ValidityState` reflecting the validity state that this control is in.
	**/
	var validity(default,null) : ValidityState;
	
	/**
		A `DOMString` representing a localized message that describes the validation constraints that the control does not satisfy (if any). This attribute is the empty string if the control is not a candidate for constraint validation (`willValidate` is false), or it satisfies its constraints.
	**/
	var validationMessage(default,null) : String;
	
	/**
		A `NodeList` of `label` elements associated with the element.
	**/
	var labels(default,null) : NodeList;
	
	
	/**
		Gets an item from the options collection for this `select` element. You can also access an item by specifying the index in array-style brackets or parentheses, without calling this method explicitly.
	**/
	function item( index : Int ) : Element;
	
	/**
		Gets the item in the options collection with the specified name. The name string can match either the `id` or the `name` attribute of an option node. You can also access an item by specifying the name in array-style brackets or parentheses, without calling this method explicitly.
	**/
	function namedItem( name : String ) : OptionElement;
	
	/**
		Adds an element to the collection of `option` elements for this `select` element.
		@throws DOMError
	**/
	function add( element : haxe.extern.EitherType<OptionElement,OptGroupElement>, ?before : haxe.extern.EitherType<Element,Int> ) : Void;
	
	/**
		Removes the element at the specified index from the options collection for this select element.
	**/
	@:overload( function( index : Int ) : Void {} )
	function remove() : Void;
	
	/**
		Checks whether the element has any constraints and whether it satisfies them. If the element fails its constraints, the browser fires a cancelable `invalid` event at the element (and returns `false`).
	**/
	function checkValidity() : Bool;
	function reportValidity() : Bool;
	
	/**
		Sets the custom validity message for the selection element to the specified message. Use the empty string to indicate that the element does not have a custom validity error.
	**/
	function setCustomValidity( error : String ) : Void;
}