Skip to content

Commit 6f0e00c

Browse files
committed
add API docs
1 parent 705ce8a commit 6f0e00c

File tree

115 files changed

+44076
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

115 files changed

+44076
-1
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ _site
66
_config-prod.yml
77
_config-local.yml
88
node_modules
9-
api
109
vendor
1110
.idea
1211
.DS_Store

modules/ROOT/nav.adoc

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,3 +204,122 @@ This is a nav file. the following info is for reference only at this time.
204204
** xref:themes/inlite.adoc[]
205205
** xref:themes/mobile.adoc[]
206206
** xref:themes/modern.adoc[]
207+
208+
* xref:api/index.adoc[]
209+
** xref:api/tinymce/root_tinymce.adoc[]
210+
*** xref:api/tinymce/tinymce.addonmanager.adoc[]
211+
*** xref:api/tinymce/tinymce.annotator.adoc[]
212+
*** xref:api/tinymce/tinymce.editor.adoc[]
213+
*** xref:api/tinymce/tinymce.editorcommands.adoc[]
214+
*** xref:api/tinymce/tinymce.editormanager.adoc[]
215+
*** xref:api/tinymce/tinymce.editorobservable.adoc[]
216+
*** xref:api/tinymce/tinymce.env.adoc[]
217+
*** xref:api/tinymce/tinymce.event.adoc[]
218+
*** xref:api/tinymce/tinymce.focusmanager.adoc[]
219+
*** xref:api/tinymce/tinymce.formatter.adoc[]
220+
*** xref:api/tinymce/tinymce.notificationmanager.adoc[]
221+
*** xref:api/tinymce/tinymce.plugin.adoc[]
222+
*** xref:api/tinymce/tinymce.shortcuts.adoc[]
223+
*** xref:api/tinymce/tinymce.theme.adoc[]
224+
*** xref:api/tinymce/tinymce.undomanager.adoc[]
225+
*** xref:api/tinymce/tinymce.windowmanager.adoc[]
226+
227+
** xref:api/tinymce.dom.adoc[]
228+
*** xref:api/tinymce.dom/tinymce.dom.bookmarkmanager.adoc[]
229+
*** xref:api/tinymce.dom/tinymce.dom.controlselection.adoc[]
230+
*** xref:api/tinymce.dom/tinymce.dom.domquery.adoc[]
231+
*** xref:api/tinymce.dom/tinymce.dom.domutils.adoc[]
232+
*** xref:api/tinymce.dom/tinymce.dom.eventutils.adoc[]
233+
*** xref:api/tinymce.dom/tinymce.dom.rangeutils.adoc[]
234+
*** xref:api/tinymce.dom/tinymce.dom.scriptloader.adoc[]
235+
*** xref:api/tinymce.dom/tinymce.dom.selection.adoc[]
236+
*** xref:api/tinymce.dom/tinymce.dom.serializer.adoc[]
237+
*** xref:api/tinymce.dom/tinymce.dom.treewalker.adoc[]
238+
239+
** xref:api/tinymce.geom.adoc[]
240+
*** xref:api/tinymce.geom/tinymce.geom.rect.adoc[]
241+
242+
** xref:api/tinymce.html.adoc[]
243+
*** xref:api/tinymce.html/tinymce.html.domparser.adoc[]
244+
*** xref:api/tinymce.html/tinymce.html.entities.adoc[]
245+
*** xref:api/tinymce.html/tinymce.html.node.adoc[]
246+
*** xref:api/tinymce.html/tinymce.html.saxparser.adoc[]
247+
*** xref:api/tinymce.html/tinymce.html.schema.adoc[]
248+
*** xref:api/tinymce.html/tinymce.html.serializer.adoc[]
249+
*** xref:api/tinymce.html/tinymce.html.styles.adoc[]
250+
*** xref:api/tinymce.html/tinymce.html.writer.adoc[]
251+
252+
** xref:api/tinymce.ui.adoc[]
253+
*** xref:api/tinymce.ui/tinymce.ui.absolutelayout.adoc[]
254+
*** xref:api/tinymce.ui/tinymce.ui.browsebutton.adoc[]
255+
*** xref:api/tinymce.ui/tinymce.ui.button.adoc[]
256+
*** xref:api/tinymce.ui/tinymce.ui.buttongroup.adoc[]
257+
*** xref:api/tinymce.ui/tinymce.ui.checkbox.adoc[]
258+
*** xref:api/tinymce.ui/tinymce.ui.collection.adoc[]
259+
*** xref:api/tinymce.ui/tinymce.ui.colorbox.adoc[]
260+
*** xref:api/tinymce.ui/tinymce.ui.colorbutton.adoc[]
261+
*** xref:api/tinymce.ui/tinymce.ui.colorpicker.adoc[]
262+
*** xref:api/tinymce.ui/tinymce.ui.combobox.adoc[]
263+
*** xref:api/tinymce.ui/tinymce.ui.container.adoc[]
264+
*** xref:api/tinymce.ui/tinymce.ui.control.adoc[]
265+
*** xref:api/tinymce.ui/tinymce.ui.draghelper.adoc[]
266+
*** xref:api/tinymce.ui/tinymce.ui.dropzone.adoc[]
267+
*** xref:api/tinymce.ui/tinymce.ui.elementpath.adoc[]
268+
*** xref:api/tinymce.ui/tinymce.ui.factory.adoc[]
269+
*** xref:api/tinymce.ui/tinymce.ui.fieldset.adoc[]
270+
*** xref:api/tinymce.ui/tinymce.ui.filepicker.adoc[]
271+
*** xref:api/tinymce.ui/tinymce.ui.fitlayout.adoc[]
272+
*** xref:api/tinymce.ui/tinymce.ui.flexlayout.adoc[]
273+
*** xref:api/tinymce.ui/tinymce.ui.floatpanel.adoc[]
274+
*** xref:api/tinymce.ui/tinymce.ui.flowlayout.adoc[]
275+
*** xref:api/tinymce.ui/tinymce.ui.form.adoc[]
276+
*** xref:api/tinymce.ui/tinymce.ui.formitem.adoc[]
277+
*** xref:api/tinymce.ui/tinymce.ui.gridlayout.adoc[]
278+
*** xref:api/tinymce.ui/tinymce.ui.iframe.adoc[]
279+
*** xref:api/tinymce.ui/tinymce.ui.infobox.adoc[]
280+
*** xref:api/tinymce.ui/tinymce.ui.keyboardnavigation.adoc[]
281+
*** xref:api/tinymce.ui/tinymce.ui.label.adoc[]
282+
*** xref:api/tinymce.ui/tinymce.ui.layout.adoc[]
283+
*** xref:api/tinymce.ui/tinymce.ui.listbox.adoc[]
284+
*** xref:api/tinymce.ui/tinymce.ui.menu.adoc[]
285+
*** xref:api/tinymce.ui/tinymce.ui.menubar.adoc[]
286+
*** xref:api/tinymce.ui/tinymce.ui.menubutton.adoc[]
287+
*** xref:api/tinymce.ui/tinymce.ui.menuitem.adoc[]
288+
*** xref:api/tinymce.ui/tinymce.ui.messagebox.adoc[]
289+
*** xref:api/tinymce.ui/tinymce.ui.movable.adoc[]
290+
*** xref:api/tinymce.ui/tinymce.ui.notification.adoc[]
291+
*** xref:api/tinymce.ui/tinymce.ui.panel.adoc[]
292+
*** xref:api/tinymce.ui/tinymce.ui.panelbutton.adoc[]
293+
*** xref:api/tinymce.ui/tinymce.ui.path.adoc[]
294+
*** xref:api/tinymce.ui/tinymce.ui.progress.adoc[]
295+
*** xref:api/tinymce.ui/tinymce.ui.radio.adoc[]
296+
*** xref:api/tinymce.ui/tinymce.ui.reflowqueue.adoc[]
297+
*** xref:api/tinymce.ui/tinymce.ui.resizable.adoc[]
298+
*** xref:api/tinymce.ui/tinymce.ui.resizehandle.adoc[]
299+
*** xref:api/tinymce.ui/tinymce.ui.scrollable.adoc[]
300+
*** xref:api/tinymce.ui/tinymce.ui.selectbox.adoc[]
301+
*** xref:api/tinymce.ui/tinymce.ui.selector.adoc[]
302+
*** xref:api/tinymce.ui/tinymce.ui.slider.adoc[]
303+
*** xref:api/tinymce.ui/tinymce.ui.spacer.adoc[]
304+
*** xref:api/tinymce.ui/tinymce.ui.splitbutton.adoc[]
305+
*** xref:api/tinymce.ui/tinymce.ui.stacklayout.adoc[]
306+
*** xref:api/tinymce.ui/tinymce.ui.tabpanel.adoc[]
307+
*** xref:api/tinymce.ui/tinymce.ui.textbox.adoc[]
308+
*** xref:api/tinymce.ui/tinymce.ui.throbber.adoc[]
309+
*** xref:api/tinymce.ui/tinymce.ui.toolbar.adoc[]
310+
*** xref:api/tinymce.ui/tinymce.ui.tooltip.adoc[]
311+
*** xref:api/tinymce.ui/tinymce.ui.widget.adoc[]
312+
*** xref:api/tinymce.ui/tinymce.ui.window.adoc[]
313+
314+
** xref:api/tinymce.util.adoc[]
315+
*** xref:api/tinymce.util/tinymce.util.color.adoc[]
316+
*** xref:api/tinymce.util/tinymce.util.delay.adoc[]
317+
*** xref:api/tinymce.util/tinymce.util.eventdispatcher.adoc[]
318+
*** xref:api/tinymce.util/tinymce.util.i18n.adoc[]
319+
*** xref:api/tinymce.util/tinymce.util.json.adoc[]
320+
*** xref:api/tinymce.util/tinymce.util.jsonrequest.adoc[]
321+
*** xref:api/tinymce.util/tinymce.util.localstorage.adoc[]
322+
*** xref:api/tinymce.util/tinymce.util.observable.adoc[]
323+
*** xref:api/tinymce.util/tinymce.util.tools.adoc[]
324+
*** xref:api/tinymce.util/tinymce.util.uri.adoc[]
325+
*** xref:api/tinymce.util/tinymce.util.xhr.adoc[]

