VCL
[ class tree: VCL ] [ index: VCL ] [ all elements ]

Class: Control

Source Location: /controls.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --Control

Control is the base class for all components that are visible at runtime.


Variables

Methods


Child classes:

TrackBar
Use TrackBar to put a track bar on a form. A track bar represents a position along a continuum using a slider and, optionally, tick marks.
FocusControl
Base class for controls with input focus.
GraphicControl
Base class for controls with graphic capabilities.
DBIteratorBegin
Creates/begins a section on a templated form
DBIteratorEnd
Closes/ends a section on a templated form
MapShape
Encapsulates a shape for images, to create mapped images.
Shape
Shape represents a geometric shape that can be drawn on a form.
PaintBox
PaintBox provides a canvas that applications can use for rendering an image.
HiddenField
A component to generate an html hidden field.
Pager
A control to paginate sets of data and adapted to work with datasets also

Inherited Variables

Inherited Methods

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 72]
Control is the base class for all components that are visible at runtime.

Controls are visual components, meaning the user can see them and possibly interact with them at runtime. All controls have properties, methods, and events that describe aspects of their appearance, such as the position of the control, the cursor or hint associated with the control, methods to paint or move the control, and events that respond to user actions.

Control has many protected properties and methods that are used or published by its descendants.




[ Top ]


Class Variables

$_adjusttolayout = "0"

[line 687]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_align = alNone

[line 88]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_alignment = agNone

[line 89]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_attributes = array()

[line 735]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_autosize = 0

[line 703]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_cached = "0"

[line 1185]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_caption = ""

[line 74]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_color = ""

[line 83]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_controlstyle = array()

[line 77]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_cursor = ""

[line 93]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_designcolor = ""

[line 87]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_divwrap = 1

[line 719]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_enabled = 1

[line 85]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_font = null

[line 97]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_height = null

[line 82]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_hidden = 0

[line 750]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_hint = ""

[line 86]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_islayer = 0

[line 99]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonactivate = null

[line 104]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonbeforecopy = null

[line 106]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonbeforecut = null

[line 107]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonbeforedeactivate = null

[line 108]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonbeforeeditfocus = null

[line 109]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonbeforepaste = null

[line 110]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonblur = null

[line 111]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonchange = null

[line 112]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonclick = null

[line 113]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsoncontextmenu = null

[line 114]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsoncontrolselect = null

[line 115]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsoncopy = null

[line 116]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsoncut = null

[line 117]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsondblclick = null

[line 118]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsondeactivate = null

[line 105]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsondrag = null

[line 119]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsondragenter = null

[line 120]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsondragleave = null

[line 121]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsondragover = null

[line 122]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsondragstart = null

[line 123]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsondrop = null

[line 124]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonfilterchange = null

[line 125]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonfocus = null

[line 126]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonhelp = null

[line 127]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonkeydown = null

[line 128]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonkeypress = null

[line 129]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonkeyup = null

[line 130]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonlosecapture = null

[line 131]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonmousedown = null

[line 132]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonmouseenter = null

[line 134]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonmouseleave = null

[line 135]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonmousemove = null

[line 136]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonmouseout = null

[line 137]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonmouseover = null

[line 138]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonmouseup = null

[line 133]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonpaste = null

[line 139]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonpropertychange = null

[line 140]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonreadystatechange = null

[line 141]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonresize = null

[line 142]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonresizeend = null

[line 143]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonresizestart = null

[line 144]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonselectstart = null

[line 145]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_layer = 0

[line 1642]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_left = 0

[line 78]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_onaftershow = null

[line 91]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_onbeforeshow = null

[line 90]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_onshow = null

[line 92]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_parent = null

[line 75]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_parentcolor = 1

[line 84]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_parentfont = 1

[line 100]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_parentshowhint = 1

[line 95]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_popupmenu = null

[line 76]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_showhint = 0

[line 94]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_style = ""

[line 667]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_top = 0

[line 80]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_visible = 1

[line 79]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_width = null

[line 81]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 796]

Control __construct( [$aowner $aowner = null])

Constructor for the class



Overridden in child classes as:

FocusControl::__construct()
CustomCheckListBox::__construct()
MonthCalendar::__construct()
DateTimePicker::__construct()
DBPaginator::__construct()
CustomPanel::__construct()
Panel::__construct()
Clock::__construct()
DBRepeater::__construct()
CustomDBGrid::__construct()
CustomListBox::__construct()
ComboBox::__construct()
Image::__construct()
CustomRadioGroup::__construct()
CustomPage::__construct()
Page::__construct()
Frameset::__construct()
Frame::__construct()
DWidget::__construct()
CustomProgressBar::__construct()
QWidget::__construct()
BitBtn::__construct()
SpeedButton::__construct()
CustomListView::__construct()
DBGrid::__construct()
CustomPageControl::__construct()
CustomTreeView::__construct()
CustomTextField::__construct()
CustomLabeledEdit::__construct()
CustomUpDown::__construct()
ColorSelector::__construct()
CustomToolBar::__construct()
GroupBox::__construct()
CustomButtonView::__construct()
Window::__construct()
CustomMainMenu::__construct()
ScrollBar::__construct()
CustomEdit::__construct()
CustomMemo::__construct()
CustomRichEdit::__construct()
ButtonControl::__construct()
Button::__construct()
CustomCheckBox::__construct()
RadioButton::__construct()
CustomUpload::__construct()
SimpleChart::__construct()
FlashObject::__construct()
Bevel::__construct()
CustomLabel::__construct()
DBIteratorBegin::__construct()
DBIteratorEnd::__construct()
MapShape::__construct()
Shape::__construct()
PaintBox::__construct()
HiddenField::__construct()
Pager::__construct()

Overrides Component::__construct() (Component constructor)

Parameters:

$aowner   $aowner   The owner component for this class

[ Top ]

method addJSWrapperToEvents [line 1249]

void addJSWrapperToEvents( &$events, string $event, string $jsEvent, string $jsEventAttr, string $events)

Adds or replaces the JS event attribute with the wrapper.

The wrapper is used to notify the PHP script that an event occured. The script then may fire an event itself (for example OnClick of a button).




Tags:



Parameters:

string   $events   A string that is empty or contains already existing JS event-handlers. This string passed by reference.
string   $event   String representation of the event (ex. $this->_onclick;)
string   $jsEvent   String representation of the JS event (ex. $this->_jsonclick;)
string   $jsEventAttr   Name of attribute for the JS event (ex. "onclick")
   &$events  

[ Top ]

method beginCache [line 1076]

void beginCache( $type)



Parameters:

   $type  

[ Top ]

method canShow [line 826]

boolean canShow( )

Determines whether a control can be shown or not.

A control can be shown if it has no parent and its Visible property is true.

If it has a parent:

-if parent has Layer handling properties, checks Visible property if Parent can be shown and Layer matches with the Activelayer.

-else, checks the visible property and if the parent can be shown.




