Class GLOBALS

Object
   |
   +--GLOBALS

class GLOBALS

_AjaxRequest

<static> Object _AjaxRequest( aRequestName, aReplyEventHandler, aBANK, anACCT, optPostData, optWaitFlag )

_RequestAccountLoad

<static> void _RequestAccountLoad( <String> aBANK, <String> anACCT )

Make a Load-Account-Data request to the server.
NOTE: this is a Command helper function.
NEVER call this from outside the context of a Command object!

Parameters:
aBANK - Account bank number
anACCT - Account number

_RequestAccountSave

<static> void _RequestAccountSave( <String> aBANK, <String> anACCT, <String> updates )

Make a Save-Account-Data request to the server.
NOTE: this is a Command helper function.
NEVER call this from outside the context of a Command object!

Parameters:
aBANK - Account bank number
anACCT - Account number
updates - list of transaction update commands

_SelectFirstUnreconciled

<static> boolean _SelectFirstUnreconciled( <boolean> selectFirst )

Select the first unreconciled Account
NOTE: this is a Command helper function.
NEVER call this from outside the context of a Command object!

Parameters:
selectFirst - if FALSE then leave selection alone if none unreconciled otherwise selected the first Account if none unreconciled.

Returns:
true iff new selection was made

ArgsToString

<static> Object ArgsToString( args )

ArrayToString

<static> Object ArrayToString( a )

Break

<static> Object Break(msg)

Breakpoint

<static> void Breakpoint()

busy

<static> void busy()

set the cursor to the hourglass icon

BusyDo

<static> void BusyDo( <String> funcname, <String> funcargs, <int> optDelayMilliSecs )

generic utility function to queue up for future execution the specified function with the specified arguments after a specified amount of delay. THIS function returns immediately, and the specified function will execute later (in potentially a different thread). If this is called with the same function specified as was specified earlier, and that function has not executed yet, then the scheduled execute time is updated, rather than the function being executed twice.

Parameters:
funcname - the name of the function to call
funcargs - a string image of the parameters to be passed
optDelayMilliSecs - optional delay amount (default 5 milliSeconds)

Author: Bruce Wallace (PolyGlotInc.com)
Version: 1.0

CallerName

<static> String CallerName( <Arguments> argumentsObj )

This utility function returns the name of the function that called this routine.

Parameters:
argumentsObj - the Javascript arguments object

Returns:
the caller's function name

See:
- FuncName()
Author: Bruce Wallace (PolyGlotInc.com)
Version: 1.0

Class

<static> Function Class( <Function> theClass, <StringArray> optConstructorArgDescArray )

Declare a class and create the glue objects and code to allow "pretty" source; A mechanism is set up to insure that required constructor parameters each have a defined value; This function also defines the "name" attribute of the specified class and initializes it with the class name.

Parameters:
theClass - the "class constructor" function
optConstructorArgDescArray - optional array of strings describing required parameters for this class' "constructor"; Note: Optional constructor parameters should not be included in this array.

Returns:
the "class object" (an extended Function object)

See:
- Extends()
- ValidateArgs()
- OObject
Author: Bruce Wallace (PolyGlotInc.com)
Version: 1.0

ClearGlobalVar

<static> void ClearGlobalVar( <String> varname )

static routine to dynamically undefine/delete a global variable

Parameters:
varname - name of "persistent" variable

ClearGlobalVars

<static> void ClearGlobalVars()

static routine to dynamically undefine/delete ALL "...GlobalVars" variables

ClearPersistentVars

<static> void ClearPersistentVars()

static routine to dynamically undefine/delete ALL "...PersistentVars" variables

DebugWindow

<static> void DebugWindow( <String> contents )

open debug window with contents in scrollable area

Parameters:
contents - what to put into this debug window

diamond

<static> String diamond(<boolean> optBlankFlag)

return the HTML to draw a diamond

Parameters:
optBlankFlag - if true, says generate blanks of same size as 1 diamond

DoCmd

<static> boolean DoCmd( command )

Do the given command in "synchonized" mode (meaning that it will wait until commands that are already running/queued have finished). NOTE: BECAUSE OF THIS, YOU WILL DEADLOCK IF ANY COMMAND INVOKES ANOTHER COMMAND!!!!!

Returns:
false if the command was invalid and not run

dollarKeyFilter

<static> boolean dollarKeyFilter( <int> keyCode, <String> valueSoFar )

is the given character a legal addition to the given dollar string

Parameters:
keyCode - the proposed new character
valueSoFar - the value so far

Returns:
true iff character is legal

dollarStrFilter

<static> Object dollarStrFilter(s)

dot

<static> String dot()

return the HTML to draw a biggish dot

DRAWVIEWS

<static> void DRAWVIEWS()

static function to draw the root view (and hence all views)

