Class ScrollingControl

(line 209)

Description

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

Located in File: /forms.inc.php

Base class for controls with scrolling area

It doesn't introduce any property/method/event and is reserved for future use.


Classes extended from ScrollingControl:
CustomPage
Base class for Page component
Frameset
A class to encapsulate a frame set and generate frames.
Frame
A frame represents a view of a document embedded into a parent document

Properties

Summary:

Defined in class FocusControl
ControlCount Returns the number of controls for which this control is the Parent.
Layout Specifies the Layout this control uses to render its controls to the browser.

Defined in class Control
Cached
Cursor Change the value of Cursor to provide feedback to the user when the mouse pointer enters the control.
Height Specifies the vertical size of the control or form in pixels.
Hint Specifies the text to show in a tooltip when the mouse is over the control for some time.
HintAttribute If control has any Hint, then returns the hint in attribute format for the tag.
Layer Determines the layer in which this control is going to be rendered.
Left Uses the Left property to determine where the left side of the control begins, or to reposition the left side of the control.
Top Uses Top to locate the top of the control, or reposition the control to a different Y coordinate.
Width Specifies the horizontal size of the control or form in pixels.
AdjustToLayout A helper property for Layouts to know if the component should adjust to the layout or not
Align Determines how the control aligns within its container (parent control).
Alignment Specifies the alignment to be used by the control, it depends on the control on how to use this property to show information.
Attributes A property for tag based controls to allow component user to add attributes to the tag
Autosize Determines if the control is going to adjust itself to the parent size
Caption Specifies a text string that identifies the control to the user.
Color Specifies the main color of the control.
ControlStyle An array which holds the control style, with settings for the IDE.
DesignColor Specifies a color to use by the control at design time.
DivWrap Specifies if the control must be wrapped by a div or not
DoParentReset Performs a parent reset if true.
Enabled Controls whether the control responds to mouse, keyboard, and timer events.
Font Determines the Font to be used when generating this control.
Hidden This property, when true, allows controls to generate all code, but don't show the control on the browser.
IsLayer Specifies if this control is a Layer instead of being integrated into the document.
JsEvents Returns a string with all assigned javascript events, ready to be added to a control tag.
JSWrapperHiddenFieldName Gets the name of the hidden field used to submit the value for the event that was fired.
Parent Indicates the parent of the control.
ParentColor Determines where a control looks for its color information.
ParentFont Determines where a control looks for its font information.
ParentShowHint Determines where a control looks to find out if its Help Hint should be shown.
PopupMenu Identifies the pop-up menu associated with the control.
ShowHint Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.
Style Use this property to attach a css style to the control.
StyleClass Normalizes the css style class name
Visible Determines whether the component appears on the browser.

Defined in class Component
Name Specifies the name for the component. The name is used as an identifier and should be unique.
Tag A versatile property of every Component that can be used in any way you want
ComponentCount Indicates the number of components owned by the component.
Components Lists all the components owned by this component.
ControlState A flag to know the state of the control, csLoading, csDesigning
DataFieldValue This property returns the value of the datafield if any.
NamePath Specifies the path to uniquely identify a component, qualified by the owner when required.
Owner Indicates the component that is responsible for streaming and freeing this component.

Defined in class Persistent
NamePath Used to serialize/unserialize. It returns the full path to identify this component.
Owner Owner of the component.

property ControlCount

Returns the number of controls for which this control is the Parent.
This property is implemented in FocusControl::ControlCount

property Layout

Specifies the Layout this control uses to render its controls to the browser.
This property is implemented in FocusControl::Layout

property Cached

This property is implemented in Control::Cached

property Cursor

Change the value of Cursor to provide feedback to the user when the mouse pointer enters the control.
This property is implemented in Control::Cursor

property Height

Specifies the vertical size of the control or form in pixels.
This property is implemented in Control::Height

property Hint

Specifies the text to show in a tooltip when the mouse is over the control for some time.
This property is implemented in Control::Hint

property HintAttribute

If control has any Hint, then returns the hint in attribute format for the tag.
This property is implemented in Control::HintAttribute

property Layer

Determines the layer in which this control is going to be rendered.
This property is implemented in Control::Layer

property Left

Uses the Left property to determine where the left side of the control begins, or to reposition the left side of the control.
This property is implemented in Control::Left

property Top

Uses Top to locate the top of the control, or reposition the control to a different Y coordinate.
This property is implemented in Control::Top

property Width

Specifies the horizontal size of the control or form in pixels.
This property is implemented in Control::Width

property AdjustToLayout

A helper property for Layouts to know if the component should adjust to the layout or not
This property is implemented in Control::AdjustToLayout

property Align

Determines how the control aligns within its container (parent control).
This property is implemented in Control::Align

property Alignment

Specifies the alignment to be used by the control, it depends on the control on how to use this property to show information.
This property is implemented in Control::Alignment

property Attributes

A property for tag based controls to allow component user to add attributes to the tag
This property is implemented in Control::Attributes

property Autosize

Determines if the control is going to adjust itself to the parent size
This property is implemented in Control::Autosize

property Caption

Specifies a text string that identifies the control to the user.
This property is implemented in Control::Caption

property Color

Specifies the main color of the control.
This property is implemented in Control::Color

property ControlStyle

An array which holds the control style, with settings for the IDE.
This property is implemented in Control::ControlStyle

property DesignColor

Specifies a color to use by the control at design time.
This property is implemented in Control::DesignColor

property DivWrap

Specifies if the control must be wrapped by a div or not
This property is implemented in Control::DivWrap

property DoParentReset

Performs a parent reset if true.
This property is implemented in Control::DoParentReset

property Enabled

Controls whether the control responds to mouse, keyboard, and timer events.
This property is implemented in Control::Enabled

property Font

Determines the Font to be used when generating this control.
This property is implemented in Control::Font

property Hidden

This property, when true, allows controls to generate all code, but don't show the control on the browser.
This property is implemented in Control::Hidden

property IsLayer

Specifies if this control is a Layer instead of being integrated into the document.
This property is implemented in Control::IsLayer

property JsEvents

Returns a string with all assigned javascript events, ready to be added to a control tag.
This property is implemented in Control::JsEvents

property JSWrapperHiddenFieldName

Gets the name of the hidden field used to submit the value for the event that was fired.
This property is implemented in Control::JSWrapperHiddenFieldName

property Parent

Indicates the parent of the control.
This property is implemented in Control::Parent

property ParentColor

Determines where a control looks for its color information.
This property is implemented in Control::ParentColor

property ParentFont

Determines where a control looks for its font information.
This property is implemented in Control::ParentFont

property ParentShowHint

Determines where a control looks to find out if its Help Hint should be shown.
This property is implemented in Control::ParentShowHint

property PopupMenu

Identifies the pop-up menu associated with the control.
This property is implemented in Control::PopupMenu

property ShowHint

Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.
This property is implemented in Control::ShowHint

property Style

Use this property to attach a css style to the control.
This property is implemented in Control::Style

property StyleClass

Normalizes the css style class name
This property is implemented in Control::StyleClass

property Visible

Determines whether the component appears on the browser.
This property is implemented in Control::Visible

property Name

Specifies the name for the component. The name is used as an identifier and should be unique.
This property is implemented in Component::Name

property Tag

A versatile property of every Component that can be used in any way you want
This property is implemented in Component::Tag

property ComponentCount

Indicates the number of components owned by the component.
This property is implemented in Component::ComponentCount

property Components

Lists all the components owned by this component.
This property is implemented in Component::Components

property ControlState

A flag to know the state of the control, csLoading, csDesigning
This property is implemented in Component::ControlState

property DataFieldValue

This property returns the value of the datafield if any.
This property is implemented in Component::DataFieldValue

property NamePath

Specifies the path to uniquely identify a component, qualified by the owner when required.
This property is implemented in Component::NamePath

property Owner

Indicates the component that is responsible for streaming and freeing this component.
This property is implemented in Component::Owner

property NamePath

Used to serialize/unserialize. It returns the full path to identify this component.
This property is implemented in Persistent::NamePath

property Owner

Owner of the component.
This property is implemented in Persistent::Owner

Methods

Summary:

Defined in class FocusControl
dumpChildren Dumps all children iterating through the Controls property and calls the show method of each one.
updateChildrenColors Updates the colors for all the children if parentcolor is set.
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.
updateChildrenParentProperties Updates all necessary properties for any children that use property values from their parent.
updateChildrenShowHints Updates the ShowHints properties for all children controls.

Defined in class Control
canShow Determines whether a control can be shown or not.
dumpChildren Dumps all children components.
dumpContents Dumps the control contents.
dumpHeaderCode Dumps the component header code.
dumpJavascript Dumps all required javascript code for the component.
dumpJsEvents Dumps all assigned javascript events code.
endCache
init Initializes a component
loaded Initializes the component after the form file has been read into memory.
updateParentColor If ParentColor == true the parent's color is assigned to this control.
updateParentFont If ParentFont == true the parent's font is assigned to this control.
updateParentProperties Updates all properties that use the parent property as source.
updateParentShowHint If ParentShowHint == true the parent's showhint is assigned to this control.

Defined in class Component
dumpChildrenJavascript Dumps the javascript code for all the children
dumpFormItems Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
dumpHeaderCode Dumps header code required
dumpJavascript Dumps the javascript code needed by this component
hasValidDataField Returns true if a valid data field is attached to the component
init Initializes a component
loaded Initializes the component after the form file has been read into memory.
loadedChildren Calls childrens loaded
preinit Method called before init()
serializeChildren Serializes all children
unserializeChildren Unserializes all children by calling unserialize for all the components

Defined in class Persistent
serialize Stores this object into the session.
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.

Defined in class Object
__construct Constructs an object and initializes its data before the object is first used.
className Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
classParent Returns the type of the immediate ancestor of a class.

Events

Summary:

Defined in class Control
OnAfterShow Fires the Event after showing the control.
OnBeforeShow Fires the Event before showing the control.
OnShow 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.

property OnAfterShow

Fires the Event after showing the control.
This event is implemented in Control::OnAfterShow

property OnBeforeShow

Fires the Event before showing the control.
This event is implemented in Control::OnBeforeShow

property OnShow

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.
This event is implemented in Control::OnShow

Javascript Events

Summary:

Defined in class Control
OnActivate Fires when the object is set as the active element.
OnBeforeCopy Fires on the source object before the selection is copied to the system clipboard.
OnBeforeCut Fires on the source object before the selection is deleted from the document.
OnBeforeDeactivate Fires immediately before the activeElement is changed from the current object to another object in the parent document.
OnBeforeEditfocus Fires before an object contained in an editable element enters a UI-activated state or when an editable container object is control selected.
OnBeforePaste Fires on the target object before the selection is pasted from the system clipboard to the document.
OnBlur Fires when the object loses the input focus.
OnChange Fires when the contents of the object or selection have changed.
OnClick Fires when the user clicks the left mouse button on the object.
OnContextMenu Fires when the user clicks the right mouse button in the client area, opening the context menu.
OnControlSelect Fires when the user is about to make a control selection of the object.
OnCopy Fires on the source element when the user copies the object or selection, adding it to the system clipboard.
OnCut Fires on the source element when the object or selection is removed from the document and added to the system clipboard.
OnDblClick Fires when the user double-clicks the object.
OnDeActivate Fires when the activeElement is changed from the current object to another object in the parent document.
OnDrag Fires on the source object continuously during a drag operation.
OnDragEnter Fires on the target element when the user drags the object to a valid drop target.
OnDragLeave Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
OnDragOver Fires on the target element continuously while the user drags the object over a valid drop target.
OnDragStart Fires on the source object when the user starts to drag a text selection or selected object.
OnDrop Fires on the target object when the mouse button is released during a drag-and-drop operation.
OnFilterChange Fires when a visual filter changes state or completes a transition.
OnFocus Fires when the object receives focus.
OnHelp Fires when the user presses the F1 key while the browser is the active window.
OnKeyDown Fires when the user presses a key.
OnKeyPress Fires when the user presses an alphanumeric key.
OnKeyUp Fires when the user releases a key.
OnLoseCapture Fires when the object loses the mouse capture.
OnMouseDown Fires when the user clicks the object with either mouse button.
OnMouseEnter Fires when the user moves the mouse pointer into the object.
OnMouseLeave Fires when the user moves the mouse pointer outside the boundaries of the object.
OnMouseMove Fires when the user moves the mouse over the object.
OnMouseOut Fires when the user moves the mouse pointer outside the boundaries of the object.
OnMouseOver Fires when the user moves the mouse pointer into the object.
OnMouseUp Fires when the user releases a mouse button while the mouse is over the object.
OnPaste Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document.
OnPropertyChange Fires when a property changes on the object.
OnReadyStateChange Fires when the state of the object has changed.
OnResize Fires when the size of the object is about to change.
OnResizeEnd Fires when the user finishes changing the dimensions of the object in a control selection.
OnResizeStart Fires when the user begins to change the dimensions of the object in a control selection
OnSelectStart Fires when the object is being selected

property OnActivate

Fires when the object is set as the active element.
This event is implemented in Control::OnActivate

property OnBeforeCopy

Fires on the source object before the selection is copied to the system clipboard.
This event is implemented in Control::OnBeforeCopy

property OnBeforeCut

Fires on the source object before the selection is deleted from the document.
This event is implemented in Control::OnBeforeCut

property OnBeforeDeactivate

Fires immediately before the activeElement is changed from the current object to another object in the parent document.
This event is implemented in Control::OnBeforeDeactivate

