Class: Frame

Source Location: /forms.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --Control
            |
            --FocusControl
               |
               --ScrollingControl
                  |
                  --Frame

A frame represents a view of a document embedded into a parent document

Author(s):

Inherited Variables

Inherited Methods

Class: FocusControl

FocusControl::__construct()
FocusControl::dumpChildren(): Dumps all children iterating through the Controls property and calls the show method of each one.
FocusControl::readControlCount(): Returns the number of controls for which this control is the Parent.
FocusControl::readLayout(): Specifies the Layout this control uses to render its controls to the browser.
FocusControl::updateChildrenColors(): Updates 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 same Font property to all children Font properties.
FocusControl::updateChildrenParentProperties(): Updates all necessary properties for any children that use property values from their parent.
FocusControl::updateChildrenShowHints(): Updates the ShowHints properties for all children controls.
FocusControl::writeLayout()

Class: Control

Control::__construct(): Constructor for the class
Control::addJSWrapperToEvents(): Adds or replaces the JS event attribute with the wrapper.
Control::beginCache()
Control::canShow(): Determines whether a control can be shown or not.
Control::defaultAdjustToLayout()
Control::defaultAlign()
Control::defaultAlignment()
Control::defaultAttributes()
Control::defaultAutosize()
Control::defaultCached()
Control::defaultCaption()
Control::defaultColor()
Control::defaultCursor()
Control::defaultDesignColor()
Control::defaultDivWrap()
Control::defaultEnabled()
Control::defaultHeight()
Control::defaultHidden()
Control::defaultHint()
Control::defaultIsLayer()
Control::defaultjsOnActivate()
Control::defaultjsOnBeforeCopy()
Control::defaultjsOnBeforeCut()
Control::defaultjsOnBeforeDeactivate()
Control::defaultjsOnBeforeEditfocus()
Control::defaultjsOnBeforePaste()
Control::defaultjsOnBlur()
Control::defaultjsOnChange()
Control::defaultjsOnClick()
Control::defaultjsOnContextMenu()
Control::defaultjsOnControlSelect()
Control::defaultjsOnCopy()
Control::defaultjsOnCut()
Control::defaultjsOnDblClick()
Control::defaultjsOnDeActivate()
Control::defaultjsOnDrag()
Control::defaultjsOnDragEnter()
Control::defaultjsOnDragLeave()
Control::defaultjsOnDragOver()
Control::defaultjsOnDragStart()
Control::defaultjsOnDrop()
Control::defaultjsOnFilterChange()
Control::defaultjsOnFocus()
Control::defaultjsOnHelp()
Control::defaultjsOnKeyDown()
Control::defaultjsOnKeyPress()
Control::defaultjsOnKeyUp()
Control::defaultjsOnLoseCapture()
Control::defaultjsOnMouseDown()
Control::defaultjsOnMouseEnter()
Control::defaultjsOnMouseLeave()
Control::defaultjsOnMouseMove()
Control::defaultjsOnMouseOut()
Control::defaultjsOnMouseOver()
Control::defaultjsOnMouseUp()
Control::defaultjsOnPaste()
Control::defaultjsOnPropertyChange()
Control::defaultjsOnReadyStateChange()
Control::defaultjsOnResize()
Control::defaultjsOnResizeEnd()
Control::defaultjsOnResizeStart()
Control::defaultjsOnSelectStart()
Control::defaultLayer()
Control::defaultLeft()
Control::defaultOnAfterShow()
Control::defaultOnBeforeShow()
Control::defaultOnShow()
Control::defaultParentColor()
Control::defaultParentFont()
Control::defaultParentShowHint()
Control::defaultPopupmenu()
Control::defaultShowHint()
Control::defaultStyle()
Control::defaultTop()
Control::defaultVisible()
Control::defaultWidth()
Control::dumpChildren(): Dumps all children components.
Control::dumpContents(): Dumps the control contents.
Control::dumpHeaderCode(): Dumps the component header code.
Control::dumpJavascript(): Dumps all required javascript code for the component.
Control::dumpJsEvents(): Dumps all assigned javascript events code.
Control::endCache()
Control::getCached()
Control::getCursor(): Change the value of Cursor to provide feedback to the user when the mouse pointer enters the control.
Control::getHeight(): Specifies the vertical size of the control or form in pixels.
Control::getHint(): Specifies the text to show in a tooltip when the mouse is over the control for some time.
Control::getHintAttribute(): If control has any Hint, then returns the hint in attribute format for the tag.
Control::getJSWrapperFunction(): JS wrapper function that forwards a JS event to the PHP script by submitting the HTML form.
Control::getJSWrapperFunctionName(): Gets the function name of a JS event wrapper.
Control::getLayer(): Determines the layer in which this control is going to be rendered.
Control::getLeft(): Uses the Left property to determine where the left side of the control begins, or to reposition the left side of the control.
Control::getOnAfterShow(): Fires the Event after showing the control.
Control::getOnBeforeShow(): Fires the Event before showing the control.
Control::getOnShow(): Fires the Event at the same moment the control is shown. Some controls can prevent the control from being shown when this event is attached.
Control::getTop(): Uses Top to locate the top of the control, or reposition the control to a different Y coordinate.
Control::getWidth(): Specifies the horizontal size of the control or form in pixels.
Control::init()
Control::loaded()
Control::readAdjustToLayout(): A helper property for Layouts to know if the component should adjust to the layout or not
Control::readAlign(): Determines how the control aligns within its container (parent control).
Control::readAlignment(): Specifies the alignment to be used by the control, it depends on the control on how to use this property to show information.
Control::readAttributes(): A property for tag based controls to allow component user to add attributes to the tag
Control::readAutosize(): Determines if the control is going to adjust itself to the parent size
Control::readCaption(): Specifies a text string that identifies the control to the user.
Control::readColor(): Specifies the main color of the control.
Control::readControlStyle(): An array which holds the control style, with settings for the IDE.
Control::readDesignColor(): Specifies a color to use by the control at design time.
Control::readDivWrap(): Specifies if the control must be wrapped by a div or not
Control::readDoParentReset(): Performs a parent reset if true.
Control::readEnabled(): Controls whether the control responds to mouse, keyboard, and timer events.
Control::readFont(): Determines the Font to be used when generating this control.
Control::readHidden(): This property, when true, allows controls to generate all code, but don't show the control on the browser.
Control::readIsLayer(): Specifies if this control is a Layer instead of being integrated into the document.
Control::readJsEvents(): Returns a string with all assigned javascript events, ready to be added to a control tag.
Control::readjsOnActivate(): Fires when the object is set as the active element.
Control::readjsOnBeforeCopy(): Fires on the source object before the selection is copied to the system clipboard.
Control::readjsOnBeforeCut(): Fires on the source object before the selection is deleted from the document.
Control::readjsOnBeforeDeactivate(): Fires immediately before the activeElement is changed from the current object to another object in the parent document.
Control::readjsOnBeforeEditfocus(): Fires before an object contained in an editable element enters a UI-activated state or when an editable container object is control selected.
Control::readjsOnBeforePaste(): Fires on the target object before the selection is pasted from the system clipboard to the document.
Control::readjsOnBlur(): Fires when the object loses the input focus.
Control::readjsOnChange(): Fires when the contents of the object or selection have changed.
Control::readjsOnClick(): Fires when the user clicks the left mouse button on the object.
Control::readjsOnContextMenu(): Fires when the user clicks the right mouse button in the client area, opening the context menu.
Control::readjsOnControlSelect(): Fires when the user is about to make a control selection of the object.
Control::readjsOnCopy(): Fires on the source element when the user copies the object or selection, adding it to the system clipboard.
Control::readjsOnCut(): Fires on the source element when the object or selection is removed from the document and added to the system clipboard.
Control::readjsOnDblClick(): Fires when the user double-clicks the object.
Control::readjsOnDeActivate(): Fires when the activeElement is changed from the current object to another object in the parent document.
Control::readjsOnDrag(): Fires on the source object continuously during a drag operation.
Control::readjsOnDragEnter(): Fires on the target element when the user drags the object to a valid drop target.
Control::readjsOnDragLeave(): Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
Control::readjsOnDragOver(): Fires on the target element continuously while the user drags the object over a valid drop target.
Control::readjsOnDragStart(): Fires on the source object when the user starts to drag a text selection or selected object.
Control::readjsOnDrop(): Fires on the target object when the mouse button is released during a drag-and-drop operation.
Control::readjsOnFilterChange(): Fires when a visual filter changes state or completes a transition.
Control::readjsOnFocus(): Fires when the object receives focus.
Control::readjsOnHelp(): Fires when the user presses the F1 key while the browser is the active window.
Control::readjsOnKeyDown(): Fires when the user presses a key.
Control::readjsOnKeyPress(): Fires when the user presses an alphanumeric key.
Control::readjsOnKeyUp(): Fires when the user releases a key.
Control::readjsOnLoseCapture(): Fires when the object loses the mouse capture.
Control::readjsOnMouseDown(): Fires when the user clicks the object with either mouse button.
Control::readjsOnMouseEnter(): Fires when the user moves the mouse pointer into the object.
Control::readjsOnMouseLeave(): Fires when the user moves the mouse pointer outside the boundaries of the object.
Control::readjsOnMouseMove(): Fires when the user moves the mouse over the object.
Control::readjsOnMouseOut(): Fires when the user moves the mouse pointer outside the boundaries of the object.
Control::readjsOnMouseOver(): Fires when the user moves the mouse pointer into the object.
Control::readjsOnMouseUp(): Fires when the user releases a mouse button while the mouse is over the object.
Control::readjsOnPaste(): Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document.
Control::readjsOnPropertyChange(): Fires when a property changes on the object.
Control::readjsOnReadyStateChange(): Fires when the state of the object has changed.
Control::readjsOnResize(): Fires when the size of the object is about to change.
Control::readjsOnResizeEnd(): Fires when the user finishes changing the dimensions of the object in a control selection.
Control::readjsOnResizeStart(): Fires when the user begins to change the dimensions of the object in a control selection
Control::readjsOnSelectStart(): Fires when the object is being selected
Control::readJSWrapperHiddenFieldName(): Gets the name of the hidden field used to submit the value for the event that was fired.
Control::readJSWrapperSubmitEventValue(): Sets the value to the hidden field when the specific JS event was fired and the wrapper function was called.
Control::readParent(): Indicates the parent of the control.
Control::readParentColor(): Determines where a control looks for its color information.
Control::readParentFont(): Determines where a control looks for its font information.
Control::readParentShowHint(): Determines where a control looks to find out if its Help Hint should be shown.
Control::readPopupMenu(): Identifies the pop-up menu associated with the control.
Control::readShowHint(): Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.
Control::readStyle(): Use this property to attach a css style to the control.
Control::readStyleClass(): Normalizes the css style class name
Control::readVisible(): Determines whether the component appears on the browser.
Control::setCached()
Control::setCursor()
Control::setHeight()
Control::setHint()
Control::setLayer()
Control::setLeft()
Control::setOnAfterShow()
Control::setOnBeforeShow()
Control::setOnShow()
Control::setTop()
Control::setWidth()
Control::show(): Dumps the code for the control to the output.
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.
Control::writeAdjustToLayout()
Control::writeAlign()
Control::writeAlignment()
Control::writeAttributes()
Control::writeAutosize()
Control::writeCaption()
Control::writeColor()
Control::writeControlStyle()
Control::writeDesignColor()
Control::writeDivWrap()
Control::writeEnabled()
Control::writeFont()
Control::writeHidden()
Control::writeIsLayer()
Control::writejsOnActivate()
Control::writejsOnBeforeCopy()
Control::writejsOnBeforeCut()
Control::writejsOnBeforeDeactivate()
Control::writejsOnBeforeEditfocus()
Control::writejsOnBeforePaste()
Control::writejsOnBlur()
Control::writejsOnChange()
Control::writejsOnClick()
Control::writejsOnContextMenu()
Control::writejsOnControlSelect()
Control::writejsOnCopy()
Control::writejsOnCut()
Control::writejsOnDblClick()
Control::writejsOnDeActivate()
Control::writejsOnDrag()
Control::writejsOnDragEnter()
Control::writejsOnDragLeave()
Control::writejsOnDragOver()
Control::writejsOnDragStart()
Control::writejsOnDrop()
Control::writejsOnFilterChange()
Control::writejsOnFocus()
Control::writejsOnHelp()
Control::writejsOnKeyDown()
Control::writejsOnKeyPress()
Control::writejsOnKeyUp()
Control::writejsOnLoseCapture()
Control::writejsOnMouseDown()
Control::writejsOnMouseEnter()
Control::writejsOnMouseLeave()
Control::writejsOnMouseMove()
Control::writejsOnMouseOut()
Control::writejsOnMouseOver()
Control::writejsOnMouseUp()
Control::writejsOnPaste()
Control::writejsOnPropertyChange()
Control::writejsOnReadyStateChange()
Control::writejsOnResize()
Control::writejsOnResizeEnd()
Control::writejsOnResizeStart()
Control::writejsOnSelectStart()
Control::writeParent()
Control::writeParentColor()
Control::writeParentFont()
Control::writeParentShowHint()
Control::writePopupMenu()
Control::writeShowHint()
Control::writeStyle()
Control::writeVisible()

Class: Component

Component::__construct(): Component constructor
Component::ajaxCall(): Dumps the javascript code to make an ajax call to the server.
Component::callEvent(): Calls a server event.
Component::defaultName()
Component::defaultTag()
Component::dumpChildrenFormItems(): This method is called by the page just after dumping the starting form tag.
Component::dumpChildrenHeaderCode(): Dumps the header code for all the children
Component::dumpChildrenJavascript(): Dumps the javascript code for all the children
Component::dumpFormItems(): Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
Component::dumpHeaderCode(): Dumps header code required
Component::dumpHiddenKeyFields(): Dumps hidden field values for the key record
Component::dumpJavascript(): Dumps the javascript code needed by this component
Component::dumpJSEvent(): Dumps javascript code for an event
Component::fixupProperty(): Resolves the right reference to an object property
Component::generateAjaxEvent(): Returns the javascript code to generate an ajax call.
Component::getName(): Specifies the name for the component. The name is used as an identifier and should be unique.
Component::getTag(): A versatile property of every Component that can be used in any way you want
Component::hasValidDataField(): Returns true if a valid data field is attached to the component
Component::init(): Initializes a component
Component::insertComponent(): Inserts a component into the component's collection
Component::loaded(): Initializes the component after the form file has been read into memory.
Component::loadedChildren(): Calls childrens loaded
Component::loadResource(): Loads this component from a string
Component::preinit(): Method called before init()
Component::readAccessibility(): Provides accessibility info to the embedded RPC engine.
Component::readComponentCount(): Indicates the number of components owned by the component.
Component::readComponents(): Lists all the components owned by this component.
Component::readControlState(): A flag to know the state of the control, csLoading, csDesigning
Component::readDataFieldValue(): This property returns the value of the datafield if any.
Component::readFromResource(): Reads a component from a resource file
Component::readNamePath(): Specifies the path to uniquely identify a component, qualified by the owner when required.
Component::readOwner(): Indicates the component that is responsible for streaming and freeing this component.
Component::removeComponent(): Removes a component from the component's collection
Component::serializeChildren(): Serializes all children
Component::setName()
Component::setTag()
Component::unserializeChildren(): Unserializes all children by calling unserialize for all the components
Component::updateDataField(): Updates the field on the dataset attached, if any
Component::writeControlState()

Class: Persistent

Persistent::allowserialize(): This method provides an opportunity for the component developer to prevent the serialization/unserialization of a property.
Persistent::assign(): Assigns the source properties to this object.
Persistent::assignError(): Raises an assignation error.
Persistent::assignTo(): Assigns this object to another object.
Persistent::inSession(): This method determines if this object exists in the current session.
Persistent::readNamePath(): Used to serialize/unserialize. It returns the full path to identify this component.
Persistent::readOwner(): Owner of the component.
Persistent::serialize(): Stores this object into the session.
Persistent::unserialize(): This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call.

Class: Object

Object::__construct(): Constructs an object and initializes its data before the object is first used.
Object::className(): Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs(): Determines whether an object is of a specific type.
Object::classParent(): Returns the type of the immediate ancestor of a class.
Object::inheritsFrom(): Determines the relationship of two object types.
Object::methodExists(): Check if a method exists declared on this object instance.
Object::readProperty(): Reads a property from the streams
Object::__get(): To virtualize properties
Object::__set(): To virtualize properties

Class Details

[line 2470]
A frame represents a view of a document embedded into a parent document

Frames allow developers to present documents in multiple views, which may be independent windows or subwindows. Multiple views offer designers a way to keep certain information visible, while other views are scrolled or replaced. For example, within the same window, one frame might display a static banner, a second a navigation menu, and a third the main document that can be scrolled through or replaced by navigating in the second frame. A frame is a sub-component of a Frameset. It should only be used within a Frameset control. For further information about HTML frames please visit following link:

