|
HAWHAW PHP |
|||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
HAW_deck
This class is the top level class of all HAWHAW classes. Your page should consist of exactly one HAW_deck object. For WML browsers one deck with one card will be generated. For HDML browsers one deck including as much cards as necessary will generated. HTML browsers will receive a normal HTML page, PDA browsers will receive handheldfriendly HTML etc.
Do not overload HAW_deck objects! Remember that a lot of WAP clients can not handle more than about 1400 byte of compiled data.
Examples:
$myPage = new HAW_deck();
$myPage = new HAW_deck("My WAP page");
$myPage = new HAW_deck("", HAW_ALIGN_CENTER);
$myPage = new HAW_deck("PDA edition", HAW_ALIGN_CENTER, HAW_OUTPUT_PDA);
...
$myPage->set_bgcolor("blue");
...
$myPage->add_text($myText);
...
$myPage->create_page();
Constructor Summary | |
HAW_deck(var $title,
var $alignment,
var $output)
Constructor |
Method Summary | |
void |
add_banner(var $banner,
var $position)
Adds a HAW_banner object to HAW_deck. |
void |
add_form(var $form)
Adds a HAW_form object to HAW_deck. |
void |
add_image(var $image)
Adds a HAW_image object to HAW_deck. |
void |
add_link(var $link)
Adds a HAW_link object to HAW_deck. |
void |
add_linkset(var $linkset)
Adds a HAW_linkset object to HAW_deck. |
void |
add_phone(var $phone)
Adds a HAW_phone object to HAW_deck. |
void |
add_rule(var $rule)
Adds a HAW_rule object to HAW_deck. |
void |
add_table(var $table)
Adds a HAW_table object to HAW_deck. |
void |
add_text(var $text)
Adds a HAW_text object to HAW_deck. |
void |
add_voicerecorder(var $voicerecorder)
Adds a HAW_voicerecorder object to HAW_deck. |
void |
create_page()
Creates the page in the according markup language. |
void |
disable_cache()
Disables deck caching in the users client. |
void |
enable_session()
Enables mobile specific session support. |
void |
set_background(var $background)
Sets a wallpaper for a HTML created page. |
void |
set_bgcolor(var $bgcolor)
Sets the background color for a HTML created page. |
void |
set_border(var $border)
Sets the thickness of the HTML display frame. |
void |
set_charset(var $charset,
var $unicodemaptab)
Sets a given character set. |
void |
set_color(var $color)
Sets the color for all characters in a HTML created page. |
void |
set_disp_background(var $background)
Sets a display wallpaper for a HTML created page. |
void |
set_disp_bgcolor(var $disp_bgcolor)
Sets the display background color for a HTML created page. |
void |
set_face(var $face)
Sets the font for all characters in a HTML created page. |
void |
set_height(var $height)
Sets the display height for a HTML created page. |
void |
set_link_color(var $link_color)
Sets the color of links in a HTML created page. |
void |
set_redirection(var $timeout,
var $red_url)
Redirects automatically after timeout to another URL. |
void |
set_size(var $size)
Sets the font size for all characters in a HTML created page. |
void |
set_vlink_color(var $vlink_color)
Sets the color of visited links in a HTML created page. |
void |
set_voice_help(var $text,
var $audio_src,
var $url)
Sets help text for voice browsers. |
void |
set_voice_jingle(var $url)
Play jingle before link <label>s are spoken. |
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_property(var $name,
var $value)
Sets a name/value property pair for VoiceXML decks. |
void |
set_voice_text(var $text,
var $audio_src)
Sets deck-related text to be spoken by voice browsers. |
void |
set_waphome(var $waphome)
Sets the URL of a website, a bigscreen-browsing user is invited to visit via WAP. |
void |
set_width(var $width)
Sets the display width for a HTML created page. |
void |
use_simulator()
Activates the built-in device simulator on bigscreen browsers. |
Constructor Detail |
public HAW_deck(var $title, var $alignment, var $output)
title
- (optional, default: HAW_NOTITLE) alignment
- (optional, default: HAW_ALIGN_LEFT) output
- (optional, default: HAW_OUTPUT_AUTOMATIC) Method Detail |
public void add_text(var $text)
text
- Some HAW_text object.HAW_text
public void add_image(var $image)
image
- Some HAW_image object.HAW_image
public void add_table(var $table)
table
- Some HAW_table object.HAW_table
public void add_form(var $form)
form
- Some HAW_form object.HAW_form
public void add_link(var $link)
link
- Some HAW_link object.HAW_link
public void add_phone(var $phone)
phone
- Some HAW_phone object.HAW_phone
public void add_linkset(var $linkset)
linkset
- Some HAW_linkset object.HAW_linkset
public void add_banner(var $banner, var $position)
banner
- Some HAW_banner object.position
- (optional)HAW_banner
public void add_rule(var $rule)
rule
- Some HAW_rule object.HAW_rule
public void add_voicerecorder(var $voicerecorder)
voicerecorder
- Some HAW_voicerecorder object.HAW_voicerecorder
public void set_redirection(var $timeout, var $red_url)
timeout
- Some timeout value in seconds.red_url
- Some URL string.public void disable_cache()
public void enable_session()
public void set_charset(var $charset, var $unicodemaptab)
charset
- Character set that is used in your country.unicodemaptab
- (optional)public void set_bgcolor(var $bgcolor)
bgcolor
- See HTML specification for possible values (e.g. "#CCFFFF",
"red", ...).public void set_background(var $background)
background
- e.g. "backgrnd.gif"public void set_border(var $border)
border
- Thickness is pixels (default: 8)public void set_disp_bgcolor(var $disp_bgcolor)
disp_bgcolor
- See HTML specification for possible values (e.g. "#CCFFFF",
"red", ...).public void set_disp_background(var $background)
background
- e.g. "backgrnd.gif"public void set_width(var $width)
width
- See HTML specification for possible values (e.g. "200", "50%", ...).public void set_height(var $height)
height
- See HTML specification for possible values (e.g. "200", "50%", ...).public void set_size(var $size)
size
- See HTML specification for possible values (e.g. "4", "+2", ...).public void set_color(var $color)
color
- See HTML specification for possible values (e.g. "#CCFFFF", "red",
...).public void set_link_color(var $link_color)
link_color
- See HTML specification for possible values (e.g. "#CCFFFF", "red",
...).public void set_vlink_color(var $vlink_color)
vlink_color
- See HTML specification for possible values (e.g. "#CCFFFF", "red",
...).public void set_face(var $face)
face
- See HTML specification for possible values (e.g. "Avalon",
"Wide Latin").public void set_waphome(var $waphome)
waphome
- Some URL string.public void use_simulator()
public void set_voice_text(var $text, var $audio_src)
text
- Some introducing text that will be spoken before any other dialog or
text output is started.audio_src
- Some audio file (e.g. *.wav file) to play (optional).public void set_voice_jingle(var $url)
url
- Some wav-file.public void set_voice_help(var $text, var $audio_src, var $url)
text
- Some helpful information concerning this deck.audio_src
- Some audio file (e.g. *.wav file) to play (optional).url
- Some other voice deck to go to (optional).public void set_voice_noinput(var $text, var $audio_src, var $url)
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).public void set_voice_nomatch(var $text, var $audio_src, var $url)
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).public void set_voice_property(var $name, var $value)
name
- Name of property (e.g. "bargein", "timeout", etc.)value
- Value of property (e.g. "false", "10s", etc.)public void create_page()
|
© Norbert Huffschmid assembled from PHP source using sed and javadoc |
|||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |