EditContext API

Text Input Service（テキスト入力サービス）と Text Edit Context（テキスト編集コンテキスト）は、多くのオペレーティングシステムに共通するテキスト入力の側面を表現する抽象化である。 EditContext は、Text Edit Context の JavaScript による表現である。 Text Edit Context に Text Input Service による変更が加えられると、その変更はイベントという形で非同期に著者へと通知され、それらのイベントは active EditContext に対してディスパッチされる。 著者が active EditContext に変更を加えると、その変更は次のライフサイクル更新時に Text Edit Context に反映される。

WebIDLpartial interface HTMLElement {
     attribute EditContext? editContext;
};

HTMLElement は、内部スロット [[EditContext]] を持つ。これは EditContext への参照であり、初期値は null である。

editContext

editContext の getter 手順は、this の内部 [[EditContext]] スロットの値を返すことである。

editContext の setter は、次の手順に従わなければならない：

Input

editContext

Output

None

1. this の local name が、valid shadow host name でも "canvas" でもない場合、"NotSupportedError" DOMException を throw する。
2. editContext が null でない場合：
   1. editContext の associated element が this と等しいなら、これらの手順を終了する。
   2. editContext の associated element が null でない場合、"NotSupportedError" DOMException を throw する。
3. oldEditContext を、this の内部 [[EditContext]] スロットの値とする。
4. oldEditContext が null でなく、かつ oldEditContext が this の node document の active EditContext である場合：
   1. oldEditContext を引数に、deactivate an EditContext の手順を実行する。
   2. oldEditContext の associated element が this と等しくないなら、これらの手順を終了する。
   3. editContext が null でなく、かつ editContext の associated element が null でなく、かつ editContext の associated element が this と等しくない場合、"NotSupportedError" DOMException を throw する。
5. oldEditContext が null でない場合、oldEditContext の associated element を null に設定する。
6. editContext が null でない場合、editContext の associated element を this に設定する。
7. this の内部 [[EditContext]] スロットを editContext に設定する。

WebIDLdictionary EditContextInit {
    DOMString text = "";
    unsigned long selectionStart = 0;
    unsigned long selectionEnd = 0;
};

[Exposed=Window]
interface EditContext : EventTarget {
    constructor(optional EditContextInit options = {});

    undefined updateText(unsigned long rangeStart, unsigned long rangeEnd,
        DOMString text);
    undefined updateSelection(unsigned long start, unsigned long end);
    undefined updateControlBounds(DOMRect controlBounds);
    undefined updateSelectionBounds(DOMRect selectionBounds);
    undefined updateCharacterBounds(unsigned long rangeStart, sequence<DOMRect> characterBounds);

    sequence<HTMLElement> attachedElements();

    readonly attribute DOMString text;
    readonly attribute unsigned long selectionStart;
    readonly attribute unsigned long selectionEnd;
    readonly attribute unsigned long characterBoundsRangeStart;
    sequence<DOMRect> characterBounds();

    attribute EventHandler ontextupdate;
    attribute EventHandler ontextformatupdate;
    attribute EventHandler oncharacterboundsupdate;
    attribute EventHandler oncompositionstart;
    attribute EventHandler oncompositionend;
};

text

text の getter 手順は、this の text を返すことである。

selectionStart

selectionStart の getter 手順は、this の selection start を返すことである。

selectionEnd

selectionEnd の getter 手順は、this の selection end を返すことである。

characterBounds

characterBounds の getter 手順は、this の codepoint rects を返すことである。

characterBoundsRangeStart

characterBoundsRangeStart の getter 手順は、this の codepoint rects start index を返すことである。

updateText() method

このメソッドは次の手順に従わなければならない：

Input

rangeStart, unsigned long

rangeEnd, unsigned long

newText, DOMString

Output

None

1. text のうち rangeStart から rangeEnd の範囲の部分文字列を newText で置換する。
   Note

   rangeStart > rangeEnd であっても許容される。 インデックス間の部分文字列は、 rangeStart と rangeEnd が入れ替えられていた場合と同じ方法で置換されるべきである。

updateSelection() method

このメソッドは次の手順に従わなければならない：

Input

start, unsigned long

end, unsigned long

Output

None

1. selection start を start に設定する。
2. selection end を end に設定する。

updateSelectionBounds() method

このメソッドは次の手順に従わなければならない：

Input

selectionBounds, DOMRect

Output

None

1. selection bounds を selectionBounds に設定する。

updateControlBounds() method

このメソッドは次の手順に従わなければならない：

