Class GLOBALS

Object
   |
   +--GLOBALS

class GLOBALS

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)

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)
See:
- Extends
- grvValidateArgs()
- GrvObject

EDOInitialize

<static> void EDOInitialize( <EDOHolderModel> edoHolder, <Function> edoIndexClass, <Function> edoHolderViewClass, optCounterViewClass, <PopupMenuController> optMenuCtrlr )

Initialize EDO Framework global variables.

Parameters:
edoHolder - wrapper model for set of EDOs
edoIndexClass - class of index used with EDOHolder
edoHolderViewClass - "class" of EDOHolderView to use
optMenuCtrlr - optional menu override
counterViewClass - "class" of EDOCountersView to use

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvAbstractException

<static> Object grvAbstractException( funcName )

return the formatted message for a calling-abstract-method exception

grvAfter

<static> boolean grvAfter( <String> datestr, <Date> date )

Determine whether given date is at or before a given datestr (where empty means "future").

Parameters:
datestr - string rendition of date in Date.parse format
date - date object to compare to

Returns:
true if given date is empty or after today's date

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvAfterNow

<static> boolean grvAfterNow( <String> datestr )

Determine whether today is at or before a given date (where empty means "future").

Parameters:
datestr - string rendition of date in Date.parse format

Returns:
true if given date is empty or after today's date

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvAppName

<static> Object grvAppName(appId)

grvArgsToString

<static> Object grvArgsToString( args )

grvArrayToString

<static> Object grvArrayToString( a )

grvAsBoolStr

<static> String grvAsBoolStr(flag)

Generate string representation of given boolean value

Returns:
boolean value or null if not boolean

grvASSERT

<static> void grvASSERT(condition,msg)

throw an exception if given condition is not true

grvBefore

<static> boolean grvBefore( <String> datestr, <Date> date )

Determine whether a given datestr is explicitly before the given date.

Parameters:
datestr - string rendition of date in Date.parse format
date - date object to compare to

Returns:
true if given date is not empty and before given date

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvBeforeNow

<static> boolean grvBeforeNow( <String> datestr )

Determine whether a given date is explicitly before today.

Parameters:
datestr - string rendition of date in Date.parse format

Returns:
true if given date is not empty and before today's date

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvBoolValue

<static> boolean grvBoolValue(s)

Evaluate boolean string value

Returns:
boolean value or null if not boolean

grvBreak

<static> Object grvBreak(msg)

output the given message and ask user if they wish to break

Returns:
true iff not "break"ing

grvBreakpoint

<static> void grvBreakpoint()

cause the debugger to stop (ala a breakpoint)

grvBusy

<static> void grvBusy()

set the cursor to the hourglass icon

grvBusyDo

<static> void grvBusyDo( <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)

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvClearGlobalVar

<static> void grvClearGlobalVar( <String> varname )

static routine to dynamically undefine/delete a global variable

Parameters:
varname - name of "persistent" variable

grvClearGlobalVars

<static> void grvClearGlobalVars()

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

grvClearPersistentVars

<static> void grvClearPersistentVars()

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

grvDateKeyFilter

