type

Doc

src @Js
class Doc : Obj

Doc models the DOM document object.

See pod doc for details.

fields

title

The title of this document.

methods

activeElem

Get the currently focused element, or null for none.

addCookie

Add a cookie to this session.

body

Get the body element.

cookies

Map of cookie values keyed by cookie name.

createElem

Create a new element with the given tag name.

elemById

Get the element with this id, or null if no element is found with this id.

elemFromPos

Get the topmost element at the specified coordinates (relative to the viewport), or null if none found.

elemsFromPos

Get a list of all elements at the specified coordinates (relative to the viewport).

exec

When a HTML document has been switched to designMode, the document object exposes the exec method which allows one to run commands to manipulate the contents of the editable region.

head

Get the head element.

onEvent

Attach an event handler for the given event on this document.

out

Return a WebOutStream for writing content into this document.

querySelector

Returns the first element within the document (using depth-first pre-order traversal of the document's nodes) that matches the specified group of selectors, or null if none found.

querySelectorAll

Returns a list of the elements within the document (using depth-first pre-order traversal of the document's nodes) that match the specified group of selectors.

removeEvent

Remove the given event handler from this document.

Slot Details

activeElem

src Elem? activeElem()

Get the currently focused element, or null for none.

addCookie

src Void addCookie(Cookie c)

Add a cookie to this session.

body

src Elem body()

Get the body element.

cookies

src Str:Str cookies()

Map of cookie values keyed by cookie name. The cookies map is readonly and case insensitive.

createElem

src Elem createElem(Str tagName, [Str:Str]? attrib := null, Uri? ns := null)

Create a new element with the given tag name. If the attrib map is specified, set the new elements attributes to the given values. Optionally a namespace for the element can be specified with ns.

elemById

src Elem? elemById(Str id)

Get the element with this id, or null if no element is found with this id.

elemFromPos

src Elem? elemFromPos(Point p)

Get the topmost element at the specified coordinates (relative to the viewport), or null if none found.

elemsFromPos

src Elem[] elemsFromPos(Point p)

Get a list of all elements at the specified coordinates (relative to the viewport). The elements are ordered from the topmost to the bottommost box of the viewport.

exec

src Bool exec(Str name, Bool defUi := false, Obj? val := null)

When a HTML document has been switched to designMode, the document object exposes the exec method which allows one to run commands to manipulate the contents of the editable region.

  • name: the command name to execute
  • defUi: flag to indicate if default user interface is shown
  • val: optional value for commands that take an argument

src Elem head()

Get the head element.

onEvent

src Func onEvent(Str type, Bool useCapture, |Event| handler)

Attach an event handler for the given event on this document. Returns callback function instance.

out

src WebOutStream out()

Return a WebOutStream for writing content into this document. You should call close on the stream when done writing to notify browser load is complete.

querySelector

src Elem? querySelector(Str selectors)

Returns the first element within the document (using depth-first pre-order traversal of the document's nodes) that matches the specified group of selectors, or null if none found.

querySelectorAll

src Elem[] querySelectorAll(Str selectors)

Returns a list of the elements within the document (using depth-first pre-order traversal of the document's nodes) that match the specified group of selectors.

removeEvent

src Void removeEvent(Str type, Bool useCapture, Func handler)

Remove the given event handler from this document. If this handler was not registered, this method does nothing.

title

src Str title

The title of this document.