Transfinite Ordinal Calculator: oGui

API Docs for: 1.0

Class oGui

Class defined in: src/js/gui.js:15

The object which communicates with the HTML-GUI. It is initialized by the function go.initGui at the start of the application.

dbgErr( msg )
src/js/gui.js:438

Debug an Error. If it will really be showed and where it will be showed is defined by the properties of the global config object.

Parameters:
  • msg <String>

    The message to show.

dbgLog( msg )
src/js/gui.js:459

Debug a log message. If it will really be showed and where it will be showed is defined by the properties of the global config object.

Parameters:
  • msg <String>

    The message to show.

dbgWarn( msg )
src/js/gui.js:448

Debug a Warning or non-fatal error. If it will really be showed and where it will be showed is defined by the properties of the global config object.

Parameters:
  • msg <String>

    The message to show.

debug( msg, level ) /* private method */
src/js/gui.js:99

Print debug messages of different levels to the console object. Is called by the methods dbgErr, dbgWarn and dbgLog; don't call it directly...

Parameters:
  • msg <String>

    The message to show

  • level <Number>

    The debug level (see config.debug)

fnKey( evt ) /* private method */
src/js/gui.js:190

Handles a click on one of the input panel's keys

Parameters:
  • evt <Object>

    The event object (the activated key or window.event in IE)

fnOverlay( content, closeBtnText )
src/js/gui.js:347

Method to create a semi-transparent overlay layer with a lightbox as a smoother alert...

Parameters:
  • content <HTMLElement>

    The Element to show in the lightbox

  • closeBtnText <String>

    A short text, e.g. "close" or "OK" or similar, which is used on a button inside the lightbox

fnPopupCompare( )
src/js/gui.js:262

Shows a popup with the complete compare register values. Triggered by Click on compare display.

fnRemoveOL( ) /* private method */
src/js/gui.js:326

Event Handler to remove the overlay layer again.

fnToggleDMode( ) /* private method */
src/js/gui.js:136

Event handler to toggle the main display mode from augmented state to reduced or from reduced (or from no-overflow) to augmented state. May also be called directly (not as an event handler), this method doesn't depend on an event parameter.

fnToNormalSizedisp( ) /* private method */
src/js/gui.js:167

When display was overflowed, and now the content is small enough again to fit in the display, this method is called to remove HTMLElements and formatting used for reduced and augmented states. This method is normally called directly (not as an event handler).

initGuiConsole( ) /* private method */
src/js/gui.js:45

Method to init the gui console (if an own console object is used instead of the browser's console)

progError( msg )
src/js/gui.js:391

Will show an error message on the gui, indicating that some software error has occurred. Should be invoked, when the result may be incorrect due to a program error. Note: This method is not for development logs, but for error notification to the USER, even in the productive state.
This method throws an error that shouldn't be handled anywhere, so it executes the script

Parameters:
  • msg <String>

    The message to log to the console as error message. (The user won't see this message! So it may be verbose...)

showHint( msg, closeBtnText )
src/js/gui.js:415

This is not an error, but can be used to inform the user without doing anything else.

Parameters:
  • msg <String / DocumentFragment>

    The message showed to the user.

  • closeBtnText <String>

    Optional. The Text of the close button of the hint dialog. If omitted, the Text defaults to "Close".

update( )
src/js/gui.js:471

Call this method to inform the gui, that the model has changed. This method will then look for the needed information and update the gui.

updateCmp( cmpDocFrag ) /* private method */
src/js/gui.js:658

Method to update the compare line to show the relationship between the two registers.

Parameters:
  • cmpDocFrag <DocumentFragment>

    The document fragment containing the content of the compare line

updateKeys( state ) /* private method */
src/js/gui.js:494

Update the keys (depending on the model state given as argument, some keys may be set inactive)

Parameters:
  • state <model.enumState>

    The state of the model

updateMainDisplay( content ) /* private method */
src/js/gui.js:703

Update the result field's content

Parameters:
  • content <String>

    The new content (innerHTML) to be set

downEvt <String>
src/js/gui.js:128

Event used to detect when a key is pressed down

selEvt <String>
src/js/gui.js:119

Event to register a kind of a click... (working with touch devices and non-touch devices).