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

Class: CustomTreeView

Source Location: /comctrls.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --Control
            |
            --FocusControl
               |
               --QWidget
                  |
                  --CustomTreeView

TreeView control


Class Details

[line 423]
TreeView control



[ Top ]

Properties

Events

    [none]

JS Events

Methods

Constants

    [none]

Child classes:

TreeView
TreeView control

Inherited Properties

Class: FocusControl

FocusControl::ControlCount
Return the number of controls for which this control is the Parent
FocusControl::Layout
Specifies the Layout this control lives in @see ActiveLayout

Class: Control

Control::AdjustToLayout
If true, the control should adjust to the selected layout
Control::Align
Specifies the Align for this control
Control::Alignment
Specifies the alignment to be used by the control
Control::Caption
Returns the caption property
Control::Color
Returns the color property
Control::ControlStyle
An array which holds the control style, with settings for the IDE
Control::Cursor
Cursor to show when the mouse is over the control
Control::DesignColor
Specifies a color can be used by the control in design time
Control::DoParentReset
Performs a parent reset if true
Control::Enabled
Determines if the controls is enabled or not
Control::Font
Determines the Font to be used when generating this control
Control::Height
Control::Hint
Text to show in a tooltip when the mouse is over the control for some time
Control::HintAttribute
This function returns the attribute for the hint that can be included in any tag. The attribute's name is "title".
Control::IsLayer
Specifies if this control is a Layer instead be integrated into the document
Control::JsEvents
Return assigned javascript events as attributes for the tag
Control::JSWrapperHiddenFieldName
Get the name of the hidden field used to submit the value which event was fired.
Control::Layer
Determines the layer this control is going to be rendered
Control::Left
Left coordinate
Control::Parent
Determines the parent control which holds this control
Control::ParentColor
Determines where a control looks for its color information.
Control::ParentFont
Determines where a control looks for its font information.
Control::ParentShowHint
Determines where a control looks to find out if its Help Hint should be shown.
Control::PopupMenu
Specifies the PopupMenu component to show when right clicking the control
Control::ShowHint
Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.
Control::Style
CSS style to be used when rendering the component
Control::StyleClass
Return the normalized CSS style
Control::Top
Top coordinate
Control::Visible
Determines if the controls is visible in run-time or not
Control::Width
Control width

Class: Component

Component::ComponentCount
Indicates how many components this component is owner
Component::Components
Component list containing all the components owned by this component
Component::ControlState
A flag to know the state of the control, csLoading, csDesigning
Component::DataFieldValue
This function returns the value of the datafield, if any
Component::Name
Name for the component, to be used as an identifier, should be unique
Component::NamePath
The path to uniquely identify a component, qualified by the owner when required
Component::Owner
The owner of this component, usually the page component, but the owner of pages is the application object
Component::Tag
A versatily property of every Component that can be used in any way you want

Class: Persistent

Persistent::NamePath
Used to serialize/unserialize
Persistent::Owner
Owner of the component, in Persistent always return null

Inherited Events

Class: Control

Control::OnAfterShow
Event fired after show the control
Control::OnBeforeShow
Event fired before show the control
Control::OnShow
Event fired at the same moment the control is show, some controls can

Inherited JS Events

Class: Control

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

Inherited Methods

Class: QWidget

QWidget::__construct
QWidget::dumpChildrenControls
Code to dump when the Widget accepts children controls.
QWidget::dumpCommonContentsBottom
Dump common qooxdoo finalization code
QWidget::dumpCommonContentsTop
Dump the common qooxdoo initialization code
QWidget::dumpCommonQWidgetJSEvents
QWidget::dumpCommonQWidgetProperties
QWidget::dumpHeaderCode
QWidget::PrepareQWJSEvent

Class: FocusControl

FocusControl::__construct
FocusControl::dumpChildren
Dump all children
FocusControl::updateChildrenColors
Update the colors for all the children if parentcolor is set
FocusControl::updateChildrenFonts
If this control has any children that have ParentFont==true then this function will assign the Font property to all children Font properties.
FocusControl::updateChildrenParentProperties
If this control has any children that use a property's value from the parent then this function will update all necessary properties.
FocusControl::updateChildrenShowHints
Update the ShowHints properties for all children controlss

Class: Control

