Class: Page

Source Location: /forms.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --Control
            |
            --FocusControl
               |
               --ScrollingControl
                  |
                  --CustomPage
                     |
                     --Page

Page class

Class Details

[line 444]
Page class

A class to encapsulate a web page

[ Top ]

Properties Action [published] Alignment [published] Background [published] BorderWidth [published] BottomMargin [published] Caption [published] Color [published] DocType [published] Encoding [published] EndForm [public] Font [published] FormEncoding [public] FrameBorder [published] FrameSpacing [published] IsForm [published] IsMaster [published] Language [published] Layout [published] LeftMargin [published] RightMargin [published] ShowFooter [published] ShowHeader [published] ShowHint [published] StartForm [public] TemplateEngine [published] TemplateFilename [published] TopMargin [published] UseAjax [published] Visible [published]	Events OnAfterShowFooter [published] OnBeforeShowHeader [published] OnCreate [published] OnShowHeader [published] OnStartBody [published] OnTemplate [published]	JS Events OnLoad [published] OnReset [published] OnSubmit [published] OnUnload [published]
Methods __construct dumpChildren dumpContents dumpFrames dumpHeaderJavascript dumpJsEvents dumpUsingTemplate loaded	Constants [none]

Inherited Properties Class: FocusControl FocusControl::ControlCount Return the number of controls for which this control is the Parent FocusControl::Layout Specifies the Layout this control lives in @see ActiveLayout Class: Control Control::AdjustToLayout If true, the control should adjust to the selected layout Control::Align Specifies the Align for this control Control::Alignment Specifies the alignment to be used by the control Control::Caption Returns the caption property Control::Color Returns the color property Control::ControlStyle An array which holds the control style, with settings for the IDE Control::Cursor Cursor to show when the mouse is over the control Control::DesignColor Specifies a color can be used by the control in design time Control::DoParentReset Performs a parent reset if true Control::Enabled Determines if the controls is enabled or not Control::Font Determines the Font to be used when generating this control Control::Height Control::Hint Text to show in a tooltip when the mouse is over the control for some time Control::HintAttribute This function returns the attribute for the hint that can be included in any tag. The attribute's name is "title". Control::IsLayer Specifies if this control is a Layer instead be integrated into the document Control::JsEvents Return assigned javascript events as attributes for the tag Control::JSWrapperHiddenFieldName Get the name of the hidden field used to submit the value which event was fired. Control::Layer Determines the layer this control is going to be rendered Control::Left Left coordinate Control::Parent Determines the parent control which holds this control Control::ParentColor Determines where a control looks for its color information. Control::ParentFont Determines where a control looks for its font information. Control::ParentShowHint Determines where a control looks to find out if its Help Hint should be shown. Control::PopupMenu Specifies the PopupMenu component to show when right clicking the control Control::ShowHint Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control. Control::Style CSS style to be used when rendering the component Control::StyleClass Return the normalized CSS style Control::Top Top coordinate Control::Visible Determines if the controls is visible in run-time or not Control::Width Control width Class: Component Component::ComponentCount Indicates how many components this component is owner Component::Components Component list containing all the components owned by this component Component::ControlState A flag to know the state of the control, csLoading, csDesigning Component::DataFieldValue This function returns the value of the datafield, if any Component::Name Name for the component, to be used as an identifier, should be unique Component::NamePath The path to uniquely identify a component, qualified by the owner when required Component::Owner The owner of this component, usually the page component, but the owner of pages is the application object Component::Tag A versatily property of every Component that can be used in any way you want Class: Persistent Persistent::NamePath Used to serialize/unserialize Persistent::Owner Owner of the component, in Persistent always return null	Inherited Events Class: Control Control::OnAfterShow Event fired after show the control Control::OnBeforeShow Event fired before show the control Control::OnShow Event fired at the same moment the control is show, some controls can	Inherited JS Events Class: Control Control::OnActivate Fires when the object is set as the active element. Control::OnBeforeCopy Fires on the source object before the selection is copied to the system clipboard. Control::OnBeforeCut Fires on the source object before the selection is deleted from the document. Control::OnBeforeDeactivate Fires immediately before the activeElement is changed from the current object to another object in the parent document. Control::OnBeforeEditfocus Fires before an object contained in an editable element enters a UI-activated state or when an editable container object is control selected. Control::OnBeforePaste Fires on the target object before the selection is pasted from the system clipboard to the document. Control::OnBlur Fires when the object loses the input focus. Control::OnChange Fires when the contents of the object or selection have changed. Control::OnClick Fires when the user clicks the left mouse button on the object. Control::OnContextMenu Fires when the user clicks the right mouse button in the client area, opening the context menu. Control::OnControlSelect Fires when the user is about to make a control selection of the object. Control::OnCopy Fires on the source element when the user copies the object or selection, adding it to the system clipboard. Control::OnCut Fires on the source element when the object or selection is removed from the document and added to the system clipboard. Control::OnDblClick Fires when the user double-clicks the object. Control::OnDeactivate Fires when the activeElement is changed from the current object to another object in the parent document. Control::OnDrag Fires on the source object continuously during a drag operation. Control::OnDragEnter Fires on the target element when the user drags the object to a valid drop target. Control::OnDragLeave Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. Control::OnDragOver Fires on the target element continuously while the user drags the object over a valid drop target. Control::OnDragStart Fires on the source object when the user starts to drag a text selection or selected object. Control::OnDrop Fires on the target object when the mouse button is released during a drag-and-drop operation. Control::OnFilterChange Fires when a visual filter changes state or completes a transition. Control::OnFocus Fires when the object receives focus Control::OnHelp Fires when the user presses the F1 key while the browser is the active window. Control::OnKeyDown Fires when the user presses a key. Control::OnKeyPress Fires when the user presses an alphanumeric key. Control::OnKeyUp Fires when the user releases a key. Control::OnLoseCapture Fires when the object loses the mouse capture. Control::OnMouseDown Fires when the user clicks the object with either mouse button. Control::OnMouseEnter Fires when the user moves the mouse pointer into the object. Control::OnMouseLeave Fires when the user moves the mouse pointer outside the boundaries of the object. Control::OnMouseMove Fires when the user moves the mouse over the object. Control::OnMouseOut Fires when the user moves the mouse pointer outside the boundaries of the object. Control::OnMouseOver Fires when the user moves the mouse pointer into the object. Control::OnMouseUp Fires when the user releases a mouse button while the mouse is over the object. Control::OnPaste Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document. Control::OnPropertyChange Fires when a property changes on the object. Control::OnReadyStateChange Fires when the state of the object has changed. Control::OnResize Fires when the size of the object is about to change. Control::OnResizeEnd Fires when the user finishes changing the dimensions of the object in a control selection. Control::OnResizeStart Fires when the user begins to change the dimensions of the object in a control selection Control::OnSelectStart Fires when the object is being selected
Inherited Methods Class: CustomPage CustomPage::__construct Class: FocusControl FocusControl::__construct FocusControl::dumpChildren Dump all children FocusControl::updateChildrenColors Update the colors for all the children if parentcolor is set FocusControl::updateChildrenFonts If this control has any children that have ParentFont==true then this function will assign the Font property to all children Font properties. FocusControl::updateChildrenParentProperties If this control has any children that use a property's value from the parent then this function will update all necessary properties. FocusControl::updateChildrenShowHints Update the ShowHints properties for all children controlss Class: Control Control::__construct Constructor for the class Control::addJSWrapperToEvents Add or replace the JS event attribute with the wrapper. Control::canShow Determines whether a control can be shown or not Control::dumpChildren Dump all children components Control::dumpContents Dump the control contents, inherit and fill this method with the code Control::dumpHeaderCode Control::dumpJavascript Dump Javascript code required for this component to work Control::dumpJSEvent Dumps a javascript named $event Control::dumpJsEvents Dump Javascript events Control::getJSWrapperFunction JS wrapper function that forwards a JS event to the PHP script by submitting the HTML form. Control::getJSWrapperFunctionName Get the function name of a JS event wrapper. Control::getJSWrapperSubmitEventValue Value set to the hidden field when the specific JS event was fired and the wrapper function was called. Control::loaded Control::show Show control contents Control::updateParentColor If ParentColor == true the parent's color is assigned to this control. Control::updateParentFont If ParentFont == true the parent's font is assigned to this control. Control::updateParentProperties Updates all properties that use the parent property as source. Control::updateParentShowHint If ParentShowHint == true the parent's showhint is assigned to this control. Class: Component Component::__construct Constructor Component::ajaxCall Returns the js event attribute to call the server using ajax Component::callEvent Calls a server event Component::dumpChildrenHeaderCode Dump the header code for all the children Component::dumpChildrenJavascript Dump the javascript code for all the children Component::dumpHeaderCode To dump header code required Component::dumpHiddenKeyFields This function dumps out the key fields for the current row, useful to Component::dumpJavascript To dump the javascript code needed by this component Component::fixupProperty This method returns the right object (or the input string if object not found) for an object name Should be used on the loaded method for object properties to find the right reference Component::generateAjaxEvent Returns the js event attribute to call the server using Ajax we use xajax to handle all the ajax stuff. Component::hasValidDataField This function returns true if the datafield is valid Component::init To initialize a component, the right place to process events Component::insertComponent Insert a component into the components collection Component::loaded A virtual method to get notified when the object has been fully loaded from a stream Component::loadedChildren Calls childrens loaded recursively Component::loadResource Load this component from a string Component::preinit To initialize a component, called before init() Component::readAccessibility Overwrite this method to provide accessibility info for the RPC engine Component::readFromResource Read a component from a resource file Component::removeComponent Remove a component from the components collection Component::serializeChildren Serialize all children Component::unserializeChildren Unserialize all children Component::updateDataField Checks if there is any datafield attached to the component Class: Persistent Persistent::assign Assing the source properties to this object Persistent::assignError Raises an assignation error Persistent::assignTo Assign this object to another object Persistent::serialize Stores this object into the session, it uses PHP reflection system to get published properties, the ones that will be stored. Persistent::unserialize Read this object properties from the session, only published properties will be recovered, components need an owner to be unserialized. Class: Object Object::__construct Constructor Object::className Returns the name of the object class Object::classNameIs Check if the object is from a specific class Object::classParent Returns the parent class of the object Object::inheritsFrom Check if the object inherits from a specific class Object::methodExists Check if a method exists Object::readProperty Reads a property from the streams Object::__get To virtualize properties Object::__set To virtualize properties

Properties

property Action [line 609]

[ Top ]

property Alignment [line 575]

Specifies the alignment to be used by the control

Defined in Control::Alignment

[ Top ]

property Background : string [line 597]

Specifies the background for the form

[ Top ]

property BorderWidth : integer [line 536]

Sets or retrieves the width of the left, right, top, and bottom borders of the object.

[ Top ]

property BottomMargin : integer [line 1107]

Specifies the bottom margin spacing

[ Top ]

property Caption [line 587]

Returns the caption property

Defined in Control::Caption

[ Top ]

property Color [line 578]

Returns the color property

Defined in Control::Color

[ Top ]

property DocType : enum [line 558]

Specifies the doctype to generate, components are responsible to adapt to this property

and generate valid code

[ Top ]

property Encoding : enum [line 547]

Specifies the encoding to use for the page

[ Top ]

property EndForm : string [line 748]

Dumps the ending form tag

[ Top ]

property Font [line 590]

Determines the Font to be used when generating this control

Defined in Control::Font

[ Top ]

property FormEncoding : enum [line 569]

Specifies the encoding to use for forms

[ Top ]

property FrameBorder : enum [line 528]

String that specifies or receives one of the following values.

fbDefault Inset border is drawn. fbNo No border is drawn. fbYes Inset border is drawn.

[ Top ]

property FrameSpacing : integer [line 517]

Sets or retrieves the amount of additional space between the frames.

[ Top ]

property IsForm : boolean [line 1131]

If false, the form doesn't generate any <form> tag, but events won't be processed

[ Top ]

property IsMaster : boolean [line 1139]

If true, this page doesn't render itself, but it's meant to be used as base for another forms

[ Top ]

property Language : string [line 633]

Specifies the language to be used when rendering this page

[ Top ]

property Layout [line 505]

Specifies the Layout this control lives in @see ActiveLayout

Defined in FocusControl::Layout

[ Top ]

property LeftMargin : integer [line 1099]

Specifies the left margin spacing

[ Top ]

property RightMargin : integer [line 1115]

Specifies the right margin spacing

[ Top ]

property ShowFooter : boolean [line 1146]

If false, the form doesn't dump any footer code

[ Top ]

property ShowHeader : boolean [line 1123]

If false, the form doesn't dump any header code

[ Top ]

property ShowHint [line 581]

Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.

Defined in Control::ShowHint

[ Top ]

property StartForm : string [line 711]

Dumps the opening form tag

[ Top ]

property TemplateEngine : string [line 604]

Specifies the engine to be used to render this page using templates

[ Top ]

property TemplateFilename : string [line 617]

Specifies the name of the template to be used to render this page

[ Top ]

property TopMargin : integer [line 1091]

Specifies the top margin spacing

[ Top ]

property UseAjax : boolean [line 625]