Tags:

return:  True if the control can be shown, false otherwise
see:  getVisible(), Control::readParent()


[ Top ]

method defaultAdjustToLayout [line 701]

void defaultAdjustToLayout( )



[ Top ]

method defaultAlign [line 1672]

void defaultAlign( )



Overridden in child classes as:

Frameset::defaultAlign()
Frame::defaultAlign()
CustomToolBar::defaultAlign()

[ Top ]

method defaultAlignment [line 1686]

void defaultAlignment( )



[ Top ]

method defaultAttributes [line 748]

void defaultAttributes( )



[ Top ]

method defaultAutosize [line 716]

void defaultAutosize( )



[ Top ]

method defaultCached [line 1189]

void defaultCached( )



[ Top ]

method defaultCaption [line 1402]

void defaultCaption( )



[ Top ]

method defaultColor [line 1446]

void defaultColor( )



[ Top ]

method defaultCursor [line 2135]

void defaultCursor( )



[ Top ]

method defaultDesignColor [line 1703]

void defaultDesignColor( )



[ Top ]

method defaultDivWrap [line 731]

void defaultDivWrap( )



[ Top ]

method defaultEnabled [line 1469]

void defaultEnabled( )



[ Top ]

method defaultHeight [line 2091]

void defaultHeight( )



[ Top ]

method defaultHidden [line 766]

void defaultHidden( )



[ Top ]

method defaultHint [line 2160]

void defaultHint( )



[ Top ]

method defaultIsLayer [line 1589]

void defaultIsLayer( )



[ Top ]

method defaultjsOnActivate [line 624]

void defaultjsOnActivate( )



[ Top ]

method defaultjsOnBeforeCopy [line 626]

void defaultjsOnBeforeCopy( )



[ Top ]

method defaultjsOnBeforeCut [line 627]

void defaultjsOnBeforeCut( )



[ Top ]

method defaultjsOnBeforeDeactivate [line 628]

void defaultjsOnBeforeDeactivate( )



[ Top ]

method defaultjsOnBeforeEditfocus [line 629]

void defaultjsOnBeforeEditfocus( )



[ Top ]

method defaultjsOnBeforePaste [line 630]

void defaultjsOnBeforePaste( )



[ Top ]

method defaultjsOnBlur [line 631]

void defaultjsOnBlur( )



[ Top ]

method defaultjsOnChange [line 632]

void defaultjsOnChange( )



Overridden in child classes as:

ScrollBar::defaultjsOnChange()

[ Top ]

method defaultjsOnClick [line 633]

void defaultjsOnClick( )



[ Top ]

method defaultjsOnContextMenu [line 634]

void defaultjsOnContextMenu( )



[ Top ]

method defaultjsOnControlSelect [line 635]

void defaultjsOnControlSelect( )



[ Top ]

method defaultjsOnCopy [line 636]

void defaultjsOnCopy( )



[ Top ]

method defaultjsOnCut [line 637]

void defaultjsOnCut( )



[ Top ]

method defaultjsOnDblClick [line 638]

void defaultjsOnDblClick( )



[ Top ]

method defaultjsOnDeActivate [line 625]

void defaultjsOnDeActivate( )



[ Top ]

method defaultjsOnDrag [line 639]

void defaultjsOnDrag( )



[ Top ]

method defaultjsOnDragEnter [line 640]

void defaultjsOnDragEnter( )



[ Top ]

method defaultjsOnDragLeave [line 641]

void defaultjsOnDragLeave( )



[ Top ]

method defaultjsOnDragOver [line 642]

void defaultjsOnDragOver( )



[ Top ]

method defaultjsOnDragStart [line 643]

void defaultjsOnDragStart( )



[ Top ]

method defaultjsOnDrop [line 644]

void defaultjsOnDrop( )



[ Top ]

method defaultjsOnFilterChange [line 645]

void defaultjsOnFilterChange( )



[ Top ]

method defaultjsOnFocus [line 646]

void defaultjsOnFocus( )



[ Top ]

method defaultjsOnHelp [line 647]

void defaultjsOnHelp( )



[ Top ]

method defaultjsOnKeyDown [line 648]

void defaultjsOnKeyDown( )



[ Top ]

method defaultjsOnKeyPress [line 649]

void defaultjsOnKeyPress( )



[ Top ]

method defaultjsOnKeyUp [line 650]

void defaultjsOnKeyUp( )



[ Top ]

method defaultjsOnLoseCapture [line 651]

void defaultjsOnLoseCapture( )



[ Top ]

method defaultjsOnMouseDown [line 652]

void defaultjsOnMouseDown( )



[ Top ]

method defaultjsOnMouseEnter [line 654]

void defaultjsOnMouseEnter( )



[ Top ]

method defaultjsOnMouseLeave [line 655]

void defaultjsOnMouseLeave( )



[ Top ]

method defaultjsOnMouseMove [line 656]

void defaultjsOnMouseMove( )



[ Top ]

method defaultjsOnMouseOut [line 657]

void defaultjsOnMouseOut( )



[ Top ]

method defaultjsOnMouseOver [line 658]

void defaultjsOnMouseOver( )



[ Top ]

method defaultjsOnMouseUp [line 653]

void defaultjsOnMouseUp( )



[ Top ]

method defaultjsOnPaste [line 659]

void defaultjsOnPaste( )



[ Top ]

method defaultjsOnPropertyChange [line 660]

void defaultjsOnPropertyChange( )



[ Top ]

method defaultjsOnReadyStateChange [line 661]

void defaultjsOnReadyStateChange( )



[ Top ]

method defaultjsOnResize [line 662]

void defaultjsOnResize( )



[ Top ]

method defaultjsOnResizeEnd [line 663]

void defaultjsOnResizeEnd( )



[ Top ]

method defaultjsOnResizeStart [line 664]

void defaultjsOnResizeStart( )



[ Top ]

method defaultjsOnSelectStart [line 665]

void defaultjsOnSelectStart( )



[ Top ]

method defaultLayer [line 1660]

void defaultLayer( )



[ Top ]

method defaultLeft [line 2049]

void defaultLeft( )



[ Top ]

method defaultOnAfterShow [line 2177]

void defaultOnAfterShow( )



[ Top ]

method defaultOnBeforeShow [line 2169]

void defaultOnBeforeShow( )



[ Top ]

method defaultOnShow [line 2186]

void defaultOnShow( )



[ Top ]

method defaultParentColor [line 1530]

void defaultParentColor( )



[ Top ]

method defaultParentFont [line 1636]

void defaultParentFont( )



[ Top ]

method defaultParentShowHint [line 1804]

void defaultParentShowHint( )



[ Top ]

method defaultPopupmenu [line 1485]

void defaultPopupmenu( )



[ Top ]

method defaultShowHint [line 1754]

void defaultShowHint( )



[ Top ]

method defaultStyle [line 685]

void defaultStyle( )



