Annotation of html5/spec/common-input-element-apis.html, revision 1.212
1.202 sruby 1: <!DOCTYPE html><html lang="en-US-x-Hixie"><meta charset="utf-8"><title>4.10.7.4 Common input element APIs — HTML5</title><style type="text/css">
1.198 sruby 2:
3: .applies thead th > * { display: block; }
4: .applies thead code { display: block; }
5: .applies tbody th { white-space: nowrap; }
6: .applies td { text-align: center; }
7: .applies .yes { background: yellow; }
8:
9: .matrix, .matrix td { border: hidden; text-align: right; }
10: .matrix { margin-left: 2em; }
11:
12: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
13: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
14: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
15:
16: td.eg { border-width: thin; text-align: center; }
17:
18: #table-example-1 { border: solid thin; border-collapse: collapse; margin-left: 3em; }
19: #table-example-1 * { font-family: "Essays1743", serif; line-height: 1.01em; }
20: #table-example-1 caption { padding-bottom: 0.5em; }
21: #table-example-1 thead, #table-example-1 tbody { border: none; }
22: #table-example-1 th, #table-example-1 td { border: solid thin; }
23: #table-example-1 th { font-weight: normal; }
24: #table-example-1 td { border-style: none solid; vertical-align: top; }
25: #table-example-1 th { padding: 0.5em; vertical-align: middle; text-align: center; }
26: #table-example-1 tbody tr:first-child td { padding-top: 0.5em; }
27: #table-example-1 tbody tr:last-child td { padding-bottom: 1.5em; }
28: #table-example-1 tbody td:first-child { padding-left: 2.5em; padding-right: 0; width: 9em; }
29: #table-example-1 tbody td:first-child::after { content: leader(". "); }
30: #table-example-1 tbody td { padding-left: 2em; padding-right: 2em; }
31: #table-example-1 tbody td:first-child + td { width: 10em; }
32: #table-example-1 tbody td:first-child + td ~ td { width: 2.5em; }
33: #table-example-1 tbody td:first-child + td + td + td ~ td { width: 1.25em; }
34:
35: .apple-table-examples { border: none; border-collapse: separate; border-spacing: 1.5em 0em; width: 40em; margin-left: 3em; }
36: .apple-table-examples * { font-family: "Times", serif; }
37: .apple-table-examples td, .apple-table-examples th { border: none; white-space: nowrap; padding-top: 0; padding-bottom: 0; }
38: .apple-table-examples tbody th:first-child { border-left: none; width: 100%; }
39: .apple-table-examples thead th:first-child ~ th { font-size: smaller; font-weight: bolder; border-bottom: solid 2px; text-align: center; }
40: .apple-table-examples tbody th::after, .apple-table-examples tfoot th::after { content: leader(". ") }
41: .apple-table-examples tbody th, .apple-table-examples tfoot th { font: inherit; text-align: left; }
42: .apple-table-examples td { text-align: right; vertical-align: top; }
43: .apple-table-examples.e1 tbody tr:last-child td { border-bottom: solid 1px; }
44: .apple-table-examples.e1 tbody + tbody tr:last-child td { border-bottom: double 3px; }
45: .apple-table-examples.e2 th[scope=row] { padding-left: 1em; }
46: .apple-table-examples sup { line-height: 0; }
47:
48: .details-example img { vertical-align: top; }
49:
50: #base64-table {
51: white-space: nowrap;
52: font-size: 0.6em;
53: column-width: 6em;
54: column-count: 5;
55: column-gap: 1em;
56: -moz-column-width: 6em;
57: -moz-column-count: 5;
58: -moz-column-gap: 1em;
59: -webkit-column-width: 6em;
60: -webkit-column-count: 5;
61: -webkit-column-gap: 1em;
62: }
63: #base64-table thead { display: none; }
64: #base64-table * { border: none; }
65: #base64-table tbody td:first-child:after { content: ':'; }
66: #base64-table tbody td:last-child { text-align: right; }
67:
68: #named-character-references-table {
69: white-space: nowrap;
70: font-size: 0.6em;
71: column-width: 30em;
72: column-gap: 1em;
73: -moz-column-width: 30em;
74: -moz-column-gap: 1em;
75: -webkit-column-width: 30em;
76: -webkit-column-gap: 1em;
77: }
78: #named-character-references-table > table > tbody > tr > td:first-child + td,
79: #named-character-references-table > table > tbody > tr > td:last-child { text-align: center; }
80: #named-character-references-table > table > tbody > tr > td:last-child:hover > span { position: absolute; top: auto; left: auto; margin-left: 0.5em; line-height: 1.2; font-size: 5em; border: outset; padding: 0.25em 0.5em; background: white; width: 1.25em; height: auto; text-align: center; }
81: #named-character-references-table > table > tbody > tr#entity-CounterClockwiseContourIntegral > td:first-child { font-size: 0.5em; }
82:
83: .glyph.control { color: red; }
84:
85: @font-face {
86: font-family: 'Essays1743';
1.204 sruby 87: src: url('fonts/Essays1743.ttf');
1.198 sruby 88: }
89: @font-face {
90: font-family: 'Essays1743';
91: font-weight: bold;
1.204 sruby 92: src: url('fonts/Essays1743-Bold.ttf');
1.198 sruby 93: }
94: @font-face {
95: font-family: 'Essays1743';
96: font-style: italic;
1.204 sruby 97: src: url('fonts/Essays1743-Italic.ttf');
1.198 sruby 98: }
99: @font-face {
100: font-family: 'Essays1743';
101: font-style: italic;
102: font-weight: bold;
1.204 sruby 103: src: url('fonts/Essays1743-BoldItalic.ttf');
1.198 sruby 104: }
105:
1.202 sruby 106: </style><link href="data:text/css," id="complete" rel="stylesheet" title="Complete specification"><link href="data:text/css,.impl%20{%20display:%20none;%20}%0Ahtml%20{%20border:%20solid%20yellow;%20}%20.domintro:before%20{%20display:%20none;%20}" id="author" rel="alternate stylesheet" title="Author documentation only"><link href="data:text/css,.impl%20{%20background:%20%23FFEEEE;%20}%20.domintro:before%20{%20background:%20%23FFEEEE;%20}" id="highlight" rel="alternate stylesheet" title="Highlight implementation requirements"><style type="text/css">
1.1 mike 107: pre { margin-left: 2em; white-space: pre-wrap; }
108: h2 { margin: 3em 0 1em 0; }
109: h3 { margin: 2.5em 0 1em 0; }
110: h4 { margin: 2.5em 0 0.75em 0; }
111: h5, h6 { margin: 2.5em 0 1em; }
112: h1 + h2, h1 + h2 + h2 { margin: 0.75em 0 0.75em; }
113: h2 + h3, h3 + h4, h4 + h5, h5 + h6 { margin-top: 0.5em; }
114: p { margin: 1em 0; }
115: hr:not(.top) { display: block; background: none; border: none; padding: 0; margin: 2em 0; height: auto; }
116: dl, dd { margin-top: 0; margin-bottom: 0; }
117: dt { margin-top: 0.75em; margin-bottom: 0.25em; clear: left; }
118: dt + dt { margin-top: 0; }
119: dd dt { margin-top: 0.25em; margin-bottom: 0; }
120: dd p { margin-top: 0; }
121: dd dl + p { margin-top: 1em; }
122: dd table + p { margin-top: 1em; }
123: p + * > li, dd li { margin: 1em 0; }
124: dt, dfn { font-weight: bold; font-style: normal; }
125: i, em { font-style: italic; }
126: dt dfn { font-style: italic; }
127: pre, code { font-size: inherit; font-family: monospace; font-variant: normal; }
128: pre strong { color: black; font: inherit; font-weight: bold; background: yellow; }
129: pre em { font-weight: bolder; font-style: normal; }
130: @media screen { code { color: orangered; } code :link, code :visited { color: inherit; } }
131: var sub { vertical-align: bottom; font-size: smaller; position: relative; top: 0.1em; }
132: table { border-collapse: collapse; border-style: hidden hidden none hidden; }
133: table thead, table tbody { border-bottom: solid; }
134: table tbody th:first-child { border-left: solid; }
135: table tbody th { text-align: left; }
136: table td, table th { border-left: solid; border-right: solid; border-bottom: solid thin; vertical-align: top; padding: 0.2em; }
137: blockquote { margin: 0 0 0 2em; border: 0; padding: 0; font-style: italic; }
138:
139: .bad, .bad *:not(.XXX) { color: gray; border-color: gray; background: transparent; }
140: .matrix, .matrix td { border: none; text-align: right; }
141: .matrix { margin-left: 2em; }
142: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
143: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
144: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
145:
146: .toc dfn, h1 dfn, h2 dfn, h3 dfn, h4 dfn, h5 dfn, h6 dfn { font: inherit; }
147: img.extra, p.overview { float: right; }
148: pre.idl { border: solid thin; background: #EEEEEE; color: black; padding: 0.5em 1em; position: relative; }
149: pre.idl :link, pre.idl :visited { color: inherit; background: transparent; }
150: pre.idl::before { content: "IDL"; font: bold small sans-serif; padding: 0.5em; background: white; position: absolute; top: 0; margin: -1px 0 0 -4em; width: 1.5em; border: thin solid; border-radius: 0 0 0 0.5em }
151: pre.css { border: solid thin; background: #FFFFEE; color: black; padding: 0.5em 1em; }
152: pre.css:first-line { color: #AAAA50; }
153: dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #DDFFDD; }
154: hr + dl.domintro, div.impl + dl.domintro { margin-top: 2.5em; margin-bottom: 1.5em; }
155: dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
156: dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
157: dl.domintro dd p { margin: 0.5em 0; }
158: dl.domintro:before { display: table; margin: -1em -0.5em -0.5em auto; width: auto; content: 'This box is non-normative. Implementation requirements are given below this box.'; color: black; font-style: italic; border: solid 2px; background: white; padding: 0 0.25em; }
159: dl.switch { padding-left: 2em; }
160: dl.switch > dt { text-indent: -1.5em; }
161: dl.switch > dt:before { content: '\21AA'; padding: 0 0.5em 0 0; display: inline-block; width: 1em; text-align: right; line-height: 0.5em; }
162: dl.triple { padding: 0 0 0 1em; }
163: dl.triple dt, dl.triple dd { margin: 0; display: inline }
164: dl.triple dt:after { content: ':'; }
165: dl.triple dd:after { content: '\A'; white-space: pre; }
166: .diff-old { text-decoration: line-through; color: silver; background: transparent; }
167: .diff-chg, .diff-new { text-decoration: underline; color: green; background: transparent; }
168: a .diff-new { border-bottom: 1px blue solid; }
169:
1.180 sruby 170: figure.diagrams { border: double black; background: white; padding: 1em; }
171: figure.diagrams img { display: block; margin: 1em auto; }
172:
1.1 mike 173: h2 { page-break-before: always; }
174: h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
175: h1 + h2, hr + h2.no-toc { page-break-before: auto; }
176:
177: p > span:not([title=""]):not([class="XXX"]):not([class="impl"]):not([class="note"]),
1.198 sruby 178: li > span:not([title=""]):not([class="XXX"]):not([class="impl"]):not([class="note"]) { border-bottom: solid #9999CC; }
1.1 mike 179:
180: div.head { margin: 0 0 1em; padding: 1em 0 0 0; }
181: div.head p { margin: 0; }
182: div.head h1 { margin: 0; }
183: div.head .logo { float: right; margin: 0 1em; }
184: div.head .logo img { border: none } /* remove border from top image */
185: div.head dl { margin: 1em 0; }
186: div.head p.copyright, div.head p.alt { font-size: x-small; font-style: oblique; margin: 0; }
187:
188: body > .toc > li { margin-top: 1em; margin-bottom: 1em; }
189: body > .toc.brief > li { margin-top: 0.35em; margin-bottom: 0.35em; }
190: body > .toc > li > * { margin-bottom: 0.5em; }
191: body > .toc > li > * > li > * { margin-bottom: 0.25em; }
192: .toc, .toc li { list-style: none; }
193:
194: .brief { margin-top: 1em; margin-bottom: 1em; line-height: 1.1; }
195: .brief li { margin: 0; padding: 0; }
196: .brief li p { margin: 0; padding: 0; }
197:
198: .category-list { margin-top: -0.75em; margin-bottom: 1em; line-height: 1.5; }
199: .category-list::before { content: '\21D2\A0'; font-size: 1.2em; font-weight: 900; }
200: .category-list li { display: inline; }
201: .category-list li:not(:last-child)::after { content: ', '; }
202: .category-list li > span, .category-list li > a { text-transform: lowercase; }
203: .category-list li * { text-transform: none; } /* don't affect <code> nested in <a> */
204:
205: .XXX { color: #E50000; background: white; border: solid red; padding: 0.5em; margin: 1em 0; }
206: .XXX > :first-child { margin-top: 0; }
207: p .XXX { line-height: 3em; }
208: .annotation { border: solid thin black; background: #0C479D; color: white; position: relative; margin: 8px 0 20px 0; }
209: .annotation:before { position: absolute; left: 0; top: 0; width: 100%; height: 100%; margin: 6px -6px -6px 6px; background: #333333; z-index: -1; content: ''; }
210: .annotation :link, .annotation :visited { color: inherit; }
211: .annotation :link:hover, .annotation :visited:hover { background: transparent; }
212: .annotation span { border: none ! important; }
213: .note { color: green; background: transparent; font-family: sans-serif; }
214: .warning { color: red; background: transparent; }
215: .note, .warning { font-weight: bolder; font-style: italic; }
216: .note em, .warning em, .note i, .warning i { font-style: normal; }
217: p.note, div.note { padding: 0.5em 2em; }
218: span.note { padding: 0 2em; }
219: .note p:first-child, .warning p:first-child { margin-top: 0; }
220: .note p:last-child, .warning p:last-child { margin-bottom: 0; }
221: .warning:before { font-style: normal; }
222: p.note:before { content: 'Note: '; }
223: p.warning:before { content: '\26A0 Warning! '; }
224:
225: .bookkeeping:before { display: block; content: 'Bookkeeping details'; font-weight: bolder; font-style: italic; }
226: .bookkeeping { font-size: 0.8em; margin: 2em 0; }
227: .bookkeeping p { margin: 0.5em 2em; display: list-item; list-style: square; }
228: .bookkeeping dt { margin: 0.5em 2em 0; }
229: .bookkeeping dd { margin: 0 3em 0.5em; }
230:
231: h4 { position: relative; z-index: 3; }
232: h4 + .element, h4 + div + .element { margin-top: -2.5em; padding-top: 2em; }
233: .element {
234: background: #EEEEFF;
235: color: black;
236: margin: 0 0 1em 0.15em;
237: padding: 0 1em 0.25em 0.75em;
238: border-left: solid #9999FF 0.25em;
239: position: relative;
240: z-index: 1;
241: }
242: .element:before {
243: position: absolute;
244: z-index: 2;
245: top: 0;
246: left: -1.15em;
247: height: 2em;
248: width: 0.9em;
249: background: #EEEEFF;
250: content: ' ';
251: border-style: none none solid solid;
252: border-color: #9999FF;
253: border-width: 0.25em;
254: }
255:
256: .example { display: block; color: #222222; background: #FCFCFC; border-left: double; margin-left: 2em; padding-left: 1em; }
257: td > .example:only-child { margin: 0 0 0 0.1em; }
258:
259: ul.domTree, ul.domTree ul { padding: 0 0 0 1em; margin: 0; }
260: ul.domTree li { padding: 0; margin: 0; list-style: none; position: relative; }
261: ul.domTree li li { list-style: none; }
262: ul.domTree li:first-child::before { position: absolute; top: 0; height: 0.6em; left: -0.75em; width: 0.5em; border-style: none none solid solid; content: ''; border-width: 0.1em; }
263: ul.domTree li:not(:last-child)::after { position: absolute; top: 0; bottom: -0.6em; left: -0.75em; width: 0.5em; border-style: none none solid solid; content: ''; border-width: 0.1em; }
264: ul.domTree span { font-style: italic; font-family: serif; }
265: ul.domTree .t1 code { color: purple; font-weight: bold; }
266: ul.domTree .t2 { font-style: normal; font-family: monospace; }
267: ul.domTree .t2 .name { color: black; font-weight: bold; }
268: ul.domTree .t2 .value { color: blue; font-weight: normal; }
269: ul.domTree .t3 code, .domTree .t4 code, .domTree .t5 code { color: gray; }
270: ul.domTree .t7 code, .domTree .t8 code { color: green; }
271: ul.domTree .t10 code { color: teal; }
272:
273: body.dfnEnabled dfn { cursor: pointer; }
274: .dfnPanel {
275: display: inline;
276: position: absolute;
277: z-index: 10;
278: height: auto;
279: width: auto;
280: padding: 0.5em 0.75em;
281: font: small sans-serif, Droid Sans Fallback;
282: background: #DDDDDD;
283: color: black;
284: border: outset 0.2em;
285: }
286: .dfnPanel * { margin: 0; padding: 0; font: inherit; text-indent: 0; }
287: .dfnPanel :link, .dfnPanel :visited { color: black; }
288: .dfnPanel p { font-weight: bolder; }
289: .dfnPanel * + p { margin-top: 0.25em; }
290: .dfnPanel li { list-style-position: inside; }
291:
292: #configUI { position: absolute; z-index: 20; top: 10em; right: 1em; width: 11em; font-size: small; }
293: #configUI p { margin: 0.5em 0; padding: 0.3em; background: #EEEEEE; color: black; border: inset thin; }
294: #configUI p label { display: block; }
295: #configUI #updateUI, #configUI .loginUI { text-align: center; }
296: #configUI input[type=button] { display: block; margin: auto; }
297:
298: fieldset { margin: 1em; padding: 0.5em 1em; }
299: fieldset > legend + * { margin-top: 0; }
300: fieldset > :last-child { margin-bottom: 0; }
301: fieldset p { margin: 0.5em 0; }
302:
1.205 sruby 303: </style><link href="http://www.w3.org/StyleSheets/TR/W3C-ED" rel="stylesheet" type="text/css"><script>
1.1 mike 304: function getCookie(name) {
305: var params = location.search.substr(1).split("&");
306: for (var index = 0; index < params.length; index++) {
307: if (params[index] == name)
308: return "1";
309: var data = params[index].split("=");
310: if (data[0] == name)
311: return unescape(data[1]);
312: }
313: var cookies = document.cookie.split("; ");
314: for (var index = 0; index < cookies.length; index++) {
315: var data = cookies[index].split("=");
316: if (data[0] == name)
317: return unescape(data[1]);
318: }
319: return null;
320: }
1.202 sruby 321: </script><link href="common-input-element-attributes.html" rel="prev" title="4.10.7.3 Common input element attributes">
322: <link href="index.html#contents" rel="contents" title="Table of contents">
323: <link href="the-button-element.html" rel="next" title="4.10.8 The button element">
324: <body class="split chapter" onload="fixBrokenLink();"><div class="head" id="head">
1.1 mike 325: <p><a href="http://www.w3.org/"><img alt="W3C" height="48" src="http://www.w3.org/Icons/w3c_home" width="72"></a></p>
326:
327: <h1>HTML5</h1>
1.195 sruby 328: <h2 class="no-num no-toc" id="a-vocabulary-and-associated-apis-for-html-and-xhtml">A vocabulary and associated APIs for HTML and XHTML</h2>
1.212 ! sruby 329: <h2 class="no-num no-toc" id="editor's-draft-date-1-january-1970">Editor's Draft 19 November 2012</h2>
1.85 mike 330: </div>
1.198 sruby 331:
332:
1.202 sruby 333: <nav class="prev_next">
334: <a href="common-input-element-attributes.html">← 4.10.7.3 Common input element attributes</a> –
335: <a href="index.html#contents">Table of contents</a> –
336: <a href="the-button-element.html">4.10.8 The button element →</a>
337: <ol class="toc"><li><ol><li><ol><li><ol><li><a href="common-input-element-apis.html#common-input-element-apis"><span class="secno">4.10.7.4 </span>Common <code>input</code> element APIs</a><li><a href="common-input-element-apis.html#common-event-behaviors"><span class="secno">4.10.7.5 </span>Common event behaviors</a></ol></ol></ol></ol></nav>
1.1 mike 338:
1.85 mike 339: <h5 id="common-input-element-apis"><span class="secno">4.10.7.4 </span>Common <code><a href="the-input-element.html#the-input-element">input</a></code> element APIs</h5>
340:
341: <dl class="domintro"><dt><var title="">input</var> . <code title="dom-input-value"><a href="#dom-input-value">value</a></code> [ = <var title="">value</var> ]</dt>
1.1 mike 342:
343: <dd>
344:
345: <p>Returns the current <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a>
346: of the form control.</p>
347:
348: <p>Can be set, to change the value.</p>
349:
350: <p>Throws an <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception if it is
351: set to any value other than the empty string when the control is a
352: file upload control.</p>
353:
354: </dd>
355:
356: <dt><var title="">input</var> . <code title="dom-input-checked"><a href="#dom-input-checked">checked</a></code> [ = <var title="">value</var> ]</dt>
357:
358: <dd>
359:
360: <p>Returns the current <a href="attributes-common-to-form-controls.html#concept-fe-checked" title="concept-fe-checked">checkedness</a> of the form
361: control.</p>
362:
363: <p>Can be set, to change the <a href="attributes-common-to-form-controls.html#concept-fe-checked" title="concept-fe-checked">checkedness</a>.</p>
364:
365: </dd>
366:
367: <dt><var title="">input</var> . <code title="dom-input-files"><a href="#dom-input-files">files</a></code></dt>
368:
369: <dd>
370:
1.8 mike 371: <p>Returns a <code><a href="infrastructure.html#filelist">FileList</a></code> object listing the <a href="states-of-the-type-attribute.html#concept-input-type-file-selected" title="concept-input-type-file-selected">selected files</a> of
1.1 mike 372: the form control.</p>
373:
374: <p>Returns null if the control isn't a file control.</p>
375:
376: </dd>
377:
378: <dt><var title="">input</var> . <code title="dom-input-valueAsDate"><a href="#dom-input-valueasdate">valueAsDate</a></code> [ = <var title="">value</var> ]</dt>
379:
380: <dd>
381:
382: <p>Returns a <code>Date</code> object representing the form
383: control's <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a>, if
384: applicable; otherwise, returns null.</p>
385:
386: <p>Can be set, to change the value.</p>
387:
388: <p>Throws an <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception if the
389: control isn't date- or time-based.</p>
390:
391: </dd>
392:
393: <dt><var title="">input</var> . <code title="dom-input-valueAsNumber"><a href="#dom-input-valueasnumber">valueAsNumber</a></code> [ = <var title="">value</var> ]</dt>
394:
395: <dd>
396:
397: <p>Returns a number representing the form control's <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a>, if applicable; otherwise,
1.47 mike 398: returns NaN.</p>
1.1 mike 399:
400: <p>Can be set, to change the value.</p>
401:
402: <p>Throws an <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception if the
403: control is neither date- or time-based nor numeric.</p>
404:
405: </dd>
406:
407: <dt><var title="">input</var> . <code title="dom-input-stepUp"><a href="#dom-input-stepup">stepUp</a></code>( [ <var title="">n</var> ] )</dt>
408: <dt><var title="">input</var> . <code title="dom-input-stepDown"><a href="#dom-input-stepdown">stepDown</a></code>( [ <var title="">n</var> ] )</dt>
409:
410: <dd>
411:
412: <p>Changes the form control's <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> by the value given in the
413: <code title="attr-input-step"><a href="common-input-element-attributes.html#attr-input-step">step</a></code> attribute, multiplied by
414: <var title="">n</var>. The default value for <var title="">n</var>
415: is 1.</p>
416:
417: <p>Throws <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception if the control
418: is neither date- or time-based nor numeric, if the <code title="attr-input-step"><a href="common-input-element-attributes.html#attr-input-step">step</a></code> attribute's value is "<code title="">any</code>", if the current <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> could not be parsed, or if
419: stepping in the given direction by the given amount would take the
420: value out of range.</p>
421:
422: </dd>
423:
424: <dt><var title="">input</var> . <code title="dom-input-list"><a href="#dom-input-list">list</a></code></dt>
425:
426: <dd>
427:
428: <p>Returns the <code><a href="the-datalist-element.html#the-datalist-element">datalist</a></code> element indicated by the
429: <code title="attr-input-list"><a href="common-input-element-attributes.html#attr-input-list">list</a></code> attribute.</p>
430:
431: </dd>
432:
433: </dl><div class="impl">
434:
435: <p>The <dfn id="dom-input-value" title="dom-input-value"><code>value</code></dfn> IDL
436: attribute allows scripts to manipulate the <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> of an <code><a href="the-input-element.html#the-input-element">input</a></code>
437: element. The attribute is in one of the following modes, which
438: define its behavior:</p>
439:
440: <dl><dt><dfn id="dom-input-value-value" title="dom-input-value-value">value</dfn>
441:
1.202 sruby 442: <dd>
1.1 mike 443:
444: <p>On getting, it must return the current <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> of the element. On setting,
445: it must set the element's <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> to the new value, set the
446: element's <a href="the-input-element.html#concept-input-value-dirty-flag" title="concept-input-value-dirty-flag">dirty value
447: flag</a> to true, invoke the <a href="the-input-element.html#value-sanitization-algorithm">value sanitization
448: algorithm</a>, if the element's <code title="attr-input-type"><a href="the-input-element.html#attr-input-type">type</a></code> attribute's current state
449: defines one, and then, if the element has a text entry cursor
450: position, should move the text entry cursor position to the end of
451: the text field, unselecting any selected text and resetting the
452: selection direction to <i>none</i>.</p>
453:
454: </dd>
455:
456: <dt><dfn id="dom-input-value-default" title="dom-input-value-default">default</dfn>
457:
1.202 sruby 458: <dd>
1.1 mike 459:
460: <p>On getting, if the element has a <code title="attr-input-value"><a href="the-input-element.html#attr-input-value">value</a></code> attribute, it must return
461: that attribute's value; otherwise, it must return the empty
462: string. On setting, it must set the element's <code title="attr-input-value"><a href="the-input-element.html#attr-input-value">value</a></code> attribute to the new
463: value.</p>
464:
465: </dd>
466:
467: <dt><dfn id="dom-input-value-default-on" title="dom-input-value-default-on">default/on</dfn>
468:
1.202 sruby 469: <dd>
1.1 mike 470:
471: <p>On getting, if the element has a <code title="attr-input-value"><a href="the-input-element.html#attr-input-value">value</a></code> attribute, it must return
472: that attribute's value; otherwise, it must return the string
473: "<code title="">on</code>". On setting, it must set the element's
474: <code title="attr-input-value"><a href="the-input-element.html#attr-input-value">value</a></code> attribute to the new
475: value.</p>
476:
477: </dd>
478:
479: <dt><dfn id="dom-input-value-filename" title="dom-input-value-filename">filename</dfn>
480:
1.202 sruby 481: <dd id="fakepath-orly">
1.1 mike 482:
483: <p>On getting, it must return the string "<code title="">C:\fakepath\</code>" followed by the filename of the
1.8 mike 484: first file in the list of <a href="states-of-the-type-attribute.html#concept-input-type-file-selected" title="concept-input-type-file-selected">selected files</a>, if
1.1 mike 485: any, or the empty string if the list is empty. On setting, if the
1.8 mike 486: new value is the empty string, it must empty the list of <a href="states-of-the-type-attribute.html#concept-input-type-file-selected" title="concept-input-type-file-selected">selected files</a>;
1.1 mike 487: otherwise, it must throw an <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code>
488: exception.</p>
489:
490: <p class="note">This "fakepath" requirement is a sad accident of
1.8 mike 491: history. See <a href="states-of-the-type-attribute.html#fakepath-srsly">the example in the File
1.1 mike 492: Upload state section</a> for more information.</p>
493:
494: </dd>
495:
496: </dl><hr><p>The <dfn id="dom-input-checked" title="dom-input-checked"><code>checked</code></dfn> IDL
497: attribute allows scripts to manipulate the <a href="attributes-common-to-form-controls.html#concept-fe-checked" title="concept-fe-checked">checkedness</a> of an
498: <code><a href="the-input-element.html#the-input-element">input</a></code> element. On getting, it must return the current
499: <a href="attributes-common-to-form-controls.html#concept-fe-checked" title="concept-fe-checked">checkedness</a> of the element;
500: and on setting, it must set the element's <a href="attributes-common-to-form-controls.html#concept-fe-checked" title="concept-fe-checked">checkedness</a> to the new value and
501: set the element's <a href="the-input-element.html#concept-input-checked-dirty-flag" title="concept-input-checked-dirty-flag">dirty checkedness
502: flag</a> to true.</p>
503:
504: <hr><p>The <dfn id="dom-input-files" title="dom-input-files"><code>files</code></dfn> IDL
1.8 mike 505: attribute allows scripts to access the element's <a href="states-of-the-type-attribute.html#concept-input-type-file-selected" title="concept-input-type-file-selected">selected files</a>. On
1.1 mike 506: getting, if the IDL attribute applies, it must return a
1.8 mike 507: <code><a href="infrastructure.html#filelist">FileList</a></code> object that represents the current <a href="states-of-the-type-attribute.html#concept-input-type-file-selected" title="concept-input-type-file-selected">selected files</a>. The
508: same object must be returned until the list of <a href="states-of-the-type-attribute.html#concept-input-type-file-selected" title="concept-input-type-file-selected">selected files</a>
1.1 mike 509: changes. If the IDL attribute does not apply, then it must instead
1.203 sruby 510: return null. <a href="references.html#refsFILEAPI">[FILEAPI]</a></p>
1.1 mike 511:
512: <hr><p>The <dfn id="dom-input-valueasdate" title="dom-input-valueAsDate"><code>valueAsDate</code></dfn> IDL
513: attribute represents the <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> of the element, interpreted
514: as a date.</p>
515:
516: <p>On getting, if the <code title="dom-input-valueAsDate"><a href="#dom-input-valueasdate">valueAsDate</a></code> attribute does not
517: apply, as defined for the <code><a href="the-input-element.html#the-input-element">input</a></code> element's <code title="attr-input-type"><a href="the-input-element.html#attr-input-type">type</a></code> attribute's current state, then
518: return null. Otherwise, run the <a href="the-input-element.html#concept-input-value-string-date" title="concept-input-value-string-date">algorithm to convert a
519: string to a <code>Date</code> object</a> defined for that state;
520: if the algorithm returned a <code>Date</code> object, then return
521: it, otherwise, return null.</p>
522:
523: <p>On setting, if the <code title="dom-input-valueAsDate"><a href="#dom-input-valueasdate">valueAsDate</a></code> attribute does not
524: apply, as defined for the <code><a href="the-input-element.html#the-input-element">input</a></code> element's <code title="attr-input-type"><a href="the-input-element.html#attr-input-type">type</a></code> attribute's current state, then
1.34 mike 525: throw an <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception; otherwise, if the
526: new value is null or a <code>Date</code> object representing the NaN
527: time value, then set the <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a>
528: of the element to the empty string; otherwise, run the <a href="the-input-element.html#concept-input-value-date-string" title="concept-input-value-date-string">algorithm to convert a
1.1 mike 529: <code>Date</code> object to a string</a>, as defined for that
530: state, on the new value, and set the <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> of the element to resulting
531: string.</p>
532:
533: <hr><p>The <dfn id="dom-input-valueasnumber" title="dom-input-valueAsNumber"><code>valueAsNumber</code></dfn> IDL
534: attribute represents the <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a>
535: of the element, interpreted as a number.</p>
536:
537: <p>On getting, if the <code title="dom-input-valueAsNumber"><a href="#dom-input-valueasnumber">valueAsNumber</a></code> attribute does
538: not apply, as defined for the <code><a href="the-input-element.html#the-input-element">input</a></code> element's <code title="attr-input-type"><a href="the-input-element.html#attr-input-type">type</a></code> attribute's current state, then
539: return a Not-a-Number (NaN) value. Otherwise, if the <code title="dom-input-valueAsDate"><a href="#dom-input-valueasdate">valueAs<em>Date</em></a></code>
540: attribute applies, run the <a href="the-input-element.html#concept-input-value-string-date" title="concept-input-value-string-date">algorithm to convert a
541: string to a <code>Date</code> object</a> defined for that state;
542: if the algorithm returned a <code>Date</code> object, then return
543: the <i>time value</i> of the object (the number of milliseconds from
544: midnight UTC the morning of 1970-01-01 to the time represented by
545: the <code>Date</code> object), otherwise, return a Not-a-Number
546: (NaN) value. Otherwise, run the <a href="the-input-element.html#concept-input-value-string-number" title="concept-input-value-string-number">algorithm to convert a
547: string to a number</a> defined for that state; if the algorithm
548: returned a number, then return it, otherwise, return a Not-a-Number
549: (NaN) value.</p>
550:
551: <p>On setting, if the <code title="dom-input-valueAsNumber"><a href="#dom-input-valueasnumber">valueAsNumber</a></code> attribute does
552: not apply, as defined for the <code><a href="the-input-element.html#the-input-element">input</a></code> element's <code title="attr-input-type"><a href="the-input-element.html#attr-input-type">type</a></code> attribute's current state, then
553: throw an <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception. Otherwise, if
554: the <code title="dom-input-valueAsDate"><a href="#dom-input-valueasdate">valueAs<em>Date</em></a></code>
555: attribute applies, run the <a href="the-input-element.html#concept-input-value-date-string" title="concept-input-value-date-string">algorithm to convert a
556: <code>Date</code> object to a string</a> defined for that state,
557: passing it a <code>Date</code> object whose <i>time value</i> is the
558: new value, and set the <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a>
559: of the element to resulting string. Otherwise, run the <a href="the-input-element.html#concept-input-value-number-string" title="concept-input-value-number-string">algorithm to convert a
560: number to a string</a>, as defined for that state, on the new
561: value, and set the <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> of
562: the element to resulting string.</p>
563:
564: <hr><p>The <dfn id="dom-input-stepdown" title="dom-input-stepDown"><code>stepDown(<var title="">n</var>)</code></dfn> and <dfn id="dom-input-stepup" title="dom-input-stepUp"><code>stepUp(<var title="">n</var>)</code></dfn> methods, when invoked, must run the
565: following algorithm:</p>
566:
567: <ol><li><p>If the <code title="dom-input-stepDown"><a href="#dom-input-stepdown">stepDown()</a></code> and
568: <code title="dom-input-stepUp"><a href="#dom-input-stepup">stepUp()</a></code> methods do not
569: apply, as defined for the <code><a href="the-input-element.html#the-input-element">input</a></code> element's <code title="attr-input-type"><a href="the-input-element.html#attr-input-type">type</a></code> attribute's current state, then
570: throw an <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception, and abort these
1.202 sruby 571: steps.</li>
1.1 mike 572:
573: <li><p>If the element has no <a href="common-input-element-attributes.html#concept-input-step" title="concept-input-step">allowed value step</a>, then throw an
574: <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception, and abort these
1.202 sruby 575: steps.</li>
1.1 mike 576:
577: <li><p>If applying the <a href="the-input-element.html#concept-input-value-string-number" title="concept-input-value-string-number">algorithm to convert a
578: string to a number</a> to the string given by the element's
579: <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> results in an error,
580: then throw an <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception, and abort
581: these steps; otherwise, let <var title="">value</var> be the result
1.202 sruby 582: of that algorithm.</li>
1.1 mike 583:
584: <li><p>Let <var title="">n</var> be the argument, or 1 if the
1.202 sruby 585: argument was omitted.</li>
1.1 mike 586:
587: <li><p>Let <var title="">delta</var> be the <a href="common-input-element-attributes.html#concept-input-step" title="concept-input-step">allowed value step</a> multiplied by
1.202 sruby 588: <var title="">n</var>.</li>
1.1 mike 589:
1.202 sruby 590: <li><p>If the method invoked was the <code title="dom-input-stepDown"><a href="#dom-input-stepdown">stepDown()</a></code> method, negate <var title="">delta</var>.</li>
1.1 mike 591:
1.202 sruby 592: <li><p>Let <var title="">value</var> be the result of adding <var title="">delta</var> to <var title="">value</var>.</li>
1.1 mike 593: <li><p>If the element has a <a href="common-input-element-attributes.html#concept-input-min" title="concept-input-min">minimum</a>, and the <var title="">value</var> is less than that <a href="common-input-element-attributes.html#concept-input-min" title="concept-input-min">minimum</a>, then throw a
1.202 sruby 594: <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception.</li>
1.1 mike 595:
596: <li><p>If the element has a <a href="common-input-element-attributes.html#concept-input-max" title="concept-input-max">maximum</a>, and the <var title="">value</var> is greater than that <a href="common-input-element-attributes.html#concept-input-max" title="concept-input-max">maximum</a>, then throw a
1.202 sruby 597: <code><a href="infrastructure.html#invalidstateerror">InvalidStateError</a></code> exception.</li>
1.1 mike 598:
599: <li><p>Let <var title="">value as string</var> be the result of
600: running the <a href="the-input-element.html#concept-input-value-number-string" title="concept-input-value-number-string">algorithm to convert a
601: number to a string</a>, as defined for the <code><a href="the-input-element.html#the-input-element">input</a></code>
602: element's <code title="attr-input-type"><a href="the-input-element.html#attr-input-type">type</a></code> attribute's
1.202 sruby 603: current state, on <var title="">value</var>.</li>
1.1 mike 604:
605: <li><p>Set the <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> of the
1.202 sruby 606: element to <var title="">value as string</var>.</li>
1.1 mike 607:
608: </ol><hr><p>The <dfn id="dom-input-list" title="dom-input-list"><code>list</code></dfn> IDL
609: attribute must return the current <a href="common-input-element-attributes.html#concept-input-list" title="concept-input-list">suggestions source element</a>, if
610: any, or null otherwise.</p>
611:
1.85 mike 612: </div>
1.159 sruby 613: <!--TOPIC:HTML-->
1.85 mike 614:
615:
616: <div class="impl">
1.1 mike 617:
1.33 mike 618: <h5 id="common-event-behaviors"><span class="secno">4.10.7.5 </span>Common event behaviors</h5>
1.1 mike 619:
620: <p>When the <dfn id="event-input-input" title="event-input-input"><code>input</code></dfn>
621: event applies, any time the user causes the element's <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> to change, the user agent must
1.203 sruby 622: <a href="webappapis.html#queue-a-task">queue a task</a> to <a href="webappapis.html#fire-a-simple-event">fire a simple event</a> that
1.1 mike 623: bubbles named <code title="event-input">input</code> at the
624: <code><a href="the-input-element.html#the-input-element">input</a></code> element. User agents may wait for a suitable
625: break in the user's interaction before queuing the task; for
626: example, a user agent could wait for the user to have not hit a key
627: for 100ms, so as to only fire the event when the user pauses,
1.159 sruby 628: instead of continuously for each keystroke.</p> <!-- same text is
629: present in the <textarea> section -->
1.4 mike 630:
1.1 mike 631: <p class="example">Examples of a user changing the element's <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> would include the user typing
632: into a text field, pasting a new value into the field, or undoing an
633: edit in that field. Some user interactions do not cause changes to
634: the value, e.g. hitting the "delete" key in an empty text field, or
635: replacing some text in the field with text from the clipboard that
636: happens to be exactly the same text.</p>
637:
638: <p>When the <dfn id="event-input-change" title="event-input-change"><code>change</code></dfn> event applies,
639: if the element does not have an <a href="content-models.html#activation-behavior">activation behavior</a>
640: defined but uses a user interface that involves an explicit commit
641: action, then any time the user commits a change to the element's
1.8 mike 642: <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> or list of <a href="states-of-the-type-attribute.html#concept-input-type-file-selected" title="concept-input-type-file-selected">selected files</a>, the
1.203 sruby 643: user agent must <a href="webappapis.html#queue-a-task">queue a task</a> to <a href="webappapis.html#fire-a-simple-event">fire a simple
1.1 mike 644: event</a> that bubbles named <code title="event-change">change</code> at the <code><a href="the-input-element.html#the-input-element">input</a></code>
645: element.</p>
646:
647: <p class="example">An example of a user interface with a commit
1.159 sruby 648: action would be a <a href="states-of-the-type-attribute.html#file-upload-state-(type=file)" title="attr-input-type-file">File
1.1 mike 649: Upload</a> control that consists of a single button that brings
650: up a file selection dialog: when the dialog is closed, if that the
1.8 mike 651: <a href="states-of-the-type-attribute.html#concept-input-type-file-selected" title="concept-input-type-file-selected">file selection</a>
652: changed as a result, then the user has committed a new <a href="states-of-the-type-attribute.html#concept-input-type-file-selected" title="concept-input-type-file-selected">file selection</a>.</p>
1.1 mike 653:
654: <p class="example">Another example of a user interface with a commit
1.159 sruby 655: action would be a <a href="states-of-the-type-attribute.html#date-state-(type=date)" title="attr-input-type-date">Date</a>
1.1 mike 656: control that allows both text-based user input and user selection
657: from a drop-down calendar: while text input might not have an
658: explicit commit step, selecting a date from the drop down calendar
659: and then dismissing the drop down would be a commit action.</p>
660:
661: <p>When the user agent changes the element's <a href="attributes-common-to-form-controls.html#concept-fe-value" title="concept-fe-value">value</a> on behalf of the user (e.g. as
662: part of a form prefilling feature), the user agent must follow these
663: steps:</p>
664:
665: <ol><li>If the <code title="event-input-input"><a href="#event-input-input">input</a></code> event
1.203 sruby 666: applies, <a href="webappapis.html#queue-a-task">queue a task</a> to <a href="webappapis.html#fire-a-simple-event">fire a simple
1.1 mike 667: event</a> that bubbles named <code title="event-input">input</code> at the <code><a href="the-input-element.html#the-input-element">input</a></code>
668: element.</li>
669:
670: <li>If the <code title="event-input-change"><a href="#event-input-change">change</a></code> event
1.203 sruby 671: applies, <a href="webappapis.html#queue-a-task">queue a task</a> to <a href="webappapis.html#fire-a-simple-event">fire a simple
1.1 mike 672: event</a> that bubbles named <code title="event-change">change</code> at the <code><a href="the-input-element.html#the-input-element">input</a></code>
673: element.</li>
674:
675: </ol><p class="note">In addition, when the <code title="event-input-change"><a href="#event-input-change">change</a></code> event applies, <code title="event-change">change</code> events can also be fired as part
676: of the element's <a href="content-models.html#activation-behavior">activation behavior</a> and as part of the
1.203 sruby 677: <a href="editing.html#unfocusing-steps">unfocusing steps</a>.</p>
1.1 mike 678:
1.203 sruby 679: <p>The <a href="webappapis.html#task-source">task source</a> for these <a href="webappapis.html#concept-task" title="concept-task">tasks</a> is the <a href="webappapis.html#user-interaction-task-source">user interaction task
1.1 mike 680: source</a>.</p>
681:
1.85 mike 682: </div>
683:
684:
685:
1.202 sruby 686:
Webmaster
![[BACK]](/https/dev.w3.org/cvsweb/icons/back.gif){kind=icon}
Return to common-input-element-apis.html CVS log ![[TXT]](/https/dev.w3.org/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/https/dev.w3.org/cvsweb/icons/dir.gif){kind=icon}
Up to [Public] / html5 / spec