Class lwh

Object
   |
   +--lwh

class lwh

The lwh object will be populated by various JavaScripts with all host specific data, functions, and objects required for LogWeb Emulation.
Defined in A.js

Version:

Field Detail

cookie

<static> lw.Cookie cookie

the current lwh session cookie, or null. Session cookies have name "lwSession__" + _SessionID.

cookieIx

<static> int cookieIx

the current lwh session cookie index.

cookies

<static> Array_lw.Cookie cookies

all lwh session cookies. Session cookies have name "lwSession__" + _SessionID.

cookiesAll

<static> lw.Cookie cookiesAll

all cookies for this document.

menu

<static> Object menu

Holds the LogWeb/Ajax emulation menus.

version

<static> <final> String version

the version id String. Example: 2.2xx

See Also:

Constant Field Values

versionDate

<static> <final> String versionDate

the version date String. Example: 2007-03-22

See Also:

Constant Field Values

lwh

lwh()

Constructs the lwh object.

Version:

cancelEvent

<static> void cancelEvent(<Event> evt)

Generic event handler: cancels the current event. Stops propagation, and prevents default action.

Parameters:
evt - the event object (DOM browser), or undefined (MS IE)

compressFont

<static> int compressFont(<int> value)

getter/setter for compressed font for "wide screen". Compresses font width by specified number of pixels (0, 1, or 2). Default value is 2px. OPERA before version 9 does not support this, due to missing dynamic CSS update. Effective on next screen only.

Parameters:
value - the (new) value; if missing: does not change the value.

Returns:
the current value.

cookieFind

<static> Array cookieFind()

Returns all lwh cookies for active sessions. Updates lwh.cookiesAll and lwh.cookies.

Returns:
lwh.cookies: an Array containing all lwh session cookies.

cookieFindFirstFreeIndex

<static> int cookieFindFirstFreeIndex()

Returns the lowest unused cookie index >= 1.

Returns:
lwh.cookiesIx: the lowest unused cookie index >= 1.

cookieGet

<static> void cookieGet(<String> sessionID)

Makes available the lwh session cookie for the specified session.

Parameters:
sessionID - the sessionID.

cookieRemove

<static> void cookieRemove()

Removes the lwh session cookie.

cookieSet

<static> lwh.cookie cookieSet()

Sets or updates the lwh session cookie.
• The cookie name is "lwSession_" + lwh.current.session()
• The cookie contains the elements sessionID, screenID and type (host type)
• It is not transient
  otherwise: would be visible in same browser instance only
• It's expiration date is rather high: 1 day (V2 was: 10 days)
  otherwise: long running batch sessions become invisble for other browser instances too early

Returns:
the current lwh session cookie, or null if no session active

cssInputBack

<static> int cssInputBack(<int> value)

getter/setter for input fields: background color. 0=neutral (from base color CSS), 1=white, 2=light gray, 3=gray, 4=dark gray, 5=black.

Parameters:
value - the (new) value, if specified (getter)

Returns:
the current value

cssInputBorder

<static> int cssInputBorder(<int> value)

getter/setter for input fields: background color. 0=neutral (from base color CSS), 1=white, 2=light gray, 3=dark gray, 4=black.

Parameters:
value - the (new) value, if specified (getter)

Returns:
the current value

display

<static> boolean display(<String> id, <boolean> action)

Sets, resets or toggles the display state of the specified node id. Adjusts cursor and buttons in case of change of layout. Does not adjust font to window.

Parameters:
id - the node id
action - optional: the action to be performed:
if missing: returns the current display state (getter);
if true: enables display;
if false: disables display;
if null: toggles display state.

Returns:
the current display state, or null if error

expandFont

<static> int expandFont(<int> value)

getter/setter for expanded font for "wide screen". Expands font width by specified number of pixels (0, 1, or 2). Default value is 0px. OPERA before version 9 does not support this, due to missing dynamic CSS update. Effective on next screen only.

Parameters:
value - the (new) value; if missing: does not change the value.

Returns:
the current value.

focus

<static> void focus(<Event> evt)

Sets browser focus to host screen.

Parameters:
evt - optional: callback from onfocus/onblur -- TEST ONLY

onunload

<static> void onunload(<Event> evt)

Event handler for on unload. If session still active: reload start.jsp to handle this (terminate or continue).

Parameters:
evt - the event object (DOM browser), or undefined (MS IE)

showEvent

<static> Event showEvent(<Event> evt, text)

Generic event handler: shows the current event.

Parameters:
evt - required: the event object (DOM browser)
optional - : the text prefix

Returns:
the Event

showNILinput

<static> Object showNILinput(val)

boolean getter/setter for showing host NIL character on input fields.

showNILoutput

<static> Object showNILoutput(val)

boolean getter/setter for showing host NIL character on output fields.

syncBrowser

<static> Object syncBrowser(<bool> returnOld)

Manages the current browser attributes adjustable by user. Checks changes of font size selection, window resizing (not implemented), and scrolling in window(not implemented). First call will initialize the settings; further calls with missing arguments may be timer callback.

Parameters:
returnOld - if true: simply returns the last values; else (false, or missing): retrieves current settings, takes appropriate actions (if modified), and saves settings.

Returns:
the (old or current) browser settings; element size: default fontSize (in px); innerSize.x/y: browser inner size.

See:
- initFont()

toView

<static> void toView()

scrolls to start of lwEmulation

usedExtent

<static> int usedExtent(<int> value)

getter/setter for amount of extra space to spread between characters. Value must be in the range [0 .. 4] corresponding to [0%, 25%, 50%, 75%, 100%].
Default value is 4, corresponding to 100%.
Effective immediately.

Parameters:
value - the (new) value; if missing: does not change the value.

Returns:
the current value.