Minibar API

The Minibar web app consists of the following objects: They are described below.

The Minibar object

This object implements the complete Minibar web app. It is defined in minibar.js. It also uses the Input and Translations objects described below, and some auxiliary functions defined in minibar_support.js and support.js, so to use it in an HTML file, you would normally include at least the following:

<script type="text/JavaScript" src="minibar.js"></script>
<script type="text/JavaScript" src="minibar_input.js"></script>
<script type="text/JavaScript" src="minibar_translations.js"></script>
<script type="text/JavaScript" src="minibar_support.js"></script>
<script type="text/JavaScript" src="../js/support.js"></script>

For an example, see minibar.html.

Constructor

var minibar=new Minibar(server,options,target)

Methods

There are several internal methods, but since this is a self-contained web app, there is usually no need to call any methods from outside.

The Input object

This object handles user input. Text can be entered by typing or by clicking on the "refrigerator magnets".

It is defined in minibar_input.js. It also uses some auxiliary functions defined in minibar_support.js and support.js, so to use it in an HTML file, you would normally include at least the following:

<script type="text/JavaScript" src="minibar_input.js"></script>
<script type="text/JavaScript" src="minibar_support.js"></script>
<script type="text/JavaScript" src="../js/support.js"></script>

Constructor

var input=new Input(server,translations,options)

Properties and user interface

The input object created by the Input constructor contains the following fields that the caller should add to the user interface:

Methods

The Translations object

This object displays translations. It is defined in minibar_translations.js. It also uses some auxiliary functions defined in minibar_support.js and support.js, so to use it in an HTML file, you would normally include at least the following:
<script type="text/JavaScript" src="minibar_translations.js"></script>
<script type="text/JavaScript" src="minibar_support.js"></script>
<script type="text/JavaScript" src="../js/support.js"></script>

Constructor

var translations=new Translations(server,options)

Properties and user interface

The translations object created by the Translations constructor contains the following fields that the caller should add to the user interface:

Methods


HTML Last modified: Tue Nov 27 15:03:15 CET 2012
TH