[ Top ]

method defaultTop [line 2067]

void defaultTop( )



[ Top ]

method defaultVisible [line 1909]

void defaultVisible( )



[ Top ]

method defaultWidth [line 2079]

void defaultWidth( )



[ Top ]

method dumpChildren [line 1202]

void dumpChildren( )

Dumps all children components.

This method iterates through all the children list, dumping all of them to the output using the show method.




Tags:



Overridden in child classes as:

FocusControl::dumpChildren()
Dumps all children iterating through the Controls property and calls the show method of each one.
Page::dumpChildren()
Dump al children controls

[ Top ]

method dumpContents [line 1227]

void dumpContents( )

Dumps the control contents.

Inherit and fill this method with the code your control must generate. This is one of the main methods in the VCL for PHP as it is responsible for generating the code for the controls. When developing components, you should override this method and write your component code here.

  1.  <?php
  2.       function dumpContents()
  3.       {
  4.           echo "<table width=\"100%\"><tr><td>Hello, my component!</td></tr></table>";
  5.       }
  6.  ?>




Tags:

see:  Control::show(), getVisible()


Overridden in child classes as:

TrackBar::dumpContents()
CustomCheckListBox::dumpContents()
MonthCalendar::dumpContents()
DateTimePicker::dumpContents()
DBPaginator::dumpContents()
CustomPanel::dumpContents()
Clock::dumpContents()
DBRepeater::dumpContents()
CustomListBox::dumpContents()
Image::dumpContents()
CustomRadioGroup::dumpContents()
Page::dumpContents()
Frameset::dumpContents()
Dump the whole frameset, with the alignment algorithm
Frame::dumpContents()
DWidget::dumpContents()
BitBtn::dumpContents()
SpeedButton::dumpContents()
CustomListView::dumpContents()
DBGrid::dumpContents()
CustomPageControl::dumpContents()
CustomTreeView::dumpContents()
CustomTextField::dumpContents()
CustomUpDown::dumpContents()
ColorSelector::dumpContents()
CustomToolBar::dumpContents()
GroupBox::dumpContents()
CustomButtonView::dumpContents()
Window::dumpContents()
CustomMainMenu::dumpContents()
ScrollBar::dumpContents()
CustomEdit::dumpContents()
CustomMemo::dumpContents()
Button::dumpContents()
CustomCheckBox::dumpContents()
RadioButton::dumpContents()
CustomUpload::dumpContents()
SimpleChart::dumpContents()
FlashObject::dumpContents()
Bevel::dumpContents()
CustomLabel::dumpContents()
DBIteratorBegin::dumpContents()
DBIteratorEnd::dumpContents()
MapShape::dumpContents()
Shape::dumpContents()
PaintBox::dumpContents()
HiddenField::dumpContents()
Pager::dumpContents()

[ Top ]

method dumpHeaderCode [line 1026]


method dumpJavascript [line 987]

void dumpJavascript( )

Dumps all required javascript code for the component.

Dumps Javascript code required for this component to work. This instance includes a call to dumpJSEvents to create all the javascript functions required to make javascript events to work.

This method is also responsible for dumping the javascript code to make the Popup property work.

If you are a component developer, this is the right method to override to dump all javascript your component needs.




Tags:



Overridden in child classes as:

CustomCheckListBox::dumpJavascript()
CustomListBox::dumpJavascript()
Image::dumpJavascript()
Write the Javascript section to the header
CustomRadioGroup::dumpJavascript()
Frameset::dumpJavascript()
Frame::dumpJavascript()
BitBtn::dumpJavascript()
CustomListView::dumpJavascript()
CustomTreeView::dumpJavascript()
Window::dumpJavascript()
CustomEdit::dumpJavascript()
CustomMemo::dumpJavascript()
ButtonControl::dumpJavascript()
RadioButton::dumpJavascript()
SimpleChart::dumpJavascript()
CustomLabel::dumpJavascript()
MapShape::dumpJavascript()
PaintBox::dumpJavascript()

Overrides Component::dumpJavascript() (Dumps the javascript code needed by this component)

[ Top ]

method dumpJsEvents [line 925]

void dumpJsEvents( )

Dumps all assigned javascript events code.

Dumps Javascript events. This method is called by the Page component to dump in the <head> section of the document all the javascript functions containing the code the user has written. Control class dumps the standard HTML javascript events. You can override it to dump yours.

Don't forget to call the parent:: method if you want the standard ones to get dumped.




Tags:



Overridden in child classes as:

TrackBar::dumpJsEvents()
MonthCalendar::dumpJsEvents()
Clock::dumpJsEvents()
Page::dumpJsEvents()
CustomListView::dumpJsEvents()
DBGrid::dumpJsEvents()
Dump Javascript events
CustomTreeView::dumpJsEvents()
CustomTextField::dumpJsEvents()
Window::dumpJsEvents()

[ Top ]

method endCache [line 1105]

void endCache( )



[ Top ]

method getCached [line 1187]

void getCached( )



[ Top ]

method getCursor [line 2133]

enum getCursor( )

Change the value of Cursor to provide feedback to the user when the mouse pointer enters the control.

The value of Cursor is one of the available cursors for the browser, in the IDE you have a drop-down list to select a valid value for this property, which can be one of the following:

crPointer - The cursor is a pointer that indicates a link.

crCrossHair - A simple crosshair (e.g., short line segments resembling a "+" sign).

crText - Indicates text that may be selected. Often rendered as an I-bar.

crWait - Indicates that the program is busy and the user should wait. Often rendered as a watch or hourglass.

crDefault - The platform-dependent default cursor. Often rendered as an arrow.

crHelp - Help is available for the object under the cursor. Often rendered as a question mark or a balloon.

crEResize - Indicate that some edge is to be moved. For example, the 'se-resize' cursor is used when the movement starts from the south-east corner of the box.

crNEResize - Indicate that some edge is to be moved. For example, the 'se-resize' cursor is used when the movement starts from the south-east corner of the box.

crNResize - Indicate that some edge is to be moved. For example, the 'se-resize' cursor is used when the movement starts from the south-east corner of the box.

crNWResize - Indicate that some edge is to be moved. For example, the 'se-resize' cursor is used when the movement starts from the south-east corner of the box.

crWResize - Indicate that some edge is to be moved. For example, the 'se-resize' cursor is used when the movement starts from the south-east corner of the box.

crSWResize - Indicate that some edge is to be moved. For example, the 'se-resize' cursor is used when the movement starts from the south-east corner of the box.

crSResize - Indicate that some edge is to be moved. For example, the 'se-resize' cursor is used when the movement starts from the south-east corner of the box.

crSEResize - Indicate that some edge is to be moved. For example, the 'se-resize' cursor is used when the movement starts from the south-east corner of the box.

crAuto - The UA determines the cursor to display based on the current context.




[ Top ]

method getHeight [line 2089]

int getHeight( )