<static> boolean grvDateKeyFilter( <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:
updated char iff character is legal else null

grvDateParseErrorMsg

<static> String grvDateParseErrorMsg(dateStr)

Verify that given string contains a date.

Returns:
error message on invalid date or null if valid

grvDebugWindow

<static> void grvDebugWindow( <String> contents )

open debug window with contents in scrollable area

Parameters:
contents - what to put into this debug window

grvDiamond

<static> String grvDiamond(<boolean> optBlankFlag)

return the HTML to draw a diamond

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

grvDollarKeyFilter

<static> boolean grvDollarKeyFilter( <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:
updated char iff character is legal else null

grvDollarStrFilter

<static> Object grvDollarStrFilter(s)

grvDot

<static> String grvDot()

return the HTML to draw a biggish dot

grvEditElem

<static> void grvEditElem( e, makeSelected, makeEdited, makeInvalid, optUnselectColor )

grvEditElemID

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

grvEpsilon

<static> String grvEpsilon()

return the HTML to draw a smallish "E"

grvError

<static> void grvError(msg)

output the given error message and ask user if they wish to break

grvExtends

<static> Function grvExtends( <Function> superClass )

This utility function takes (via "THIS") a "class" and (re)sets its superClass. THIS VERSION SETS UP "super" ACCESS TO OVERRIDDEN METHODS.

Parameters:
superClass - the "superclass constructor" function

Returns:
a reference to the "class object"

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)
See:
- Class()
- GrvObject

grvFilterNum

<static> String grvFilterNum( str )

remove dollar formatting characters from given string

Returns:
filtered version of numeric string

grvFormatDate

<static> Object grvFormatDate( d, f )

grvFormatDecimal

<static> String grvFormatDecimal( <anyType> v, <String> currencyPreSymbol, <String> currencyPostSymbol, <String> sepSymbol, <boolean> optZeroAsBlankFlag )

format given value as -<$>#<,>###.00<%>

Parameters:
v - value to format
currencyPreSymbol - prefix "currency symbol" to add
currencyPostSymbol - postfix "currency symbol" to add
sepSymbol - thousands "separator" to add
optZeroAsBlankFlag - optional flag to make zero format as blank

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvFormatDollar

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

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

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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvFormatDollarNot

<static> String grvFormatDollarNot( v )

like format_dollar except empty string returned for zero

grvFormatErrorStr

<static> String grvFormatErrorStr( msg )

format Server Error Messages

grvFormatLpadded

<static> String grvFormatLpadded( s,len,padChar )

pad or truncate to be exactly given length

grvFormatMultilineStr

<static> String grvFormatMultilineStr( s,len )

convert CRs to
tags

grvFormatPaddedStr

<static> String grvFormatPaddedStr( s,len )

blankpad or truncate to be exactly given length

grvFormatPercent

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

format given value as ####.00%

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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvFormatRpadded

<static> String grvFormatRpadded( s,len,padChar )

pad or truncate to be exactly given length

grvFuncName

<static> String grvFuncName(<Function> f)

This function returns the name of a given function; It does this by using a regular expression to extract the function name from the function source code.

Parameters:
f - reference to a function

Returns:
name of given function

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvGenHook

<static> String grvGenHook( <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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)
See:
- grvGetHook()

grvGetArg

<static> Object grvGetArg( argname )

grvGetElemVisibility

<static> Object grvGetElemVisibility( e )

grvGetFormInt

<static> Object grvGetFormInt( ID )

grvGetFormValue

<static> Object grvGetFormValue( ID )

grvGetGlobalVar

<static> Object grvGetGlobalVar( <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)

grvGetHook

<static> Object grvGetHook( hookID )

grvGetPersistentVar

<static> Object grvGetPersistentVar( <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)

grvGetTodayAsMMDDYYYY

<static> Object grvGetTodayAsMMDDYYYY()

grvGetTodayAsXXDDYYYY

<static> Object grvGetTodayAsXXDDYYYY(monthNames)

grvGetXslDOM

<static> Object grvGetXslDOM( xslURL )

retrieve XSL DOM from given URL

Returns:
XSL DOM

grvGlobalVar

<static> Object grvGlobalVar()

grvHighlightElem

<static> void grvHighlightElem( e, makeSelected, selectColor, optUnselectColor )

grvImplements

<static> void grvImplements()

This utility function sets up multiple "implements" inheritance with all of the interfaces/classes passed in as parameters. Multiple inheritance is implemented where method references (either explicit or implicit-via-super) are resolved with left-to-right precedence (with "Extends" superclass getting highest)

Version: 2.2

Author: Bruce Wallace (PolyGlotInc.com)
See:
- Class()
- GrvObject

grvIsAlpha

<static> boolean grvIsAlpha(s)

Verify that all characters in given string are alpha chars.

grvIsAlphaBlank

<static> boolean grvIsAlphaBlank(s)

Verify that all characters in given string are alpha or blank chars.

grvIsAlphaNum

<static> boolean grvIsAlphaNum(s)

Verify that all characters in given string are alphanumeric chars.

grvIsChecked

<static> Object grvIsChecked( ID )

grvIsDigit

<static> boolean grvIsDigit(c)

Verify that given character is a digit (0 .. 9).

grvIsEmpty

<static> boolean grvIsEmpty(x)

Verify that given string is "empty".

grvIsFalse

<static> boolean grvIsFalse(s)

Verify that given string equates to "false".

grvIsFloat

<static> boolean grvIsFloat(s)

Verify given string represents a float. Does not accept exponential notation.

Returns:
True if string s is an unsigned floating point (real) number.

grvIsIntDelimInt

<static> boolean grvIsIntDelimInt(s,delim)

Verify that given string is a delimited integer

Returns:
True iff string s is

grvIsInteger

<static> boolean grvIsInteger(s)

Verify that given string contains an integer. 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.

Returns:
true if all characters in string s are numbers

grvIsLetter

<static> boolean grvIsLetter(c)

Verify that given character is an English letter (A .. Z, a..z).

grvIsPhoneNum

<static> boolean grvIsPhoneNum(s)

Verify given string is a phone number.

Returns:
True if string s only has x()-# chars.

grvIsSelected

<static> boolean grvIsSelected(s)

Verify that given string explicitly equates to "true".

grvIsSignedFloat

<static> boolean grvIsSignedFloat(s)

Verify that given string contains a signed or unsigned floating point (real) number. First character is allowed to be + or -. Does not accept exponential notation.

Returns:
true iff string contains a "real" number.

grvIsTrue

<static> boolean grvIsTrue(s)

Verify that given string equates to "true".

grvIsUndefined

<static> boolean grvIsUndefined(<any> x)

Perform a robust test for JavaScript "undefined" using the wisdom at Dont Assume Undefined is Undefined.

Parameters:
x - variable to check for undefinedness

Returns:
true iff x is undefined (as opposed to merely null)

grvIsZeroDollars

<static> Object grvIsZeroDollars(v)

grvIsZipCode

<static> boolean grvIsZipCode(s)

Verify that the given string is a zip code

Returns:
True iff string s is .

grvKeyFilter

<static> boolean grvKeyFilter( <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

grvLoudThrow

<static> void grvLoudThrow( exceptionObj )

throw an exception but first give user a chance to "break"

grvMissingArgException

<static> Object grvMissingArgException( argDesc, funcName )

return the formatted message for a missing-argument exception

grvMustOverride

<static> void grvMustOverride( funcName )

throw an exception because given function is abstract

grvNoDuplicates

<static> boolean grvNoDuplicates( <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

grvNotBusy

<static> void grvNotBusy()

set the cursor to the default icon

grvNotImplemented

<static> void grvNotImplemented( what )

throw an exception because given functionality is unimplemented

grvNotImplementedException

<static> Object grvNotImplementedException( what )

return the formatted message for a not-implemented exception

grvObjectToInitializer

<static> Object grvObjectToInitializer( o )

grvObjectToShortInitializer

<static> Object grvObjectToShortInitializer( o )

grvObjectToString

<static> Object grvObjectToString( o )

grvPersistentVar

<static> Object grvPersistentVar()

grvPleaseWait

<static> Object grvPleaseWait( <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

grvRightArrow

<static> String grvRightArrow()

return the HTML to draw a bold right arrow

grvSelectElem

<static> void grvSelectElem( e, makeSelected, optUnselectColor )

grvSelectElemID

<static> void grvSelectElemID( ID, makeSelected, optUnselectColor )

grvSendStatusMessage

<static> void grvSendStatusMessage( <String> msg )

send a message to the browser status bar

Parameters:
msg - the message to send.

grvSetBackgroundColor

<static> void grvSetBackgroundColor( ID, color )

grvSetButtonElemText

<static> void grvSetButtonElemText( button, str )

grvSetButtonText

<static> void grvSetButtonText( buttonId, str )

grvSetElemBackgroundColor

<static> void grvSetElemBackgroundColor( e, color )

grvSetElemDisplay

<static> void grvSetElemDisplay( e, visibleFlag )

grvSetElemText

<static> void grvSetElemText( e, str )

grvSetElemVisibility

<static> void grvSetElemVisibility( e, visibleFlag )

grvSetFormValue

<static> void grvSetFormValue( ID, theValue )

grvSetGlobalVar

<static> void grvSetGlobalVar( <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

grvSetPersistentVar

<static> void grvSetPersistentVar( <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

grvSetText

<static> void grvSetText( ID, str )

grvSetVisibility

<static> void grvSetVisibility( ID, visibleFlag )

grvStrFilter

<static> boolean grvStrFilter( 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

grvSubitem

<static> String grvSubitem( isInValid )

return the HTML to draw a subitem bullet

grvTimestamp

<static> Object grvTimestamp()

grvTooFewArgsException

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

return the formatted message for a too-few-arguments exception

grvTrace

<static> Object grvTrace(flag,msg)

grvTraceEvt

<static> Object grvTraceEvt(msg)

grvTraceMrk

<static> Object grvTraceMrk(msg)

grvTraceMsg

<static> Object grvTraceMsg(msg)

grvTraceMVC

<static> Object grvTraceMVC(msg)

grvTraceObj

<static> Object grvTraceObj(msg)

grvTraceTODO

<static> Object grvTraceTODO(msg)

grvTrimStr

<static> String grvTrimStr(sInString)

Strip leading and trailing whitespace from given string

grvUNWAIT

<static> void grvUNWAIT(appId)

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

grvUpperKeyFilter

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

convert the given character to uppercase

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

Returns:
updated char iff character is legal else null

grvURLDecode

<static> String grvURLDecode( <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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

grvValidateArgs

<static> void grvValidateArgs( callerName, <StringArray> argDescArray, callersArgs )

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:
argDescArray - array of strings describing required parameters; Note: Optional constructor parameters should not be included in this array.

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)
See:
- Class()
Throws:
- grvMissingArgException

grvValidateDate

<static> void grvValidateDate( fieldName )

validate date value of form field with given element ID

grvValidateDollar

<static> void grvValidateDollar( fieldName )

validate dollar value of form field with given element ID

grvValidateFloat

<static> void grvValidateFloat( fieldName )

validate float value of form field with given element ID

grvValidateInteger

<static> void grvValidateInteger( fieldName )

validate integer value of form field with given element ID

grvWAIT

<static> void grvWAIT(appId)

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

grvWAITING

<static> boolean grvWAITING(appId)

are we in "please wait" mode?

grvWaitWindowName

<static> Object grvWaitWindowName(appId)

grvWarnInvalid

<static> void grvWarnInvalid(<element> theField, <String> s)

Notify user that contents of field theField are invalid.

Parameters:
theField - HTML element containing form field
s - describes expected contents of theField.value.

grvXformDOM

<static> String grvXformDOM( xslDOM, xmlDOM )

transform given XML DOM using given XSLT DOM

Returns:
transformed XML

Throws:
- ErrMsg on fatal error

grvXformURL

<static> String grvXformURL( xslURL, xmlDOM )

transform given XML DOM using an XSLT retrieved from given URL

Returns:
transformed XML

Throws:
- ErrMsg on fatal error

handleEvent

<static> Object handleEvent(aEvent) * { * var myEvent = aEvent ? aEvent : window.event; * } * * @author Bruce Wallace (PolyGlotInc.com) * @requires grvUtils.js * @requires grvValidate.js * @requires grvClass.js * @version 2.0 */ var kMVCImgPath = "/images/"; var kMVCDim_ = "DIM_"; var kMVCImgSpacer = 'spacer.gif'; var kMVCImgRedSpacer = 'redspacer.gif'; var kMVCImgCalendar = 'calendar.gif'; function mvcSPACER()

mvcDoCmd

<static> boolean mvcDoCmd( 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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

mvcEmbedAttributeViewer

<static> String mvcEmbedAttributeViewer( <MVCView> parentView, <String> attribute, <Function> optFormatter, <Object> optParam )

Create and embed, as a subview, a MVCScalarView 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)

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

mvcEmbedBoolDualEditor

<static> String mvcEmbedBoolDualEditor( <MVCView> parentView, <String> attribute, <int> min, <String> className )

Create and embed, as a subview, a MVCDualBoolController of the specified data model attribute which is expected to be a (boolean) 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
min - minimum number of chars to support (i.e. display size)
className - the CSS classname to use for formatting

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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

mvcEmbedChkBoxDualEditor

<static> String mvcEmbedChkBoxDualEditor( <MVCView> parentView, <String> attribute, <int> min, <String> className )

Create and embed, as a subview, a MVCDualChkBoxController of the specified data model attribute which is expected to be a (boolean) 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
min - minimum number of chars to support (i.e. display size)
className - the CSS classname to use for formatting

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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

mvcEmbedDateDualEditor

<static> String mvcEmbedDateDualEditor( <MVCView> parentView, <String> attribute, <String> className )

Create and embed, as a subview, a MVCDualDateController of the specified data model attribute which is expected to be a String data element containing a Date.

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)

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

mvcEmbedDollarDualEditor

<static> String mvcEmbedDollarDualEditor( <MVCView> parentView, <String> attribute, <String> className, <Function> optFormatFunction )

Create and embed, as a subview, a MVCDualDollarController 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
optFormatFunction - optional formatter function

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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

mvcEmbedDualMenu

<static> String mvcEmbedDualMenu( <MVCView> parentView, <String> attribute, <MVCSelectionModel> menuModel, <String> className, <String> optEvtHndlrName, <String> optInitDesc )

Create and embed, as a subview, a MVCDualMenuController 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
optEvtHndlrName - optional edit event handler (default is to launch a MVCScalarEditCmd command).
optInitDesc - optional initial description string

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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

mvcEmbedStringDualEditor

<static> String mvcEmbedStringDualEditor( <MVCView> parentView, <String> attribute, <int> min, <int> max, <String> className, <Function> optKeyFilter )

Create and embed, as a subview, a MVCDualStringController of the specified data model attribute which is expected to be a String 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
min - minimum number of chars to support (i.e. display size)
max - maximum number of chars to support
className - the CSS classname to use for formatting
optKeyFilter - optional keypress filter function

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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

mvcEmbedTextDualEditor

<static> String mvcEmbedTextDualEditor( <MVCView> parentView, <String> attribute, <int> rows, <int> cols, <int> max, <String> className )

Create and embed, as a subview, a MVCDualTextController of the specified data model attribute which is expected to be a String 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
rows - number of rows to support
cols - number of cols to support
max - maximum number of chars to support
className - the CSS classname to use for formatting

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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

mvcREDSPACER600

<static> Object mvcREDSPACER600()

mvcREDSPACER768

<static> Object mvcREDSPACER768()

mvcSECTIONBREAK

<static> Object mvcSECTIONBREAK()

onEDOAddClick

<static> void onEDOAddClick( <EDOIndex> xi )

handle event for 'click on an EDO Add Button'

Parameters:
xi - index of EDO to append after

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOClick

<static> void onEDOClick( <EDOIndex> xi )

handle event for 'click on an EDO'

Parameters:
xi - index of EDO clicked

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDODeleteBtnPressed

<static> void onEDODeleteBtnPressed()

handle event for 'delete EDO button pressed'

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOEditBtnPressed

<static> void onEDOEditBtnPressed()

handle event for 'edit EDO button pressed'

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOHolderCancelBtnPressed

<static> void onEDOHolderCancelBtnPressed()

handle event for 'cancel button pressed'

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOHolderExitBtnPressed

<static> void onEDOHolderExitBtnPressed()

handle event for 'exit button pressed'

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOHolderLoadReply

<static> void onEDOHolderLoadReply( <XMLreq> xmlReq )

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

Parameters:
xmlReq - the XML request being replied to

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOHolderPageBeforeUnLoad

<static> void onEDOHolderPageBeforeUnLoad()

onEDOHolderPageLoad

<static> void onEDOHolderPageLoad()

handle event for 'entering EDOHolder web page'

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOHolderSaveBtnPressed

<static> void onEDOHolderSaveBtnPressed()

handle event for 'save button pressed'

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOHolderSaveReply

<static> void onEDOHolderSaveReply( <XMLreq> xmlReq )

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

Parameters:
xmlReq - the XML request being replied to

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOHolderSelect

<static> void onEDOHolderSelect( <int> selectedHolderIndex )

handle event for 'user selects from the select menu which loads a new EDOHolder'

Parameters:
selectedHolderIndex - the new menu-selection

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOInsertBtnPressed

<static> void onEDOInsertBtnPressed()

handle event for 'insert EDO button pressed'

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onEDOToggle

<static> void onEDOToggle( <EDOIndex> xi )

handle event for 'toggle an EDO'

Parameters:
xi - index of EDO to collapse/expand

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onMVCFieldEditFocus

<static> void onMVCFieldEditFocus( <Element> field )

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

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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onMVCFieldEditKey

<static> boolean onMVCFieldEditKey( <String> viewID )

handle "key pressed" events in text fields

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

Returns:
false if this key should be suppressed

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onMVCGlobalKeyPress

<static> Object onMVCGlobalKeyPress()

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

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onMVCRedoBtnPressed

<static> void onMVCRedoBtnPressed()

redo-button-pressed event handler

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onMVCScalarEditUpdate

<static> boolean onMVCScalarEditUpdate( <String> viewID )

ScalarEditController update-event handler

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

Returns:
event success?? flag

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)

onMVCUndoBtnPressed

<static> void onMVCUndoBtnPressed()

undo-button-pressed event handler

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)