Docs For Class PaintBox

Class: Control

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

Class: Component

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

Class: Persistent

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

Class: Object

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

constructor __construct [line 3163]

PaintBox __construct(
[
$aowner = null])

Overrides Control::__construct() (Constructor for the class)

Parameters:

$aowner

[ Top ]

method defaultOnClick [line 3237]

void defaultOnClick(
)

[ Top ]

method defaultOnDblClick [line 3241]

void defaultOnDblClick(
)

[ Top ]

method dumpContents [line 3113]

void dumpContents(
)

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

[ Top ]

method dumpForAjax [line 3072]

void dumpForAjax(
)

This is an internal method you don't need to call directly

This method is called by the Ajax engine to get the code to update the component after an ajax call

[ Top ]

method dumpHeaderCode [line 3079]

void dumpHeaderCode(
)

Overrides Control::dumpHeaderCode() (Dumps the component header code.)

[ Top ]

method dumpJavascript [line 3087]

void dumpJavascript(
)

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

[ Top ]

method getjsOnClick [line 3245]

void getjsOnClick(
)

[ Top ]

method getjsOnDblClick [line 3248]

void getjsOnDblClick(
)

[ Top ]

method getjsOnDragOver [line 3251]

void getjsOnDragOver(
)

[ Top ]

method getjsOnDragStart [line 3254]

void getjsOnDragStart(
)

[ Top ]

method getjsOnMouseDown [line 3258]

void getjsOnMouseDown(
)

[ Top ]

method getjsOnMouseEnter [line 3261]

void getjsOnMouseEnter(
)

[ Top ]

method getjsOnMouseLeave [line 3264]

void getjsOnMouseLeave(
)

[ Top ]

method getjsOnMouseMove [line 3267]

void getjsOnMouseMove(
)

[ Top ]

method getjsOnMouseUp [line 3270]

void getjsOnMouseUp(
)

[ Top ]

method getOnClick [line 3235]

mixed getOnClick(
)

Occurs when the user clicks the control.

Use the OnClick event handler to respond when the user clicks the control.

Usually OnClick occurs when the user presses and releases the left mouse button with the mouse pointer over the control. This event can also occur when:

The user selects an item in a grid, outline, list, or combo box by pressing an arrow key.

The user presses Spacebar while a button or check box has focus.

The user presses Enter when the active form has a default button (specified by the Default property).

The user presses Esc when the active form has a cancel button (specified by the Cancel property).

[ Top ]

method getOnDblClick [line 3239]

void getOnDblClick(
)

[ Top ]

method getOnPaint [line 3213]

mixed getOnPaint(
)

Fired when the control requires you to paint its contents.

The canvas you can use to draw is sent on the $params parameter of the event, checkout the Canvas class to know the methods and properties you have available to draw

Tags:

see:	Canvas
example:	example not found

[ Top ]

method getParentShowHint [line 3192]

void getParentShowHint(
)

[ Top ]

method getPopupMenu [line 3189]

void getPopupMenu(
)

[ Top ]

method getShowHint [line 3198]

void getShowHint(
)

[ Top ]

method getVisible [line 3195]

void getVisible(
)

[ Top ]

method init [line 3044]

void init(
)

This is an internal method you don't need to call directly

This method is called by the Ajax engine to get the code to update the component after an ajax call

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

[ Top ]

method readCanvas [line 3182]

Canvas readCanvas(
)

Provides the Canvas to use to draw on the OnPaint event

Use this property to get the Canvas object you need to use when drawing on the PaintBox object.

Tags:

example:

example not found

[ Top ]

method setjsOnClick [line 3246]

void setjsOnClick(

$value)

Parameters:

$value

[ Top ]

method setjsOnDblClick [line 3249]

void setjsOnDblClick(

$value)

Parameters:

$value

[ Top ]

method setjsOnDragOver [line 3252]

void setjsOnDragOver(

$value)

Parameters:

$value

[ Top ]

method setjsOnDragStart [line 3255]

void setjsOnDragStart(

$value)

Parameters:

$value

[ Top ]

method setjsOnMouseDown [line 3259]

void setjsOnMouseDown(

$value)

Parameters:

$value

[ Top ]

method setjsOnMouseEnter [line 3262]

void setjsOnMouseEnter(

$value)

Parameters:

$value

[ Top ]

method setjsOnMouseLeave [line 3265]

void setjsOnMouseLeave(

$value)

Parameters:

$value

[ Top ]

method setjsOnMouseMove [line 3268]

void setjsOnMouseMove(

$value)

Parameters:

$value

[ Top ]

method setjsOnMouseUp [line 3271]

void setjsOnMouseUp(

$value)

Parameters:

$value

[ Top ]

method setOnClick [line 3236]

void setOnClick(

$value)

Parameters:

$value

[ Top ]

method setOnDblClick [line 3240]

void setOnDblClick(

$value)

Parameters:

$value

[ Top ]

method setOnPaint [line 3214]

void setOnPaint(

$value)

Parameters:

$value

[ Top ]

method setParentShowHint [line 3193]

void setParentShowHint(

$value)

Parameters:

$value

[ Top ]

method setPopupMenu [line 3190]

void setPopupMenu(

$value)

Parameters:

$value

[ Top ]

method setShowHint [line 3199]

void setShowHint(

$value)

Parameters:

$value

[ Top ]

method setVisible [line 3196]

void setVisible(

$value)

Parameters:

$value

[ Top ]

Class: PaintBox

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Class: Control

Class: Component

Class: Object

Inherited Methods

Class: Control

Class: Component

Class: Persistent

Class: Object

Class Details

Tags:

Class Variables

$_canvas = null

Tags:

$_onclick = null

Tags:

$_ondblclick = null

Tags:

$_onpaint = null

Tags:

Class Methods

constructor __construct [line 3163]

Parameters:

method defaultOnClick [line 3237]

method defaultOnDblClick [line 3241]

method dumpContents [line 3113]

method dumpForAjax [line 3072]

method dumpHeaderCode [line 3079]

method dumpJavascript [line 3087]

method getjsOnClick [line 3245]

method getjsOnDblClick [line 3248]

method getjsOnDragOver [line 3251]

method getjsOnDragStart [line 3254]

method getjsOnMouseDown [line 3258]

method getjsOnMouseEnter [line 3261]

method getjsOnMouseLeave [line 3264]

method getjsOnMouseMove [line 3267]

method getjsOnMouseUp [line 3270]

method getOnClick [line 3235]

method getOnDblClick [line 3239]

method getOnPaint [line 3213]

Tags:

method getParentShowHint [line 3192]

method getPopupMenu [line 3189]

method getShowHint [line 3198]

method getVisible [line 3195]

method init [line 3044]

method readCanvas [line 3182]

Tags:

method setjsOnClick [line 3246]

Parameters:

method setjsOnDblClick [line 3249]

Parameters:

method setjsOnDragOver [line 3252]

Parameters:

method setjsOnDragStart [line 3255]

Parameters:

method setjsOnMouseDown [line 3259]

Parameters:

method setjsOnMouseEnter [line 3262]

Parameters:

method setjsOnMouseLeave [line 3265]

Parameters:

method setjsOnMouseMove [line 3268]

Parameters:

method setjsOnMouseUp [line 3271]

Parameters:

method setOnClick [line 3236]

Parameters:

method setOnDblClick [line 3240]

Parameters:

method setOnPaint [line 3214]

Parameters:

method setParentShowHint [line 3193]

Parameters: