nsIEditingSession

Methods

makeWindowEditable(window, aEditorType, doAfterUriLoad, aMakeWholeDocumentEditable, aInteractive)

Make this window editable

Parameters

aWindow	nsIDOMWindow, the window the embedder needs to make editable
aEditorType	string, "html" "htmlsimple" "text" "textsimple"
aMakeWholeDocumentEditable	if PR_TRUE make the whole document in aWindow editable, otherwise it's the embedder who should make the document (or part of it) editable.
aInteractive	if PR_FALSE turn off scripting and plugins

windowIsEditable(window)

Test whether a specific window has had its editable flag set; it may have an editor
now, or will get one after the uri load.

Use this, passing the content root window, to test if we’ve set up editing
for this content.

getEditorForWindow(window)

Get the editor for this window. May return null

setupEditorOnWindow(window)

Setup editor and related support objects

tearDownEditorOnWindow(window)

Destroy editor and related support objects

setEditorOnControllers(aWindow, aEditor)

disableJSAndPlugins(aWindow)

Disable scripts and plugins in aWindow.

restoreJSAndPlugins(aWindow)

Restore JS and plugins (enable/disable them) according to the state they
were before the last call to disableJSAndPlugins.

detachFromWindow(aWindow)

Removes all the editor’s controllers/listeners etc and makes the window
uneditable.

reattachToWindow(aWindow)

Undos detachFromWindow(), reattaches this editing session/editor
to the window.

Attributes

editorStatus

Status after editor creation and document loading
Value is one of the above error codes

jsAndPluginsDisabled

Whether this session has disabled JS and plugins.

Constants

eEditorOK

Error codes when we fail to create an editor
is placed in attribute editorStatus