editElem

<static> void editElem( e, makeSelected, makeEdited, makeInvalid )

editElemID

<static> void editElemID( ID, makeSelected, makeEdited, makeInvalid )

EmbedAttributeViewer

<static> String EmbedAttributeViewer( <View> parentView, <String> attribute, <Function> optFormatter, <Object> optParam )

Create and embed, as a subview, a ScalarView of the specified data model attribute.

Parameters:
parentView - the view to embed the new view into
attribute - the identifier of the attribute of the parent view's primary data model to view
optFormatter - optional formatter function
optParam - optional parameter to pass to model method if the attribute actually refers to a method rather than a data element

Returns:
the HTML string of the parentView (that includes the new embedded subview)

EmbedDollarDualEditor

<static> String EmbedDollarDualEditor( <View> parentView, <String> attribute, <String> className )

Create and embed, as a subview, a DualDollarController of the specified data model attribute which is expected to be a dollar amount data element.

Parameters:
parentView - the view to embed the new controller into
attribute - the identifier of the attribute of the parent view's primary data model to view/edit
className - the CSS classname to use for formatting

Returns:
the HTML string of the parentView (that includes the new embedded subviews)

EmbedDualMenu

<static> DualMenuController EmbedDualMenu( <View> parentView, <String> attribute, <SelectionModel> menuModel, <String> className, <Function> optEvtHndlr )

Create and embed, as a subview, a DualMenuController of the specified data model attribute

Parameters:
parentView - the view to embed the new controller into
attribute - the identifier of the attribute of the parent view's primary data model to view/edit
menuModel - data model for the popup menu
className - the CSS classname to use for formatting
optEvtHndlr - optional edit event handler (default is to launch a ScalarEditCmd command).

Returns:
the newly created viewer/editor

epsilon

<static> String epsilon()

return the HTML to draw a smallish "E"

Error

<static> void Error(msg)

Extends

<static> Function Extends( <Function> superClass )

This utility function takes (via "THIS") a "class" and (re)sets its superClass.

Parameters:
superClass - the "superclass constructor" function

Returns:
a reference to the "class object"

See:
- Class()
- OObject
Author: Bruce Wallace (PolyGlotInc.com)
Version: 1.0

filterNum

<static> Object filterNum( str )

FindComplexCode

<static> String FindComplexCode( <Collection> transtypes )

static routine to search for the special "complex" code

Parameters:
transtypes - Decode collection of transaction-types

Returns:
the "code" of the special "complex" transaction type

format_dollar

<static> String format_dollar( <anyType> v, <boolean> optZeroAsBlankFlag )

format given value as $#,###.00

Parameters:
v - value to format
optZeroAsBlankFlag - optional flag to make zero format as blank

Author: Bruce Wallace (PolyGlotInc.com)
Version: 1.0

format_dollar_not

<static> String format_dollar_not( v )

like format_dollar except empty string returned for zero

FuncName

<static> String FuncName(<Function> f)

This function returns the name of a given function; It does this by converting the function to a string, then using a regular expression to extract the function name from the resulting code.

Parameters:
f - reference to a function

Returns:
name of given function

Author: Bruce Wallace (PolyGlotInc.com)
Version: 1.0

genHook

<static> String genHook( <String> hookID, <String> optInnerHTML )

generate a piece of HTML, identified by the given ID, that can safely have its innerHTML replaced at runtime.

Parameters:
hookID - name of the HTML to be generated
optInnerHTML - optional HTML to be inserted into the generated HTML

Returns:
generated HTML

See:
- getHook()
Author: Bruce Wallace (PolyGlotInc.com)
Version: 1.0

GetArg

<static> Object GetArg( argname )

GetGlobalVar

<static> Object GetGlobalVar( <String> varname )

static routine to return the value of persistent variable with given name

Parameters:
varname - name of "global" i.e. "static" variable

Returns:
{Object} value of variable (empty object if not previously defined)

getHook

<static> Object getHook( hookID )

GetPersistentVar

<static> Object GetPersistentVar( <String> varname )

static routine to return the value of the persistent variable with given name

Parameters:
varname - name of "persistent" variable

Returns:
{Object} value of variable (empty object if not previously defined)

getTodayAsMMDDYYYY

<static> Object getTodayAsMMDDYYYY()

getTodayAsXXDDYYYY

<static> Object getTodayAsXXDDYYYY(monthNames)

GetXslDOM

<static> Object GetXslDOM( xslURL )

retrieve XSL DOM from given URL

Returns:
XSL DOM

highlightElem

<static> void highlightElem( e, makeSelected, selectColor )

isDate

<static> Object isDate(dateStr)

return error message on invalid date or null if valid

isDigit

<static> Object isDigit(c)

Returns true if character c is a digit (0 .. 9).