property OnBeforeEditfocus

Fires before an object contained in an editable element enters a UI-activated state or when an editable container object is control selected.
This event is implemented in Control::OnBeforeEditfocus

property OnBeforePaste

Fires on the target object before the selection is pasted from the system clipboard to the document.
This event is implemented in Control::OnBeforePaste

property OnBlur

Fires when the object loses the input focus.
This event is implemented in Control::OnBlur

property OnChange

Fires when the contents of the object or selection have changed.
This event is implemented in Control::OnChange

property OnClick

Fires when the user clicks the left mouse button on the object.
This event is implemented in Control::OnClick

property OnContextMenu

Fires when the user clicks the right mouse button in the client area, opening the context menu.
This event is implemented in Control::OnContextMenu

property OnControlSelect

Fires when the user is about to make a control selection of the object.
This event is implemented in Control::OnControlSelect

property OnCopy

Fires on the source element when the user copies the object or selection, adding it to the system clipboard.
This event is implemented in Control::OnCopy

property OnCut

Fires on the source element when the object or selection is removed from the document and added to the system clipboard.
This event is implemented in Control::OnCut

property OnDblClick

Fires when the user double-clicks the object.
This event is implemented in Control::OnDblClick

property OnDeActivate

Fires when the activeElement is changed from the current object to another object in the parent document.
This event is implemented in Control::OnDeActivate

property OnDrag

Fires on the source object continuously during a drag operation.
This event is implemented in Control::OnDrag

property OnDragEnter

Fires on the target element when the user drags the object to a valid drop target.
This event is implemented in Control::OnDragEnter

property OnDragLeave

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
This event is implemented in Control::OnDragLeave

property OnDragOver

Fires on the target element continuously while the user drags the object over a valid drop target.
This event is implemented in Control::OnDragOver

property OnDragStart

Fires on the source object when the user starts to drag a text selection or selected object.
This event is implemented in Control::OnDragStart

property OnDrop

Fires on the target object when the mouse button is released during a drag-and-drop operation.
This event is implemented in Control::OnDrop

property OnFilterChange

Fires when a visual filter changes state or completes a transition.
This event is implemented in Control::OnFilterChange

property OnFocus

Fires when the object receives focus.
This event is implemented in Control::OnFocus

property OnHelp

Fires when the user presses the F1 key while the browser is the active window.
This event is implemented in Control::OnHelp

property OnKeyDown

Fires when the user presses a key.
This event is implemented in Control::OnKeyDown

property OnKeyPress

Fires when the user presses an alphanumeric key.
This event is implemented in Control::OnKeyPress

property OnKeyUp

Fires when the user releases a key.
This event is implemented in Control::OnKeyUp

property OnLoseCapture

Fires when the object loses the mouse capture.
This event is implemented in Control::OnLoseCapture

property OnMouseDown

Fires when the user clicks the object with either mouse button.
This event is implemented in Control::OnMouseDown

property OnMouseEnter

Fires when the user moves the mouse pointer into the object.
This event is implemented in Control::OnMouseEnter

property OnMouseLeave

Fires when the user moves the mouse pointer outside the boundaries of the object.
This event is implemented in Control::OnMouseLeave

property OnMouseMove

Fires when the user moves the mouse over the object.
This event is implemented in Control::OnMouseMove

property OnMouseOut

Fires when the user moves the mouse pointer outside the boundaries of the object.
This event is implemented in Control::OnMouseOut

property OnMouseOver

Fires when the user moves the mouse pointer into the object.
This event is implemented in Control::OnMouseOver

property OnMouseUp

Fires when the user releases a mouse button while the mouse is over the object.
This event is implemented in Control::OnMouseUp

property OnPaste

Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document.
This event is implemented in Control::OnPaste

property OnPropertyChange

Fires when a property changes on the object.
This event is implemented in Control::OnPropertyChange

property OnReadyStateChange

Fires when the state of the object has changed.
This event is implemented in Control::OnReadyStateChange

property OnResize

Fires when the size of the object is about to change.
This event is implemented in Control::OnResize

property OnResizeEnd

Fires when the user finishes changing the dimensions of the object in a control selection.
This event is implemented in Control::OnResizeEnd

property OnResizeStart

Fires when the user begins to change the dimensions of the object in a control selection
This event is implemented in Control::OnResizeStart

property OnSelectStart

Fires when the object is being selected
This event is implemented in Control::OnSelectStart
Documentation generated on Fri, 26 Dec 2008 11:45:22 +0100 by phpDocumentor 1.4.0a2