If true, ajax requests will be processed and handled

[ Top ]

property Visible [line 584]

Determines if the controls is visible in run-time or not

Defined in Control::Visible

[ Top ]

Events

property OnAfterShowFooter [line 1160]

Fired after show the footer

[ Top ]

property OnBeforeShowHeader [line 1153]

Fired before show the header

[ Top ]

property OnCreate [line 1181]

Fired when the page is created and all components have been loaded

[ Top ]

property OnShowHeader [line 1167]

Fired when showing the header

[ Top ]

property OnStartBody [line 1174]

Fired when showing the body

[ Top ]

property OnTemplate [line 779]

Fired when the template is about to be rendered

[ Top ]

Javascript Events

property OnLoad [line 481]

The javascript OnLoad event is called after all nested framesets and frames are finished with loading their content.

[ Top ]

property OnReset [line 693]

Fired when the page is going to be reset

[ Top ]

property OnSubmit [line 684]

Fired when the page is going to be submitted to the form

[ Top ]

property OnUnload [line 495]

The javascript OnUnload event is called after all nested framesets and frames are finished with unloading their content.

[ Top ]

Methods

constructor __construct [line 666]

Page __construct(
[
$aowner = null])

Overrides CustomPage::__construct (parent method not documented)

Parameters:

$aowner

[ Top ]

void dumpChildren [line 1010]

void dumpChildren(
)

Dump al children controls

Overrides FocusControl::dumpChildren (Dump all children)

[ Top ]

void dumpContents [line 815]

void dumpContents(
)

Overrides Control::dumpContents (Dump the control contents, inherit and fill this method with the code)

[ Top ]

void dumpFrames [line 1076]

void dumpFrames(
)

Dump the page using frames

[ Top ]

void dumpHeaderJavascript [line 787]

void dumpHeaderJavascript(
[
$return_contents = false])

Parameters:

$return_contents

[ Top ]

void dumpJsEvents [line 697]

void dumpJsEvents(
)

Overrides Control::dumpJsEvents (Dump Javascript events)

[ Top ]

void dumpUsingTemplate [line 758]

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

[ Top ]

void loaded [line 673]

void loaded(
)

Overrides Control::loaded (parent method not documented)

[ Top ]

Documentation generated on Tue, 27 Mar 2007 13:34:59 +0200 by phpDocumentor 1.3.1

Class: Page

Class Overview

Class Details

Properties

Events

JS Events

Methods

Constants

Inherited Properties

Class: FocusControl

Class: Control

Class: Component

Class: Persistent

Inherited Events

Class: Control

Inherited JS Events

Class: Control

Inherited Methods

Class: CustomPage

Class: FocusControl

Class: Control

Class: Component

Class: Persistent

Class: Object

Properties

property Action [line 609]

property Alignment [line 575]

property Background : string [line 597]

property BorderWidth : integer [line 536]

property BottomMargin : integer [line 1107]

property Caption [line 587]

property Color [line 578]

property DocType : enum [line 558]

property Encoding : enum [line 547]

property EndForm : string [line 748]

property Font [line 590]

property FormEncoding : enum [line 569]

property FrameBorder : enum [line 528]

property FrameSpacing : integer [line 517]

property IsForm : boolean [line 1131]

property IsMaster : boolean [line 1139]

property Language : string [line 633]

property Layout [line 505]

property LeftMargin : integer [line 1099]

property RightMargin : integer [line 1115]

property ShowFooter : boolean [line 1146]

property ShowHeader : boolean [line 1123]

property ShowHint [line 581]

property StartForm : string [line 711]

property TemplateEngine : string [line 604]

property TemplateFilename : string [line 617]

property TopMargin : integer [line 1091]

property UseAjax : boolean [line 625]

property Visible [line 584]

Events

property OnAfterShowFooter [line 1160]

property OnBeforeShowHeader [line 1153]

property OnCreate [line 1181]

property OnShowHeader [line 1167]

property OnStartBody [line 1174]

property OnTemplate [line 779]

Javascript Events

property OnLoad [line 481]

property OnReset [line 693]

property OnSubmit [line 684]

property OnUnload [line 495]

Methods

constructor __construct [line 666]

Parameters:

void dumpChildren [line 1010]

void dumpContents [line 815]

void dumpFrames [line 1076]

void dumpHeaderJavascript [line 787]

Parameters:

void dumpJsEvents [line 697]

void dumpUsingTemplate [line 758]

void loaded [line 673]