constructor __construct [line 1247]
method defaultAction [line 1130]
method defaultBorderWidth [line 1010]
void defaultBorderWidth(
)
|
|
method defaultBottomMargin [line 1874]
void defaultBottomMargin(
)
|
|
method defaultCache [line 1258]
method defaultDirectionality [line 1561]
void defaultDirectionality(
)
|
|
method defaultDocType [line 1046]
method defaultEncoding [line 1028]
method defaultFormEncoding [line 1063]
void defaultFormEncoding(
)
|
|
method defaultFrameBorder [line 998]
void defaultFrameBorder(
)
|
|
method defaultFrameSpacing [line 980]
void defaultFrameSpacing(
)
|
|
method defaultIcon [line 963]
method defaultIsForm [line 1919]
method defaultjsOnLoad [line 934]
method defaultjsOnReset [line 1285]
method defaultjsOnSubmit [line 1276]
void defaultjsOnSubmit(
)
|
|
method defaultjsOnUnload [line 943]
void defaultjsOnUnload(
)
|
|
method defaultLanguage [line 1244]
method defaultLeftMargin [line 1862]
void defaultLeftMargin(
)
|
|
method defaultOnAfterAjaxProcess [line 1448]
void defaultOnAfterAjaxProcess(
)
|
|
method defaultOnAfterShowFooter [line 1967]
void defaultOnAfterShowFooter(
)
|
|
method defaultOnBeforeAjaxProcess [line 1432]
void defaultOnBeforeAjaxProcess(
)
|
|
method defaultOnBeforeShowHeader [line 1959]
void defaultOnBeforeShowHeader(
)
|
|
method defaultOnCreate [line 1993]
method defaultOnShowHeader [line 1976]
void defaultOnShowHeader(
)
|
|
method defaultOnStartBody [line 1984]
void defaultOnStartBody(
)
|
|
method defaultOnTemplate [line 1416]
void defaultOnTemplate(
)
|
|
method defaultRightMargin [line 1886]
void defaultRightMargin(
)
|
|
method defaultShowFooter [line 1951]
void defaultShowFooter(
)
|
|
method defaultShowHeader [line 1904]
void defaultShowHeader(
)
|
|
method defaultTarget [line 1291]
method defaultTemplateEngine [line 1113]
void defaultTemplateEngine(
)
|
|
method defaultTemplateFilename [line 1150]
void defaultTemplateFilename(
)
|
|
method defaultTopMargin [line 1850]
method defaultUseAjax [line 1168]
method defaultUseAjaxDebug [line 1183]
void defaultUseAjaxDebug(
)
|
|
method defaultUseAjaxUri [line 1189]
void defaultUseAjaxUri(
)
|
|
method dumpChildren [line 1771]
Dump al children controls
Overrides
FocusControl::dumpChildren() (Dumps all children iterating through the Controls property and calls the show method of each one.)
method dumpChildrenFormItems [line 1739]
void dumpChildrenFormItems(
[
$return_contents = false])
|
|
Overrides
Component::dumpChildrenFormItems() (This method is called by the page just after dumping the starting form tag.)
Parameters:
method dumpContents [line 1563]
method dumpFrames [line 1829]
Dump the page using frames, it's called when the Page contain Frame or Frameset components
This method is called internally by the Page component when it detects it has Frames or Framesets inside, so the code it generates must be different
Tags:
method dumpHeaderJavascript [line 1506]
string dumpHeaderJavascript(
[boolean
$return_contents = false])
|
|
This method is used internally by the Page component to dump all javascript must be located at the header.
This method iterates through all components to dump all children javascript inside the header section of the document.
It also dumps common javascript stored in js/common.js and if ajax is enabled for the page with the UseAjax property, it also includes the xajax library.
Parameters:
method dumpJsEvents [line 1295]
method dumpUsingTemplate [line 1384]
void dumpUsingTemplate(
)
|
|
Dump the page using a template, it doesn't generate an HTML page.
It uses the template and tries to insert components inside it. To make it work you need to assign TemplateEngine and TemplateFilename properties with the right values, check here to know more:
Tags:
method getAction [line 1128]
This property allows you to override the action parameter for the form that is generated by the Page component.
Usually, the action for the form is the script that generates the page i.e. "unit1.php", but if you need to override this behaviour, you can use this property for that.
This property is useful to create forms that post information to another script for further processing.
method getAlignment [line 1067]
method getBackground [line 1093]
Specifies the background to be used when generating the HTML document.
The background should be an image file, and will be used to fill the page background with it. For example: images/mybackground.gif
method getBorderWidth [line 1008]
integer getBorderWidth(
)
|
|
The BorderWidth property sets the width of all four borders of the page.
You can set this property to a value which will be used as width for the border of the page.
method getBottomMargin [line 1872]
integer getBottomMargin(
)
|
|
Sets or retrieves the height of the bottom margin of the object.
Use this property to specify the margin at the bottom of the page.
Tags:
method getCache [line 1256]
method getCaption [line 1079]
method getColor [line 1070]
method getDirectionality [line 1559]
enum(ddLeftToRight,ddRightToLeft) getDirectionality(
)
|
|
Set the text directionality of the page
Use this property to set the directionality of the text inside the page.
method getDocType [line 1044]
Specifies the doctype to include on the generation of the page.
DocType specifies the type of document you want to generate, components are responsible to adapt to this property and generate valid code, the Page simply sets the doctype for the HTML document and expects components use it to determine the kind of valid HTML must generate
Tags:
method getEncoding [line 1026]
Specifies the encoding to use for the page.
Use this property to specify the encoding to use when generating this page, this encoding is set on the charset of the generated HTML and it's different from the Charset you setup PHP to work on.
Tags:
method getFont [line 1082]
method getFrameBorder [line 996]
Specifies the frameborder when the page generates Frames, this value is used only when Frames or Framesets are placed inside the Page
fbDefault - Inset border is drawn
fbNo - No border is drawn
fbYes - Inset border is drawn
Tags:
method getFrameSpacing [line 978]
integer getFrameSpacing(
)
|
|
Sets or retrieves the amount of additional space between the frames, this value is used only when Frames or Framesets are placed inside the Page.
When this happens, the Page control, instead generate an HTML document generates a Frameset and renders all the Frames and Framesets inside depending on the align property.
Tags:
method getIcon [line 961]
Specifies the icon to be used on the address bar when loading this page and for bookmarks.
method getIsForm [line 1917]
If false, the form doesn't generate any <form> tag, but events won't be processed
To allow VCL for PHP process events, there must be a form on the html document that allows the document to be posted to the server, but, for example, if you want to include your page into another page, you should set this property to false to prevent generate nested <form> tags, as that is not allowed by HTML
Tags:
method getIsMaster [line 1932]
If true, this page doesn't render itself, but it's meant to be used as base for another forms
This property is useful to create Master pages, when set to true, the page won't be shown and you can create a new page and inherit from it.
You can get more details here:
Tags:
method getjsOnLoad [line 932]
The javascript OnLoad event is called after all nested framesets and frames are finished with loading their content.
method getjsOnReset [line 1283]
Fired when the page is going to be reset using a reset input button
method getjsOnSubmit [line 1274]
Fired when the page is going to be submitted to the form, return false
to prevent the form from being posted
method getjsOnUnload [line 941]
The javascript OnUnload event is called after all nested framesets and frames are finished with unloading their content.
method getLanguage [line 1210]
Specifies the language to be used when rendering this page.
By setting it to a different value than (default), the Page will look for a file named [language].xml.php to be loaded. That file must contain the properties need to be changed to localize the interface to that specific language
Check here to know more:
Tags:
method getLayout [line 946]
method getLeftMargin [line 1860]
Sets or retrieves the width of the left margin of the object.
Use this property to specify the margin at the left of the page.
Tags:
method getOnAfterAjaxProcess [line 1446]
mixed getOnAfterAjaxProcess(
)
|
|
Fired just after the routine specified in ajaxcall is about to be called
Use this event to perform any operation just after the routine specified in ajaxcall is going to be called.
Tags:
method getOnAfterShowFooter [line 1965]
void getOnAfterShowFooter(
)
|
|
Fired after show the footer, which should be the last oportunity for you to
add code to the html document
method getOnBeforeAjaxProcess [line 1430]
mixed getOnBeforeAjaxProcess(
)
|
|
Fired just before the routine specified in ajaxcall is about to be called
Use this event to perform any operation just before the routine specified in ajaxcall is going to be called.
Tags:
method getOnBeforeShowHeader [line 1957]
void getOnBeforeShowHeader(
)
|
|
Fired before the page is going to render the header, this is useful to add
contents on that document location
method getOnCreate [line 1991]
Fired when the page is created and all components have been loaded, this is
the right event to perform initialization stuff, the other event for this is OnBeforeShow
method getOnShowHeader [line 1974]
Fired when showing the header, this event is the right place if you want to
add CSS styles or Javascript scripts to your HTML using code, as the code you dump in this event, will be placed inside the HTML header
method getOnStartBody [line 1982]
Fired just right after dump the <body> tag, so you can add anything you may need
there
method getOnTemplate [line 1414]
Fired when the template is about to be rendered.
This event is only fired if TemplateEngine and TemplateFilename are correctly set and it provides you with an opportunity to access to the internal template object, check here:
Tags:
method getRightMargin [line 1884]
integer getRightMargin(
)
|
|
Sets or retrieves the width of the right margin of the object.
Use this property to specify the margin at the right of the page.
Tags:
method getShowFooter [line 1949]
If false, the form doesn't dump any footer code.
This property is useful, for example if you want to include your form inside another form, so it doesn't generate a full HTML document.
When the Page generates the HTML document, it starts from top to bottom, first dumps the header, after that, the body and at the end, the footer. By setting this property to false, you tell the Page to don't generate the footer and also, events for the footer won't be generated.
Tags:
method getShowHeader [line 1902]
If false, the form doesn't dump any header code.
This property is useful, for example if you want to include your form inside another form, so it doesn't generate a full HTML document.
When the Page generates the HTML document, it starts from top to bottom, first dumps the header, after that, the body and at the end, the footer. By setting this property to false, you tell the Page to don't generate the footer and also, events for the footer won't be generated.
Tags:
method getShowHint [line 1073]
method getTarget [line 1289]
method getTemplateEngine [line 1111]
string getTemplateEngine(
)
|
|
Specifies the engine to be used to render this page using templates.
Valid values for this property are registered Template Plugins, at this time, only Smarty is included, checkout here to know more:
Tags:
method getTemplateFilename [line 1148]
string getTemplateFilename(
)
|
|
Specifies the name of the template file to be used to render this page.
Usually is an HTML file with some placeholders to allow insert information inside. To insert components inside templates, you must add a placeholder with the name of the component you want to insert, i.e. {$Button1}
Tags:
method getTopMargin [line 1848]
Sets or retrieves the height of the top margin of the object.
Use this property to specify the margin at the top of the page.
Tags:
method getUseAjax [line 1166]
This property allows the Page, if set, to process and handle Ajax requests performed using Component::ajaxCall.
If you want to use Ajax with the built-in engine, you need to use ajaxCall and set this property to true, to inform the page that must process any ajax requests. If set to false, ajax calls won't be processed.
Tags:
method getUseAjaxDebug [line 1181]
boolean getUseAjaxDebug(
)
|
|
This property enables a debug window, to show ajax calls information
When set to true, ajax calls will make a popup window to be shown with information about all ajax requests. UseAjax must also be set to true.
Tags:
method getUseAjaxUri [line 1187]
method getVisible [line 1076]
method loaded [line 1261]
method processAjax [line 1462]
This method is called to setup the Ajax functionality when dumping Page code
When generating the page code, if ajax support is enabled, this method dumps the right code to create the xajax object, setup xajax debug support if required and to register the processing function for ajax requests as ajaxProcess(), and finally, processes all the incomming ajax requests
Tags:
method readEndForm [line 1366]
Returns the ending form tag
This property, depending on the settings of IsForm and ShowFooter will dump the ending form tag.
Tags:
method readFormEncoding [line 1061]
Specifies the encoding to use the form generated by the Page.
Every Page component generates a Form (unless IsForm is false) to allow process events, you can modify this property to set the encoding to a different value.
This is useful, for example, to allow you upload data to the server
method readStartForm [line 1319]
Dumps the opening form tag
This property, depending on the settings of IsForm and ShowHeader properties returns the opening form tag, it also checks for Action property to know if it must point the action for the form to the script itself or to another place.
It also dumps code to process page events like OnSubmit and OnReset and sets the form enconding according to the FormEncoding property.-
Tags:
method setAction [line 1129]
method setAlignment [line 1068]
void setAlignment(
$value)
|
|
Parameters:
method setBackground [line 1094]
void setBackground(
$value)
|
|
Parameters:
method setBorderWidth [line 1009]
void setBorderWidth(
$value)
|
|
Parameters:
method setBottomMargin [line 1873]
void setBottomMargin(
$value)
|
|
Parameters:
method setCache [line 1257]
method setCaption [line 1080]
method setColor [line 1071]
method setDirectionality [line 1560]
void setDirectionality(
$value)
|
|
Parameters:
method setDocType [line 1045]
method setEncoding [line 1027]
void setEncoding(
$value)
|
|
Parameters:
method setFont [line 1083]
method setFrameBorder [line 997]
void setFrameBorder(
$value)
|
|
Parameters:
method setFrameSpacing [line 979]
void setFrameSpacing(
$value)
|
|
Parameters:
method setIcon [line 962]
method setIsForm [line 1918]
method setIsMaster [line 1933]
void setIsMaster(
$value)
|
|
Parameters:
method setjsOnLoad [line 933]
void setjsOnLoad(
$value)
|
|
Parameters:
method setjsOnReset [line 1284]
void setjsOnReset(
$value)
|
|
Parameters:
method setjsOnSubmit [line 1275]
void setjsOnSubmit(
$value)
|
|
Parameters:
method setjsOnUnload [line 942]
void setjsOnUnload(
$value)
|
|
Parameters:
method setLanguage [line 1211]
void setLanguage(
$value)
|
|
Parameters:
method setLayout [line 947]
method setLeftMargin [line 1861]
void setLeftMargin(
$value)
|
|
Parameters:
method setOnAfterAjaxProcess [line 1447]
void setOnAfterAjaxProcess(
$value)
|
|
Parameters:
method setOnAfterShowFooter [line 1966]
void setOnAfterShowFooter(
$value)
|
|
Parameters:
method setOnBeforeAjaxProcess [line 1431]
void setOnBeforeAjaxProcess(
$value)
|
|
Parameters:
method setOnBeforeShowHeader [line 1958]
void setOnBeforeShowHeader(
$value)
|
|
Parameters:
method setOnCreate [line 1992]
void setOnCreate(
$value)
|
|
Parameters:
method setOnShowHeader [line 1975]
void setOnShowHeader(
$value)
|
|
Parameters:
method setOnStartBody [line 1983]
void setOnStartBody(
$value)
|
|
Parameters:
method setOnTemplate [line 1415]
void setOnTemplate(
$value)
|
|
Parameters:
method setRightMargin [line 1885]
void setRightMargin(
$value)
|
|
Parameters:
method setShowFooter [line 1950]
void setShowFooter(
$value)
|
|
Parameters:
method setShowHeader [line 1903]
void setShowHeader(
$value)
|
|
Parameters:
method setShowHint [line 1074]
void setShowHint(
$value)
|
|
Parameters:
method setTarget [line 1290]
method setTemplateEngine [line 1112]
void setTemplateEngine(
$value)
|
|
Parameters:
method setTemplateFilename [line 1149]
void setTemplateFilename(
$value)
|
|
Parameters:
method setTopMargin [line 1849]
void setTopMargin(
$value)
|
|
Parameters:
method setUseAjax [line 1167]
method setUseAjaxDebug [line 1182]
void setUseAjaxDebug(
$value)
|
|
Parameters:
method setUseAjaxUri [line 1188]
void setUseAjaxUri(
$value)
|
|
Parameters:
method setVisible [line 1077]
method writeFormEncoding [line 1062]
void writeFormEncoding(
$value)
|
|
Parameters:
