Annotation of html5/spec-author-view/editing-apis.html, revision 1.20

1.1       mike        1: <!doctype html>
1.15      mike        2: <html lang="en-US-x-Hixie"><meta content="text/html; charset=utf-8" http-equiv="Content-Type"><title>7.5.4 Editing APIs &mdash; HTML5: Edition for Web Authors</title><link href="style.css" rel="stylesheet"><link href="http://www.w3.org/StyleSheets/TR/W3C-ED" rel="stylesheet" type="text/css"><script src="link-fixup.js" type="text/javascript"></script><style type="text/css">
1.1       mike        3: 
                      4:    .applies thead th > * { display: block; }
                      5:    .applies thead code { display: block; }
                      6:    .applies tbody th { whitespace: nowrap; }
                      7:    .applies td { text-align: center; }
                      8:    .applies .yes { background: yellow; }
                      9: 
                     10:    .matrix, .matrix td { border: hidden; text-align: right; }
                     11:    .matrix { margin-left: 2em; }
                     12: 
                     13:    .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
                     14:    .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
                     15:    .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
                     16: 
                     17:    td.eg { border-width: thin; text-align: center; }
                     18: 
                     19:    #table-example-1 { border: solid thin; border-collapse: collapse; margin-left: 3em; }
                     20:    #table-example-1 * { font-family: "Essays1743", serif; line-height: 1.01em; }
                     21:    #table-example-1 caption { padding-bottom: 0.5em; }
                     22:    #table-example-1 thead, #table-example-1 tbody { border: none; }
                     23:    #table-example-1 th, #table-example-1 td { border: solid thin; }
                     24:    #table-example-1 th { font-weight: normal; }
                     25:    #table-example-1 td { border-style: none solid; vertical-align: top; }
                     26:    #table-example-1 th { padding: 0.5em; vertical-align: middle; text-align: center; }
                     27:    #table-example-1 tbody tr:first-child td { padding-top: 0.5em; }
                     28:    #table-example-1 tbody tr:last-child td { padding-bottom: 1.5em; }
                     29:    #table-example-1 tbody td:first-child { padding-left: 2.5em; padding-right: 0; width: 9em; }
                     30:    #table-example-1 tbody td:first-child::after { content: leader(". "); }
                     31:    #table-example-1 tbody td { padding-left: 2em; padding-right: 2em; }
                     32:    #table-example-1 tbody td:first-child + td { width: 10em; }
                     33:    #table-example-1 tbody td:first-child + td ~ td { width: 2.5em; }
                     34:    #table-example-1 tbody td:first-child + td + td + td ~ td { width: 1.25em; }
                     35: 
                     36:    .apple-table-examples { border: none; border-collapse: separate; border-spacing: 1.5em 0em; width: 40em; margin-left: 3em; }
                     37:    .apple-table-examples * { font-family: "Times", serif; }
                     38:    .apple-table-examples td, .apple-table-examples th { border: none; white-space: nowrap; padding-top: 0; padding-bottom: 0; }
                     39:    .apple-table-examples tbody th:first-child { border-left: none; width: 100%; }
                     40:    .apple-table-examples thead th:first-child ~ th { font-size: smaller; font-weight: bolder; border-bottom: solid 2px; text-align: center; }
                     41:    .apple-table-examples tbody th::after, .apple-table-examples tfoot th::after { content: leader(". ") }
                     42:    .apple-table-examples tbody th, .apple-table-examples tfoot th { font: inherit; text-align: left; }
                     43:    .apple-table-examples td { text-align: right; vertical-align: top; }
                     44:    .apple-table-examples.e1 tbody tr:last-child td { border-bottom: solid 1px; }
                     45:    .apple-table-examples.e1 tbody + tbody tr:last-child td { border-bottom: double 3px; }
                     46:    .apple-table-examples.e2 th[scope=row] { padding-left: 1em; }
                     47:    .apple-table-examples sup { line-height: 0; }
                     48: 
                     49:    .details-example img { vertical-align: top; }
                     50: 
                     51:    #base64-table {
                     52:      white-space: nowrap;
                     53:      font-size: 0.6em;
                     54:      column-width: 6em;
                     55:      column-count: 5;
                     56:      column-gap: 1em;
                     57:      -moz-column-width: 6em;
                     58:      -moz-column-count: 5;
                     59:      -moz-column-gap: 1em;
                     60:      -webkit-column-width: 6em;
                     61:      -webkit-column-count: 5;
                     62:      -webkit-column-gap: 1em;
                     63:    }
                     64:    #base64-table thead { display: none; }
                     65:    #base64-table * { border: none; }
                     66:    #base64-table tbody td:first-child:after { content: ':'; }
                     67:    #base64-table tbody td:last-child { text-align: right; }
                     68: 
                     69:    #named-character-references-table {
                     70:      white-space: nowrap;
                     71:      font-size: 0.6em;
                     72:      column-width: 30em;
                     73:      column-gap: 1em;
                     74:      -moz-column-width: 30em;
                     75:      -moz-column-gap: 1em;
                     76:      -webkit-column-width: 30em;
                     77:      -webkit-column-gap: 1em;
                     78:    }
                     79:    #named-character-references-table > table > tbody > tr > td:first-child + td,
                     80:    #named-character-references-table > table > tbody > tr > td:last-child { text-align: center; }
                     81:    #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; }
                     82:    #named-character-references-table > table > tbody > tr#entity-CounterClockwiseContourIntegral > td:first-child { font-size: 0.5em; }
                     83: 
                     84:    .glyph.control { color: red; }
                     85: 
                     86:    @font-face {
                     87:      font-family: 'Essays1743';
                     88:      src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743.ttf');
                     89:    }
                     90:    @font-face {
                     91:      font-family: 'Essays1743';
                     92:      font-weight: bold;
                     93:      src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-Bold.ttf');
                     94:    }
                     95:    @font-face {
                     96:      font-family: 'Essays1743';
                     97:      font-style: italic;
                     98:      src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-Italic.ttf');
                     99:    }
                    100:    @font-face {
                    101:      font-family: 'Essays1743';
                    102:      font-style: italic;
                    103:      font-weight: bold;
                    104:      src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-BoldItalic.ttf');
                    105:    }
                    106: 
                    107:   </style><script type="text/javascript">
                    108:  function getCookie(name) {
                    109:    var params = location.search.substr(1).split("&");
                    110:    for (var index = 0; index < params.length; index++) {
                    111:      if (params[index] == name)
                    112:        return "1";
                    113:      var data = params[index].split("=");
                    114:      if (data[0] == name)
                    115:        return unescape(data[1]);
                    116:    }
                    117:    var cookies = document.cookie.split("; ");
                    118:    for (var index = 0; index < cookies.length; index++) {
                    119:      var data = cookies[index].split("=");
                    120:      if (data[0] == name)
                    121:        return unescape(data[1]);
                    122:    }
                    123:    return null;
                    124:  }
                    125:  function load(script) {
                    126:    var e = document.createElement('script');
                    127:    e.setAttribute('src', script + '?' + encodeURIComponent(location) + '&' + encodeURIComponent(document.referrer));
                    128:    document.body.appendChild(e);
                    129:  }
                    130:  function init() {
                    131:    if (location.search == '?slow-browser')
                    132:      return;
                    133:    var configUI = document.createElement('div');
                    134:    configUI.id = 'configUI';
                    135:    document.body.appendChild(configUI);
                    136:    if (document.getElementById('head'))
                    137:      load('toc.js');
                    138:    load('dfn.js');
                    139:    if (getCookie('profile') == '1')
                    140:      document.getElementsByTagName('h2')[0].textContent += '; load: ' + (new Date() - loadTimer) + 'ms';
                    141:    fixBrokenLink();
                    142:  }