isEmpty

<static> Object isEmpty(s)

Check whether string s is "empty".

isFloat

<static> Object isFloat(s)

Returns true if string s is an unsigned floating point (real) number. Does not accept exponential notation.

isInteger

<static> Object isInteger(s)

Returns true if all characters in string s are numbers. Accepts non-signed integers only. Does not accept floating point, exponential notation, etc. We don't use parseInt() because that would accept a string with trailing non-numeric characters.

isLetter

<static> Object isLetter(c)

Returns true if character c is an English letter (A .. Z, a..z).

isSignedFloat

<static> Object isSignedFloat(s)

Returns true if string s is a signed or unsigned floating point (real) number. First character is allowed to be + or -. Does not accept exponential notation.

isZeroDollars

<static> Object isZeroDollars(v)

keyFilter

<static> boolean keyFilter( <int> keyCode, <String> allowedChars )

Is the given keyCode in the given list of allowed characters?

Parameters:
keyCode - the charCode of the character to validate
allowedChars - the list of characters that are allowed

Returns:
true iff keyCode is legal

LoudThrow

<static> void LoudThrow( exceptionObj )

MissingArgException

<static> Object MissingArgException( argDesc, funcName )

MUTEX_CPU_SLICE

<static> void MUTEX_CPU_SLICE( <int> cmdID, <int> optStartID )

static routine to give a slice of CPU to mutex with given ID

Parameters:
cmdID - ID of command to resume
optStartID - optional ID of command on which we are waiting; if not specified then start at top of list of all pending commands.

See:
- Mutex

noDuplicates

<static> boolean noDuplicates( <String> s, <String> charList )

Is there no more than one occurance of each character in the given character list in the given string?

Parameters:
s - string to check
charList - list of characters that should occur only once

Returns:
true if there are no duplicates

notbusy

<static> void notbusy()

set the cursor to the default icon

NullArgException

<static> Object NullArgException( argDesc, funcName )

ObjectToInitializer

<static> Object ObjectToInitializer( o )

ObjectToShortInitializer

<static> Object ObjectToShortInitializer( o )

ObjectToString

<static> Object ObjectToString( o )

OnAccountLoadReply

<static> void OnAccountLoadReply( <XMLreq> xmlReq )

handle event for 'reply received from "load account data" server-request'

Parameters:
xmlReq - the XML request being replied to

OnAccountSaveReply

<static> void OnAccountSaveReply( <XMLreq> xmlReq )

handle event for 'reply received from "save account data" server-request'

Parameters:
xmlReq - the XML request being replied to

OnAccountSelect

<static> void OnAccountSelect( <int> selectedAccountKey )

handle event for 'user selects from the account menu'

Parameters:
selectedAccountKey - the new menu-selection

OnBalanceClick

<static> void OnBalanceClick( <int> balanceIndex )

handle event for 'click on a balance record'

Parameters:
balanceIndex - index into balance list (aka account data)

OnBeforeUnLoad

<static> void OnBeforeUnLoad()

handle event for 'about to leave web page'; warn if attempting to leave with unsaved changes

OnCancelBtnPressed

<static> void OnCancelBtnPressed()

handle event for 'cancel button pressed'

OnDeleteBtnPressed

<static> void OnDeleteBtnPressed()

handle event for 'delete button pressed'

OnEditBtnPressed

<static> void OnEditBtnPressed()

handle event for 'edit button pressed'

OnExitBtnPressed

<static> void OnExitBtnPressed()

handle event for 'exit button pressed'

OnFieldEditFocus

<static> void OnFieldEditFocus( <Element> field )

handle "entering a text field" event per webreference tip)

Parameters:
field - HTML element of text field generating this event

OnFieldEditKey

<static> boolean OnFieldEditKey( <String> viewID )

handle "key pressed" events in text fields

Parameters:
viewID - view ID of the FieldEditController generating this event.

Returns:
false if this key should be suppressed

OnGlobalKeyPress

<static> Object OnGlobalKeyPress()

pre-screen all keypress events for entire page This implementation handles ctrl-z and ctrl-y to invoke Undo and Redo respectively.

OnInsertBtnPressed

<static> void OnInsertBtnPressed()

handle event for 'insert button pressed'

OnLoad

<static> void OnLoad()

handle event for 'entering web page'

OnRedoBtnPressed

<static> void OnRedoBtnPressed()

redo-button-pressed event handler

OnSaveBtnPressed

<static> void OnSaveBtnPressed()

handle event for 'save button pressed'

OnScalarEditUpdate

<static> boolean OnScalarEditUpdate( <String> viewID )

ScalarEditController update-event handler

Parameters:
viewID - view ID of the ScalarEditController generating this event.

Returns:
event success?? flag

OnTransactionClick

