WebWindow class | webui.t[1667]

Web Window tracker. This is a game object that controls and remembers the state of a "window" in the browser user interface. By "window", we basically mean an HTML page, which might reside at the top level of the browser itself, or inside an IFRAME element within an enclosing page.

Each WebWindow class corresponds to a particular HTML page that we serve the client. The HTML page is the expression of the window in the browser, and the WebWindow object is the expression of the same information in the game program. The two are different facets of the same conceptual UI object. The reason we need the two separate expressions is that the server controls everything, but the client has to do the actual display work, and the two parts of the program speak different languages - the server is TADS, and the client is HTML.

The WebWindow object on the server lets us easily reconstruct the UI state in a newly opened browser window, or when the user performs a page refresh. This object's job is to send information to the client on demand that allows the client to display the page in its current state.

Note that a given WebWindow/HTML page combination can be used more than once within the same UI. The pages defined in the library are designed to be generic and reusable, so you might use the same window class more than once for different purposes within the UI. The library pages can also be subclassed, by subclassing the WebWindow object and creating a customized copy of the corresponding HTML page resource.

`class WebWindow : WebResourceResFile`

Superclass Tree (in declaration order)

`WebWindow`
`WebResourceResFile`
`WebResource`
`object`

Subclass Tree

`WebWindow`
`WebCommandWin`
`WebLayoutWindow`
`WebStatusWin`

Global Objects

(none)

Summary of Properties

`name pathName src sthCtx vpath`

Inherited from `WebResourceResFile` :
`binaryExts browserExtToMime`

Inherited from `WebResource` :
`group priority`

Summary of Methods

`clearWindow flushWin getState processName sendWinEvent sendWinEventTo winFromPath write`

Inherited from `WebResourceResFile` :
`isTextFile matchRequest processRequest`

Inherited from `WebResource` :
`sendAck sendXML`

Properties

`name` | `webui.t[1750]`

the name of this window

`pathName` | `webui.t[1753]`

the full path name of this window, in "win.sub.sub" format

`src` | `webui.t[1689]`

The window's actual source location, as a resource path. A given WebWindow subclass corresponds to a particular HMTL page, since the class and the page are facets of the same conceptual object (one facet is the browser expression, the other is the game program expression).

`sthCtx` | `webui.t[1747]`

specialsToHtml context

`vpath` OVERRIDDEN | `webui.t[1680]`

The URL path to the window's HTML definition file, as seen by the browser. For the pre-defined library window types, we expose the HTML file in the root of the URL namespace - e.g., "/main.htm". The files are actually stored in the /webuires folder, but we expose them to the browser as though they were in the root folder to make embedded object references on the pages simpler. The browser figures the path to an embedded object relative to the containing page, so by placing the containing page in the root folder, embedded object paths don't have to worry about referencing parent folders.

Methods

`clearWindow ( )` | `webui.t[1718]`

Clear the window. Subclasses must override this.

`flushWin ( )` | `webui.t[1707]`

Flush the window. This sends any buffered text to the UI.

`getState (client)` | `webui.t[1728]`

Get the window's current state. This returns a string containing an XML fragment that describes the state of the window. This information is sent to the HTML page when the browser asks for the current layout state when first loaded or when the page is refreshed. The XML format for each subclass is specific to the Javascript on the class's HTML page.

`processName (n)`OVERRIDDEN | `webui.t[1692]`

process a request path referencing me into my actual resource path

`sendWinEvent (evt)` | `webui.t[1731]`

send an event related to this window to all clients

`sendWinEventTo (evt, client)` | `webui.t[1741]`

send a window event to a specific client

`winFromPath (path)` | `webui.t[1699]`

Resolve a window path name. For container windows, this should search the sub-windows for the given path. By default, we match simply if the path matches our name.

`write (txt)` | `webui.t[1713]`

Write text to the window. Subclasses with stream-oriented APIs must override this.

TADS 3 Library Manual
Generated on 8/21/2012 from TADS version 3.1.2