Specifies the vertical size of the control or form in pixels.

Use the Height property to read or change the height of the control.




Tags:



[ Top ]

method getHint [line 2158]

string getHint( )

Specifies the text to show in a tooltip when the mouse is over the control for some time.

Use the Hint property to provide a string of help text, either as a Help Hint or as help text on a particular location such as a status bar.

A Help Hint is a box containing help text that appears for a control when the user moves the mouse pointer over the control and pauses momentarily.

To set up Help Hints:

Specify the Hint property of each control for which a Help Hint should appear.

Set the ShowHint property of each appropriate control to true, or set the ParentShowHint property of all controls to true and set the ShowHint property of the form to true.




Tags:

see:  Control::readShowHint(), Control::readParentShowHint()
example:  example not found


[ Top ]

method getHintAttribute [line 1060]

string getHintAttribute( )

If control has any Hint, then returns the hint in attribute format for the tag.

This function returns the attribute for the hint that can be included in any tag. The attribute's name is "title". If the hint is defined and can be shown a is string with the attribute, otherwise an empty string.




Tags:

see:  Control::readShowHint()
access:  protected


[ Top ]

method getJSWrapperFunction [line 1303]

string getJSWrapperFunction( string $event)

JS wrapper function that forwards a JS event to the PHP script by submitting the HTML form.

It is the responsiblity of the component to add this function to the <javascript> section in the HTML header. Usually this is done in the dumpJavascript() function of the component.




Tags:

return:  Returns the whole JS wrapper function for the $event.
see:  Control::addJSWrapperToEvents(), Control::readJSWrapperSubmitEventValue(), Control::readJSWrapperSubmitEventValue()
access:  protected


Parameters:

string   $event   String representation of the event (ex. $this->_onclick;)

[ Top ]

method getJSWrapperFunctionName [line 1283]

string getJSWrapperFunctionName( string $event)

Gets the function name of a JS event wrapper.

This method can be used to generate a normalized function name for a wrapper. Wrappers are often used to make a process before or after a javascript event is fired.




Tags:



Parameters:

string   $event   String representation of the event (ex. $this->_onclick;)

[ Top ]

method getLayer [line 1658]

mixed getLayer( )

Determines the layer in which this control is going to be rendered.

This property must match with the ActiveLayer property of the parent control for the component to be shown. It allows you to create stacked interfaces and then switch the active stack by changing ActiveLayer.

If parent control does not implement ActiveLayer, you do not have to worry about this property.




Tags:

see:  FocusControl::readActiveLayer()


[ Top ]

method getLeft [line 2047]

int getLeft( )

Uses the Left property to determine where the left side of the control begins, or to reposition the left side of the control.

If the control is contained in another control, the Left and Top properties are relative to the parent control. If the control is contained directly by the form, the property values are relative to the form. For forms, the value of the Left property is always 0.




Tags:



[ Top ]

method getOnAfterShow [line 2175]

mixed getOnAfterShow( )

Fires the Event after showing the control.



[ Top ]

method getOnBeforeShow [line 2167]

mixed getOnBeforeShow( )

Fires the Event before showing the control.



[ Top ]

method getOnShow [line 2184]

mixed 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.



[ Top ]

method getTop [line 2065]

int getTop( )

Uses Top to locate the top of the control, or reposition the control to a different Y coordinate.

The Top property, like the Left property, is the position of the control relative to its container. Thus, if a control is contained in a Panel, the Left and Top properties are relative to the panel. If the control is contained directly by the form, it is relative to the form. For forms, the value of the Top property is always 0




Tags:



[ Top ]

method getWidth [line 2077]

int getWidth( )

Specifies the horizontal size of the control or form in pixels.

Use the Width property to read or change the width of the control.




Tags:



[ Top ]

method init [line 1986]


method loaded [line 805]


method readAdjustToLayout [line 699]

boolean readAdjustToLayout( )

A helper property for Layouts to know if the component should adjust to the layout or not

If true, the control should adjust to the selected layout. This property can be used by a Layout component to render the component it contains.




Tags:



[ Top ]

method readAlign [line 1670]

enum readAlign( )

Determines how the control aligns within its container (parent control).

In the current implementation, is only used in a few controls. The goal is to replicate the Align model present in VCL for Windows in VCL for PHP.




[ Top ]

method readAlignment [line 1684]

enum readAlignment( )

Specifies the alignment to be used by the control, it depends on the control on how to use this property to show information.

For example, Label uses it to align the text to show. If you are a component developer, you can implement this property and use it to change the alignment of information.




[ Top ]

method readAttributes [line 746]

array readAttributes( )

A property for tag based controls to allow component user to add attributes to the tag

This is an array property you can use to specify, for tag based controls, some extra attributes to be included in the tag generation.




[ Top ]

method readAutosize [line 714]

boolean readAutosize( )

Determines if the control is going to adjust itself to the parent size

This property can be used by component developers to generate code that adjusts to the size of the parent cell/div/etc. It's useful for templated forms.




[ Top ]

method readCaption [line 1400]

string readCaption( )

Specifies a text string that identifies the control to the user.

Use Caption to specify the text string that labels the control.

Caption property which is defined in the Control class. If used by the control, is in sync with the Name when the control is first dropped on the designer. The usage of this property depends on the component, for example, Caption for Button components is the text inside the button while for Page components, is the title of the HTML document.

Note: Controls that display text use either the Caption property or the Text property to specify the text value. Which property is used depends on the type of control. In general, Caption is used for text that appears as a window title or label, while Text is used for text that appears as the content of a control.




Tags:

access:  protected


[ Top ]

method readColor [line 1424]

string readColor( )

Specifies the main color of the control.

Color property, defined in Control class, usually define the main color for the component, it's responsability of the component developer to use the property to generate the appropiate code and reflect the color setting. This property follows the HTML/CSS color specification, for example: #FF0000 -> red color or can also be "red"

If a control's ParentColor property is true, then changing the Color property of the control's parent automatically changes the Color property of the control. When the value of the Color property is changed, the control's ParentColor property is automatically set to false.




Tags:

see:  Control::readParentColor()
link:  http://www.w3.org/TR/REC-CSS2/syndata.html#color-units
access:  protected
example:  example not found


[ Top ]

method readControlStyle [line 1978]

array readControlStyle( )

An array which holds the control style, with settings for the IDE.

Valid settings are:

csAcceptsControls - Indicates to the IDE this control accepts children controls inside.

csImageContent - Indicates to the IDE the content dumped by this component is image binary data.

csSlowRedraw - Indicates to the IDE this component uses javascript and needs more time to get repainted.

csVerySlowRedraw - Indicates to the IDE this component uses javascript and needs a lot more time to get repainted.

csRenderOwner - Indicates to the IDE to render the Owner along with the control.

csDesignEncoding - Indicates to the IDE to use a different encoding for the HTML produced by the component.

csRenderAlso - Indicates to the IDE to also render components of a specific class.