1.11      mike      143: </script><script src="dfn.js" type="text/javascript"></script><script src="toc.js" type="text/javascript"></script><link href="editing.html" rel="prev" title="7 User interaction">
1.1       mike      144:   <link href="Overview.html#contents" rel="contents" title="Table of contents">
1.11      mike      145:   <link href="dnd.html" rel="next" title="7.6 Drag and drop">
1.20    ! mike      146:   <body class="split chapter" onload="fixBrokenLink(); None"><div class="head" id="head">
1.1       mike      147: <div aria-haspopup="true" id="jumpIndexA-button" role="button" tabindex="0">jump
1.18      mike      148: <div id="jumpIndexA"><ul><li><a class="noindex" href="the-a-element.html#the-a-element">a</a><a class="noindex" href="the-abbr-element.html#the-abbr-element">abbr</a><a class="noindex" href="the-address-element.html#the-address-element">address</a><a class="noindex" href="the-area-element.html#the-area-element">area</a><a class="noindex" href="the-article-element.html#the-article-element">article</a><a class="noindex" href="the-aside-element.html#the-aside-element">aside</a><a class="noindex" href="the-audio-element.html#the-audio-element">audio</a></ul><ul><li><a class="noindex" href="the-b-element.html#the-b-element">b</a><a class="noindex" href="the-base-element.html#the-base-element">base</a><a class="noindex" href="the-bdi-element.html#the-bdi-element">bdi</a><a class="noindex" href="the-bdo-element.html#the-bdo-element">bdo</a><a class="noindex" href="the-blockquote-element.html#the-blockquote-element">blockquote</a><a class="noindex" href="the-body-element.html#the-body-element">body</a><a class="noindex" href="the-br-element.html#the-br-element">br</a><a class="noindex" href="the-button-element.html#the-button-element">button</a></ul><ul><li><a class="noindex" href="the-canvas-element.html#the-canvas-element">canvas</a><a class="noindex" href="the-caption-element.html#the-caption-element">caption</a><a class="noindex" href="the-cite-element.html#the-cite-element">cite</a><a class="noindex" href="the-code-element.html#the-code-element">code</a><a class="noindex" href="the-col-element.html#the-col-element">col</a><a class="noindex" href="the-colgroup-element.html#the-colgroup-element">colgroup</a><a class="noindex" href="the-command-element.html#the-command-element">command</a></ul><ul><li><a class="noindex" href="the-datalist-element.html#the-datalist-element">datalist</a><a class="noindex" href="the-dd-element.html#the-dd-element">dd</a><a class="noindex" href="the-del-element.html#the-del-element">del</a><a class="noindex" href="the-details-element.html#the-details-element">details</a><a class="noindex" href="the-dfn-element.html#the-dfn-element">dfn</a><a class="noindex" href="the-div-element.html#the-div-element">div</a><a class="noindex" href="the-dl-element.html#the-dl-element">dl</a><a class="noindex" href="the-dt-element.html#the-dt-element">dt</a></ul><ul><li><a class="noindex" href="the-em-element.html#the-em-element">em</a><a class="noindex" href="the-embed-element.html#the-embed-element">embed</a><a class="noindex" href="the-fieldset-element.html#the-fieldset-element">fieldset</a><a class="noindex" href="the-figcaption-element.html#the-figcaption-element">figcaption</a><a class="noindex" href="the-figure-element.html#the-figure-element">figure</a><a class="noindex" href="the-footer-element.html#the-footer-element">footer</a><a class="noindex" href="the-form-element.html#the-form-element">form</a></ul><ul><li><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h2</a><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h3</a><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h4</a><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h5</a><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h6</a><a class="noindex" href="the-head-element.html#the-head-element">head</a><a class="noindex" href="the-header-element.html#the-header-element">header</a><a class="noindex" href="the-hgroup-element.html#the-hgroup-element">hgroup</a><a class="noindex" href="the-hr-element.html#the-hr-element">hr</a><a class="noindex" href="the-html-element.html#the-html-element">html</a></ul><ul><li><a class="noindex" href="the-i-element.html#the-i-element">i</a><a class="noindex" href="the-iframe-element.html#the-iframe-element">iframe</a><a class="noindex" href="the-img-element.html#the-img-element">img</a><a class="noindex" href="the-input-element.html#the-input-element">input</a><a class="noindex" href="the-ins-element.html#the-ins-element">ins</a><a class="noindex" href="the-kbd-element.html#the-kbd-element">kbd</a><a class="noindex" href="the-keygen-element.html#the-keygen-element">keygen</a></ul><ul><li><a class="noindex" href="the-label-element.html#the-label-element">label</a><a class="noindex" href="the-legend-element.html#the-legend-element">legend</a><a class="noindex" href="the-li-element.html#the-li-element">li</a><a class="noindex" href="the-link-element.html#the-link-element">link</a><a class="noindex" href="the-map-element.html#the-map-element">map</a><a class="noindex" href="the-mark-element.html#the-mark-element">mark</a><a class="noindex" href="the-menu-element.html#the-menu-element">menu</a><a class="noindex" href="the-meta-element.html#the-meta-element">meta</a><a class="noindex" href="the-meter-element.html#the-meter-element">meter</a></ul><ul><li><a class="noindex" href="the-nav-element.html#the-nav-element">nav</a><a class="noindex" href="the-noscript-element.html#the-noscript-element">noscript</a><a class="noindex" href="the-object-element.html#the-object-element">object</a><a class="noindex" href="the-ol-element.html#the-ol-element">ol</a><a class="noindex" href="the-optgroup-element.html#the-optgroup-element">optgroup</a><a class="noindex" href="the-option-element.html#the-option-element">option</a><a class="noindex" href="the-output-element.html#the-output-element">output</a></ul><ul><li><a class="noindex" href="the-p-element.html#the-p-element">p</a><a class="noindex" href="the-param-element.html#the-param-element">param</a><a class="noindex" href="the-pre-element.html#the-pre-element">pre</a><a class="noindex" href="the-progress-element.html#the-progress-element">progress</a><a class="noindex" href="the-q-element.html#the-q-element">q</a><a class="noindex" href="the-rp-element.html#the-rp-element">rp</a><a class="noindex" href="the-rt-element.html#the-rt-element">rt</a><a class="noindex" href="the-ruby-element.html#the-ruby-element">ruby</a></ul><ul><li><a class="noindex" href="the-s-element.html#the-s-element">s</a><a class="noindex" href="the-samp-element.html#the-samp-element">samp</a><a class="noindex" href="the-script-element.html#the-script-element">script</a><a class="noindex" href="the-section-element.html#the-section-element">section</a><a class="noindex" href="the-select-element.html#the-select-element">select</a><a class="noindex" href="the-small-element.html#the-small-element">small</a><a class="noindex" href="the-source-element.html#the-source-element">source</a><a class="noindex" href="the-span-element.html#the-span-element">span</a></ul><ul><li><a class="noindex" href="the-strong-element.html#the-strong-element">strong</a><a class="noindex" href="the-style-element.html#the-style-element">style</a><a class="noindex" href="the-sub-and-sup-elements.html#the-sub-and-sup-elements">sub</a><a class="noindex" href="the-summary-element.html#the-summary-element">summary</a><a class="noindex" href="the-sub-and-sup-elements.html#the-sub-and-sup-elements">sup</a></ul><ul><li><a class="noindex" href="the-table-element.html#the-table-element">table</a><a class="noindex" href="the-tbody-element.html#the-tbody-element">tbody</a><a class="noindex" href="the-td-element.html#the-td-element">td</a><a class="noindex" href="the-textarea-element.html#the-textarea-element">textarea</a><a class="noindex" href="the-tfoot-element.html#the-tfoot-element">tfoot</a><a class="noindex" href="the-th-element.html#the-th-element">th</a><a class="noindex" href="the-thead-element.html#the-thead-element">thead</a><a class="noindex" href="the-time-element.html#the-time-element">time</a><a class="noindex" href="the-title-element.html#the-title-element">title</a></ul><ul><li><a class="noindex" href="the-tr-element.html#the-tr-element">tr</a><a class="noindex" href="the-track-element.html#the-track-element">track</a><a class="noindex" href="the-u-element.html#the-u-element">u</a><a class="noindex" href="the-ul-element.html#the-ul-element">ul</a><a class="noindex" href="the-var-element.html#the-var-element">var</a><a class="noindex" href="the-video-element.html#the-video-element">video</a><a class="noindex" href="the-wbr-element.html#the-wbr-element">wbr</a></ul><ul class="jumpIndexA-other"><li><a class="noindex" href="global-attributes.html#global-attributes">global attributes</a><a class="noindex" href="index-of-terms.html#index-of-terms">terms</a></ul></div></div>
1.1       mike      149: <script src="jump-indexes.js"></script><p><a href="http://www.w3.org/"><img alt="W3C" height="48" src="http://www.w3.org/Icons/w3c_home" width="72"></a></p>
                    150: 
                    151:    <h1>HTML5: Edition for Web Authors</h1>
                    152:    
                    153:    </div><div class="prev_next">
1.11      mike      154:    <a href="editing.html">&larr; 7 User interaction</a> &ndash;
1.1       mike      155:    <a href="Overview.html#contents">Table of contents</a> &ndash;
1.11      mike      156:    <a href="dnd.html">7.6 Drag and drop &rarr;</a>
1.13      mike      157:   <ol class="toc"><li><ol><li><ol><li><a href="editing-apis.html#editing-apis"><span class="secno">7.5.4 </span>Editing APIs</a><li><a href="editing-apis.html#spelling-and-grammar-checking"><span class="secno">7.5.5 </span>Spelling and grammar checking</a></ol></ol></ol></div>
1.1       mike      158: 
1.13      mike      159:   <h4 id="editing-apis"><span class="secno">7.5.4 </span>Editing APIs</h4><p>The definition of the terms <dfn aria-haspopup="true" id="active-range" role="button" tabindex="0">active range</dfn>, <dfn aria-haspopup="true" id="editing-host" role="button" tabindex="0">editing
1.11      mike      160:   host</dfn>, and <dfn aria-haspopup="true" id="editable" role="button" tabindex="0">editable</dfn>, the user interface requirements
1.13      mike      161:   of elements that are <a href="#editing-host" id="editing-host_1" title="editing host">editing hosts</a>
1.19      mike      162:   or <a href="#editable" id="editable_0">editable</a>, the
1.11      mike      163: 
                    164:   <dfn aria-haspopup="true" id="execCommand" role="button" tabindex="0"><code>execCommand()</code></dfn>,
                    165:   <dfn aria-haspopup="true" id="dom-document-querycommandenabled" role="button" tabindex="0"><code>queryCommandEnabled()</code></dfn>,
                    166:   <dfn aria-haspopup="true" id="dom-document-querycommandindeterm" role="button" tabindex="0"><code>queryCommandIndeterm()</code></dfn>,
                    167:   <dfn aria-haspopup="true" id="dom-document-querycommandstate" role="button" tabindex="0"><code>queryCommandState()</code></dfn>,
                    168:   <dfn aria-haspopup="true" id="dom-document-querycommandsupported" role="button" tabindex="0"><code>queryCommandSupported()</code></dfn>, and
                    169:   <dfn aria-haspopup="true" id="dom-document-querycommandvalue" role="button" tabindex="0"><code>queryCommandValue()</code></dfn>
                    170: 