Tags:

see:	Frameset
link:	http://www.w3.org/TR/html401/present/frames.html
example:	example not found
example:	example not found

[ Top ]

Class Variables

$_align = alLeft

[line 2520]

Tags:

access:

protected

Type:	mixed
Overrides:	Array

[ Top ]

Class Methods

constructor __construct [line 2472]

Frame __construct(
[
$aowner = null])

Overrides FocusControl::__construct() (parent method not documented)

Parameters:

$aowner

[ Top ]

method defaultAlign [line 2524]

void defaultAlign(
)

Overrides Control::defaultAlign() (parent method not documented)

[ Top ]

method defaultBorders [line 2518]

void defaultBorders(
)

[ Top ]

method defaultjsOnLoad [line 2618]

void defaultjsOnLoad(
)

[ Top ]

method defaultLongDesc [line 2668]

void defaultLongDesc(
)

[ Top ]

method defaultMarginHeight [line 2552]

void defaultMarginHeight(
)

[ Top ]

method defaultMarginWidth [line 2538]

void defaultMarginWidth(
)

[ Top ]

method defaultResizeable [line 2570]

void defaultResizeable(
)

[ Top ]

method defaultScrolling [line 2590]

void defaultScrolling(
)

[ Top ]

method defaultSource [line 2498]