csTopOffset - Indicates to the IDE to capture the control image from different coordinates.

csLeftOffset - Indicates to the IDE to capture the control image from different coordinates.

csTemplateOutput - Indicates this component produces output valid for a template




[ Top ]

method readDesignColor [line 1701]

string readDesignColor( )

Specifies a color to use by the control at design time.

This is a property a component developer can use to simplify the design of controls. The goal is that this property is only used at design-time. For example, Label control uses it to allow you set a background color which will only be visible at design-time, so you can freely set the Font color and still see the contents.




Tags:

see:  Control::readColor(), Control::readControlState()


[ Top ]

method readDivWrap [line 729]

boolean readDivWrap( )

Specifies if the control must be wrapped by a div or not

Use this property to specify if the control must be wrapped by a div or not. The usage of this property is leave to the component developer discretion.




[ Top ]

method readDoParentReset [line 1380]

boolean readDoParentReset( )

Performs a parent reset if true.



[ Top ]

method readEnabled [line 1467]

boolean readEnabled( )

Controls whether the control responds to mouse, keyboard, and timer events.

Use Enabled to change the availability of the control to the user. To disable a control, set Enabled to false. Disabled controls appear dimmed. If Enabled is false, the control ignores mouse, keyboard, and timer events.

To re-enable a control, set Enabled to true. The control is no longer dimmed, and the user can use the control.

Disabled controls must not react to user interaction and must show a different color or aspect to specify that to the user. Do not confuse this with ReadOnly properties, as ReadOnly controls may allow the user to copy information. Disabled controls do not allow any operations with it.




Tags:

see:  Control::readVisible()
access:  protected


[ Top ]

method readFont [line 1549]

Font readFont( )

Determines the Font to be used when generating this control.

This property is an object property, so you can individually set specific attributes for it, for example, Font->Color.

In the IDE, this property shows a list of all properties of Font class so you can set them individually

Checks the Style property also, as that property also influences the aspect of the Control.




Tags:

see:  Control::readParentFont()
access:  protected
example:  example not found


[ Top ]

method readHidden [line 764]

boolean readHidden( )

This property, when true, allows controls to generate all code, but don't show the control on the browser.

You can use this property to specify the control should not be shown on the browser, but the code for it will be generated, this is useful if you want to use javascript code to make the control visible.




Tags:



[ Top ]

method readIsLayer [line 1587]

boolean readIsLayer( )

Specifies if this control is a Layer instead of being integrated into the document.

If true, control will be generated into a div tag and won't visible when the application is executed. You will need to use Javascript events to show it.

This is useful for creating hover areas. For example, on a Panel containing controls, if IsLayer is true, you can write javascript code on the OnMouseOver javascript event of a Button to show that layer so you get a nice effect.




Tags:

see:  Control::readVisible()
access:  protected


[ Top ]

method readJsEvents [line 853]

string readJsEvents( )

Returns a string with all assigned javascript events, ready to be added to a control tag.

Returns assigned javascript events as attributes for the tag. This function is useful to get the tags to assign javascript events to the right code.




Tags:



[ Top ]

method readjsOnActivate [line 158]

mixed readjsOnActivate( )

Fires when the object is set as the active element.

This event is fired when the user click an element, other than the active element of the document, or use the keyboard to move focus from the active element to another element. Also can be fired if the script invokes the setActive method on an element, when the element is not the active element.




Tags:

access:  protected


[ Top ]

method readjsOnBeforeCopy [line 180]

mixed readjsOnBeforeCopy( )

Fires on the source object before the selection is copied to the system clipboard.

Is fired if the user right-click to display the shortcut menu and select Copy or presses CTRL+C.




Tags:

access:  protected


[ Top ]

method readjsOnBeforeCut [line 190]

mixed readjsOnBeforeCut( )

Fires on the source object before the selection is deleted from the document.

Is fired if the user right-click to display the shortcut menu and select Cut or presses CTRL+X.




Tags:

access:  protected


[ Top ]

method readjsOnBeforeDeactivate [line 202]

mixed readjsOnBeforeDeactivate( )

Fires immediately before the activeElement is changed from the current object to another object in the parent document.

This event is fired when the user click an element, other than the active element of the document, or use the keyboard to move focus from the active element to another element. Also can be fired if the script invokes the setActive method on an element, when the element is not the active element.




Tags:

access:  protected


[ Top ]

method readjsOnBeforeEditfocus [line 214]

mixed readjsOnBeforeEditfocus( )

Fires before an object contained in an editable element enters a UI-activated state or when an editable container object is control selected.

To invoke this event, press the ENTER key or click an object when it has focus or double-click an object. The onbeforeeditfocus event differs from the onfocus event. The onbeforeeditfocus event fires before an object enters a UI-activated state, whereas the onfocus event fires when an object has focus.




Tags:

access:  protected


[ Top ]

method readjsOnBeforePaste [line 224]

mixed readjsOnBeforePaste( )

Fires on the target object before the selection is pasted from the system clipboard to the document.

Is fired if the user right-click to display the shortcut menu and select Paste or presses CTRL+V.




Tags:

access:  protected


[ Top ]

method readjsOnBlur [line 238]

mixed readjsOnBlur( )

Fires when the object loses the input focus.

The onblur event fires on the original object before the onfocus or onclick event fires on the object that is receiving focus. Where applicable, the onblur event fires after the onchange event.

Use the focus events to determine when to prepare an object to receive or validate input from the user.




Tags:

access:  protected


[ Top ]

method readjsOnChange [line 252]

mixed readjsOnChange( )

Fires when the contents of the object or selection have changed.

This event is fired when the contents are committed and not while the value is changing. For example, on a text box, this event is not fired while the user is typing, but rather when the user commits the change by leaving the text box that has focus. In addition, this event is executed before the code specified by onblur when the control is also losing the focus.




Tags:

access:  protected


[ Top ]

method readjsOnClick [line 265]

mixed readjsOnClick( )

Fires when the user clicks the left mouse button on the object.

If the user clicks the left mouse button, the onclick event for an object occurs only if the mouse pointer is over the object and an onmousedown and an onmouseup event occur in that order. For example, if the user clicks the mouse on the object but moves the mouse pointer away from the object before releasing, no onclick event occurs.




Tags:

access:  protected


[ Top ]

method readjsOnContextMenu [line 273]

mixed readjsOnContextMenu( )

Fires when the user clicks the right mouse button in the client area, opening the context menu.



Tags:

access:  protected


[ Top ]

method readjsOnControlSelect [line 283]

mixed readjsOnControlSelect( )

Fires when the user is about to make a control selection of the object.

This event fires before the element is selected, so inspecting the selection object gives no information about the element to be selected.




Tags:

access:  protected


[ Top ]

method readjsOnCopy [line 293]

mixed readjsOnCopy( )

Fires on the source element when the user copies the object or selection, adding it to the system clipboard.

