classdom::Win

sys::Obj
  dom::Win

@Js

Win models the DOM window object.

See pod doc for details.

addStyleRules

Source

Void addStyleRules(Str rules)

Add new CSS style rules to this page.

alert

Source

Void alert(Obj obj)

Display a modal message box with the given text.

clearInterval

Source

Void clearInterval(Int intervalId)

Cancels a repeated action which was set up using setInterval.

clearTimeout

Source

Void clearTimeout(Int timeoutId)

Clears the delay set by setTimeout.

clipboardReadText

Source

Void clipboardReadText(|Str f)

Read textual contents of the system clipboard. Returns an empty string if the clipboard is empty, does not contain text, or does not include a textual representation of clipboard's contents.

The user has to interact with the page or a UI element in order for this feature to work.

clipboardWriteText

Source

Void clipboardWriteText(Str text)

Write given text to the system clipboard.

The user has to interact with the page or a UI element in order for this feature to work.

close

Source

Win close()

Close this window. Only applicable to windows created with open. Otherwise method has no effect. Returns this.

confirm

Source

Bool confirm(Obj obj)

Display a confirmation dialog box with the given text. Returns true if ok was selected, false othterwise.

cur

Source

static Win cur()

Return the current window instance.

doc

Source

Doc doc()

Return the Doc instance for this window.

eval

Source

static Obj eval(Str js)

Evaluate given JavaScript code.

geoClearWatch

Source

Void geoClearWatch(Int id)

Unregister location/error monitoring handlers previously installed using geoWatchPosition. This feature is only available in secure contexts (HTTPS).

geoCurPosition

Source

Void geoCurPosition(|DomCoord onSuccess, |Err? onErr := null, [Str:Obj]? opts := null)

Get the the current position of this device. This feature is only available in secure contexts (HTTPS).

geoWatchPosition

Source

Int geoWatchPosition(|DomCoord onSuccess, |Err? onErr := null, [Str:Obj]? opts := null)

Register a handler function that will be called automatically each time the position of the device changes. This method returns a watch ID value that then can be used to unregister the handler with the geoClearWatch method. This feature is only available in secure contexts (HTTPS).

hisBack

Source

Void hisBack()

Go to previous page in session history.

hisForward

Source

Void hisForward()

Go to next page in the session history.

hisPushState

Source

Void hisPushState(Str title, Uri uri, Str:Obj map)

Push a new history item onto the history stack. Use onpopstate to listen for changes:

// Event.stash contains state map passed into pushState
Win.cur.onEvent("popstate", false) |e| { echo("# state: $e.stash") }
hisReplaceState

Source

Void hisReplaceState(Str title, Uri uri, Str:Obj map)

Modify the current history item.

Source

Void hyperlink(Uri uri)

Hyperlink to the given Uri in this window.

localStorage

Source

Storage localStorage()

Return local storage instance for window.

log

Source

Void log(Obj? obj)

Log object to console.

onEvent

Source

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

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

open

Source

Win open(Uri uri := `about:blank`, Str? winName := null, [Str:Str]? opts := null)

Open a new window. Returns the new window instance.

parent

Source

Win? parent()

Returns a reference to the parent of the current window or subframe, or null if this is the top-most window.

reload

Source

Void reload(Bool force := false)

Reload the current page. Use force to bypass browse cache.

removeEvent

Source

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

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

reqAnimationFrame

Source

Void reqAnimationFrame(|This f)

Request the browser to perform an animation before the next repaint.

screenSize

Source

Size screenSize()

Return the size of the screen in pixels.

scrollBy

Source

This scrollBy(Int x, Int y)

Scrolls the document in the window by the given amount.

scrollPos

Source

Point scrollPos()

Return current scroll position of document in this window.

scrollTo

Source

This scrollTo(Int x, Int y)

Scrolls to a particular set of coordinates in the document.

sessionStorage

Source

Storage sessionStorage()

Return session storage instance for window.

setInterval

Source

Int setInterval(Duration delay, |This f)

Calls a function repeatedly, with a fixed time delay between each call to that function. Returns an intervalId that can be used in clearInterval.

setTimeout

Source

Int setTimeout(Duration delay, |This f)

Call the specified function after a specified delay. Returns a timeoutId that can be used in clearTimeout.

top

Source

Win top()

Returns a reference to the topmost window in the window hierarchy. If this window is the topmost window, returns self.

uri

Source

Uri uri()

Get the Uri for this window.

viewport

Source

Size viewport()

Return the size of the window viewport in pixels.