void defaultSource(
)

[ Top ]

method defaultTitle [line 2684]

void defaultTitle(
)

[ Top ]

method dumpContents [line 2690]

void dumpContents(
)

Overrides Control::dumpContents() (Dumps the control contents.)

[ Top ]

method dumpJavascript [line 2639]

void dumpJavascript(
)

Overrides Control::dumpJavascript() (Dumps all required javascript code for the component.)

[ Top ]

method FrameJSEvents [line 2628]

string FrameJSEvents(
)

Returns the defined JS events for the frame. You don't need to call this

method directly, is called by the component when generating the header code to add all the required events to the document. Used in this case to generate the OnLoad javascript event and the rest of standard events defined in Control

Tags:

return:

If empty no JS events are set.

[ Top ]

method getAlign [line 2522]

void getAlign(
)

[ Top ]

method getBorders [line 2516]

integer getBorders(
)

Specifies whether or not to display a border around the frame

Possible values for this property are:

true - This value specifies to the browser to draw a separator between this frame and every adjoining frame. This is the default value

false - This value specifies to the browser not to draw a separator between this frame and every adjoining frame. Note that separators may be drawn next to this frame nonetheless if specified by other frames

[ Top ]

method getjsOnBlur [line 2647]

void getjsOnBlur(
)

[ Top ]

method getjsOnFocus [line 2650]

void getjsOnFocus(
)

[ Top ]

method getjsOnLoad [line 2616]

mixed getjsOnLoad(
)

The javascript OnLoad event is called after all nested framesets and frames are finished with loading their content. At this point, all of the objects in the document are in the DOM, and all the images and sub-frames have finished loading.

<?php
function Frame1JSLoad($sender, $params)
{
?>
//Add your javascript code here
alert("frame has been loaded");
<?php
}
?>