modules/ROOT/pages/api/index.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
= API Reference
2+
3+
JavaScript API reference for TinyMCE
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
= tinymce.dom
2+
3+
APIs for working with the DOM from within the editor.
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
= tinymce.dom.BookmarkManager
2+
3+
This class handles selection bookmarks.
4+
5+
[#constructors .anchor]##
6+
7+
== link:#constructors[Constructors]
8+
9+
[cols=",,",options="header",]
10+
|===
11+
|name |summary |defined by
12+
|link:#bookmarkmanager[BookmarkManager()] |Constructs a new BookmarkManager instance for a specific selection instance. |link:/docs-4x/api/tinymce.dom/tinymce.dom.bookmarkmanager[tinymce.dom.BookmarkManager]
13+
|===
14+
15+
[#methods .anchor]##
16+
17+
== link:#methods[Methods]
18+
19+
[cols=",,",options="header",]
20+
|===
21+
|name |summary |defined by
22+
|link:#getbookmark[getBookmark()] |Returns a bookmark location for the current selection. This bookmark object can then be used to restore the selection after some content modification to the document. |link:/docs-4x/api/tinymce.dom/tinymce.dom.bookmarkmanager[tinymce.dom.BookmarkManager]
23+
|link:#isbookmarknode[isBookmarkNode()] |Returns true/false if the specified node is a bookmark node or not. |link:/docs-4x/api/tinymce.dom/tinymce.dom.bookmarkmanager[tinymce.dom.BookmarkManager]
24+
|link:#movetobookmark[moveToBookmark()] |Restores the selection to the specified bookmark. |link:/docs-4x/api/tinymce.dom/tinymce.dom.bookmarkmanager[tinymce.dom.BookmarkManager]
25+
|===
26+
27+
== Constructors
28+
29+
[#bookmarkmanager .anchor]##
30+
31+
=== link:#bookmarkmanager[BookmarkManager]
32+
33+
public constructor function BookmarkManager(selection:tinymce.dom.Selection)
34+
35+
Constructs a new BookmarkManager instance for a specific selection instance.
36+
37+
==== Parameters
38+
39+
* [.param-name]#selection# link:/docs-4x/api/tinymce.dom/tinymce.dom.selection[[.param-type]#(tinymce.dom.Selection)#] - Selection instance to handle bookmarks for.
40+
41+
== Methods
42+
43+
[#getbookmark .anchor]##
44+
45+
=== link:#getbookmark[getBookmark]
46+
47+
getBookmark(type:Number, normalized:Boolean):Object
48+
49+
Returns a bookmark location for the current selection. This bookmark object can then be used to restore the selection after some content modification to the document.
50+
51+
==== Examples
52+
53+
[source,prettyprint]
54+
----
55+
// Stores a bookmark of the current selection
56+
var bm = tinymce.activeEditor.selection.getBookmark();
57+
58+
tinymce.activeEditor.setContent(tinymce.activeEditor.getContent() + 'Some new content');
59+
60+
// Restore the selection bookmark
61+
tinymce.activeEditor.selection.moveToBookmark(bm);
62+
----
63+
64+
==== Parameters
65+
66+
* [.param-name]#type# [.param-type]#(Number)# - Optional state if the bookmark should be simple or not. Default is complex.
67+
* [.param-name]#normalized# [.param-type]#(Boolean)# - Optional state that enables you to get a position that it would be after normalization.
68+
69+
==== Return value
70+
71+
* [.return-type]#Object# - Bookmark object, use moveToBookmark with this object to restore the selection.
72+
73+
[#isbookmarknode .anchor]##
74+
75+
=== link:#isbookmarknode[isBookmarkNode]
76+
77+
isBookmarkNode(node:DOMNode):Boolean
78+
79+
Returns true/false if the specified node is a bookmark node or not.
80+
81+
==== Parameters
82+
83+
* [.param-name]#node# [.param-type]#(DOMNode)# - DOM Node to check if it's a bookmark node or not.
84+
85+
==== Return value
86+
87+
* [.return-type]#Boolean# - true/false if the node is a bookmark node or not.
88+
89+
[#movetobookmark .anchor]##
90+
91+
=== link:#movetobookmark[moveToBookmark]
92+
93+
moveToBookmark(bookmark:Object):Boolean
94+
95+
Restores the selection to the specified bookmark.
96+
97+
==== Examples
98+
99+
[source,prettyprint]
100+
----
101+
// Stores a bookmark of the current selection
102+
var bm = tinymce.activeEditor.selection.getBookmark();
103+
104+
tinymce.activeEditor.setContent(tinymce.activeEditor.getContent() + 'Some new content');
105+
106+
// Restore the selection bookmark
107+
tinymce.activeEditor.selection.moveToBookmark(bm);
108+
----
109+
110+
==== Parameters
111+
112+
* [.param-name]#bookmark# [.param-type]#(Object)# - Bookmark to restore selection from.
113+
114+
==== Return value
115+
116+
* [.return-type]#Boolean# - true/false if it was successful or not.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
= tinymce.dom.ControlSelection
2+
3+
This class handles control selection of elements. Controls are elements that can be resized and needs to be selected as a whole. It adds custom resize handles to all browser engines that support properly disabling the built in resize logic.

0 commit comments

Comments
 (0)