WebCommandWinclasswebui.t[1936]

Superclass
Tree 		Subclass
Tree 		Global
Objects 		Property
Summary 		Method
Summary 		Property
Details 		Method
Details

Command Window. This object keeps track of the state of command window within the web UI.

class WebCommandWin :   WebWindow

Superclass Tree   (in declaration order)

WebCommandWin
        WebWindow
                WebResourceResFile
                        WebResource
                                object

Subclass Tree  

(none)

Global Objects  

commandWin 

Summary of Properties  

isInputOpen  lastInput  lastInputClient  lastInputReady  mode  moreMode  outbuf  scrollback  scrollbackLimit  src  textbuf  vpath 

Inherited from WebWindow :
name  pathName  sthCtx 

Inherited from WebResourceResFile :
binaryExts  browserExtToMime 

Inherited from WebResource :
group  priority 

Summary of Methods  

cancelInputLine  clearWindow  endMoreMode  flushWin  getInputLine  getState  receiveInput  showMorePrompt  textbufToScrollback  write 

Inherited from WebWindow :
processName  sendWinEvent  sendWinEventTo  winFromPath 

Inherited from WebResourceResFile :
isTextFile  matchRequest  processRequest 

Inherited from WebResource :
sendAck  sendXML 

Properties  

isInputOpenwebui.t[2201]

Is an input line open? This is true between sending an <inputLine> event and either getting a reply, or explicitly sending a close or cancel event.

lastInputwebui.t[2188]
the text of the last input line we received from the client

lastInputClientwebui.t[2194]
client session who sent the last input line

lastInputReadywebui.t[2191]
is input ready?

modewebui.t[2212]
Current UI mode. This is 'working' if the program is running and in the process of computing and/or generating output; 'inputLine' if we're waiting for the user to enter a line of input; 'morePrompt' if we're showing a "More" prompt.

moreModewebui.t[2204]
flag: we're in More mode

outbufwebui.t[2185]
pending output buffer, since last flush

scrollbackwebui.t[2174]
Scrollback list. After each input, we add the contents of 'textbuf' to this list. If this pushes the list past the limit, we drop the oldest item. This is used to reconstruct a reasonable amount of scrollback history when a new client connects, or when an existing client refreshes the page.

scrollbackLimitwebui.t[2182]
The scrollback limit, as a number of command inputs. Each input interaction adds one item to the scrollback list. When the number of items in the list exceeds the limit set here, we drop the oldest item.

srcOVERRIDDENwebui.t[2216]
no description available

textbufwebui.t[2165]
main window text buffer since last input read

vpathOVERRIDDENwebui.t[2215]
my virtual path, and the actual resource file location

Methods  

cancelInputLine (reset)webui.t[2026]

Cancel an input line that was interrupted by a timeout

clearWindow ( )OVERRIDDENwebui.t[2086]
Clear the window

endMoreMode ( )webui.t[2158]
receive notification from the client that the user has responded to the More prompt, ending the pause

flushWin ( )OVERRIDDENwebui.t[1949]
Flush the buffers

getInputLine (timeout?)webui.t[1968]
Read a line of input in this window. Blocks until the reply is received. Returns nil on timeout.

getState (client)OVERRIDDENwebui.t[2046]
Get the state of this command window

receiveInput (req, query)webui.t[2057]
Receive input from the client

showMorePrompt ( )webui.t[2137]
Show a "More" prompt

textbufToScrollback (cmd)webui.t[2114]
Move the current text buffer contents to the scrollback list. If this would make the scrollback list exceed the limit, we'll drop the oldest item.

'cmd' is the command line text of the last input. We include this in the srollback list with special tagging so that the UI can display it in a custom style, if it wants.

write (txt)OVERRIDDENwebui.t[1940]
Write to the window

Adv3Lite Library Reference Manual
Generated on 25/04/2024 from adv3Lite version 2.0