Is fired if the user right-click to display the shortcut menu and select Copy or presses CTRL+C.




Tags:

access:  protected


[ Top ]

method readjsOnCut [line 303]

mixed readjsOnCut( )

Fires on the source element when the object or selection is removed from the document and added to the system clipboard.

Is fired if the user right-click to display the shortcut menu and select Cut or presses CTRL+X.




Tags:

access:  protected


[ Top ]

method readjsOnDblClick [line 313]

mixed readjsOnDblClick( )

Fires when the user double-clicks the object.

The order of events leading to the ondblclick event is onmousedown, onmouseup, onclick, onmouseup, and then ondblclick.




Tags:

access:  protected


[ Top ]

method readjsOnDeActivate [line 170]

mixed readjsOnDeActivate( )

Fires when the activeElement is changed from the current object to another object in the parent document.

This event is fired when the user click an element, other than the active element of the document, or use the keyboard to move focus from the active element to another element. Also can be fired if the script invokes the setActive method on an element, when the element is not the active element.




Tags:

access:  protected


[ Top ]

method readjsOnDrag [line 324]

mixed readjsOnDrag( )

Fires on the source object continuously during a drag operation.

This event fires on the source object after the ondragstart event. The ondrag event fires throughout the drag operation, whether the selection being dragged is over the drag source, a valid target, or an invalid target.




Tags:

access:  protected


[ Top ]

method readjsOnDragEnter [line 335]

mixed readjsOnDragEnter( )

Fires on the target element when the user drags the object to a valid drop target.

You can handle the ondragenter event on the source or on the target object. Of the target events, it is the first to fire during a drag operation.




Tags:

access:  protected


[ Top ]

method readjsOnDragLeave [line 341]

mixed readjsOnDragLeave( )

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.



Tags:

access:  protected


[ Top ]

method readjsOnDragOver [line 352]

mixed readjsOnDragOver( )

Fires on the target element continuously while the user drags the object over a valid drop target.

The ondragover event fires on the target object after the ondragenter event has fired.




Tags:

access:  protected


[ Top ]

method readjsOnDragStart [line 363]

mixed readjsOnDragStart( )

Fires on the source object when the user starts to drag a text selection or selected object.

The ondragstart event is the first to fire when the user starts to drag the mouse.




Tags:

access:  protected


[ Top ]

method readjsOnDrop [line 373]

mixed readjsOnDrop( )

Fires on the target object when the mouse button is released during a drag-and-drop operation.

The ondrop event fires before the ondragleave and ondragend events.




Tags:

access:  protected


[ Top ]

method readjsOnFilterChange [line 380]

mixed readjsOnFilterChange( )

Fires when a visual filter changes state or completes a transition.



Tags:

access:  protected


[ Top ]

method readjsOnFocus [line 393]

mixed readjsOnFocus( )

Fires when the object receives focus.

When one object loses activation and another object becomes the activeElement, the onfocus event fires on the object becoming the activeElement only after the onblur event fires on the object losing activation. Use the focus events to determine when to prepare an object to receive input from the user.




Tags:

access:  protected


[ Top ]

method readjsOnHelp [line 399]

mixed readjsOnHelp( )

Fires when the user presses the F1 key while the browser is the active window.



Tags:

access:  protected


[ Top ]

method readjsOnKeyDown [line 409]

mixed readjsOnKeyDown( )

Fires when the user presses a key.

This event is specifically fired when the key is pressed down and is repeated multiple times until the key is released.




Tags:

access:  protected


[ Top ]

method readjsOnKeyPress [line 419]

mixed readjsOnKeyPress( )

Fires when the user presses an alphanumeric key.

This event can be used to detect key presses of standard keys, if you need to process other keys (like cursor keys), use jsOnKeyDown.




Tags:

access:  protected


[ Top ]

method readjsOnKeyUp [line 429]

mixed readjsOnKeyUp( )

Fires when the user releases a key.

This event is fired whenever a key pressed is released, both for keypress and keydown events.




Tags:

access:  protected


[ Top ]

method readjsOnLoseCapture [line 434]

mixed readjsOnLoseCapture( )

Fires when the object loses the mouse capture.



Tags:

access:  protected


[ Top ]

method readjsOnMouseDown [line 445]

mixed readjsOnMouseDown( )

Fires when the user clicks the object with either mouse button.

Use this event to detect when the mouse is pressed on an element, you can use the button property of the event to determine which mouse button is clicked.




Tags:

access:  protected


[ Top ]

method readjsOnMouseEnter [line 467]

mixed readjsOnMouseEnter( )

Fires when the user moves the mouse pointer into the object.

The event fires only if the mouse pointer is outside the boundaries of the object and the user moves the mouse pointer inside the boundaries of the object.




Tags:

access:  protected


[ Top ]

method readjsOnMouseLeave [line 478]

mixed readjsOnMouseLeave( )

Fires when the user moves the mouse pointer outside the boundaries of the object.

The event fires only if the mouse pointer is inside the boundaries of the object and the user moves the mouse pointer outside the boundaries of the object.




Tags:

access:  protected


[ Top ]

method readjsOnMouseMove [line 488]

mixed readjsOnMouseMove( )

Fires when the user moves the mouse over the object.

If the user presses a mouse button, use the button property to determine which button was pressed.




Tags:

access:  protected


[ Top ]

method readjsOnMouseOut [line 500]

mixed readjsOnMouseOut( )

Fires when the user moves the mouse pointer outside the boundaries of the object.

When the user moves the mouse over an object, one onmouseover event occurs, followed by one or more onmousemove events as the user moves the mouse pointer within the object. One onmouseout event occurs when the user moves the mouse pointer out of the object.




Tags:

access:  protected


[ Top ]

method readjsOnMouseOver [line 511]

mixed readjsOnMouseOver( )

Fires when the user moves the mouse pointer into the object.

The event occurs when the user moves the mouse pointer into the object, and it does not repeat unless the user moves the mouse pointer out of the object and then back into it.




Tags:

access:  protected


[ Top ]

method readjsOnMouseUp [line 456]

mixed readjsOnMouseUp( )

Fires when the user releases a mouse button while the mouse is over the object.

When any mouse button stops from being pressed over an element, this event is fired, you can use the button property to determine which mouse button is clicked.




Tags:

access:  protected


[ Top ]

method readjsOnPaste [line 519]

mixed readjsOnPaste( )

Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document.



Tags:

access:  protected


[ Top ]

method readjsOnPropertyChange [line 530]

mixed readjsOnPropertyChange( )

Fires when a property changes on the object.

The onpropertychange event fires when properties of an object, expando, or style sub-object change. To retrieve the name of the changed property, use the event object's propertyName property.




Tags:

access:  protected


[ Top ]

method readjsOnReadyStateChange [line 540]

mixed readjsOnReadyStateChange( )

Fires when the state of the object has changed.

You can use the readyState property to query the current state of the element when the onreadystatechange event fires.




