nsIContentViewer

Methods

init(aParentWidget, aBounds)

loadStart(aDoc)

loadComplete(aStatus)

permitUnload(aCallerClosesWindow)

Checks if the document wants to prevent unloading by firing beforeunload on
the document, and if it does, prompts the user. The result is returned.

Parameters

aCallerClosesWindow indicates that the current caller will close the window. If the method returns true, all subsequent calls will be ignored.

permitUnloadInternal(aCallerClosesWindow, aShouldPrompt)

As above, but this passes around the aShouldPrompt argument to keep
track of whether the user has responded to a prompt.
Used internally by the scriptable version to ensure we only prompt once.

resetCloseWindow()

Works in tandem with permitUnload, if the caller decides not to close the
window it indicated it will, it is the caller’s responsibility to reset
that with this method.

@Note this method is only meant to be called on documents for which the
caller has indicated that it will close the window. If that is not the case
the behavior of this method is undefined.

pageHide(isUnload)

close(historyEntry)

All users of a content viewer are responsible for calling both
close() and destroy(), in that order.

close() should be called when the load of a new page for the next
content viewer begins, and destroy() should be called when the next
content viewer replaces this one.

|historyEntry| sets the session history entry for the content viewer. If
this is null, then Destroy() will be called on the document by close().
If it is non-null, the document will not be destroyed, and the following
actions will happen when destroy() is called (*):
- Sanitize() will be called on the viewer’s document
- The content viewer will set the contentViewer property on the
history entry, and release its reference (ownership reversal).
- hide() will be called, and no further destruction will happen.

(*) unless the document is currently being printed, in which case
it will never be saved in session history.

destroy()

stop()

getDocument()

Returns DOMDocument as nsIDocument and without addrefing.

getBounds(aBounds)

setBounds(aBounds)

move(aX, aY)

show()

hide()

requestWindowClose()

open(aState, aSHEntry)

Attach the content viewer to its DOM window and docshell.

Parameters

aState A state object that might be useful in attaching the DOM window.
aSHEntry The history entry that the content viewer was stored in. The entry must have the docshells for all of the child documents stored in its child shell list.

clearHistoryEntry()

Clears the current history entry. This is used if we need to clear out
the saved presentation state.

setPageMode(aPageMode, aPrintSettings)

Change the layout to view the document with page layout (like print preview), but
dynamic and editable (like Galley layout).

setDocumentInternal(aDocument, aForceReuseInnerWindow)

findContainerView()

Find the view to use as the container view for MakeWindow. Returns
null if this will be the root of a view manager hierarchy. In that
case, if mParentWidget is null then this document should not even
be displayed.

setNavigationTiming(aTiming)

Set collector for navigation timing data (load, unload events).

scrollToNode(node)

getContentSize(width, height)

Requests the size of the content to the container.

appendSubtree(array)

Append |this| and all of its descendants to the given array,
in depth-first pre-order traversal.

changeMaxLineBoxWidth(maxLineBoxWidth)

Set the maximum line width for the document.
NOTE: This will generate a reflow!

Parameters

maxLineWidth The maximum width of any line boxes on the page, in CSS pixels.

pausePainting()

Instruct the refresh driver to discontinue painting until further
notice.

resumePainting()

Instruct the refresh driver to resume painting after a previous call to
pausePainting().

emulateMedium(aMediaType)

stopEmulatingMedium()

Attributes

container

inPermitUnload

Exposes whether we’re blocked in a call to permitUnload.

beforeUnloadFiring

Exposes whether we’re in the process of firing the beforeunload event.
In this case, the corresponding docshell will not allow navigation.

DOMDocument

previousViewer

The previous content viewer, which has been close d but not
  destroy ed.

sticky

historyEntry

Get the history entry that this viewer will save itself into when
destroyed. Can return null

isTabModalPromptAllowed

Indicates when we’re in a state where content shouldn’t be allowed to
trigger a tab-modal prompt (as opposed to a window-modal prompt) because
we’re part way through some operation (eg beforeunload) that shouldn’t be
rentrant if the user closes the tab while the prompt is showing.
See bug 613800.

isHidden

Returns whether this content viewer is in a hidden state.

@note Only Gecko internal code should set the attribute!

presShell

presContext

textZoom

The amount by which to scale all text. Default is 1.0. */

fullZoom

The amount by which to scale all lengths. Default is 1.0. */

authorStyleDisabled

Disable entire author style level (including HTML presentation hints) */

forceCharacterSet

XXX comm-central only: bug 829543. Not the Character Encoding menu in
browser!

hintCharacterSet

XXX comm-central only: bug 829543.

hintCharacterSetSource

XXX comm-central only: bug 829543.

minFontSize

The minimum font size */