1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/.
*
* The origin of this IDL file is
* https://w3c.github.io/selection-api/#selection-interface
*
* Copyright © 2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
* liability, trademark and document use rules apply.
*/
[Exposed=Window]
interface Selection {
[NeedsCallerType]
readonly attribute Node? anchorNode;
[NeedsCallerType]
readonly attribute unsigned long anchorOffset;
[NeedsCallerType]
readonly attribute Node? focusNode;
[NeedsCallerType]
readonly attribute unsigned long focusOffset;
readonly attribute boolean isCollapsed;
/**
* Returns the number of ranges in the selection.
*/
readonly attribute unsigned long rangeCount;
readonly attribute DOMString type;
/**
* Returns the range at the specified index. Throws if the index is
* out of range.
*/
[Throws]
Range getRangeAt(unsigned long index);
/**
* Adds a range to the current selection.
*/
[Throws, BinaryName="addRangeJS"]
undefined addRange(Range range);
/**
* Removes a range from the current selection.
*/
[Throws, BinaryName="removeRangeAndUnselectFramesAndNotifyListeners"]
undefined removeRange(Range range);
/**
* Removes all ranges from the current selection.
*/
[Throws]
undefined removeAllRanges();
[Throws, BinaryName="RemoveAllRanges"]
undefined empty();
[Throws, BinaryName="collapseJS"]
undefined collapse(Node? node, optional unsigned long offset = 0);
[Throws, BinaryName="collapseJS"]
undefined setPosition(Node? node, optional unsigned long offset = 0);
[Throws, BinaryName="collapseToStartJS"]
undefined collapseToStart();
[Throws, BinaryName="collapseToEndJS"]
undefined collapseToEnd();
[Throws, BinaryName="extendJS"]
undefined extend(Node node, optional unsigned long offset = 0);
[Throws, BinaryName="setBaseAndExtentJS"]
undefined setBaseAndExtent(Node anchorNode,
unsigned long anchorOffset,
Node focusNode,
unsigned long focusOffset);
[Throws, BinaryName="selectAllChildrenJS"]
undefined selectAllChildren(Node node);
[CEReactions, Throws]
undefined deleteFromDocument();
[Throws]
boolean containsNode(Node node,
optional boolean allowPartialContainment = false);
stringifier DOMString ();
};
// Additional methods not currently in the spec
partial interface Selection {
[Throws]
undefined modify(DOMString alter, DOMString direction,
DOMString granularity);
};
// Additional chrome-only methods.
interface nsISelectionListener;
partial interface Selection {
/**
* A true value means "selection after newline"; false means "selection before
* newline" when a selection is positioned "between lines".
*/
[ChromeOnly,Throws, BinaryName=interlinePositionJS]
attribute boolean interlinePosition;
[Throws]
attribute short? caretBidiLevel;
[ChromeOnly,Throws]
DOMString toStringWithFormat(DOMString formatType, unsigned long flags, long wrapColumn);
[ChromeOnly]
undefined addSelectionListener(nsISelectionListener newListener);
[ChromeOnly]
undefined removeSelectionListener(nsISelectionListener listenerToRemove);
[ChromeOnly,BinaryName="rawType"]
readonly attribute short selectionType;
/**
* Return array of ranges intersecting with the given DOM interval.
*/
[ChromeOnly,Throws,Pref="dom.testing.selection.GetRangesForInterval"]
sequence<Range> GetRangesForInterval(Node beginNode, long beginOffset, Node endNode, long endOffset,
boolean allowAdjacent);
/**
* Scrolls a region of the selection, so that it is visible in
* the scrolled view.
*
* @param aRegion the region inside the selection to scroll into view
* (see selection region constants defined in
* nsISelectionController).
* @param aIsSynchronous when true, scrolls the selection into view
* before returning. If false, posts a request which
* is processed at some point after the method returns.
* @param aVPercent how to align the frame vertically.
* @param aHPercent how to align the frame horizontally.
*/
[ChromeOnly,Throws]
undefined scrollIntoView(short aRegion, boolean aIsSynchronous, short aVPercent, short aHPercent);
/**
* setColors() sets custom colors for the selection.
* Currently, this is supported only when the selection type is SELECTION_FIND.
* Otherwise, throws an exception.
*
* @param aForegroundColor The foreground color of the selection.
* If this is "currentColor", foreground color
* isn't changed by this selection.
* @param aBackgroundColor The background color of the selection.
* If this is "transparent", background color is
* never painted.
* @param aAltForegroundColor The alternative foreground color of the
* selection.
* If aBackgroundColor doesn't have sufficient
* contrast with its around or foreground color
* if "currentColor" is specified, alternative
* colors are used if it have higher contrast.
* @param aAltBackgroundColor The alternative background color of the
* selection.
*/
[ChromeOnly,Throws]
undefined setColors(DOMString aForegroundColor, DOMString aBackgroundColor,
DOMString aAltForegroundColor, DOMString aAltBackgroundColor);
/**
* resetColors() forget the customized colors which were set by setColors().
*/
[ChromeOnly]
undefined resetColors();
};
|
