Public Method Details |
Message |
public void Message( string $msg )
|
|
Outputs JavaScript used to send an alert message
|
Parameter |
|
string |
$msg |
|
|
Text to be displayed in the JavaScript alert box |
|
Returns |
void |
|
Navigate |
public void Navigate( string $url )
|
|
Outputs JavaScript used to redirect a browser window
|
Parameter |
|
string |
$url |
|
|
Relative or absolute URL to redirect to |
|
Returns |
void |
|
OpenWidget |
public void OpenWidget( string $titlebar, [ integer $size ] )
|
|
Outputs an opening container table for a program interface with a titlebar and set width
|
Parameter |
|
string |
$titlebar |
|
|
Text to be displayed in the widget interfaces titlebar area |
|
|
integer |
$size |
= >>600<< |
|
Width of the widget interface in pixels, if not supplied the dfault with of 600 pixels will be used |
|
Returns |
void |
|
CloseWidget |
public void CloseWidget( )
|
|
Outputs a closing container table for a program interface
|
Returns |
void |
|
OpenForm |
public void OpenForm( string $name, string $action, string $onsubmit )
|
|
Outputs an opening HTML form for POST data
|
Parameter |
|
string |
$name |
|
|
The value used for the HTML forms name attribute |
|
|
string |
$action |
|
|
The value used for the HTML forms action attribute |
|
|
string |
$onsubmit |
|
|
The value used for the HTML forms onSubmit () JavaScript event |
|
Returns |
void |
|
CloseForm |
public void CloseForm( )
|
|
Outputs a closing HTML form element
|
Returns |
void |
|
Label |
public string Label( string $text )
|
|
Returns a text label
|
Parameter |
|
string |
$text |
|
|
Text to be displayed as the label |
|
Returns |
string |
|
CheckBox |
public string CheckBox( string $name, string $value, [ integer $checked ] )
|
|
Returns a HTML checkbox element
|
Parameter |
|
string |
$name |
|
|
The value used for the HTML checkbox name attribute |
|
|
string |
$value |
|
|
The value used for the HTML checkbox value attribute |
|
|
integer |
$checked |
= >>0<< |
|
Sets the initial state of the checkbox, 1 = checked, 0 = unchecked. If the value is not supplied 0 will be used as the default |
|
Returns |
string |
|
RadioOption |
public string RadioOption( string $name, string $value, [ integer $checked ] )
|
|
Returns a HTML radio option element
|
Parameter |
|
string |
$name |
|
|
The value used for the HTML radio option name attribute |
|
|
string |
$value |
|
|
The value used for the HTML radio option value attribute |
|
|
integer |
$checked |
= >>0<< |
|
Sets the initial state of the radio option, 1 = checked, 0 = unchecked. If the value is not supplied 0 will be used as the default |
|
Returns |
string |
|
TextBox |
public string TextBox( string $name, string $value, integer $size )
|
|
Returns a HTML text box
|
Parameter |
|
string |
$name |
|
|
The value used for the HTML text box name attribute |
|
|
string |
$value |
|
|
The value used for the HTML text box value attribute |
|
|
integer |
$size |
|
|
The value used for the HTML text box size attribute |
|
Returns |
string |
|
PwdBox |
public string PwdBox( string $name, string $value, integer $size )
|
|
Returns a HTML password box
|
Parameter |
|
string |
$name |
|
|
The value used for the HTML password box name attribute |
|
|
string |
$value |
|
|
The value used for the HTML password box value attribute |
|
|
integer |
$size |
|
|
The value used for the HTML text password size attribute |
|
Returns |
string |
|
Hidden |
public string Hidden( string $name, string $value )
|
|
Returns a HTML hidden form element
|
Parameter |
|
string |
$name |
|
|
The value used for the HTML password box name attribute |
|
|
string |
$value |
|
|
The value used for the HTML password box value attribute |
|
Returns |
string |
|
TextArea |
public string TextArea( string $name, string $value, integer $rows, integer $cols )
|
|
Returns a HTML text area box
|
Parameter |
|
string |
$name |
|
|
The value used for the HTML text area box name attribute |
|
|
string |
$value |
|
|
The value used for the HTML text area box value attribute |
|
|
integer |
$rows |
|
|
The value used for the HTML text area rows attribute |
|
|
integer |
$cols |
|
|
The value used for the HTML text area cols attribute |
|
Returns |
string |
|
OpenListBox |
public void OpenListBox( string $name, integer $size, [ integer $multiple ] )
|
|
Outputs an opening HTML select box element
|
Parameter |
|
string |
$name |
|
|
The value used for the HTML select box name attribute |
|
|
integer |
$size |
|
|
The value used for the select box size attribute |
|
|
integer |
$multiple |
= >>0<< |
|
Sets the allow single or multiple selection state, 1 = multiple 0 = single. If this value is not given the default of 0 will be used |
|
Returns |
void |
|
ListOption |
public void ListOption( string $value, string $label, [ integer $selected ] )
|
|
Outputs a HTML select box option element
|
Parameter |
|
string |
$value |
|
|
The value used for the option name attribute |
|
|
string |
$label |
|
|
The value used for the option display text |
|
|
integer |
$selected |
= >>0<< |
|
Sets the option selection state, 1 = selected 0 = unselected. If this value is not given the default of 0 will be used |
|
Returns |
void |
|
CloseListBox |
public void CloseListBox( )
|
|
Outputs an closing HTML select box element
|
Returns |
void |
|
Button |
public string Button( string $label )
|
|
Returns a HTML submit button for use in forms
|
Parameter |
|
string |
$label |
|
|
Text to be displayed on the button |
|
Returns |
string |
|
Hyperlink |
public void Hyperlink( string $label, string $url, [ string $target ] )
|
|
Outputs a textual hyperlink
|
Parameter |
|
string |
$label |
|
|
Text to be displayed in the hyperlink |
|
|
string |
$url |
|
|
Relative or absolute URL to link to |
|
|
string |
$target |
= >>""<< |
|
Value to be used as the HTML target attribute, options include _self, _blank |
|
Returns |
void |
|
PageBody |
public void PageBody( [ integer $is_mod ] )
|
|
Outputs an opening HTML body tag with defined attributes
|
Parameter |
|
integer |
$is_mod |
= >>0<< |
|
Determines how to set the URL to the background image used in the body tag. If set to 1 the URL of the background image will be adjusted accordingly for use in a module. If this value is not given the default of 0 will be used. |
|
Returns |
void |
|