1.19      mike      171:   methods, and text selections are defined in the HTML Editing APIs
                    172:   specification. The interaction of editing and the undo/redo features
                    173:   in user agents is defined by the UndoManager and DOM Transaction
                    174:   specification. <a href="references.html#refsEDITING">[EDITING]</a> <a href="references.html#refsUNDO">[UNDO]</a><h4 id="spelling-and-grammar-checking"><span class="secno">7.5.5 </span>Spelling and grammar checking</h4><p>The <dfn aria-haspopup="true" id="attr-spellcheck" role="button" tabindex="0"><code>spellcheck</code></dfn>
1.11      mike      175:   attribute is an <a href="common-microsyntaxes.html#enumerated-attribute" id="enumerated-attribute_18">enumerated attribute</a> whose keywords are
                    176:   the empty string, <code title="">true</code> and <code title="">false</code>. The empty string and the <code title="">true</code> keyword map to the <i>true</i> state. The <code title="">false</code> keyword maps to the <i>false</i> state. In
                    177:   addition, there is a third state, the <a href="common-input-element-attributes.html#attr-input-autocomplete-default-state" id="default_4"><i>default</i></a> state, which is
                    178:   the <i>missing value default</i> (and the <i>invalid value
1.12      mike      179:   default</i>).<p class="note">The <i>true</i> state indicates that the element is
                    180:   to have its spelling and grammar checked. The <a href="common-input-element-attributes.html#attr-input-autocomplete-default-state" id="default_5"><i>default</i></a> state
                    181:   indicates that the element is to act according to a default
                    182:   behavior, possibly based on the parent element's own <code title="attr-spellcheck"><a href="#attr-spellcheck" id="spellcheck_0">spellcheck</a></code> state, as defined below.
                    183:   The <i>false</i> state indicates that the element is not to be
                    184:   checked.<dl class="domintro"><dt><var title="">element</var> . <code id="dom-spellcheck" title="dom-spellcheck"><a href="#dom-spellcheck">spellcheck</a></code> [ = <var title="">value</var> ]</dt>
1.1       mike      185: 
                    186:    <dd>
                    187: 
1.11      mike      188:     <p>Returns true if the element is to have its spelling and grammar
                    189:     checked; otherwise, returns false.</p>
1.1       mike      190: 
1.11      mike      191:     <p>Can be set, to override the default and set the <code title="attr-spellcheck"><a href="#attr-spellcheck" id="spellcheck_1">spellcheck</a></code> content attribute.</p>
1.1       mike      192: 
                    193:    </dd>
                    194: 
1.11      mike      195:   </dl><p class="note">This specification does not define the user
                    196:   interface for spelling and grammar checkers. A user agent could
                    197:   offer on-demand checking, could perform continuous checking while
                    198:   the checking is enabled, or could use other interfaces.

Webmaster