HAWHAW

PHP

Class HAW_linkset

HAW_linkset

public class HAW_linkset

This class defines a set of links. It should be preferably used for all kinds of menus. The links have to be defined as separate HAW_link objects and are attached to the linkset with a special "add_link" function. For WAP devices browser-dependent WML code will be created. On all UP-browser-based WAP devices linksets allow easier navigation through WML decks by using the "onpick" WML option and therefore are improving the "usability" of an application. Instead of painfully navigating through the links "sports->football->results->today" the mobile user e.g. can press "2431" on the keypad to enter his favorite deck. For all other WAP devices normal <a> tags are created. One HAW_deck object can contain only one linkset object.

Examples:

$myPage = new HAW_deck(...);
...
$myLinkset = new HAW_linkset();
$myLink1 = new HAW_link("Phonebook", "/wap/phonebook.php");
$myLinkset->add_link($myLink1);
$myLink2 = new HAW_link("DateBook", "/wap/datebook.php");
$myLinkset->add_link($myLink2);
...
$myPage->add_linkset($myLinkset);
...
$myPage->create_page();

See Also:
HAW_link, HAW_deck

Constructor Summary
HAW_linkset()
          Constructor
 
Method Summary
 void add_link(var $link)
          Adds a HAW_link object to HAW_linkset
 void set_voice_help(var $text, var $audio_src, var $url)
          Sets help text for voice browsers.
 void set_voice_noinput(var $text, var $audio_src, var $url)
          Sets noinput text for voice browsers.
 void set_voice_nomatch(var $text, var $audio_src, var $url)
          Sets nomatch text for voice browsers.
 void set_voice_text(var $text, var $audio_src)
          Sets text to be spoken by voice browsers.
 

Constructor Detail

HAW_linkset

public HAW_linkset()
Constructor
Method Detail

add_link

public void add_link(var $link)
Adds a HAW_link object to HAW_linkset
Parameters:
link - Some HAW_link object.
See Also:
HAW_link

set_voice_text

public void set_voice_text(var $text,
                           var $audio_src)
Sets text to be spoken by voice browsers.
Parameters:
text - Some alternative text that replaces the enumeration of link <label>s.
audio_src - Some audio file (e.g. *.wav file) to play (optional).

set_voice_help

public void set_voice_help(var $text,
                           var $audio_src,
                           var $url)
Sets help text for voice browsers.
Parameters:
text - Some helpful information concerning this linkset.
audio_src - Some audio file (e.g. *.wav file) to play (optional).
url - Some other voice deck to go to (optional).

set_voice_noinput

public void set_voice_noinput(var $text,
                              var $audio_src,
                              var $url)
Sets noinput text for voice browsers.
Parameters:
text - Some text to inform the user that no input has been received.
audio_src - Some audio file (e.g. *.wav file) to play (optional).
url - Some other voice deck to go to (optional).

set_voice_nomatch

public void set_voice_nomatch(var $text,
                              var $audio_src,
                              var $url)
Sets nomatch text for voice browsers.
Parameters:
text - Some text to complain that user input was not recognized.
audio_src - Some audio file (e.g. *.wav file) to play (optional).
url - Some other voice deck to go to (optional).

© Norbert Huffschmid
assembled from PHP source
using sed and javadoc