Input

controlBounds, DOMRect

Output

None

1. control bounds を controlBounds に設定する。

updateCharacterBounds() method

このメソッドは次の手順に従わなければならない：

Input

rangeStart, unsigned long

characterBounds, DOMRect の配列

Output

None

1. codepoint rects start index を rangeStart に設定する。
2. codepoint rects を characterBounds に設定する。

attachedElements() method

このメソッドは、EditContext の associated element を唯一の要素として持つリストを返す。ただし、EditContext の associated element が null の場合は空のリストを返す。

Note

このメソッドが単一の要素ではなくリストを返すのは、将来、EditContext が複数の associated elements を持てるようになった場合の前方互換性のためである。

ontextupdate

TextUpdateEvent のイベントハンドラ。

oncharacterboundsupdate

CharacterBoundsUpdateEvent のイベントハンドラ。

ontextformatupdate

TextFormatUpdateEvent のイベントハンドラ。

oncompositionstart

compositionstart イベントのイベントハンドラ。

oncompositionend

compositionend イベントのイベントハンドラ。

WebIDLdictionary TextUpdateEventInit : EventInit {
    unsigned long updateRangeStart = 0;
    unsigned long updateRangeEnd = 0;
    DOMString text = "";
    unsigned long selectionStart = 0;
    unsigned long selectionEnd = 0;
};

[Exposed=Window]
interface TextUpdateEvent : Event {
    constructor(DOMString type, optional TextUpdateEventInit options = {});
    readonly attribute unsigned long updateRangeStart;
    readonly attribute unsigned long updateRangeEnd;
    readonly attribute DOMString text;
    readonly attribute unsigned long selectionStart;
    readonly attribute unsigned long selectionEnd;
};

updateRangeStart, of type unsigned long, readonly

置換される範囲の開始位置。

updateRangeEnd, of type unsigned long, readonly

置換される範囲の終了位置。

text, of type DOMString, readonly

当該範囲において古い文字列を置換する新しい文字列。

selectionStart, of type unsigned long, readonly

テキスト置換後の選択範囲の開始位置。

selectionEnd, of type unsigned long, readonly

テキスト置換後の選択範囲の終了位置。

WebIDLenum UnderlineStyle { "none", "solid", "dotted", "dashed", "wavy" };
enum UnderlineThickness { "none", "thin", "thick" };

dictionary TextFormatInit {
    unsigned long rangeStart = 0;
    unsigned long rangeEnd = 0;
    UnderlineStyle underlineStyle = "none";
    UnderlineThickness underlineThickness = "none";
};

[Exposed=Window]
interface TextFormat {
    constructor(optional TextFormatInit options = {});
    readonly attribute unsigned long rangeStart;
    readonly attribute unsigned long rangeEnd;
    readonly attribute UnderlineStyle underlineStyle;
    readonly attribute UnderlineThickness underlineThickness;
};

dictionary TextFormatUpdateEventInit : EventInit {
    sequence<TextFormat> textFormats = [];
};

[Exposed=Window]
interface TextFormatUpdateEvent : Event {
    constructor(DOMString type, optional TextFormatUpdateEventInit options = {});
    sequence<TextFormat> getTextFormats();
};

rangeStart, of type unsigned long, readonly

装飾を適用すべき最初のコードポイントの直前の位置を表すオフセット。

rangeEnd, of type unsigned long, readonly

装飾を適用すべき最後のコードポイントの直後の位置を表すオフセット。

underlineStyle, of type UnderlineStyle, readonly

装飾されたテキスト範囲に対して希望される下線スタイル。

underlineThickness, of type UnderlineThickness, readonly

装飾されたテキスト範囲に対して希望される下線の太さ。

getTextFormats method

this の text format list を返す。

TextFormatUpdateEvent は、関連付けられた text format list を持つ。これは、0 個以上の text format からなるリストである。

WebIDLdictionary CharacterBoundsUpdateEventInit : EventInit {
    unsigned long rangeStart = 0;
    unsigned long rangeEnd = 0;
};

[Exposed=Window]
interface CharacterBoundsUpdateEvent : Event {
    constructor(DOMString type, optional CharacterBoundsUpdateEventInit options = {});
    readonly attribute unsigned long rangeStart;
    readonly attribute unsigned long rangeEnd;
};

rangeStart, of type unsigned long, readonly

Text Input Service が文字境界を必要とする範囲の開始位置。

rangeEnd, of type unsigned long, readonly

Text Input Service が文字境界を必要とする範囲の終了位置。