Annotation of html5/spec-author-view/the-button-element.html, revision 1.136
1.55 mike 1: <!DOCTYPE html><!-- when publishing, change bits marked ZZZ --><html class="split chapter" lang="en-US-x-Hixie"><head><meta content="text/html; charset=UTF-8" http-equiv="Content-Type"><title>4.10.8 The button element — HTML5 (Edition for Web Authors)</title><link href="whatwg.css" rel="stylesheet"><style type="text/css">
1.1 mike 2: pre { margin-left: 2em; white-space: pre-wrap; }
3: h2 { margin: 3em 0 1em 0; }
4: h3 { margin: 2.5em 0 1em 0; }
5: h4 { margin: 2.5em 0 0.75em 0; }
6: h5, h6 { margin: 2.5em 0 1em; }
7: h1 + h2, h1 + h2 + h2 { margin: 0.75em 0 0.75em; }
8: h2 + h3, h3 + h4, h4 + h5, h5 + h6 { margin-top: 0.5em; }
9: p { margin: 1em 0; }
10: hr:not(.top) { display: block; background: none; border: none; padding: 0; margin: 2em 0; height: auto; }
11: dl, dd { margin-top: 0; margin-bottom: 0; }
12: dt { margin-top: 0.75em; margin-bottom: 0.25em; clear: left; }
13: dt + dt { margin-top: 0; }
14: dd dt { margin-top: 0.25em; margin-bottom: 0; }
15: dd p { margin-top: 0; }
16: dd dl + p { margin-top: 1em; }
17: dd table + p { margin-top: 1em; }
18: p + * > li, dd li { margin: 1em 0; }
19: dt, dfn { font-weight: bold; font-style: normal; }
20: dt dfn { font-style: italic; }
21: pre, code { font-size: inherit; font-family: monospace; font-variant: normal; }
22: pre strong { color: black; font: inherit; font-weight: bold; background: yellow; }
23: pre em { font-weight: bolder; font-style: normal; }
24: @media screen { code { color: orangered; } code :link, code :visited { color: inherit; } }
25: var sub { vertical-align: bottom; font-size: smaller; position: relative; top: 0.1em; }
26: table { border-collapse: collapse; border-style: hidden hidden none hidden; }
1.34 mike 27: table thead, table tbody { border-bottom: solid; }
1.1 mike 28: table tbody th:first-child { border-left: solid; }
29: table tbody th { text-align: left; }
30: table td, table th { border-left: solid; border-right: solid; border-bottom: solid thin; vertical-align: top; padding: 0.2em; }
31: blockquote { margin: 0 0 0 2em; border: 0; padding: 0; font-style: italic; }
32:
33: .bad, .bad *:not(.XXX) { color: gray; border-color: gray; background: transparent; }
34: .matrix, .matrix td { border: none; text-align: right; }
35: .matrix { margin-left: 2em; }
36: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
37: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
38: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
39:
40: .toc dfn, h1 dfn, h2 dfn, h3 dfn, h4 dfn, h5 dfn, h6 dfn { font: inherit; }
41: img.extra { float: right; }
42: pre.idl { border: solid thin; background: #EEEEEE; color: black; padding: 0.5em 1em; }
43: pre.idl :link, pre.idl :visited { color: inherit; background: transparent; }
44: pre.css { border: solid thin; background: #FFFFEE; color: black; padding: 0.5em 1em; }
45: pre.css:first-line { color: #AAAA50; }
1.23 mike 46: dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #DDFFDD; }
1.1 mike 47: hr + dl.domintro, div.impl + dl.domintro { margin-top: 2.5em; margin-bottom: 1.5em; }
48: dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
49: dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
50: dl.domintro dd p { margin: 0.5em 0; }
51: dl.switch { padding-left: 2em; }
52: dl.switch > dt { text-indent: -1.5em; }
53: dl.switch > dt:before { content: '\21AA'; padding: 0 0.5em 0 0; display: inline-block; width: 1em; text-align: right; line-height: 0.5em; }
54: dl.triple { padding: 0 0 0 1em; }
55: dl.triple dt, dl.triple dd { margin: 0; display: inline }
56: dl.triple dt:after { content: ':'; }
57: dl.triple dd:after { content: '\A'; white-space: pre; }
58: .diff-old { text-decoration: line-through; color: silver; background: transparent; }
59: .diff-chg, .diff-new { text-decoration: underline; color: green; background: transparent; }
60: a .diff-new { border-bottom: 1px blue solid; }
61:
62: h2 { page-break-before: always; }
63: h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
64: h1 + h2, hr + h2.no-toc { page-break-before: auto; }
65:
66: p > span:not([title=""]):not([class="XXX"]):not([class="impl"]), li > span:not([title=""]):not([class="XXX"]):not([class="impl"]) { border-bottom: solid #9999CC; }
67:
68: div.head { margin: 0 0 1em; padding: 1em 0 0 0; }
69: div.head p { margin: 0; }
70: div.head h1 { margin: 0; }
71: div.head .logo { float: right; margin: 0 1em; }
72: div.head .logo img { border: none } /* remove border from top image */
73: div.head dl { margin: 1em 0; }
74: div.head p.copyright, div.head p.alt { font-size: x-small; font-style: oblique; margin: 0; }
75:
76: body > .toc > li { margin-top: 1em; margin-bottom: 1em; }
77: body > .toc.brief > li { margin-top: 0.35em; margin-bottom: 0.35em; }
78: body > .toc > li > * { margin-bottom: 0.5em; }
79: body > .toc > li > * > li > * { margin-bottom: 0.25em; }
80: .toc, .toc li { list-style: none; }
81:
82: .brief { margin-top: 1em; margin-bottom: 1em; line-height: 1.1; }
83: .brief li { margin: 0; padding: 0; }
84: .brief li p { margin: 0; padding: 0; }
85:
86: .category-list { margin-top: -0.75em; margin-bottom: 1em; line-height: 1.5; }
87: .category-list::before { content: '\21D2\A0'; font-size: 1.2em; font-weight: 900; }
88: .category-list li { display: inline; }
89: .category-list li:not(:last-child)::after { content: ', '; }
90: .category-list li > span, .category-list li > a { text-transform: lowercase; }
91: .category-list li * { text-transform: none; } /* don't affect <code> nested in <a> */
92:
93: .XXX { color: #E50000; background: white; border: solid red; padding: 0.5em; margin: 1em 0; }
94: .XXX > :first-child { margin-top: 0; }
95: p .XXX { line-height: 3em; }
96: .annotation { border: solid thin black; background: #0C479D; color: white; position: relative; margin: 8px 0 20px 0; }
97: .annotation:before { position: absolute; left: 0; top: 0; width: 100%; height: 100%; margin: 6px -6px -6px 6px; background: #333333; z-index: -1; content: ''; }
98: .annotation :link, .annotation :visited { color: inherit; }
99: .annotation :link:hover, .annotation :visited:hover { background: transparent; }
100: .annotation span { border: none ! important; }
101: .note { color: green; background: transparent; font-family: sans-serif; }
102: .warning { color: red; background: transparent; }
103: .note, .warning { font-weight: bolder; font-style: italic; }
104: p.note, div.note { padding: 0.5em 2em; }
105: span.note { padding: 0 2em; }
106: .note p:first-child, .warning p:first-child { margin-top: 0; }
107: .note p:last-child, .warning p:last-child { margin-bottom: 0; }
108: .warning:before { font-style: normal; }
109: p.note:before { content: 'Note: '; }
110: p.warning:before { content: '\26A0 Warning! '; }
111:
112: .bookkeeping:before { display: block; content: 'Bookkeeping details'; font-weight: bolder; font-style: italic; }
113: .bookkeeping { font-size: 0.8em; margin: 2em 0; }
114: .bookkeeping p { margin: 0.5em 2em; display: list-item; list-style: square; }
1.132 mike 115: .bookkeeping dt { margin: 0.5em 2em 0; }
116: .bookkeeping dd { margin: 0 3em 0.5em; }
1.1 mike 117:
118: h4 { position: relative; z-index: 3; }
119: h4 + .element, h4 + div + .element { margin-top: -2.5em; padding-top: 2em; }
120: .element {
121: background: #EEEEFF;
122: color: black;
123: margin: 0 0 1em 0.15em;
124: padding: 0 1em 0.25em 0.75em;
125: border-left: solid #9999FF 0.25em;
126: position: relative;
127: z-index: 1;
128: }
129: .element:before {
130: position: absolute;
131: z-index: 2;
132: top: 0;
133: left: -1.15em;
134: height: 2em;
135: width: 0.9em;
136: background: #EEEEFF;
137: content: ' ';
138: border-style: none none solid solid;
139: border-color: #9999FF;
140: border-width: 0.25em;
141: }
142:
143: .example { display: block; color: #222222; background: #FCFCFC; border-left: double; margin-left: 2em; padding-left: 1em; }
144: td > .example:only-child { margin: 0 0 0 0.1em; }
145:
146: ul.domTree, ul.domTree ul { padding: 0 0 0 1em; margin: 0; }
147: ul.domTree li { padding: 0; margin: 0; list-style: none; position: relative; }
148: ul.domTree li li { list-style: none; }
149: 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; }
150: 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; }
151: ul.domTree span { font-style: italic; font-family: serif; }
152: ul.domTree .t1 code { color: purple; font-weight: bold; }
153: ul.domTree .t2 { font-style: normal; font-family: monospace; }
154: ul.domTree .t2 .name { color: black; font-weight: bold; }
155: ul.domTree .t2 .value { color: blue; font-weight: normal; }
156: ul.domTree .t3 code, .domTree .t4 code, .domTree .t5 code { color: gray; }
157: ul.domTree .t7 code, .domTree .t8 code { color: green; }
158: ul.domTree .t10 code { color: teal; }
159:
1.14 mike 160: body.dfnEnabled dfn { cursor: pointer; }
161: .dfnPanel {
162: display: inline;
163: position: absolute;
164: z-index: 10;
165: height: auto;
166: width: auto;
167: padding: 0.5em 0.75em;
168: font: small sans-serif, Droid Sans Fallback;
169: background: #DDDDDD;
170: color: black;
171: border: outset 0.2em;
172: }
173: .dfnPanel * { margin: 0; padding: 0; font: inherit; text-indent: 0; }
174: .dfnPanel :link, .dfnPanel :visited { color: black; }
175: .dfnPanel p { font-weight: bolder; }
176: .dfnPanel * + p { margin-top: 0.25em; }
177: .dfnPanel li { list-style-position: inside; }
178:
1.1 mike 179: #configUI { position: absolute; z-index: 20; top: 10em; right: 1em; width: 11em; font-size: small; }
180: #configUI p { margin: 0.5em 0; padding: 0.3em; background: #EEEEEE; color: black; border: inset thin; }
181: #configUI p label { display: block; }
182: #configUI #updateUI, #configUI .loginUI { text-align: center; }
183: #configUI input[type=button] { display: block; margin: auto; }
1.121 mike 184:
1.1 mike 185: </style><style type="text/css">
186:
187: .applies thead th > * { display: block; }
188: .applies thead code { display: block; }
189: .applies tbody th { whitespace: nowrap; }
190: .applies td { text-align: center; }
191: .applies .yes { background: yellow; }
192:
1.136 ! mike 193: .matrix, .matrix td { border: hidden; text-align: right; }
1.1 mike 194: .matrix { margin-left: 2em; }
195:
196: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
197: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
198: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
199:
200: #table-example-1 { border: solid thin; border-collapse: collapse; margin-left: 3em; }
201: #table-example-1 * { font-family: "Essays1743", serif; line-height: 1.01em; }
202: #table-example-1 caption { padding-bottom: 0.5em; }
203: #table-example-1 thead, #table-example-1 tbody { border: none; }
204: #table-example-1 th, #table-example-1 td { border: solid thin; }
205: #table-example-1 th { font-weight: normal; }
206: #table-example-1 td { border-style: none solid; vertical-align: top; }
207: #table-example-1 th { padding: 0.5em; vertical-align: middle; text-align: center; }
208: #table-example-1 tbody tr:first-child td { padding-top: 0.5em; }
209: #table-example-1 tbody tr:last-child td { padding-bottom: 1.5em; }
210: #table-example-1 tbody td:first-child { padding-left: 2.5em; padding-right: 0; width: 9em; }
211: #table-example-1 tbody td:first-child::after { content: leader(". "); }
212: #table-example-1 tbody td { padding-left: 2em; padding-right: 2em; }
213: #table-example-1 tbody td:first-child + td { width: 10em; }
214: #table-example-1 tbody td:first-child + td ~ td { width: 2.5em; }
215: #table-example-1 tbody td:first-child + td + td + td ~ td { width: 1.25em; }
216:
217: .apple-table-examples { border: none; border-collapse: separate; border-spacing: 1.5em 0em; width: 40em; margin-left: 3em; }
218: .apple-table-examples * { font-family: "Times", serif; }
219: .apple-table-examples td, .apple-table-examples th { border: none; white-space: nowrap; padding-top: 0; padding-bottom: 0; }
220: .apple-table-examples tbody th:first-child { border-left: none; width: 100%; }
221: .apple-table-examples thead th:first-child ~ th { font-size: smaller; font-weight: bolder; border-bottom: solid 2px; text-align: center; }
222: .apple-table-examples tbody th::after, .apple-table-examples tfoot th::after { content: leader(". ") }
223: .apple-table-examples tbody th, .apple-table-examples tfoot th { font: inherit; text-align: left; }
224: .apple-table-examples td { text-align: right; vertical-align: top; }
225: .apple-table-examples.e1 tbody tr:last-child td { border-bottom: solid 1px; }
1.9 mike 226: .apple-table-examples.e1 tbody + tbody tr:last-child td { border-bottom: double 3px; }
227: .apple-table-examples.e2 th[scope=row] { padding-left: 1em; }
228: .apple-table-examples sup { line-height: 0; }
229:
1.11 mike 230: .details-example img { vertical-align: top; }
231:
1.26 mike 232: #named-character-references-table {
233: font-size: 0.6em;
234: column-width: 28em;
235: column-gap: 1em;
236: -moz-column-width: 28em;
237: -moz-column-gap: 1em;
238: -webkit-column-width: 28em;
239: -webkit-column-gap: 1em;
240: }
241: #named-character-references-table > table > tbody > tr > td:last-child { text-align: center; }
242: #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; }
243:
1.35 mike 244: .glyph.control { color: red; }
245:
1.38 mike 246: @font-face {
247: font-family: 'Essays1743';
248: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743.ttf');
249: }
250: @font-face {
251: font-family: 'Essays1743';
252: font-weight: bold;
253: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-Bold.ttf');
254: }
255: @font-face {
256: font-family: 'Essays1743';
257: font-style: italic;
258: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-Italic.ttf');
259: }
260: @font-face {
261: font-family: 'Essays1743';
262: font-style: italic;
263: font-weight: bold;
264: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-BoldItalic.ttf');
265: }
266:
1.25 mike 267: </style><link href="data:text/css," id="complete" rel="stylesheet" title="Complete specification"><link href="data:text/css,.impl%20%7B%20display:%20none;%20%7D%0Ahtml%20%7B%20border:%20solid%20yellow;%20%7D%20.domintro:before%20%7B%20display:%20none;%20%7D" id="author" rel="alternate stylesheet" title="Author documentation only"><link href="data:text/css,.impl%20%7B%20background:%20%23FFEEEE;%20%7D%20.domintro:before%20%7B%20background:%20%23FFEEEE;%20%7D" id="highlight" rel="alternate stylesheet" title="Highlight implementation requirements"><script type="text/javascript">
1.9 mike 268: function getCookie(name) {
269: var params = location.search.substr(1).split("&");
270: for (var index = 0; index < params.length; index++) {
271: if (params[index] == name)
272: return "1";
273: var data = params[index].split("=");
274: if (data[0] == name)
275: return unescape(data[1]);
276: }
277: var cookies = document.cookie.split("; ");
278: for (var index = 0; index < cookies.length; index++) {
279: var data = cookies[index].split("=");
280: if (data[0] == name)
281: return unescape(data[1]);
282: }
283: return null;
284: }
285: function load(script) {
286: var e = document.createElement('script');
287: e.setAttribute('src', 'http://www.whatwg.org/specs/web-apps/current-work/' + script + '?' + encodeURIComponent(location) + '&' + encodeURIComponent(document.referrer));
288: document.body.appendChild(e);
289: }
290: function init() {
291: if (location.search == '?slow-browser')
292: return;
293: var configUI = document.createElement('div');
294: configUI.id = 'configUI';
295: document.body.appendChild(configUI);
296: // load('reviewer.js'); // would need cross-site XHR
297: if (document.getElementById('head'))
298: load('toc.js');
299:
300: // load('updater.js'); // would need cross-site XHR
1.11 mike 301: load('dfn.js'); // doesn't support split-out specs, but, oh well.
1.9 mike 302: // load('status.js'); // would need cross-site XHR
303: if (getCookie('profile') == '1')
304: document.getElementsByTagName('h2')[0].textContent += '; load: ' + (new Date() - loadTimer) + 'ms';
305: fixBrokenLink();
306: }
1.54 mike 307: </script><link href="http://www.w3.org/StyleSheets/TR/W3C-ED" rel="stylesheet" type="text/css"><link href="style.css" rel="stylesheet"><script src="link-fixup.js"></script><link href="common-input-element-attributes.html" rel="prev" title="4.10.7.2 Common input element attributes">
1.48 mike 308: <link href="Overview.html#contents" rel="index" title="Table of contents">
309: <link href="association-of-controls-and-forms.html" rel="next" title="4.10.18 Association of controls and forms">
310: <body onload="fixBrokenLink(); init()"><div class="head" id="head">
1.9 mike 311: <p><a href="http://www.w3.org/"><img alt="W3C" height="48" src="http://www.w3.org/Icons/w3c_home" width="72"></a></p>
1.36 mike 312:
1.136 ! mike 313: <h1>HTML5 (Edition for Web Authors)<span class="rcsrevision"> revision 1.4206</span></h1>
1.9 mike 314: </div><div>
1.48 mike 315: <a href="common-input-element-attributes.html">← 4.10.7.2 Common input element attributes</a> –
316: <a href="Overview.html#contents">Table of contents</a> –
317: <a href="association-of-controls-and-forms.html">4.10.18 Association of controls and forms →</a>
318: <ol class="toc"><li><ol><li><ol><li><a href="the-button-element.html#the-button-element"><span class="secno">4.10.8 </span>The <code>button</code> element</a><li><a href="the-button-element.html#the-select-element"><span class="secno">4.10.9 </span>The <code>select</code> element</a><li><a href="the-button-element.html#the-datalist-element"><span class="secno">4.10.10 </span>The <code>datalist</code> element</a><li><a href="the-button-element.html#the-optgroup-element"><span class="secno">4.10.11 </span>The <code>optgroup</code> element</a><li><a href="the-button-element.html#the-option-element"><span class="secno">4.10.12 </span>The <code>option</code> element</a><li><a href="the-button-element.html#the-textarea-element"><span class="secno">4.10.13 </span>The <code>textarea</code> element</a><li><a href="the-button-element.html#the-keygen-element"><span class="secno">4.10.14 </span>The <code>keygen</code> element</a><li><a href="the-button-element.html#the-output-element"><span class="secno">4.10.15 </span>The <code>output</code> element</a><li><a href="the-button-element.html#the-progress-element"><span class="secno">4.10.16 </span>The <code>progress</code> element</a><li><a href="the-button-element.html#the-meter-element"><span class="secno">4.10.17 </span>The <code>meter</code> element</a></ol></ol></ol></div>
1.9 mike 319:
1.48 mike 320: <h4 id="the-button-element"><span class="secno">4.10.8 </span>The <dfn><code>button</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i><dl class="element"><dt>Categories</dt>
1.9 mike 321: <dd><a href="content-models.html#flow-content">Flow content</a>.</dd>
322: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>.</dd>
323: <dd><a href="content-models.html#interactive-content">Interactive content</a>.</dd>
324: <dd><a href="forms.html#category-listed" title="category-listed">Listed</a>, <a href="forms.html#category-label" title="category-label">labelable</a>, and <a href="forms.html#category-submit" title="category-submit">submittable</a> <a href="forms.html#form-associated-element">form-associated element</a>.</dd>
325: <dt>Contexts in which this element may be used:</dt>
326: <dd>Where <a href="content-models.html#phrasing-content">phrasing content</a> is expected.</dd>
327: <dt>Content model:</dt>
328: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>, but there must be no <a href="content-models.html#interactive-content">interactive content</a> descendant.</dd>
329: <dt>Content attributes:</dt>
330: <dd><a href="elements.html#global-attributes">Global attributes</a></dd>
331: <dd><code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus">autofocus</a></code></dd>
332: <dd><code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled">disabled</a></code></dd>
333: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code></dd>
334: <dd><code title="attr-fs-formaction"><a href="association-of-controls-and-forms.html#attr-fs-formaction">formaction</a></code></dd>
335: <dd><code title="attr-fs-formenctype"><a href="association-of-controls-and-forms.html#attr-fs-formenctype">formenctype</a></code></dd>
336: <dd><code title="attr-fs-formmethod"><a href="association-of-controls-and-forms.html#attr-fs-formmethod">formmethod</a></code></dd>
337: <dd><code title="attr-fs-formnovalidate"><a href="association-of-controls-and-forms.html#attr-fs-formnovalidate">formnovalidate</a></code></dd>
338: <dd><code title="attr-fs-formtarget"><a href="association-of-controls-and-forms.html#attr-fs-formtarget">formtarget</a></code></dd>
339: <dd><code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name">name</a></code></dd>
340: <dd><code title="attr-button-type"><a href="#attr-button-type">type</a></code></dd>
341: <dd><code title="attr-button-value"><a href="#attr-button-value">value</a></code></dd>
342: <dt>DOM interface:</dt>
343: <dd>
344: <pre class="idl">interface <dfn id="htmlbuttonelement">HTMLButtonElement</dfn> : <a href="elements.html#htmlelement">HTMLElement</a> {
1.48 mike 345: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-autofocus" title='Read about this "autofocus" reference in the full HTML5 spec.'>autofocus</a>;
346: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
347: readonly attribute <a href="forms.html#htmlformelement">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
348: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fs-formaction" title='Read about this "formAction" reference in the full HTML5 spec.'>formAction</a>;
349: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fs-formenctype" title='Read about this "formEnctype" reference in the full HTML5 spec.'>formEnctype</a>;
350: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fs-formmethod" title='Read about this "formMethod" reference in the full HTML5 spec.'>formMethod</a>;
351: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fs-formnovalidate" title='Read about this "formNoValidate" reference in the full HTML5 spec.'>formNoValidate</a>;
352: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fs-formtarget" title='Read about this "formTarget" reference in the full HTML5 spec.'>formTarget</a>;
353: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-name" title='Read about this "name" reference in the full HTML5 spec.'>name</a>;
354: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-button-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a>;
355: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-button-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
356:
357: readonly attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-willvalidate" title='Read about this "willValidate" reference in the full HTML5 spec.'>willValidate</a>;
358: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#validitystate" title='Read about this "ValidityState" reference in the full HTML5 spec.'>ValidityState</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validity" title='Read about this "validity" reference in the full HTML5 spec.'>validity</a>;
359: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validationmessage" title='Read about this "validationMessage" reference in the full HTML5 spec.'>validationMessage</a>;
360: boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-checkvalidatity" title='Read about this "checkValidity" reference in the full HTML5 spec.'>checkValidity</a>();
361: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-setcustomvalidity" title='Read about this "setCustomValidity" reference in the full HTML5 spec.'>setCustomValidity</a>(in DOMString error);
1.9 mike 362:
1.48 mike 363: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.9 mike 364: };</pre>
365: </dd>
1.48 mike 366: </dl><p>The <code><a href="#the-button-element">button</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a
367: button. <p>The element is a <a href="forms.html#concept-button" title="concept-button">button</a>.<p>The <dfn id="attr-button-type" title="attr-button-type"><code>type</code></dfn>
1.9 mike 368: attribute controls the behavior of the button when it is activated.
369: It is an <a href="common-microsyntaxes.html#enumerated-attribute">enumerated attribute</a>. The following table
1.48 mike 370: lists the keywords and states for the attribute — the keywords
1.9 mike 371: in the left column map to the states in the cell in the second
1.48 mike 372: column on the same row as the keyword.<table><thead><tr><th> Keyword
373: <th> State
374: <th> Brief description
375: <tbody><tr><td><dfn id="attr-button-type-submit" title="attr-button-type-submit"><code>submit</code></dfn>
376: <td><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-submit-state" title='Read about this "Submit Button" reference in the full HTML5 spec.'>Submit Button</a>
377: <td>Submits the form.
378: <tr><td><dfn id="attr-button-type-reset" title="attr-button-type-reset"><code>reset</code></dfn>
379: <td><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-reset-state" title='Read about this "Reset Button" reference in the full HTML5 spec.'>Reset Button</a>
380: <td>Resets the form.
381: <tr><td><dfn id="attr-button-type-button" title="attr-button-type-button"><code>button</code></dfn>
382: <td><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-button-state" title='Read about this "Button" reference in the full HTML5 spec.'>Button</a>
383: <td>Does nothing.
384: </table><p>The <i>missing value default</i> is the <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-submit-state" title='Read about this "Submit Button" reference in the full HTML5 spec.'>Submit Button</a>
385: state.<p>If the <code title="attr-button-type"><a href="#attr-button-type">type</a></code> attribute is in
386: the <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-submit-state" title='Read about this "Submit Button" reference in the full HTML5 spec.'>Submit Button</a>
387: state, the element is specifically a <a href="forms.html#concept-submit-button" title="concept-submit-button">submit button</a>.<p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code> attribute is used to
1.9 mike 388: explicitly associate the <code><a href="#the-button-element">button</a></code> element with its
389: <a href="association-of-controls-and-forms.html#form-owner">form owner</a>. The <code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name">name</a></code>
390: attribute represents the element's name. The <code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled">disabled</a></code> attribute is used to make
391: the control non-interactive and to prevent its value from being
392: submitted. The <code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus">autofocus</a></code>
393: attribute controls focus. The <code title="attr-fs-formaction"><a href="association-of-controls-and-forms.html#attr-fs-formaction">formaction</a></code>, <code title="attr-fs-formenctype"><a href="association-of-controls-and-forms.html#attr-fs-formenctype">formenctype</a></code>, <code title="attr-fs-formmethod"><a href="association-of-controls-and-forms.html#attr-fs-formmethod">formmethod</a></code>, <code title="attr-fs-formnovalidate"><a href="association-of-controls-and-forms.html#attr-fs-formnovalidate">formnovalidate</a></code>, and <code title="attr-fs-formtarget"><a href="association-of-controls-and-forms.html#attr-fs-formtarget">formtarget</a></code> attributes are
1.48 mike 394: <a href="association-of-controls-and-forms.html#attributes-for-form-submission">attributes for form submission</a>.<p class="note">The <code title="attr-fs-formnovalidate"><a href="association-of-controls-and-forms.html#attr-fs-formnovalidate">formnovalidate</a></code> attribute can
1.9 mike 395: be used to make submit buttons that do not trigger the constraint
1.48 mike 396: validation.<p>The <code title="attr-fs-formaction"><a href="association-of-controls-and-forms.html#attr-fs-formaction">formaction</a></code>, <code title="attr-fs-formenctype"><a href="association-of-controls-and-forms.html#attr-fs-formenctype">formenctype</a></code>, <code title="attr-fs-formmethod"><a href="association-of-controls-and-forms.html#attr-fs-formmethod">formmethod</a></code>, <code title="attr-fs-formnovalidate"><a href="association-of-controls-and-forms.html#attr-fs-formnovalidate">formnovalidate</a></code>, and <code title="attr-fs-formtarget"><a href="association-of-controls-and-forms.html#attr-fs-formtarget">formtarget</a></code> must not be specified
1.15 mike 397: if the element's <code title="attr-button-type"><a href="#attr-button-type">type</a></code>
1.48 mike 398: attribute is not in the <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-submit-state" title='Read about this "Submit Button" reference in the full HTML5 spec.'>Submit Button</a>
399: state.<p>The <dfn id="attr-button-value" title="attr-button-value"><code>value</code></dfn>
1.9 mike 400: attribute gives the element's value for the purposes of form
1.48 mike 401: submission. The element's <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#concept-fe-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a> is the value of the element's
1.10 mike 402: <code title="attr-button-value"><a href="#attr-button-value">value</a></code> attribute, if there is
1.48 mike 403: one, or the empty string otherwise.<p class="note">A button (and its value) is only included in the
1.9 mike 404: form submission if the button itself was used to initiate the form
1.48 mike 405: submission.<div class="example">
1.9 mike 406:
407: <p>The following button is labeled "Show hint" and pops up a dialog
408: box when activated:</p>
409:
410: <pre><button type=button
411: onclick="alert('This 15-20 minute piece was composed by George Gershwin.')">
412: Show hint
413: </button></pre>
414:
1.48 mike 415: </div><h4 id="the-select-element"><span class="secno">4.10.9 </span>The <dfn><code>select</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i><dl class="element"><dt>Categories</dt>
1.9 mike 416: <dd><a href="content-models.html#flow-content">Flow content</a>.</dd>
417: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>.</dd>
418: <dd><a href="content-models.html#interactive-content">Interactive content</a>.</dd>
419: <dd><a href="forms.html#category-listed" title="category-listed">Listed</a>, <a href="forms.html#category-label" title="category-label">labelable</a>, <a href="forms.html#category-submit" title="category-submit">submittable</a>, and <a href="forms.html#category-reset" title="category-reset">resettable</a> <a href="forms.html#form-associated-element">form-associated element</a>.</dd>
420: <dt>Contexts in which this element may be used:</dt>
421: <dd>Where <a href="content-models.html#phrasing-content">phrasing content</a> is expected.</dd>
422: <dt>Content model:</dt>
423: <dd>Zero or more <code><a href="#the-option-element">option</a></code> or <code><a href="#the-optgroup-element">optgroup</a></code> elements.</dd>
424: <dt>Content attributes:</dt>
425: <dd><a href="elements.html#global-attributes">Global attributes</a></dd>
426: <dd><code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus">autofocus</a></code></dd>
427: <dd><code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled">disabled</a></code></dd>
428: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code></dd>
429: <dd><code title="attr-select-multiple"><a href="#attr-select-multiple">multiple</a></code></dd>
430: <dd><code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name">name</a></code></dd>
431: <dd><code title="attr-select-size"><a href="#attr-select-size">size</a></code></dd>
432: <dt>DOM interface:</dt>
433: <dd>
434: <pre class="idl">interface <dfn id="htmlselectelement">HTMLSelectElement</dfn> : <a href="elements.html#htmlelement">HTMLElement</a> {
1.48 mike 435: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-autofocus" title='Read about this "autofocus" reference in the full HTML5 spec.'>autofocus</a>;
436: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
437: readonly attribute <a href="forms.html#htmlformelement">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
438: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-multiple" title='Read about this "multiple" reference in the full HTML5 spec.'>multiple</a>;
439: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-name" title='Read about this "name" reference in the full HTML5 spec.'>name</a>;
440: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-size" title='Read about this "size" reference in the full HTML5 spec.'>size</a>;
441:
442: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a>;
443:
444: readonly attribute <a href="urls.html#htmloptionscollection">HTMLOptionsCollection</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-options" title='Read about this "options" reference in the full HTML5 spec.'>options</a>;
445: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-length" title='Read about this "length" reference in the full HTML5 spec.'>length</a>;
446: caller getter any <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-item" title='Read about this "item" reference in the full HTML5 spec.'>item</a>(in unsigned long index);
447: caller getter any <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-nameditem" title='Read about this "namedItem" reference in the full HTML5 spec.'>namedItem</a>(in DOMString name);
448: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-add" title='Read about this "add" reference in the full HTML5 spec.'>add</a>(in <a href="elements.html#htmlelement">HTMLElement</a> element, in optional <a href="elements.html#htmlelement">HTMLElement</a> before);
449: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-add" title='Read about this "add" reference in the full HTML5 spec.'>add</a>(in <a href="elements.html#htmlelement">HTMLElement</a> element, in long before);
450: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-remove" title='Read about this "remove" reference in the full HTML5 spec.'>remove</a>(in long index);
451:
452: readonly attribute <a href="urls.html#htmlcollection">HTMLCollection</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-selectedoptions" title='Read about this "selectedOptions" reference in the full HTML5 spec.'>selectedOptions</a>;
453: attribute long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-selectedindex" title='Read about this "selectedIndex" reference in the full HTML5 spec.'>selectedIndex</a>;
454: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
455:
456: readonly attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-willvalidate" title='Read about this "willValidate" reference in the full HTML5 spec.'>willValidate</a>;
457: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#validitystate" title='Read about this "ValidityState" reference in the full HTML5 spec.'>ValidityState</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validity" title='Read about this "validity" reference in the full HTML5 spec.'>validity</a>;
458: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validationmessage" title='Read about this "validationMessage" reference in the full HTML5 spec.'>validationMessage</a>;
459: boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-checkvalidatity" title='Read about this "checkValidity" reference in the full HTML5 spec.'>checkValidity</a>();
460: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-setcustomvalidity" title='Read about this "setCustomValidity" reference in the full HTML5 spec.'>setCustomValidity</a>(in DOMString error);
1.9 mike 461:
1.48 mike 462: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.9 mike 463: };</pre>
464: </dd>
465: </dl><!-- Proposals for v2:
466: * <select value=""> as an alternative to <option selected>
467: http://developers.slashdot.org/comments.pl?sid=426306&cid=22142072
1.11 mike 468: <Philip`> http://www.ipiao.com.cn/ does <select size="1" name="to"><script type="text/javascript">City_Default="PEK"</script><SCRIPT language=javascript
1.9 mike 469: src="/js/flightcity.js"></SCRIPT></select> which is the kind of thing that could be much simpler with <select value="PEK">
470: * a way to make the <select> not have a default value at all (ack
471: or to have a "placeholer" like value that doesn't count as a value being selected but shows a prompt until a value is selected
472: * once we can have no default, a way to require="" a value.
473: ack Weston Ruter: http://weston.ruter.net/projects/test-cases/html-select-element/
474: q.v. http://lists.whatwg.org/pipermail/whatwg-whatwg.org/2008-November/017583.html
475: --><p>The <code><a href="#the-select-element">select</a></code> element represents a control for
1.48 mike 476: selecting amongst a set of options.<p>The <dfn id="attr-select-multiple" title="attr-select-multiple"><code>multiple</code></dfn>
1.9 mike 477: attribute is a <a href="common-microsyntaxes.html#boolean-attribute">boolean attribute</a>. If the attribute is
478: present, then the <code><a href="#the-select-element">select</a></code> element
1.48 mike 479: <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a control for selecting zero or more options
1.9 mike 480: from the <a href="#concept-select-option-list" title="concept-select-option-list">list of
481: options</a>. If the attribute is absent, then the
1.48 mike 482: <code><a href="#the-select-element">select</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a control for
483: selecting a single option from the <a href="#concept-select-option-list" title="concept-select-option-list">list of options</a>.<p>The <dfn id="concept-select-option-list" title="concept-select-option-list">list of options</dfn>
1.9 mike 484: for a <code><a href="#the-select-element">select</a></code> element consists of all the
485: <code><a href="#the-option-element">option</a></code> element children of the <code><a href="#the-select-element">select</a></code>
486: element, and all the <code><a href="#the-option-element">option</a></code> element children of all the
487: <code><a href="#the-optgroup-element">optgroup</a></code> element children of the <code><a href="#the-select-element">select</a></code>
1.48 mike 488: element, in <a href="infrastructure.html#tree-order">tree order</a>.<p>The <dfn id="attr-select-size" title="attr-select-size"><code>size</code></dfn>
1.9 mike 489: attribute gives the number of options to show to the user. The <code title="attr-input-size"><a href="common-input-element-attributes.html#attr-input-size">size</a></code> attribute, if specified, must
490: have a value that is a <a href="common-microsyntaxes.html#valid-non-negative-integer">valid non-negative integer</a>
491: greater than zero. If the <code title="attr-select-multiple"><a href="#attr-select-multiple">multiple</a></code> attribute is present,
492: then the <code title="attr-input-size"><a href="common-input-element-attributes.html#attr-input-size">size</a></code> attribute's
493: default value is 4. If the <code title="attr-select-multiple"><a href="#attr-select-multiple">multiple</a></code> attribute is absent,
494: then the <code title="attr-input-size"><a href="common-input-element-attributes.html#attr-input-size">size</a></code> attribute's
1.48 mike 495: default value is 1.<p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code> attribute is used to
1.9 mike 496: explicitly associate the <code><a href="#the-select-element">select</a></code> element with its
497: <a href="association-of-controls-and-forms.html#form-owner">form owner</a>. The <code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name">name</a></code>
498: attribute represents the element's name. The <code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled">disabled</a></code> attribute is used to make
499: the control non-interactive and to prevent its value from being
500: submitted. The <code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus">autofocus</a></code>
1.48 mike 501: attribute controls focus.<dl class="domintro"><dt><var title="">select</var> . <code title="dom-select-type"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a></code></dt>
1.9 mike 502:
503: <dd>
504:
505: <p>Returns "<code title="">select-multiple</code>" if the element
506: has a <code title="attr-select-multiple"><a href="#attr-select-multiple">multiple</a></code>
507: attribute, and "<code title="">select-one</code>"
508: otherwise.</p>
509:
510: </dd>
511:
1.48 mike 512: <dt><var title="">select</var> . <code title="dom-select-options"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-options" title='Read about this "options" reference in the full HTML5 spec.'>options</a></code></dt>
1.9 mike 513:
514: <dd>
515:
516: <p>Returns an <code><a href="urls.html#htmloptionscollection">HTMLOptionsCollection</a></code> of the <a href="#concept-select-option-list" title="concept-select-option-list">list of options</a>.</p>
517:
518: </dd>
519:
1.48 mike 520: <dt><var title="">select</var> . <code title="dom-select-length"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-length" title='Read about this "length" reference in the full HTML5 spec.'>length</a></code> [ = <var title="">value</var> ]</dt>
1.9 mike 521: <dd>
522: <p>Returns the number of elements in the <a href="#concept-select-option-list" title="concept-select-option-list">list of options</a>.</p>
523: <p>When set to a smaller number, truncates the number of <code><a href="#the-option-element">option</a></code> elements in the <code><a href="#the-select-element">select</a></code>.</p>
524: <p>When set to a greater number, adds new blank <code><a href="#the-option-element">option</a></code> elements to the <code><a href="#the-select-element">select</a></code>.</p>
525: </dd>
526:
1.48 mike 527: <dt><var title="">element</var> = <var title="">select</var> . <code title="dom-select-item"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-item" title='Read about this "item" reference in the full HTML5 spec.'>item</a></code>(<var title="">index</var>)</dt>
1.9 mike 528: <dt><var title="">select</var>[<var title="">index</var>]</dt>
529: <dt><var title="">select</var>(<var title="">index</var>)</dt>
530: <dd>
531: <p>Returns the item with index <var title="">index</var> from the <a href="#concept-select-option-list" title="concept-select-option-list">list of options</a>. The items are sorted in <a href="infrastructure.html#tree-order">tree order</a>.</p>
532: <p>Returns null if <var title="">index</var> is out of range.</p>
533: </dd>
534:
1.48 mike 535: <dt><var title="">element</var> = <var title="">select</var> . <code title="dom-select-item"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-item" title='Read about this "namedItem" reference in the full HTML5 spec.'>namedItem</a></code>(<var title="">name</var>)</dt>
1.9 mike 536: <dt><var title="">select</var>[<var title="">name</var>]</dt>
537: <dt><var title="">select</var>(<var title="">name</var>)</dt>
538: <dd>
1.28 mike 539: <p>Returns the item with ID or <code title="attr-option-name"><a href="obsolete.html#attr-option-name">name</a></code> <var title="">name</var> from the <a href="#concept-select-option-list" title="concept-select-option-list">list of options</a>.</p>
1.48 mike 540: <p>If there are multiple matching items, then a <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a></code> object containing all those elements is returned.</p>
1.9 mike 541: <p>Returns null if no element with that ID could be found.</p>
542: </dd>
543:
1.48 mike 544: <dt><var title="">select</var> . <code title="dom-select-add"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-add" title='Read about this "add" reference in the full HTML5 spec.'>add</a></code>(<var title="">element</var> [, <var title="">before</var> ])</dt>
1.9 mike 545: <dd>
546: <p>Inserts <var title="">element</var> before the node given by <var title="">before</var>.</p>
547: <p>The <var title="">before</var> argument can be a number, in
548: which case <var title="">element</var> is inserted before the item
549: with that number, or an element from the <a href="#concept-select-option-list" title="concept-select-option-list">list of options</a>, in
550: which case <var title="">element</var> is inserted before that
551: element.</p>
552: <p>If <var title="">before</var> is omitted, null, or a number out
553: of range, then <var title="">element</var> will be added at the
554: end of the list.</p>
555: <p>This method will throw a <code><a href="urls.html#hierarchy_request_err">HIERARCHY_REQUEST_ERR</a></code>
556: exception if <var title="">element</var> is an ancestor of the
557: element into which it is to be inserted. If <var title="">element</var> is not an <code><a href="#the-option-element">option</a></code> or
558: <code><a href="#the-optgroup-element">optgroup</a></code> element, then the method does nothing.</p>
559: </dd>
560:
1.48 mike 561: <dt><var title="">select</var> . <code title="dom-select-selectedOptions"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-selectedoptions" title='Read about this "selectedOptions" reference in the full HTML5 spec.'>selectedOptions</a></code></dt>
1.9 mike 562:
563: <dd>
564:
565: <p>Returns an <code><a href="urls.html#htmlcollection">HTMLCollection</a></code> of the <a href="#concept-select-option-list" title="concept-select-option-list">list of options</a> that are
566: selected.</p>
567:
568: </dd>
569:
1.48 mike 570: <dt><var title="">select</var> . <code title="dom-select-selectedIndex"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-selectedindex" title='Read about this "selectedIndex" reference in the full HTML5 spec.'>selectedIndex</a></code> [ = <var title="">value</var> ]</dt>
1.9 mike 571:
572: <dd>
573:
574: <p>Returns the index of the first selected item, if any, or
1.48 mike 575: −1 if there is no selected item.</p>
1.9 mike 576:
577: <p>Can be set, to change the selection.</p>
578:
579: </dd>
580:
1.48 mike 581: <dt><var title="">select</var> . <code title="dom-select-value"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a></code> [ = <var title="">value</var> ]</dt>
1.9 mike 582:
583: <dd>
584:
1.48 mike 585: <p>Returns the <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#concept-fe-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a> of the
1.9 mike 586: first selected item, if any, or the empty string if there is no
587: selected item.</p>
588:
589: <p>Can be set, to change the selection.</p>
590:
591: </dd>
592:
593: </dl><div class="example">
594:
595: <p>The following example shows how a <code><a href="#the-select-element">select</a></code> element
596: can be used to offer the user with a set of options from which the
597: user can select a single option. The default option is
598: preselected.</p>
599:
600: <pre><p>
601: <label for="unittype">Select unit type:</label>
602: <select id="unittype" name="unittype">
603: <option value="1"> Miner </option>
604: <option value="2"> Puffer </option>
605: <option value="3" selected> Snipey </option>
606: <option value="4"> Max </option>
607: <option value="5"> Firebot </option>
608: </select>
609: </p></pre>
610:
611: </div><div class="example">
612:
613: <p>Here, the user is offered a set of options from which he can
614: select any number. By default, all five options are selected.</p>
615:
616: <pre><p>
617: <label for="allowedunits">Select unit types to enable on this map:</label>
618: <select id="allowedunits" name="allowedunits" multiple>
619: <option value="1" selected> Miner </option>
620: <option value="2" selected> Puffer </option>
621: <option value="3" selected> Snipey </option>
622: <option value="4" selected> Max </option>
623: <option value="5" selected> Firebot </option>
624: </select>
625: </p></pre>
626:
1.48 mike 627: </div><h4 id="the-datalist-element"><span class="secno">4.10.10 </span>The <dfn><code>datalist</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i><dl class="element"><dt>Categories</dt>
1.9 mike 628: <dd><a href="content-models.html#flow-content">Flow content</a>.</dd>
629: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>.</dd>
630: <dt>Contexts in which this element may be used:</dt>
631: <dd>Where <a href="content-models.html#phrasing-content">phrasing content</a> is expected.</dd>
632: <dt>Content model:</dt>
633: <dd>Either: <a href="content-models.html#phrasing-content">phrasing content</a>.</dd>
634: <dd>Or: Zero or more <code><a href="#the-option-element">option</a></code> elements.</dd>
635: <dt>Content attributes:</dt>
636: <dd><a href="elements.html#global-attributes">Global attributes</a></dd>
637: <dt>DOM interface:</dt>
638: <dd>
639: <pre class="idl">interface <dfn id="htmldatalistelement">HTMLDataListElement</dfn> : <a href="elements.html#htmlelement">HTMLElement</a> {
1.48 mike 640: readonly attribute <a href="urls.html#htmlcollection">HTMLCollection</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-datalist-options" title='Read about this "options" reference in the full HTML5 spec.'>options</a>;
1.9 mike 641: };</pre>
642: </dd>
643: </dl><p>The <code><a href="#the-datalist-element">datalist</a></code> element represents a set of
644: <code><a href="#the-option-element">option</a></code> elements that represent predefined options for
645: other controls. The contents of the element represents fallback
646: content for legacy user agents, intermixed with <code><a href="#the-option-element">option</a></code>
647: elements that represent the predefined options. In the rendering,
1.48 mike 648: the <code><a href="#the-datalist-element">datalist</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a>
649: nothing.<p>The <code><a href="#the-datalist-element">datalist</a></code> element is hooked up to an
1.9 mike 650: <code><a href="the-input-element.html#the-input-element">input</a></code> element using the <code title="attr-input-list"><a href="common-input-element-attributes.html#attr-input-list">list</a></code> attribute on the
651: <code><a href="the-input-element.html#the-input-element">input</a></code> element. <!-- v2DATAGRID The
652: <code>datalist</code> element can also be used with a
653: <code>datagrid</code> element, as the source of autocompletion hints
654: for <code title="datagrid-type-editable">editable</code>
1.48 mike 655: cells. --><p>Each <code><a href="#the-option-element">option</a></code> element that is a descendant of the
1.9 mike 656: <code><a href="#the-datalist-element">datalist</a></code> element, that is not <a href="#concept-option-disabled" title="concept-option-disabled">disabled</a>, and whose <a href="#concept-option-value" title="concept-option-value">value</a> is a string that isn't the
657: empty string, represents a suggestion. Each suggestion has a <a href="#concept-option-value" title="concept-option-value">value</a> and a <a href="#concept-option-label" title="concept-option-label">label</a>.
658:
1.48 mike 659: <dl class="domintro"><dt><var title="">datalist</var> . <code title="dom-datalist-options"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-datalist-options" title='Read about this "options" reference in the full HTML5 spec.'>options</a></code></dt>
1.9 mike 660:
661: <dd>
662: <p>Returns an <code><a href="urls.html#htmlcollection">HTMLCollection</a></code> of the <code>options</code> elements of the table.</p>
663: </dd>
664:
1.48 mike 665: </dl><h4 id="the-optgroup-element"><span class="secno">4.10.11 </span>The <dfn><code>optgroup</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i><dl class="element"><dt>Categories</dt>
1.9 mike 666: <dd>None.</dd>
667: <dt>Contexts in which this element may be used:</dt>
668: <dd>As a child of a <code><a href="#the-select-element">select</a></code> element.</dd>
669: <dt>Content model:</dt>
670: <dd>Zero or more <code><a href="#the-option-element">option</a></code> elements.</dd>
671: <dt>Content attributes:</dt>
672: <dd><a href="elements.html#global-attributes">Global attributes</a></dd>
673: <dd><code title="attr-optgroup-disabled"><a href="#attr-optgroup-disabled">disabled</a></code></dd>
674: <dd><code title="attr-optgroup-label"><a href="#attr-optgroup-label">label</a></code></dd>
675: <dt>DOM interface:</dt>
676: <dd>
677: <pre class="idl">interface <dfn id="htmloptgroupelement">HTMLOptGroupElement</dfn> : <a href="elements.html#htmlelement">HTMLElement</a> {
1.48 mike 678: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-optgroup-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
679: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-optgroup-label" title='Read about this "label" reference in the full HTML5 spec.'>label</a>;
1.9 mike 680: };</pre>
681: </dd>
1.48 mike 682: </dl><!-- v2: make optgroups selectable if they have a value. --><p>The <code><a href="#the-optgroup-element">optgroup</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a group of
683: <code><a href="#the-option-element">option</a></code> elements with a common label.<p>The element's group of <code><a href="#the-option-element">option</a></code> elements consists of
1.9 mike 684: the <code><a href="#the-option-element">option</a></code> elements that are children of the
1.48 mike 685: <code><a href="#the-optgroup-element">optgroup</a></code> element.<p>The <dfn id="attr-optgroup-disabled" title="attr-optgroup-disabled"><code>disabled</code></dfn> attribute
1.9 mike 686: is a <a href="common-microsyntaxes.html#boolean-attribute">boolean attribute</a> and can be used to <a href="#concept-option-disabled" title="concept-option-disabled">disable</a> a group of
1.48 mike 687: <code><a href="#the-option-element">option</a></code> elements together.<p>The <dfn id="attr-optgroup-label" title="attr-optgroup-label"><code>label</code></dfn>
1.9 mike 688: attribute must be specified. Its value gives the name of the group,
1.48 mike 689: for the purposes of the user interface. <div class="example">
1.9 mike 690:
691: <p>The following snippet shows how a set of lessons from three
692: courses could be offered in a <code><a href="#the-select-element">select</a></code> drop-down
693: widget:</p>
694:
695: <pre><form action="courseselector.dll" method="get">
696: <p>Which course would you like to watch today?
697: <p><label>Course:
698: <select name="c">
699: <optgroup label="8.01 Physics I: Classical Mechanics">
700: <option value="8.01.1">Lecture 01: Powers of Ten
701: <option value="8.01.2">Lecture 02: 1D Kinematics
702: <option value="8.01.3">Lecture 03: Vectors
703: <optgroup label="8.02 Electricity and Magnestism">
704: <option value="8.02.1">Lecture 01: What holds our world together?
705: <option value="8.02.2">Lecture 02: Electric Field
706: <option value="8.02.3">Lecture 03: Electric Flux
707: <optgroup label="8.03 Physics III: Vibrations and Waves">
708: <option value="8.03.1">Lecture 01: Periodic Phenomenon
709: <option value="8.03.2">Lecture 02: Beats
710: <option value="8.03.3">Lecture 03: Forced Oscillations with Damping
711: </select>
712: </label>
1.55 mike 713: <p><input type=submit value="▶ Play">
1.9 mike 714: </form></pre>
715:
1.48 mike 716: </div><h4 id="the-option-element"><span class="secno">4.10.12 </span>The <dfn><code>option</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i><dl class="element"><dt>Categories</dt>
1.9 mike 717: <dd>None.</dd>
718: <dt>Contexts in which this element may be used:</dt>
719: <dd>As a child of a <code><a href="#the-select-element">select</a></code> element.</dd>
720: <dd>As a child of a <code><a href="#the-datalist-element">datalist</a></code> element.</dd>
721: <dd>As a child of an <code><a href="#the-optgroup-element">optgroup</a></code> element.</dd>
722: <dt>Content model:</dt>
723: <dd><a href="content-models.html#text-content" title="text content">Text</a>.</dd>
724: <dt>Content attributes:</dt>
725: <dd><a href="elements.html#global-attributes">Global attributes</a></dd>
726: <dd><code title="attr-option-disabled"><a href="#attr-option-disabled">disabled</a></code></dd>
727: <dd><code title="attr-option-label"><a href="#attr-option-label">label</a></code></dd>
728: <dd><code title="attr-option-selected"><a href="#attr-option-selected">selected</a></code></dd>
729: <dd><code title="attr-option-value"><a href="#attr-option-value">value</a></code></dd>
730: <dt>DOM interface:</dt>
731: <dd>
1.48 mike 732: <pre class="idl">[NamedConstructor=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a>(),
733: NamedConstructor=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-t" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a>(in DOMString text),
734: NamedConstructor=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-tv" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a>(in DOMString text, in DOMString value),
735: NamedConstructor=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-tvd" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a>(in DOMString text, in DOMString value, in boolean defaultSelected),
736: NamedConstructor=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-tvds" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a>(in DOMString text, in DOMString value, in boolean defaultSelected, in boolean selected)]
1.9 mike 737: interface <dfn id="htmloptionelement">HTMLOptionElement</dfn> : <a href="elements.html#htmlelement">HTMLElement</a> {
1.48 mike 738: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
739: readonly attribute <a href="forms.html#htmlformelement">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
740: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-label" title='Read about this "label" reference in the full HTML5 spec.'>label</a>;
741: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-defaultselected" title='Read about this "defaultSelected" reference in the full HTML5 spec.'>defaultSelected</a>;
742: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-selected" title='Read about this "selected" reference in the full HTML5 spec.'>selected</a>;
743: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
1.9 mike 744:
1.48 mike 745: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-text" title='Read about this "text" reference in the full HTML5 spec.'>text</a>;
746: readonly attribute long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-index" title='Read about this "index" reference in the full HTML5 spec.'>index</a>;
1.9 mike 747: };</pre>
748: </dd>
1.48 mike 749: </dl><p>The <code><a href="#the-option-element">option</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> an option
1.9 mike 750: in a <code><a href="#the-select-element">select</a></code> element or as part of a list of suggestions
1.48 mike 751: in a <code><a href="#the-datalist-element">datalist</a></code> element.<p>The <dfn id="attr-option-disabled" title="attr-option-disabled"><code>disabled</code></dfn>
1.9 mike 752: attribute is a <a href="common-microsyntaxes.html#boolean-attribute">boolean attribute</a>. An
753: <code><a href="#the-option-element">option</a></code> element is <dfn id="concept-option-disabled" title="concept-option-disabled">disabled</dfn> if its <code title="attr-option-disabled"><a href="#attr-option-disabled">disabled</a></code> attribute is present or
754: if it is a child of an <code><a href="#the-optgroup-element">optgroup</a></code> element whose <code title="attr-optgroup-disabled"><a href="#attr-optgroup-disabled">disabled</a></code> attribute is
1.48 mike 755: present.<p>The <dfn id="attr-option-label" title="attr-option-label"><code>label</code></dfn>
1.9 mike 756: attribute provides a label for element. The <dfn id="concept-option-label" title="concept-option-label">label</dfn> of an <code><a href="#the-option-element">option</a></code>
757: element is the value of the <code title="attr-option-label"><a href="#attr-option-label">label</a></code> attribute, if there is one,
1.48 mike 758: or the <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#textcontent" title='Read about this "textContent" reference in the full HTML5 spec.'>textContent</a></code> of the element, if there isn't.<p>The <dfn id="attr-option-value" title="attr-option-value"><code>value</code></dfn>
1.9 mike 759: attribute provides a value for element. The <dfn id="concept-option-value" title="concept-option-value">value</dfn> of an <code><a href="#the-option-element">option</a></code>
760: element is the value of the <code title="attr-option-value"><a href="#attr-option-value">value</a></code> attribute, if there is one,
1.48 mike 761: or the <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#textcontent" title='Read about this "textContent" reference in the full HTML5 spec.'>textContent</a></code> of the element, if there isn't.<p>The <dfn id="attr-option-selected" title="attr-option-selected"><code>selected</code></dfn>
762: attribute represents the default <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#concept-option-selectedness" title='Read about this "selectedness" reference in the full HTML5 spec.'>selectedness</a> of the
763: element.<p>A <code><a href="#the-select-element">select</a></code> element whose <code title="attr-select-multiple"><a href="#attr-select-multiple">multiple</a></code> attribute is not
1.33 mike 764: specified must not have more than one descendant <code><a href="#the-option-element">option</a></code>
765: element with its <code title="attr-option-selected"><a href="#attr-option-selected">selected</a></code>
1.48 mike 766: attribute set.<dl class="domintro"><dt><var title="">option</var> . <code title="dom-option-selected"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-selected" title='Read about this "selected" reference in the full HTML5 spec.'>selected</a></code></dt>
1.9 mike 767:
768: <dd>
769:
770: <p>Returns true if the element is selected, and false otherwise.</p>
771:
772: </dd>
773:
1.48 mike 774: <dt><var title="">option</var> . <code title="dom-option-index"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-index" title='Read about this "index" reference in the full HTML5 spec.'>index</a></code></dt>
1.9 mike 775:
776: <dd>
777:
778: <p>Returns the index of the element in its <code><a href="#the-select-element">select</a></code>
1.48 mike 779: element's <code title="dom-select-options"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-options" title='Read about this "options" reference in the full HTML5 spec.'>options</a></code>
1.9 mike 780: list.</p>
781:
782: </dd>
783:
1.48 mike 784: <dt><var title="">option</var> . <code title="dom-option-form"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a></code></dt>
1.9 mike 785:
786: <dd>
787:
788: <p>Returns the element's <code><a href="forms.html#the-form-element">form</a></code> element, if any, or
789: null otherwise.</p>
790:
791: </dd>
792:
1.48 mike 793: <dt><var title="">option</var> . <code title="dom-option-text"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-text" title='Read about this "text" reference in the full HTML5 spec.'>text</a></code></dt>
1.11 mike 794:
795: <dd>
796:
1.48 mike 797: <p>Same as <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#textcontent" title='Read about this "textContent" reference in the full HTML5 spec.'>textContent</a></code>.</p>
1.11 mike 798:
799: </dd>
800:
1.48 mike 801: <dt><var title="">option</var> = new <code title="dom-option"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a></code>( [ <var title="">text</var> [, <var title="">value</var> [, <var title="">defaultSelected</var> [, <var title="">selected</var> ] ] ] ] )</dt>
1.9 mike 802:
803: <dd>
804:
805: <p>Returns a new <code><a href="#the-option-element">option</a></code> element.</p>
806:
807: <p>The <var title="">text</var> argument sets the contents of the element.</p>
808: <p>The <var title="">value</var> argument sets the <code title="attr-option-value"><a href="#attr-option-value">value</a></code> attribute.</p>
809: <p>The <var title="">defaultSelected</var> argument sets the <code title="attr-option-selected"><a href="#attr-option-selected">selected</a></code> attribute.</p>
810: <p>The <var title="">selected</var> argument sets whether or not the element is selected. If it is omitted, even if the <var title="">defaultSelected</var> argument is true, the element is not selected.</p>
811:
812: </dd>
813:
1.48 mike 814: </dl><h4 id="the-textarea-element"><span class="secno">4.10.13 </span>The <dfn><code>textarea</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i><dl class="element"><dt>Categories</dt>
1.9 mike 815: <dd><a href="content-models.html#flow-content">Flow content</a>.</dd>
816: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>.</dd>
817: <dd><a href="content-models.html#interactive-content">Interactive content</a>.</dd>
818: <dd><a href="forms.html#category-listed" title="category-listed">Listed</a>, <a href="forms.html#category-label" title="category-label">labelable</a>, <a href="forms.html#category-submit" title="category-submit">submittable</a>, and <a href="forms.html#category-reset" title="category-reset">resettable</a> <a href="forms.html#form-associated-element">form-associated element</a>.</dd>
819: <dt>Contexts in which this element may be used:</dt>
820: <dd>Where <a href="content-models.html#phrasing-content">phrasing content</a> is expected.</dd>
821: <dt>Content model:</dt>
822: <dd><a href="content-models.html#text-content" title="text content">Text</a>.</dd>
823: <dt>Content attributes:</dt>
824: <dd><a href="elements.html#global-attributes">Global attributes</a></dd>
825: <dd><code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus">autofocus</a></code></dd>
826: <dd><code title="attr-textarea-cols"><a href="#attr-textarea-cols">cols</a></code></dd>
827: <dd><code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled">disabled</a></code></dd>
828: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code></dd>
829: <dd><code title="attr-textarea-maxlength"><a href="#attr-textarea-maxlength">maxlength</a></code></dd>
830: <dd><code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name">name</a></code></dd>
831: <dd><code title="attr-textarea-placeholder"><a href="#attr-textarea-placeholder">placeholder</a></code></dd>
832: <dd><code title="attr-textarea-readonly"><a href="#attr-textarea-readonly">readonly</a></code></dd>
833: <dd><code title="attr-textarea-required"><a href="#attr-textarea-required">required</a></code></dd>
834: <dd><code title="attr-textarea-rows"><a href="#attr-textarea-rows">rows</a></code></dd>
835: <dd><code title="attr-textarea-wrap"><a href="#attr-textarea-wrap">wrap</a></code></dd>
836: <dt>DOM interface:</dt>
837: <dd>
838: <pre class="idl">interface <dfn id="htmltextareaelement">HTMLTextAreaElement</dfn> : <a href="elements.html#htmlelement">HTMLElement</a> {
1.48 mike 839: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-autofocus" title='Read about this "autofocus" reference in the full HTML5 spec.'>autofocus</a>;
840: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-cols" title='Read about this "cols" reference in the full HTML5 spec.'>cols</a>;
841: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
842: readonly attribute <a href="forms.html#htmlformelement">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
843: attribute long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-maxlength" title='Read about this "maxLength" reference in the full HTML5 spec.'>maxLength</a>;
844: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-name" title='Read about this "name" reference in the full HTML5 spec.'>name</a>;
845: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-placeholder" title='Read about this "placeholder" reference in the full HTML5 spec.'>placeholder</a>;
846: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-readonly" title='Read about this "readOnly" reference in the full HTML5 spec.'>readOnly</a>;
847: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-required" title='Read about this "required" reference in the full HTML5 spec.'>required</a>;
848: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-rows" title='Read about this "rows" reference in the full HTML5 spec.'>rows</a>;
849: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-wrap" title='Read about this "wrap" reference in the full HTML5 spec.'>wrap</a>;
850:
851: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a>;
852: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-defaultvalue" title='Read about this "defaultValue" reference in the full HTML5 spec.'>defaultValue</a>;
853: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
854: readonly attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-textlength" title='Read about this "textLength" reference in the full HTML5 spec.'>textLength</a>;
855:
856: readonly attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-willvalidate" title='Read about this "willValidate" reference in the full HTML5 spec.'>willValidate</a>;
857: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#validitystate" title='Read about this "ValidityState" reference in the full HTML5 spec.'>ValidityState</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validity" title='Read about this "validity" reference in the full HTML5 spec.'>validity</a>;
858: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validationmessage" title='Read about this "validationMessage" reference in the full HTML5 spec.'>validationMessage</a>;
859: boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-checkvalidatity" title='Read about this "checkValidity" reference in the full HTML5 spec.'>checkValidity</a>();
860: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-setcustomvalidity" title='Read about this "setCustomValidity" reference in the full HTML5 spec.'>setCustomValidity</a>(in DOMString error);
861:
862: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
863:
864: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#dom-textarea-input-select" title='Read about this "select" reference in the full HTML5 spec.'>select</a>();
865: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#dom-textarea-input-selectionstart" title='Read about this "selectionStart" reference in the full HTML5 spec.'>selectionStart</a>;
866: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#dom-textarea-input-selectionend" title='Read about this "selectionEnd" reference in the full HTML5 spec.'>selectionEnd</a>;
867: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#dom-textarea-input-setselectionrange" title='Read about this "setSelectionRange" reference in the full HTML5 spec.'>setSelectionRange</a>(in unsigned long start, in unsigned long end);
1.9 mike 868: };</pre>
869: </dd>
1.48 mike 870: </dl><p>The <code><a href="#the-textarea-element">textarea</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a
1.9 mike 871: multiline plain text edit control. The contents of the control represent the
1.48 mike 872: control's default value.<p>The <dfn id="attr-textarea-readonly" title="attr-textarea-readonly"><code>readonly</code></dfn> attribute
1.9 mike 873: is a <a href="common-microsyntaxes.html#boolean-attribute">boolean attribute</a> used to control whether the text
1.48 mike 874: can be edited by the user or not.<p>The <dfn id="attr-textarea-cols" title="attr-textarea-cols"><code>cols</code></dfn>
1.9 mike 875: attribute specifies the expected maximum number of characters per
876: line. If the <code title="attr-textarea-cols"><a href="#attr-textarea-cols">cols</a></code> attribute
877: is specified, its value must be a <a href="common-microsyntaxes.html#valid-non-negative-integer">valid non-negative
1.48 mike 878: integer</a> greater than zero. <p>The <dfn id="attr-textarea-rows" title="attr-textarea-rows"><code>rows</code></dfn>
1.9 mike 879: attribute specifies the number of lines to show. If the <code title="attr-textarea-rows"><a href="#attr-textarea-rows">rows</a></code> attribute is specified, its
880: value must be a <a href="common-microsyntaxes.html#valid-non-negative-integer">valid non-negative integer</a> greater than
1.48 mike 881: zero. <p>The <dfn id="attr-textarea-wrap" title="attr-textarea-wrap"><code>wrap</code></dfn>
1.9 mike 882: attribute is an <a href="common-microsyntaxes.html#enumerated-attribute">enumerated attribute</a> with two keywords
883: and states: the <dfn id="attr-textarea-wrap-soft" title="attr-textarea-wrap-soft"><code>soft</code></dfn> keyword
884: which maps to the <dfn id="attr-textarea-wrap-soft-state" title="attr-textarea-wrap-soft-state">Soft</dfn> state, and the
885: <dfn id="attr-textarea-wrap-hard" title="attr-textarea-wrap-hard"><code>hard</code></dfn> keyword
886: which maps to the <dfn id="attr-textarea-wrap-hard-state" title="attr-textarea-wrap-hard-state">Hard</dfn> state. The
1.48 mike 887: <i>missing value default</i> is the <a href="#attr-textarea-wrap-soft-state" title="attr-textarea-wrap-soft-state">Soft</a> state.<p>If the element's <code title="attr-textarea-wrap"><a href="#attr-textarea-wrap">wrap</a></code>
1.9 mike 888: attribute is in the <a href="#attr-textarea-wrap-hard-state" title="attr-textarea-wrap-hard-state">Hard</a> state, the <code title="attr-textarea-cols"><a href="#attr-textarea-cols">cols</a></code> attribute must be
889: specified.</p><!-- attr-textarea-wrap-off (attr-textarea-wrap-off-state): not
890: conforming; turns off the rendering of wrapping but otherwise acts
891: like 'soft' --><p>The <dfn id="attr-textarea-maxlength" title="attr-textarea-maxlength"><code>maxlength</code></dfn>
892: attribute is a <a href="association-of-controls-and-forms.html#attr-fe-maxlength" title="attr-fe-maxlength">form control <code title="">maxlength</code> attribute</a> controlled by the
1.48 mike 893: <code><a href="#the-textarea-element">textarea</a></code> element's <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#concept-textarea-dirty" title='Read about this "dirty value flag" reference in the full HTML5 spec.'>dirty value flag</a>.<p>If the <code><a href="#the-textarea-element">textarea</a></code> element has a <a href="association-of-controls-and-forms.html#maximum-allowed-value-length">maximum allowed
1.9 mike 894: value length</a>, then the element's children must be such that
1.48 mike 895: the <a class="full-spec-link" href="http://dev.w3.org/html5/spec/common-microsyntaxes.html#code-point-length" title='Read about this "code-point length" reference in the full HTML5 spec.'>code-point length</a> of the value of the element's
896: <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#textcontent" title='Read about this "textContent" reference in the full HTML5 spec.'>textContent</a></code> IDL attribute is equal to or less than the
897: element's <a href="association-of-controls-and-forms.html#maximum-allowed-value-length">maximum allowed value length</a>.<p>The <dfn id="attr-textarea-required" title="attr-textarea-required"><code>required</code></dfn> attribute
1.9 mike 898: is a <a href="common-microsyntaxes.html#boolean-attribute">boolean attribute</a>. When specified, the user will
899: be required to enter a value before submitting the form.</p><!-- similar text in the <input> section --><p>The <dfn id="attr-textarea-placeholder" title="attr-textarea-placeholder"><code>placeholder</code></dfn>
900: attribute represents a hint (a word or short phrase) intended to aid
901: the user with data entry. A hint could be a sample value or a brief
902: description of the expected format. The attribute, if specified,
903: must have a value that contains no U+000A LINE FEED (LF) or U+000D
1.48 mike 904: CARRIAGE RETURN (CR) characters.<p class="note">For a longer hint or other advisory text, the <code title="attr-title"><a href="elements.html#the-title-attribute">title</a></code> attribute is more appropriate.<p>The <code title="attr-textarea-placeholder"><a href="#attr-textarea-placeholder">placeholder</a></code>
1.9 mike 905: attribute should not be used as an alternative to a
1.48 mike 906: <code><a href="forms.html#the-label-element">label</a></code>.<p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code> attribute is used to
1.9 mike 907: explicitly associate the <code><a href="#the-textarea-element">textarea</a></code> element with its
908: <a href="association-of-controls-and-forms.html#form-owner">form owner</a>. The <code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name">name</a></code>
909: attribute represents the element's name. The <code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled">disabled</a></code> attribute is used to make
910: the control non-interactive and to prevent its value from being
911: submitted. The <code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus">autofocus</a></code>
1.48 mike 912: attribute controls focus.<dl class="domintro"><dt><var title="">textarea</var> . <code title="attr-textarea-type">type</code></dt>
1.9 mike 913:
914: <dd>
915:
916: <p>Returns the string "<code title="">textarea</code>".</p>
917:
918: </dd>
919:
920: <dt><var title="">textarea</var> . <code title="attr-textarea-value">value</code></dt>
921:
922: <dd>
923:
924: <p>Returns the current value of the element.</p>
925:
926: <p>Can be set, to change the value.</p>
927:
928: </dd>
929:
930: </dl><div class="example">
931:
932: <p>Here is an example of a <code><a href="#the-textarea-element">textarea</a></code> being used for
933: unrestricted free-form text input in a form:</p>
934:
935: <pre><p>If you have any comments, please let us know: <textarea cols=80 name=comments></textarea></p></pre>
936:
1.48 mike 937: </div><h4 id="the-keygen-element"><span class="secno">4.10.14 </span>The <dfn><code>keygen</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i><dl class="element"><dt>Categories</dt>
1.9 mike 938: <dd><a href="content-models.html#flow-content">Flow content</a>.</dd>
939: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>.</dd>
940: <dd><a href="content-models.html#interactive-content">Interactive content</a>.</dd>
941: <dd><a href="forms.html#category-listed" title="category-listed">Listed</a>, <a href="forms.html#category-label" title="category-label">labelable</a>, <a href="forms.html#category-submit" title="category-submit">submittable</a>, and <a href="forms.html#category-reset" title="category-reset">resettable</a> <a href="forms.html#form-associated-element">form-associated element</a>.</dd>
942: <dt>Contexts in which this element may be used:</dt>
943: <dd>Where <a href="content-models.html#phrasing-content">phrasing content</a> is expected.</dd>
944: <dt>Content model:</dt>
945: <dd>Empty.</dd>
946: <dt>Content attributes:</dt>
947: <dd><a href="elements.html#global-attributes">Global attributes</a></dd>
948: <dd><code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus">autofocus</a></code></dd>
949: <dd><code title="attr-keygen-challenge"><a href="#attr-keygen-challenge">challenge</a></code></dd>
950: <dd><code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled">disabled</a></code></dd>
951: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code></dd>
952: <dd><code title="attr-keygen-keytype"><a href="#attr-keygen-keytype">keytype</a></code></dd>
953: <dd><code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name">name</a></code></dd>
954: <dt>DOM interface:</dt>
955: <dd>
956: <pre class="idl">interface <dfn id="htmlkeygenelement">HTMLKeygenElement</dfn> : <a href="elements.html#htmlelement">HTMLElement</a> {
1.48 mike 957: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-autofocus" title='Read about this "autofocus" reference in the full HTML5 spec.'>autofocus</a>;
958: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-keygen-challenge" title='Read about this "challenge" reference in the full HTML5 spec.'>challenge</a>;
959: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
960: readonly attribute <a href="forms.html#htmlformelement">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
961: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-keygen-keytype" title='Read about this "keytype" reference in the full HTML5 spec.'>keytype</a>;
962: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-name" title='Read about this "name" reference in the full HTML5 spec.'>name</a>;
963:
964: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-keygen-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a>;
965:
966: readonly attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-willvalidate" title='Read about this "willValidate" reference in the full HTML5 spec.'>willValidate</a>;
967: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#validitystate" title='Read about this "ValidityState" reference in the full HTML5 spec.'>ValidityState</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validity" title='Read about this "validity" reference in the full HTML5 spec.'>validity</a>;
968: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validationmessage" title='Read about this "validationMessage" reference in the full HTML5 spec.'>validationMessage</a>;
969: boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-checkvalidatity" title='Read about this "checkValidity" reference in the full HTML5 spec.'>checkValidity</a>();
970: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-setcustomvalidity" title='Read about this "setCustomValidity" reference in the full HTML5 spec.'>setCustomValidity</a>(in DOMString error);
1.9 mike 971:
1.48 mike 972: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.9 mike 973: };</pre>
974: </dd>
1.48 mike 975: </dl><p>The <code><a href="#the-keygen-element">keygen</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a key
1.9 mike 976: pair generator control. When the control's form is submitted, the
977: private key is stored in the local keystore, and the public key is
1.48 mike 978: packaged and sent to the server.<p>The <dfn id="attr-keygen-challenge" title="attr-keygen-challenge"><code>challenge</code></dfn> attribute
1.9 mike 979: may be specified. Its value will be packaged with the submitted
1.48 mike 980: key.<p>The <dfn id="attr-keygen-keytype" title="attr-keygen-keytype"><code>keytype</code></dfn>
1.9 mike 981: attribute is an <a href="common-microsyntaxes.html#enumerated-attribute">enumerated attribute</a>. The following
1.48 mike 982: table lists the keywords and states for the attribute — the
1.9 mike 983: keywords in the left column map to the states listed in the cell in
984: the second column on the same row as the keyword. User agents are
1.26 mike 985: not required to support these values, and must only recognize values
1.48 mike 986: whose corresponding algorithms they support.<table><thead><tr><th> Keyword <th> State
987: <tbody><tr><td> <code title="">rsa</code>
988: <td> <i title="">RSA</i>
1.9 mike 989: <!-- v2 (see below)
990: <tr>
991: <td> <code title="">ec</code>
992: <td> <i title="">EC</i>
993: -->
1.48 mike 994: </table><p>The <i>invalid value default</i> state is the <i title="">unknown</i> state. The <i>missing value default</i> state
995: is the <i title="">RSA</i> state, if it is supported, or the <i title="">unknown</i> state otherwise.<p class="note">This specification does not specify what key types
996: user agents are to support — it is possible for a user agent
997: to not support any key types at all.<p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code> attribute is used to
1.9 mike 998: explicitly associate the <code><a href="#the-keygen-element">keygen</a></code> element with its
999: <a href="association-of-controls-and-forms.html#form-owner">form owner</a>. The <code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name">name</a></code>
1000: attribute represents the element's name. The <code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled">disabled</a></code> attribute is used to make
1001: the control non-interactive and to prevent its value from being
1002: submitted. The <code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus">autofocus</a></code>
1.48 mike 1003: attribute controls focus.<dl class="domintro"><dt><var title="">keygen</var> . <code title="attr-keygen-type">type</code></dt>
1.9 mike 1004:
1005: <dd>
1006:
1007: <p>Returns the string "<code title="">keygen</code>".</p>
1008:
1009: </dd>
1010:
1011: </dl><p class="note">This specification does not specify how the private
1012: key generated is to be used. It is expected that after receiving the
1.48 mike 1013: <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#signedpublickeyandchallenge" title='Read about this "SignedPublicKeyAndChallenge" reference in the full HTML5 spec.'>SignedPublicKeyAndChallenge</a></code> (SPKAC) structure, the
1.9 mike 1014: server will generate a client certificate and offer it back to the
1015: user for download; this certificate, once downloaded and stored in
1016: the key store along with the private key, can then be used to
1.88 mike 1017: authenticate to services that use TLS and certificate
1.9 mike 1018: authentication.</p><!-- how does the UA know which private key is associated with a
1019: certificate it gets back after the server has taken the public key
1020: created by <keygen> and turned it into a client cert? --><div class="example">
1021:
1022: <p>To generate a key pair, add the private key to the user's key
1023: store, and submit the public key to the server, markup such as the
1024: following can be used:</p>
1025:
1.22 mike 1026: <pre><form action="processkey.cgi" method="post" enctype="multipart/form-data">
1.9 mike 1027: <p><keygen name="key"></p>
1028: <p><input type=submit value="Submit key..."></p>
1029: </form></pre>
1030:
1031: <p>The server will then receive a form submission with a packaged
1032: RSA public key as the value of "<code title="">key</code>". This
1033: can then be used for various purposes, such as generating a client
1034: certificate, as mentioned above.</p>
1035:
1.48 mike 1036: </div><h4 id="the-output-element"><span class="secno">4.10.15 </span>The <dfn><code>output</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments</i><dl class="element"><dt>Categories</dt>
1.9 mike 1037: <dd><a href="content-models.html#flow-content">Flow content</a>.</dd>
1038: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>.</dd>
1.11 mike 1039: <dd><a href="forms.html#category-listed" title="category-listed">Listed</a>, <a href="forms.html#category-label" title="category-label">labelable</a>, and <a href="forms.html#category-reset" title="category-reset">resettable</a> <a href="forms.html#form-associated-element">form-associated element</a>.</dd>
1.9 mike 1040: <dt>Contexts in which this element may be used:</dt>
1041: <dd>Where <a href="content-models.html#phrasing-content">phrasing content</a> is expected.</dd>
1042: <dt>Content model:</dt>
1043: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>.</dd>
1044: <dt>Content attributes:</dt>
1045: <dd><a href="elements.html#global-attributes">Global attributes</a></dd>
1046: <dd><code title="attr-output-for"><a href="#attr-output-for">for</a></code></dd>
1047: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code></dd>
1048: <dd><code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name">name</a></code></dd>
1049: <dt>DOM interface:</dt>
1050: <dd>
1051: <pre class="idl">interface <dfn id="htmloutputelement">HTMLOutputElement</dfn> : <a href="elements.html#htmlelement">HTMLElement</a> {
1.48 mike 1052: [PutForwards=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/common-dom-interfaces.html#dom-domsettabletokenlist-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>] readonly attribute <a href="urls.html#domsettabletokenlist">DOMSettableTokenList</a> <span title="dom-output-wrap">htmlFor</span>;
1053: readonly attribute <a href="forms.html#htmlformelement">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
1054: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-name" title='Read about this "name" reference in the full HTML5 spec.'>name</a>;
1055:
1056: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a>;
1057: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-defaultvalue" title='Read about this "defaultValue" reference in the full HTML5 spec.'>defaultValue</a>;
1058: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
1059:
1060: readonly attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-willvalidate" title='Read about this "willValidate" reference in the full HTML5 spec.'>willValidate</a>;
1061: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#validitystate" title='Read about this "ValidityState" reference in the full HTML5 spec.'>ValidityState</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validity" title='Read about this "validity" reference in the full HTML5 spec.'>validity</a>;
1062: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validationmessage" title='Read about this "validationMessage" reference in the full HTML5 spec.'>validationMessage</a>;
1063: boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-checkvalidatity" title='Read about this "checkValidity" reference in the full HTML5 spec.'>checkValidity</a>();
1064: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-setcustomvalidity" title='Read about this "setCustomValidity" reference in the full HTML5 spec.'>setCustomValidity</a>(in DOMString error);
1.11 mike 1065:
1.48 mike 1066: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.9 mike 1067: };</pre>
1068: </dd>
1.48 mike 1069: </dl><p>The <code><a href="#the-output-element">output</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> the result of a
1070: calculation.<p>The <dfn id="attr-output-for" title="attr-output-for"><code>for</code></dfn> content
1.9 mike 1071: attribute allows an explicit relationship to be made between the
1072: result of a calculation and the elements that represent the values
1073: that went into the calculation or that otherwise influenced the
1074: calculation. The <code title="attr-output-for"><a href="#attr-output-for">for</a></code> attribute,
1075: if specified, must contain a string consisting of an <a href="common-microsyntaxes.html#unordered-set-of-unique-space-separated-tokens">unordered
1076: set of unique space-separated tokens</a>, each of which must have
1077: the value of an ID of an element in the same
1.48 mike 1078: <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#document" title='Read about this "Document" reference in the full HTML5 spec.'>Document</a></code>.<p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code> attribute is used to
1.9 mike 1079: explicitly associate the <code><a href="#the-output-element">output</a></code> element with its
1080: <a href="association-of-controls-and-forms.html#form-owner">form owner</a>. The <code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name">name</a></code>
1.48 mike 1081: attribute represents the element's name.<dl class="domintro"><dt><var title="">output</var> . <code title="dom-output-value"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a></code> [ = <var title="">value</var> ]</dt>
1.9 mike 1082:
1083: <dd>
1084:
1085: <p>Returns the element's current value.</p>
1086:
1087: <p>Can be set, to change the value.</p>
1088:
1089: </dd>
1090:
1.48 mike 1091: <dt><var title="">output</var> . <code title="dom-output-defaultValue"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-defaultvalue" title='Read about this "defaultValue" reference in the full HTML5 spec.'>defaultValue</a></code> [ = <var title="">value</var> ]</dt>
1.9 mike 1092:
1093: <dd>
1094:
1095: <p>Returns the element's current default value.</p>
1096:
1097: <p>Can be set, to change the default value.</p>
1098:
1099: </dd>
1100:
1.48 mike 1101: <dt><var title="">output</var> . <code title="dom-output-type"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a></code></dt>
1.9 mike 1102:
1103: <dd>
1104:
1105: <p>Returns the string "<code title="">output</code>".</p>
1106:
1107: </dd>
1108:
1109: </dl><div class="example">
1110:
1111: <p>A simple calculator could use <code><a href="#the-output-element">output</a></code> for its
1112: display of calculated results:</p>
1113:
1114: <pre><form onsubmit="return false">
1115: <input name=a type=number step=any> +
1116: <input name=b type=number step=any> =
1.32 mike 1117: <output onforminput="value = a.valueAsNumber + b.valueAsNumber"></output>
1.9 mike 1118: </form></pre>
1119:
1.48 mike 1120: </div><h4 id="the-progress-element"><span class="secno">4.10.16 </span>The <dfn><code>progress</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments. </i><span><a href="http://www.w3.org/html/wg/tracker/issues/96">ISSUE-96</a> (progress) blocks progress to Last Call</span><dl class="element"><dt>Categories</dt>
1.11 mike 1121: <dd><a href="content-models.html#flow-content">Flow content</a>.</dd>
1122: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>.</dd>
1123: <dd><a href="forms.html#category-label" title="category-label">Labelable</a> <a href="forms.html#form-associated-element">form-associated element</a>.</dd>
1124: <dt>Contexts in which this element may be used:</dt>
1125: <dd>Where <a href="content-models.html#phrasing-content">phrasing content</a> is expected.</dd>
1126: <dt>Content model:</dt>
1127: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>, but there must be no <code><a href="#the-progress-element">progress</a></code> element descendants.</dd>
1128: <dt>Content attributes:</dt>
1129: <dd><a href="elements.html#global-attributes">Global attributes</a></dd>
1130: <dd><code title="attr-progress-value"><a href="#attr-progress-value">value</a></code></dd>
1131: <dd><code title="attr-progress-max"><a href="#attr-progress-max">max</a></code></dd>
1132: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code></dd>
1133: <dt>DOM interface:</dt>
1134: <dd>
1135: <pre class="idl">interface <dfn id="htmlprogresselement">HTMLProgressElement</dfn> : <a href="elements.html#htmlelement">HTMLElement</a> {
1.48 mike 1136: attribute float <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-progress-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
1137: attribute float <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-progress-max" title='Read about this "max" reference in the full HTML5 spec.'>max</a>;
1138: readonly attribute float <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-progress-position" title='Read about this "position" reference in the full HTML5 spec.'>position</a>;
1139: readonly attribute <a href="forms.html#htmlformelement">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
1140: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.11 mike 1141: };</pre>
1142: </dd>
1.48 mike 1143: </dl><p>The <code><a href="#the-progress-element">progress</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> the
1.11 mike 1144: completion progress of a task. The progress is either indeterminate,
1145: indicating that progress is being made but that it is not clear how
1146: much more work remains to be done before the task is complete
1147: (e.g. because the task is waiting for a remote host to respond), or
1148: the progress is a number in the range zero to a maximum, giving the
1.48 mike 1149: fraction of work that has so far been completed.<p>There are two attributes that determine the current task
1150: completion represented by the element.<p>The <dfn id="attr-progress-value" title="attr-progress-value"><code>value</code></dfn>
1.11 mike 1151: attribute specifies how much of the task has been completed, and the
1152: <dfn id="attr-progress-max" title="attr-progress-max"><code>max</code></dfn> attribute
1153: specifies how much work the task requires in total. The units are
1.48 mike 1154: arbitrary and not specified.<p>Authors are encouraged to also include the current value and the
1.11 mike 1155: maximum value inline as text inside the element, so that the
1.48 mike 1156: progress is made available to users of legacy user agents.<div class="example">
1.11 mike 1157: <p>Here is a snippet of a Web application that shows the progress
1158: of some automated task:</p>
1159: <pre><section>
1160: <h2>Task Progress</h2>
1161: <p>Progress: <progress id="p" max=100><span>0</span>%</progress></p>
1162: <script>
1163: var progressBar = document.getElementById('p');
1164: function updateProgress(newValue) {
1165: progressBar.value = newValue;
1166: progressBar.getElementsByTagName('span')[0].textContent = newValue;
1167: }
1168: </script>
1169: </section></pre>
1170: <p>(The <code>updateProgress()</code> method in this example would
1171: be called by some other code on the page to update the actual
1172: progress bar as the task progressed.)</p>
1173: </div><p>The <code title="attr-progress-value"><a href="#attr-progress-value">value</a></code> and <code title="attr-progress-max"><a href="#attr-progress-max">max</a></code> attributes, when present, must
1174: have values that are <a href="common-microsyntaxes.html#valid-floating-point-number" title="valid floating point number">valid
1175: floating point numbers</a>. The <code title="attr-progress-value"><a href="#attr-progress-value">value</a></code> attribute, if present, must
1176: have a value equal to or greater than zero, and less than or equal
1177: to the value of the <code title="attr-progress-max"><a href="#attr-progress-max">max</a></code>
1178: attribute, if present, or 1.0, otherwise. The <code title="attr-progress-max"><a href="#attr-progress-max">max</a></code> attribute, if present, must
1.48 mike 1179: have a value greater than zero.<p class="note">The <code><a href="#the-progress-element">progress</a></code> element is the wrong
1.11 mike 1180: element to use for something that is just a gauge, as opposed to
1181: task progress. For instance, indicating disk space usage using
1182: <code><a href="#the-progress-element">progress</a></code> would be inappropriate. Instead, the
1.48 mike 1183: <code><a href="#the-meter-element">meter</a></code> element is available for such use cases.<dl class="domintro"><dt><var title="">progress</var> . <code title="dom-progress-position"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-progress-position" title='Read about this "position" reference in the full HTML5 spec.'>position</a></code></dt>
1.11 mike 1184:
1185: <dd>
1186:
1187: <p>For a determinate progress bar (one with known current and
1188: maximum values), returns the result of dividing the current value
1189: by the maximum value.</p>
1190:
1.48 mike 1191: <p>For an indeterminate progress bar, returns −1.</p>
1.11 mike 1192:
1.48 mike 1193: </dl><h4 id="the-meter-element"><span class="secno">4.10.17 </span>The <dfn><code>meter</code></dfn> element</h4><p class="XXX annotation"><b>Status: </b><i>Last call for comments. </i><span><a href="http://www.w3.org/html/wg/tracker/issues/97">ISSUE-97</a> (meter) blocks progress to Last Call</span></p><!-- Keep this after <progress> and NOT close to <time> --><dl class="element"><dt>Categories</dt>
1.11 mike 1194: <dd><a href="content-models.html#flow-content">Flow content</a>.</dd>
1195: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>.</dd>
1196: <dd><a href="forms.html#category-label" title="category-label">Labelable</a> <a href="forms.html#form-associated-element">form-associated element</a>.</dd>
1197: <dt>Contexts in which this element may be used:</dt>
1198: <dd>Where <a href="content-models.html#phrasing-content">phrasing content</a> is expected.</dd>
1199: <dt>Content model:</dt>
1200: <dd><a href="content-models.html#phrasing-content">Phrasing content</a>, but there must be no <code><a href="#the-meter-element">meter</a></code> element descendants.</dd>
1201: <dt>Content attributes:</dt>
1202: <dd><a href="elements.html#global-attributes">Global attributes</a></dd>
1203: <dd><code title="attr-meter-value"><a href="#attr-meter-value">value</a></code></dd>
1204: <dd><code title="attr-meter-min"><a href="#attr-meter-min">min</a></code></dd>
1205: <dd><code title="attr-meter-max"><a href="#attr-meter-max">max</a></code></dd>
1206: <dd><code title="attr-meter-low"><a href="#attr-meter-low">low</a></code></dd>
1207: <dd><code title="attr-meter-high"><a href="#attr-meter-high">high</a></code></dd>
1208: <dd><code title="attr-meter-optimum"><a href="#attr-meter-optimum">optimum</a></code></dd>
1209: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code></dd>
1210: <dt>DOM interface:</dt>
1211: <dd>
1212: <pre class="idl">interface <dfn id="htmlmeterelement">HTMLMeterElement</dfn> : <a href="elements.html#htmlelement">HTMLElement</a> {
1.48 mike 1213: attribute float <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
1214: attribute float <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-min" title='Read about this "min" reference in the full HTML5 spec.'>min</a>;
1215: attribute float <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-max" title='Read about this "max" reference in the full HTML5 spec.'>max</a>;
1216: attribute float <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-low" title='Read about this "low" reference in the full HTML5 spec.'>low</a>;
1217: attribute float <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-high" title='Read about this "high" reference in the full HTML5 spec.'>high</a>;
1218: attribute float <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-optimum" title='Read about this "optimum" reference in the full HTML5 spec.'>optimum</a>;
1219: readonly attribute <a href="forms.html#htmlformelement">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
1220: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.11 mike 1221: };</pre>
1222: </dd>
1.48 mike 1223: </dl><p>The <code><a href="#the-meter-element">meter</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a scalar
1.11 mike 1224: measurement within a known range, or a fractional value; for example
1225: disk usage, the relevance of a query result, or the fraction of a
1.48 mike 1226: voting population to have selected a particular candidate.<p>This is also known as a gauge.<p class="note">The <code><a href="#the-meter-element">meter</a></code> element should not be used to
1.11 mike 1227: indicate progress (as in a progress bar). For that role, HTML
1.48 mike 1228: provides a separate <code><a href="#the-progress-element">progress</a></code> element.<p class="note">The <code><a href="#the-meter-element">meter</a></code> element also does not
1229: represent a scalar value of arbitrary range — for example, it
1.11 mike 1230: would be wrong to use this to report a weight, or height, unless
1.48 mike 1231: there is a known maximum value.<p>There are six attributes that determine the semantics of the
1232: gauge represented by the element.<p>The <dfn id="attr-meter-min" title="attr-meter-min"><code>min</code></dfn> attribute
1.11 mike 1233: specifies the lower bound of the range, and the <dfn id="attr-meter-max" title="attr-meter-max"><code>max</code></dfn> attribute specifies
1234: the upper bound. The <dfn id="attr-meter-value" title="attr-meter-value"><code>value</code></dfn> attribute
1235: specifies the value to have the gauge indicate as the "measured"
1.48 mike 1236: value.<p>The other three attributes can be used to segment the gauge's
1.11 mike 1237: range into "low", "medium", and "high" parts, and to indicate which
1238: part of the gauge is the "optimum" part. The <dfn id="attr-meter-low" title="attr-meter-low"><code>low</code></dfn> attribute specifies
1239: the range that is considered to be the "low" part, and the <dfn id="attr-meter-high" title="attr-meter-high"><code>high</code></dfn> attribute specifies
1240: the range that is considered to be the "high" part. The <dfn id="attr-meter-optimum" title="attr-meter-optimum"><code>optimum</code></dfn> attribute
1241: gives the position that is "optimum"; if that is higher than the
1242: "high" value then this indicates that the higher the value, the
1243: better; if it's lower than the "low" mark then it indicates that
1244: lower values are better, and naturally if it is in between then it
1.48 mike 1245: indicates that neither high nor low values are good.<p> The <code title="attr-meter-value"><a href="#attr-meter-value">value</a></code> attribute must be
1.11 mike 1246: specified. The <code title="attr-meter-value"><a href="#attr-meter-value">value</a></code>, <code title="attr-meter-min"><a href="#attr-meter-min">min</a></code>, <code title="attr-meter-low"><a href="#attr-meter-low">low</a></code>, <code title="attr-meter-high"><a href="#attr-meter-high">high</a></code>, <code title="attr-meter-max"><a href="#attr-meter-max">max</a></code>, and <code title="attr-meter-optimum"><a href="#attr-meter-optimum">optimum</a></code> attributes, when present,
1247: must have values that are <a href="common-microsyntaxes.html#valid-floating-point-number" title="valid floating point
1.48 mike 1248: number">valid floating point numbers</a>.<p>In addition, the attributes' values are further constrained:<p>Let <var title="">value</var> be the <code title="attr-meter-value"><a href="#attr-meter-value">value</a></code> attribute's number.<p>If the <code title="attr-meter-min"><a href="#attr-meter-min">min</a></code> attribute
1.11 mike 1249: attribute is specified, then let <var title="">minimum</var> be that
1.48 mike 1250: attribute's value; otherwise, let it be zero.<p>If the <code title="attr-meter-max"><a href="#attr-meter-max">max</a></code> attribute
1.11 mike 1251: attribute is specified, then let <var title="">maximum</var> be that
1.48 mike 1252: attribute's value; otherwise, let it be 1.0.<p>The following inequalities must hold, as applicable:<ul class="brief"><li><var title="">minimum</var> ≤ <var title="">value</var> ≤ <var title="">maximum</var></li>
1253: <li><var title="">minimum</var> ≤ <code title="attr-meter-low"><a href="#attr-meter-low">low</a></code> ≤ <var title="">maximum</var> (if <code title="attr-meter-low"><a href="#attr-meter-low">low</a></code> is specified)</li>
1254: <li><var title="">minimum</var> ≤ <code title="attr-meter-high"><a href="#attr-meter-high">high</a></code> ≤ <var title="">maximum</var> (if <code title="attr-meter-high"><a href="#attr-meter-high">high</a></code> is specified)</li>
1255: <li><var title="">minimum</var> ≤ <code title="attr-meter-optimum"><a href="#attr-meter-optimum">optimum</a></code> ≤ <var title="">maximum</var> (if <code title="attr-meter-optimum"><a href="#attr-meter-optimum">optimum</a></code> is specified)</li>
1256: <li><code title="attr-meter-low"><a href="#attr-meter-low">low</a></code> ≤ <code title="attr-meter-high"><a href="#attr-meter-high">high</a></code> (if both <code title="attr-meter-low"><a href="#attr-meter-low">low</a></code> and <code title="attr-meter-high"><a href="#attr-meter-high">high</a></code> are specified)</li>
1.21 mike 1257: </ul><p class="note">If no minimum or maximum is specified, then the
1.11 mike 1258: range is assumed to be 0..1, and the value thus has to be within
1.48 mike 1259: that range.<p>Authors are encouraged to include a textual representation of the
1.11 mike 1260: gauge's state in the element's contents, for users of user agents
1.48 mike 1261: that do not support the <code><a href="#the-meter-element">meter</a></code> element.<div class="example">
1.11 mike 1262:
1263: <p>The following examples show three gauges that would all be
1264: three-quarters full:</p>
1265:
1266: <pre>Storage space usage: <meter value=6 max=8>6 blocks used (out of 8 total)</meter>
1267: Voter turnout: <meter value=0.75><img alt="75%" src="graph75.png"></meter>
1268: Tickets sold: <meter min="0" max="100" value="75"></meter></pre>
1269:
1270: <p>The following example is incorrect use of the element, because
1271: it doesn't give a range (and since the default maximum is 1, both
1272: of the gauges would end up looking maxed out):</p>
1273:
1274: <pre class="bad"><p>The grapefruit pie had a radius of <meter value=12>12cm</meter>
1275: and a height of <meter value=2>2cm</meter>.</p> <!-- <strong>BAD!</strong> --></pre>
1276:
1277: <p>Instead, one would either not include the meter element, or use
1278: the meter element with a defined range to give the dimensions in
1279: context compared to other pies:</p>
1280:
1281: <pre><p>The grapefruit pie had a radius of 12cm and a height of
1282: 2cm.</p>
1283: <dl>
1284: <dt>Radius: <dd> <meter min=0 max=20 value=12>12cm</meter>
1285: <dt>Height: <dd> <meter min=0 max=10 value=2>2cm</meter>
1286: </dl></pre>
1287:
1288: </div><p>There is no explicit way to specify units in the
1289: <code><a href="#the-meter-element">meter</a></code> element, but the units may be specified in the
1.48 mike 1290: <code title="attr-title"><a href="elements.html#the-title-attribute">title</a></code> attribute in free-form text.<div class="example">
1.11 mike 1291:
1292: <p>The example above could be extended to mention the units:</p>
1293:
1294: <pre><dl>
1295: <dt>Radius: <dd> <meter min=0 max=20 value=12 title="centimeters">12cm</meter>
1296: <dt>Height: <dd> <meter min=0 max=10 value=2 title="centimeters">2cm</meter>
1297: </dl></pre>
1298:
1299: </div><div class="example">
1300: <p>The following markup:</p>
1301: <pre><h3>Suggested groups</h3>
1302: <menu type="toolbar">
1303: <a href="?cmd=hsg" onclick="hideSuggestedGroups()">Hide suggested groups</a>
1304: </menu>
1305: <ul>
1306: <li>
1307: <p><a href="/group/comp.infosystems.www.authoring.stylesheets/view">comp.infosystems.www.authoring.stylesheets</a> -
1308: <a href="/group/comp.infosystems.www.authoring.stylesheets/subscribe">join</a></p>
1309: <p>Group description: <strong>Layout/presentation on the WWW.</strong></p>
1310: <p><strong><meter value="0.5">Moderate activity,</meter></strong> Usenet, 618 subscribers</p>
1311: </li>
1312: <li>
1313: <p><a href="/group/netscape.public.mozilla.xpinstall/view">netscape.public.mozilla.xpinstall</a> -
1314: <a href="/group/netscape.public.mozilla.xpinstall/subscribe">join</a></p>
1315: <p>Group description: <strong>Mozilla XPInstall discussion.</strong></p>
1316: <p><strong><meter value="0.25">Low activity,</meter></strong> Usenet, 22 subscribers</p>
1317: </li>
1318: <li>
1319: <p><a href="/group/mozilla.dev.general/view">mozilla.dev.general</a> -
1320: <a href="/group/mozilla.dev.general/subscribe">join</a></p>
1321: <p><strong><meter value="0.25">Low activity,</meter></strong> Usenet, 66 subscribers</p>
1322: </li>
1323: </ul></pre>
1324: <p>Might be rendered as follows:</p>
1.48 mike 1325: <p><img alt="With the <meter> elements rendered as inline green bars of varying lengths." src="http://dev.w3.org/html5/spec/images/sample-meter.png"></p>
1.13 mike 1326: </div><p>User agents combine the value of
1327: the <code title="attr-title"><a href="elements.html#the-title-attribute">title</a></code> attribute and the other
1.11 mike 1328: attributes to provide context-sensitive help or inline text
1.48 mike 1329: detailing the actual values.<div class="example">
1.11 mike 1330: <p>For example, the following snippet:</p>
1331: <pre><meter min=0 max=60 value=23.2 title=seconds></meter></pre>
1332: <p>...might cause the user agent to display a gauge with a tooltip
1333: saying "Value: 23.2 out of 60." on one line and "seconds" on a
1334: second line.</p>
1335: </div><p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form">form</a></code> attribute is used to
1336: explicitly associate the <code><a href="#the-meter-element">meter</a></code> element with its
1.48 mike 1337: <a href="association-of-controls-and-forms.html#form-owner">form owner</a>.<div class="example">
1.11 mike 1338:
1339: <p>The following example shows how a gauge could fall back to
1340: localized or pretty-printed text.</p>
1341:
1.48 mike 1342: <pre><p>Disk usage: <meter min=0 value=170261928 max=233257824>170 261 928 bytes used
1343: out of 233 257 824 bytes available</meter></p></pre>
1.11 mike 1344:
1.48 mike 1345: </div>
Webmaster
![[BACK]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/back.gif?vpn-1){kind=icon}
Return to the-button-element.html CVS log ![[TXT]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/text.gif?vpn-1){kind=icon}
![[DIR]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/dir.gif?vpn-1){kind=icon}
Up to [Public] / html5 / spec-author-view