Tags:

access:  protected


[ Top ]

method readjsOnResize [line 550]

mixed readjsOnResize( )

Fires when the size of the object is about to change.

The onresize event fires for block and inline objects with layout, even if document or CSS (cascading style sheets) property values are changed.




Tags:

access:  protected


[ Top ]

method readjsOnResizeEnd [line 560]

mixed readjsOnResizeEnd( )

Fires when the user finishes changing the dimensions of the object in a control selection.

Only content editable objects can be included in a control selection.




Tags:

access:  protected


[ Top ]

method readjsOnResizeStart [line 570]

mixed readjsOnResizeStart( )

Fires when the user begins to change the dimensions of the object in a control selection

Only content editable objects can be included in a control selection.




Tags:

access:  protected


[ Top ]

method readjsOnSelectStart [line 579]

mixed readjsOnSelectStart( )

Fires when the object is being selected

The object at the beginning of the selection fires the event.




Tags:

access:  protected


[ Top ]

method readJSWrapperHiddenFieldName [line 1351]

string readJSWrapperHiddenFieldName( )

Gets the name of the hidden field used to submit the value for the event that was fired.

There should be one hidden field for each component that can forward JS events to the PHP script. It is the responsiblity of the component to add this field.




Tags:



[ Top ]

method readJSWrapperSubmitEventValue [line 1371]

string readJSWrapperSubmitEventValue( string $event)

Sets the value to the hidden field when the specific JS event was fired and the wrapper function was called.

See getJSWrapperFunction()where the value gets set to the hidden field. It is also used in the component to check if the defined $event has been fired on the page. This should be done in the init() function of the component.




Tags:

return:  The value that will be set in the hidden input.
see:  Control::addJSWrapperToEvents(), Control::readJSWrapperSubmitEventValue(), Control::readJSWrapperHiddenFieldName()
access:  public


Parameters:

string   $event   String representation of the event (ex. $this->_onclick;)

[ Top ]

method readParent [line 1933]

FocusControl readParent( )

Indicates the parent of the control.

Use the Parent property to get or set the parent of this control. The parent of a control is the control that contains the control. For example, if an application includes three radio buttons in a group box, the group box is the parent of the three radio buttons, and the radio buttons are the child controls of the group box.

To serve as a parent, a control must be an instance of a descendant of FocusControl.

When creating a new control at runtime, assign a Parent property value for the new control. Usually, this is a form, panel, group box, or some control that is designed to contain another. Changing the parent of a control moves the control on the browser so that it is displayed within the new parent. When the parent control moves, the child moves with the parent.




Tags:

see:  Component::readOwner()
example:  example not found


[ Top ]

method readParentColor [line 1506]

boolean readParentColor( )

Determines where a control looks for its color information.

To have a control use the same color as its parent control, set ParentColor to true. If ParentColor is false, the control uses its own Color property.

Set ParentColor to true for all controls in order to ensure that all the controls on a form have a uniform appearance. For example, if ParentColor is true for all controls in a form, changing the background color of the form to gray causes all the controls on the form to also have a gray background.

When the value of a control's Color property changes, ParentColor becomes false automatically.




Tags:

see:  Control::readColor()
access:  protected
example:  example not found


[ Top ]

method readParentFont [line 1609]

boolean readParentFont( )

Determines where a control looks for its font information.

To have a control use the same font as its parent control, set ParentFont to true. If ParentFont is false, the control uses its own Font property.

Many controls default ParentFont to true so that all the controls in a form or other container present a uniform appearance. When the value of a control's Font property changes, ParentFont becomes false automatically.

When ParentFont is true for a form, the form uses the default font.




Tags:

see:  Control::readFont()
access:  protected
example:  example not found


[ Top ]

method readParentShowHint [line 1779]

boolean readParentShowHint( )

Determines where a control looks to find out if its Help Hint should be shown.

Use ParentShowHint to ensure that all the controls on a form either uniformly show their Help Hints or uniformly do not show them.

If ParentShowHint is true, the control uses the ShowHint property value of its parent. If ParentShowHint is false, the control uses the value of its own ShowHint property.

To provide Help Hints for only selected controls on a form, set the ShowHint property to true for those controls that should have Help Hints. ParentShowHint becomes false automatically.

Note: Enable or disable all Help Hints for the entire application using the ShowHint property of the application object.




Tags:

see:  Control::readShowHint()
example:  example not found


[ Top ]

method readPopupMenu [line 1483]

PopupMenu readPopupMenu( )

Identifies the pop-up menu associated with the control.

Assign a value to PopupMenu to make a pop-up menu appear when the user selects the control and clicks the right mouse button.

The value for this property must be a PopupMenu component. If you are working on the IDE you will get a drop-down on the Object Inspector with valid values for it.




Tags:

access:  protected


[ Top ]

method readShowHint [line 1731]

boolean readShowHint( )

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

The Help Hint is the value of the Hint property, which is displayed in a box just beneath the control. Use ShowHint to determine whether a Help Hint appears for the control.

To enable Help Hint for a particular control, the application ShowHint property must be true and either:

the controls own ShowHint property must be true, or

the controls ParentShowHint property must be true and its parent's ShowHint property must be true.

For example, imagine a check box within a group box. If the ShowHint property of the group box is true and the ParentShowHint property of the check box is true, but the ShowHint property of the check box is false, the check box still displays its Help Hint.

Changing the ShowHint value automatically sets the ParentShowHint property to false. Also checks the Hint property, which specifies the text to be shown.




Tags:

see:  readHint(), Control::readParentShowHint()
example:  example not found


[ Top ]

method readStyle [line 683]

string readStyle( )

Use this property to attach a css style to the control.

CSS style to be used when rendering the component, the style must be included in a .css file referenced by the Page component. You can use OnShowHeader to write the code to include the stylesheet or use the StyleSheet component. Using the StyleSheet component you will be able to see the style rendered in design-time, and this property will be shown as a drop-down with the styles available in the linked stylesheet




Tags:

see:  StyleSheet


[ Top ]

method readStyleClass [line 777]

string readStyleClass( )

Normalizes the css style class name

Return the normalized CSS style without the starting dot if any.




Tags:



[ Top ]

method readVisible [line 1907]

boolean readVisible( )

Determines whether the component appears on the browser.

This property determines if the control is visible at run-time or not. Use it to hide this control when generating the page. Note: The behaviour can be different than in VCL for Windows. Since the control uses javascript to get rendered, you might not be able to access it using javascript as the code won't be generated.

If you want to get a control code on the browser but not being visible, you should use javascript to hide the control.




Tags:



[ Top ]

method setCached [line 1188]

void setCached( $value)



Parameters:

   $value  

[ Top ]

method setCursor [line 2134]

void setCursor( $value)



Parameters:

   $value  

[ Top ]

method setHeight [line 2090]

void setHeight( $value)



Parameters:

   $value  

[ Top ]