<static> void OnTransactionClick( <int> balanceIndex, <int> transIndex )

handle event for 'click on a transaction record'

Parameters:
balanceIndex - index into balance list (aka account data)
transIndex - index into transaction list (of balance)

OnTrTypeSelect

<static> Object OnTrTypeSelect( <String> viewID )

handle event for 'user selects from the transaction type menu'

Parameters:
viewID - ID of the controller generating this event

OnUndoBtnPressed

<static> void OnUndoBtnPressed()

undo-button-pressed event handler

OnUnreconciledClick

<static> void OnUnreconciledClick( <int> balanceIndex )

handle event for 'click on an unreconciled panel'

Parameters:
balanceIndex - index into balance list (aka account data)

pleaseWait

<static> Object pleaseWait( <boolean> enableFlag, <String> msg, appId )

create and open a window (if enabled) with the specified message

Parameters:
enableFlag - iff true then create window
msg - message to place in window

Returns:
the created window or null if not enabled

selectElem

<static> void selectElem( e, makeSelected )

selectElemID

<static> void selectElemID( ID, makeSelected )

SendStatusMessage

<static> void SendStatusMessage( <String> msg )

send a message via the browser status bar

Parameters:
msg - the message to send.

setBackgroundColor

<static> void setBackgroundColor( ID, color )

setElemBackgroundColor

<static> void setElemBackgroundColor( e, color )

setElemText

<static> void setElemText( e, str )

setElemVisibility

<static> void setElemVisibility( e, visibleFlag )

SetGlobalVar

<static> void SetGlobalVar( <String> varname, <Object> value )

static routine to dynamically define/update a global (to window/page but reloaded with page) variable with the given name and value.

Parameters:
varname - name of "persistent" variable
value - value to set variable to

SetPersistentVar

<static> void SetPersistentVar( <String> varname, <Object> value )

static routine to dynamically define/update a persistent (across page loads) variable with the given name and value.

Parameters:
varname - name of "persistent" variable
value - value to set variable to

setText

<static> void setText( ID, str )

setVisibility

<static> void setVisibility( ID, visibleFlag )

strFilter

<static> boolean strFilter( s, <String> allowedChars )

Does the given string consist of only characters in the given list of allowed characters?

Parameters:
allowedChars - the list of characters that are allowed
keyCode - the charCode of the character to validate

Returns:
true iff keyCode is legal

subitem

<static> String subitem( isInValid )

return the HTML to draw a subitem bullet

timestamp

<static> Object timestamp()

return the current time in milliseconds since start of epoc

TooFewArgsException

<static> Object TooFewArgsException( funcName, required, passed )

Trace

<static> Object Trace(flag,msg)

TraceEvt

<static> Object TraceEvt(msg)

TraceMsg

<static> Object TraceMsg(msg)

TraceMVC

<static> Object TraceMVC(msg)

trimStr

<static> String trimStr(sInString)

strip leading and trailing whitespace

UNWAIT

<static> void UNWAIT(appId)

close the "please wait" window if it exists otherwise no effect

URLDecode

<static> String URLDecode( <String> encoded )

This decodes URL-encoded strings because the Javascript function "unescape" only does part of the job; adapted from here.

Parameters:
encoded - the URL-encoded string to translate

Returns:
decoded version of given encoded string

Author: Bruce Wallace (PolyGlotInc.com)
Version: 1.0

ValidateArgs

<static> void ValidateArgs( <StringArray> optArgDescArray )

generic utility function to verify that required args (of the caller of this function) have been passed; The given array of descriptions defines how many arguments should be found with a defined value; Therefore, the caller of this routine should place its optional arguments at the end of its parameter list with no description specified in "optArgDescArray".

Parameters:
optArgDescArray - optional array of strings describing required parameters; Note: Optional constructor parameters should not be included in this array.

See:
- Class()
Throws:
- MissingArgException
Author: Bruce Wallace (PolyGlotInc.com)
Version: 1.0

validateDate

<static> void validateDate( hookID )

validateDollar

<static> void validateDollar( hookID )

validateFloat

<static> void validateFloat( hookID )

validateInteger

<static> void validateInteger( hookID )

WAIT

<static> void WAIT(appId)

Create an idempotent "wait a minute" window, if one doesn't exist, and squirrel away a reference to it that survives window reloads

WaitWindowName

<static> Object WaitWindowName(appId)

warnInvalid

<static> void warnInvalid(theField, s)

Notify user that contents of field theField are invalid. String s describes expected contents of theField.value.

XformDOM

<static> String XformDOM( xslDOM, xmlDOM )

transform given XML DOM using given XSLT DOM

Returns:
transformed XML

XformURL

<static> String XformURL( xslURL, xmlDOM )

transform given XML DOM using an XSLT retrieved from given URL

Returns:
transformed XML