Control::__construct
Constructor for the class
Control::addJSWrapperToEvents
Add or replace the JS event attribute with the wrapper.
Control::canShow
Determines whether a control can be shown or not
Control::dumpChildren
Dump all children components
Control::dumpContents
Dump the control contents, inherit and fill this method with the code
Control::dumpHeaderCode
Control::dumpJavascript
Dump Javascript code required for this component to work
Control::dumpJSEvent
Dumps a javascript named $event
Control::dumpJsEvents
Dump Javascript events
Control::getJSWrapperFunction
JS wrapper function that forwards a JS event to the PHP script by submitting the HTML form.
Control::getJSWrapperFunctionName
Get the function name of a JS event wrapper.
Control::getJSWrapperSubmitEventValue
Value set to the hidden field when the specific JS event was fired and the wrapper function was called.
Control::loaded
Control::show
Show control contents
Control::updateParentColor
If ParentColor == true the parent's color is assigned to this control.
Control::updateParentFont
If ParentFont == true the parent's font is assigned to this control.
Control::updateParentProperties
Updates all properties that use the parent property as source.
Control::updateParentShowHint
If ParentShowHint == true the parent's showhint is assigned to this control.

Class: Component

Component::__construct
Constructor
Component::ajaxCall
Returns the js event attribute to call the server using ajax
Component::callEvent
Calls a server event
Component::dumpChildrenHeaderCode
Dump the header code for all the children
Component::dumpChildrenJavascript
Dump the javascript code for all the children
Component::dumpHeaderCode
To dump header code required
Component::dumpHiddenKeyFields
This function dumps out the key fields for the current row, useful to
Component::dumpJavascript
To dump the javascript code needed by this component
Component::fixupProperty
This method returns the right object (or the input string if object not found) for an object name Should be used on the loaded method for object properties to find the right reference
Component::generateAjaxEvent
Returns the js event attribute to call the server using Ajax we use xajax to handle all the ajax stuff.
Component::hasValidDataField
This function returns true if the datafield is valid
Component::init
To initialize a component, the right place to process events
Component::insertComponent
Insert a component into the components collection
Component::loaded
A virtual method to get notified when the object has been fully loaded from a stream
Component::loadedChildren
Calls childrens loaded recursively
Component::loadResource
Load this component from a string
Component::preinit
To initialize a component, called before init()
Component::readAccessibility
Overwrite this method to provide accessibility info for the RPC engine
Component::readFromResource
Read a component from a resource file
Component::removeComponent
Remove a component from the components collection
Component::serializeChildren
Serialize all children
Component::unserializeChildren
Unserialize all children
Component::updateDataField
Checks if there is any datafield attached to the component

Class: Persistent

Persistent::assign
Assing the source properties to this object
Persistent::assignError
Raises an assignation error
Persistent::assignTo
Assign this object to another object
Persistent::serialize
Stores this object into the session, it uses PHP reflection system to get published properties, the ones that will be stored.
Persistent::unserialize
Read this object properties from the session, only published properties will be recovered, components need an owner to be unserialized.

Class: Object

Object::__construct
Constructor
Object::className
Returns the name of the object class
Object::classNameIs
Check if the object is from a specific class
Object::classParent
Returns the parent class of the object
Object::inheritsFrom
Check if the object inherits from a specific class
Object::methodExists
Check if a method exists
Object::readProperty
Reads a property from the streams
Object::__get
To virtualize properties
Object::__set
To virtualize properties

Properties


property ImageList : ImageList [line 563]

Lists the images that can appear beside individual menu items.



Tags:

access:  protected
[ Top ]

property Items : array [line 572]

List of Items associated with the Tree



Tags:

return:  Array of Items
access:  protected
[ Top ]

property ShowLines : boolean [line 581]

Specifies whether to display the lines that link child nodes to their corresponding parent nodes.



Tags:

access:  protected
[ Top ]

property ShowRoot : boolean [line 590]

Specifies whether lines connecting top-level nodes are displayed.



Tags:

access:  protected
[ Top ]


Events



Javascript Events


property OnChangeSelected [line 599]

Triggered when Current selected item is changed



Tags:

access:  protected

Overridden in child classes as:

TreeView::OnChangeSelected()

[ Top ]


Methods


constructor __construct [line 543]

CustomTreeView __construct( [ $aowner = null])



Overrides QWidget::__construct (parent method not documented)

Parameters:

   $aowner  

[ Top ]

void dumpContents [line 493]

void dumpContents( )



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

[ Top ]

void dumpItem [line 458]

void dumpItem( $item, $parent, $level)

Dumps a tree node



Tags:

access:  protected


Parameters:

   $item  
   $parent  
   $level  

[ Top ]

void dumpJsEvents [line 536]

void dumpJsEvents( )



Overrides Control::dumpJsEvents (Dump Javascript events)

[ Top ]

void dumpRow [line 434]

void dumpRow( $item, $level)

Dumps the first row for the items



Tags:

access:  protected


Parameters:

   $item  
   $level  

[ Top ]

void loaded [line 552]

void loaded( )



Overrides Control::loaded (parent method not documented)

[ Top ]



Documentation generated on Tue, 27 Mar 2007 13:33:48 +0200 by phpDocumentor 1.3.1