method setHint [line 2159]

void setHint( $value)



Parameters:

   $value  

[ Top ]

method setLayer [line 1659]

void setLayer( $value)



Parameters:

   $value  

[ Top ]

method setLeft [line 2048]

void setLeft( $value)



Parameters:

   $value  

[ Top ]

method setOnAfterShow [line 2176]

void setOnAfterShow( $value)



Parameters:

   $value  

[ Top ]

method setOnBeforeShow [line 2168]

void setOnBeforeShow( $value)



Parameters:

   $value  

[ Top ]

method setOnShow [line 2185]

void setOnShow( $value)



Parameters:

   $value  

[ Top ]

method setTop [line 2066]

void setTop( $value)



Parameters:

   $value  

[ Top ]

method setWidth [line 2078]

void setWidth( $value)



Parameters:

   $value  

[ Top ]

method show [line 1149]

mixed show( [boolean $return_contents = false])

Dumps the code for the control to the output.

Shows control contents. You can use this method to show the contents of the control, optionally, by setting $return_contents to true. You can get the contents of the control returned instead of having it dumped to the output.

This method also checks if the global var has $output_enabled. You can globally disable output of controls by setting that var to false.

This method is also responsible to call beforeshow and aftershow events




Tags:

return:  If $return_contents is true, it will return the control contents, void otherwise
see:  $output_enabled, Component::callEvent(), readOnBeforeShow(), Control::dumpContents(), readOnAfterShow()


Parameters:

boolean   $return_contents   return contents as string or dumps to output

[ Top ]

method updateParentColor [line 1855]

void updateParentColor( )

If ParentColor == true the parent's color is assigned to this control.



Tags:

see:  Control::readParentColor()
example:  example not found


[ Top ]

method updateParentFont [line 1833]

void updateParentFont( )

If ParentFont == true the parent's font is assigned to this control.



Tags:

see:  Control::readParentFont()
example:  example not found


[ Top ]

method updateParentProperties [line 1817]

void updateParentProperties( )

Updates all properties that use the parent property as source.

You don't need to call this method, is called by Control to update all properties that have a Parent relative.

These include ShowHint, Color and Font.




Tags:



[ Top ]

method updateParentShowHint [line 1877]

void updateParentShowHint( )

If ParentShowHint == true the parent's showhint is assigned to this control.



Tags:

see:  Control::readParentShowHint()
example:  example not found


[ Top ]

method writeAdjustToLayout [line 700]

void writeAdjustToLayout( $value)



Parameters:

   $value  

[ Top ]

method writeAlign [line 1671]

void writeAlign( $value)



Parameters:

   $value  

[ Top ]

method writeAlignment [line 1685]

void writeAlignment( $value)



Parameters:

   $value  

[ Top ]

method writeAttributes [line 747]

void writeAttributes( $value)



Parameters:

   $value  

[ Top ]

method writeAutosize [line 715]

void writeAutosize( $value)



Parameters:

   $value  

[ Top ]

method writeCaption [line 1401]

void writeCaption( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writeColor [line 1425]

void writeColor( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writeControlStyle [line 1979]

void writeControlStyle( $value)



Parameters:

   $value  

[ Top ]

method writeDesignColor [line 1702]

void writeDesignColor( $value)



Parameters:

   $value  

[ Top ]

method writeDivWrap [line 730]

void writeDivWrap( $value)



Parameters:

   $value  

[ Top ]

method writeEnabled [line 1468]

void writeEnabled( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writeFont [line 1550]

void writeFont( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writeHidden [line 765]

void writeHidden( $value)



Parameters:

   $value  

[ Top ]

method writeIsLayer [line 1588]

void writeIsLayer( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnActivate [line 581]

void writejsOnActivate( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnBeforeCopy [line 583]

void writejsOnBeforeCopy( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnBeforeCut [line 584]

void writejsOnBeforeCut( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnBeforeDeactivate [line 585]

void writejsOnBeforeDeactivate( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnBeforeEditfocus [line 586]

void writejsOnBeforeEditfocus( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnBeforePaste [line 587]

void writejsOnBeforePaste( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnBlur [line 588]

void writejsOnBlur( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnChange [line 589]

void writejsOnChange( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnClick [line 590]

void writejsOnClick( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnContextMenu [line 591]

void writejsOnContextMenu( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnControlSelect [line 592]

void writejsOnControlSelect( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnCopy [line 593]

void writejsOnCopy( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnCut [line 594]

void writejsOnCut( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnDblClick [line 595]

void writejsOnDblClick( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnDeActivate [line 582]

void writejsOnDeActivate( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnDrag [line 596]

void writejsOnDrag( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnDragEnter [line 597]

void writejsOnDragEnter( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnDragLeave [line 598]

void writejsOnDragLeave( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnDragOver [line 599]

void writejsOnDragOver( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnDragStart [line 600]

void writejsOnDragStart( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnDrop [line 601]

void writejsOnDrop( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnFilterChange [line 602]

void writejsOnFilterChange( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnFocus [line 603]

void writejsOnFocus( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnHelp [line 604]

void writejsOnHelp( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnKeyDown [line 605]

void writejsOnKeyDown( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnKeyPress [line 606]

void writejsOnKeyPress( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnKeyUp [line 607]

void writejsOnKeyUp( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnLoseCapture [line 608]

void writejsOnLoseCapture( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnMouseDown [line 609]

void writejsOnMouseDown( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnMouseEnter [line 611]

void writejsOnMouseEnter( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnMouseLeave [line 612]

void writejsOnMouseLeave( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnMouseMove [line 613]

void writejsOnMouseMove( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnMouseOut [line 614]

void writejsOnMouseOut( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnMouseOver [line 615]

void writejsOnMouseOver( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnMouseUp [line 610]

void writejsOnMouseUp( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnPaste [line 616]

void writejsOnPaste( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnPropertyChange [line 617]

void writejsOnPropertyChange( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnReadyStateChange [line 618]

void writejsOnReadyStateChange( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnResize [line 619]

void writejsOnResize( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnResizeEnd [line 620]

void writejsOnResizeEnd( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnResizeStart [line 621]

void writejsOnResizeStart( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnSelectStart [line 622]

void writejsOnSelectStart( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writeParent [line 1934]

void writeParent( $value)



Parameters:

   $value  

[ Top ]

method writeParentColor [line 1507]

void writeParentColor( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writeParentFont [line 1610]

void writeParentFont( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writeParentShowHint [line 1780]

void writeParentShowHint( $value)



Parameters:

   $value  

[ Top ]

method writePopupMenu [line 1484]

void writePopupMenu( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writeShowHint [line 1732]

void writeShowHint( $value)



Parameters:

   $value  

[ Top ]

method writeStyle [line 684]

void writeStyle( $value)



Parameters:

   $value  

[ Top ]

method writeVisible [line 1908]

void writeVisible( $value)



Parameters:

   $value  

[ Top ]


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