[ Top ]

method getjsOnResize [line 2653]

void getjsOnResize(
)

[ Top ]

method getLongDesc [line 2666]

string getLongDesc(
)

This property specifies a link to a long description of the frame.

This description should supplement the short description provided using the title attribute, and may be particularly useful for non-visual user agents.

[ Top ]

method getMarginHeight [line 2550]

integer getMarginHeight(
)

This property specifies the amount of space to be left between the frame's contents in its top and bottom margins.

The value must be greater than zero (pixels). The default value depends on the browser.

[ Top ]

method getMarginWidth [line 2536]

integer getMarginWidth(
)

This property specifies the amount of space to be left between the frame's contents in its left and right margins.

The value must be greater than zero (pixels). The default value depends on the browser.

[ Top ]

method getResizeable [line 2568]

bool getResizeable(
)

Specifies if the frame is able to be resized by the user or not.

When set to false the user cannot resize the frame, when true, the user has an option, by placing the mouse over the margin of the frame, to adjust the size of the control. You have to check also the Borders property of the Frameset that holds this frame, as must be set to true for borders to show.

Tags:

see:

Frameset::getBorders()

[ Top ]

method getScrolling [line 2588]

enum getScrolling(
)

Determines if the frame is going to have scrollbars to allow the user navigate through all the content.

fsAuto will show scrollbars when needed, that is, when the content is outside the viewport of the frame. fsYes will always show scrollbars and fsNo won't show any.

fsAuto - This value tells the browser to provide scrolling devices for the frame window when necessary. This is the default value. fsYes - This value tells the browser to always provide scrolling devices for the frame window. fsNo - This value tells the browser not to provide scrolling devices for the frame window.

Tags:

return:

(fsAuto, fsYes, fsNo)

[ Top ]

method getSource [line 2496]

string getSource(
)

Defines the URL of the file/document to show inside the frame.

The frame, when rendered, will load the contents specified by the URL set on this property, it can be an URL to internet, intranet, a file on your system, etc.

<?php
//This line sets the Frame::Source property to an external document
$this->Frame1->Source="http://vcl4php.sourceforge.net";
?>

[ Top ]

method getStyle [line 2687]

void getStyle(
)

[ Top ]

method getTitle [line 2682]

string getTitle(
)

This property offers advisory information about the frame component.

Values of this property may be rendered by browsers in a variety of ways. For instance, visual browsers frequently display the title as a "tool tip" (a short message that appears when the pointing device pauses over an object). Audio user agents may speak the title information in a similar context.

[ Top ]

method setAlign [line 2523]

void setAlign(

$value)

Parameters:

$value

[ Top ]

method setBorders [line 2517]

void setBorders(

$value)

Parameters:

$value

[ Top ]

method setjsOnBlur [line 2648]

void setjsOnBlur(

$value)

Parameters:

$value

[ Top ]

method setjsOnFocus [line 2651]

void setjsOnFocus(

$value)

Parameters:

$value

[ Top ]

method setjsOnLoad [line 2617]

void setjsOnLoad(

$value)

Parameters:

$value

[ Top ]

method setjsOnResize [line 2654]

void setjsOnResize(

$value)

Parameters:

$value

[ Top ]

method setLongDesc [line 2667]

void setLongDesc(

$value)

Parameters:

$value

[ Top ]

method setMarginHeight [line 2551]

void setMarginHeight(

$value)

Parameters:

$value

[ Top ]

method setMarginWidth [line 2537]

void setMarginWidth(

$value)

Parameters:

$value

[ Top ]

method setResizeable [line 2569]

void setResizeable(

$value)

Parameters:

$value

[ Top ]

method setScrolling [line 2589]

void setScrolling(

$value)

Parameters:

$value

[ Top ]

method setSource [line 2497]

void setSource(

$value)

Parameters:

$value

[ Top ]

method setStyle [line 2688]

void setStyle(

$value)

Parameters:

$value

[ Top ]

method setTitle [line 2683]

void setTitle(

$value)

Parameters:

$value

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:51:39 -0700 by phpDocumentor 1.4.1