Listbox

^{Listbox 2.1}

Category / Domain :	Interface
SCOL Voy@ger Compatibility&nb:	V 3.5 or above
Update :	2001/06

Function

The LISTBOX module creates a list of elements in the client graphic interface. According to a given user's action, elements can be added or removed from the list. These elements are able to generate specific events towards other modules. They can be transmitted as a link parameter and thus be got back by the target module.
The on-line additions / suppressions of elements are not saved in case of restart of the server.

Configuration

Figure 1 : Listbox module interface

(1) : Add=> Allows to add an element in the list

(2) : Delete => Allows to remove an element in the list

(3) : Same list for all clients => Allows to display or not the same list for all the clients (if a user dynamically modifies the list (the site being launched), this one is automatically updated on the other clients)

(4) : The name of the selected item will be passed as parameter of the link => This option should be ticked if the name of the item that ones clicks in the list must be passed through the link parameters

Implementation

Open the SCS creation tree, select the Interf folder and double-click on Listbox 2.1.
Create required links for the project.

Action	Function
module.event à Listbox.start	Starts the module at the client side
module.event à Listbox.add	Adds an event to the list (the element must be passed as parameter of the action)
module.event à Listbox.del	Removes an element of the list (the element must be passed as parameter of the action)
module.event à Listbox.sort	Alphabetizes the list without taking into account upper case letters / lower case letters
module.event à Listbox.kill	Stops the module on the client

Event	Function
Listbox.killed à module Action	Generates an action when shutting-down the module
Listbox.started à module Action	Generates an action at the starting up of the module
Listbox.dclick à module Action	Generates an action when an element of the list is double-clicked
Listbox.click à module Action	Generates an action when an element of the list is clicked. The sent parameter is the name of the item
Listbox.click alias à module Action	Generates an action when an element of the list determined by its name is clicked (applies only to the items defined as static)
Listbox.dclick alias à module Action	Generates an action when an element of the list determined by its name double-is clicked (applies only to the items defined as static)

Zone	Function	Interface	Assignment
Listebox.listbox	Elements list	Client	Yes