Class HAW_link

HAW_link

public class HAW_link

This class provides a link in a HAW_deck, HAW_linkset or HAW_table object.

Examples:

$myPage = new HAW_deck(...);
...
$myLink = new HAW_link("Continue","/mynextpage.php");
$myPage->add_link($myLink);

See Also:

HAW_deck, HAW_linkset, HAW_table

Constructor Summary

HAW_link(var $label, var $url, var $title)
Constructor

Method Summary

void	set_br(var $br) Sets the number of line breaks (CRLF) after link. (default: 1)
void	set_voice_text(var $text, var $audio_src) Sets link text to be spoken by voice browsers.
void	set_voice_timeout(var $timeout) Sets the link timeout for voice browsers (default: 10 sec).

Constructor Detail

HAW_link

public HAW_link(var $label,
                var $url,
                var $title)

Constructor

Parameters:

label - Describes the link on the surfer's screen/display.

url - Next destination address.

title - (optional)
If a string is provided here, it will be displayed in the HTML browser status bar during "MouseOver", respectively somewhere on the WAP display. In order to work well with a broad range of user agents, keep your title under 6 characters.

Method Detail

set_br

public void set_br(var $br)

Sets the number of line breaks (CRLF) after link. (default: 1)

Parameters:

br - Some number of line breaks.

set_voice_text

public void set_voice_text(var $text,
                           var $audio_src)

Sets link text to be spoken by voice browsers.

Parameters:

text - Some alternative text that replaces <label>.

audio_src - Some audio file (e.g. *.wav file) to play (optional).

set_voice_timeout

public void set_voice_timeout(var $timeout)

Sets the link timeout for voice browsers (default: 10 sec).
Note: Voice decks with text only will force a disconnect immediately after the complete text has been spoken. Voice decks with text and links will wait some time for user voice input and will initiate the disconnect too, if no user input is received. For each link it is possible to specify an individual timeout value, i.e. a voice deck does not disconnect before the longest timeout of all active links expires.

Parameters:

timeout - Timeout in seconds.