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

Class: DBGrid

Source Location: /dbgrids.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --Control
            |
            --FocusControl
               |
               --QWidget
                  |
                  --CustomListView
                     |
                     --DBGrid

DBGrid displays and manipulates records from a dataset in a tabular grid.


Author(s):

Variables

Methods


Inherited Variables

Class: Control

Control::$_adjusttolayout
Control::$_align
Control::$_alignment
Control::$_attributes
Control::$_autosize
Control::$_cached
Control::$_caption
Control::$_color
Control::$_controlstyle
Control::$_cursor
Control::$_designcolor
Control::$_divwrap
Control::$_enabled
Control::$_font
Control::$_height
Control::$_hidden
Control::$_hint
Control::$_islayer
Control::$_jsonactivate
Control::$_jsonbeforecopy
Control::$_jsonbeforecut
Control::$_jsonbeforedeactivate
Control::$_jsonbeforeeditfocus
Control::$_jsonbeforepaste
Control::$_jsonblur
Control::$_jsonchange
Control::$_jsonclick
Control::$_jsoncontextmenu
Control::$_jsoncontrolselect
Control::$_jsoncopy
Control::$_jsoncut
Control::$_jsondblclick
Control::$_jsondeactivate
Control::$_jsondrag
Control::$_jsondragenter
Control::$_jsondragleave
Control::$_jsondragover
Control::$_jsondragstart
Control::$_jsondrop
Control::$_jsonfilterchange
Control::$_jsonfocus
Control::$_jsonhelp
Control::$_jsonkeydown
Control::$_jsonkeypress
Control::$_jsonkeyup
Control::$_jsonlosecapture
Control::$_jsonmousedown
Control::$_jsonmouseenter
Control::$_jsonmouseleave
Control::$_jsonmousemove
Control::$_jsonmouseout
Control::$_jsonmouseover
Control::$_jsonmouseup
Control::$_jsonpaste
Control::$_jsonpropertychange
Control::$_jsonreadystatechange
Control::$_jsonresize
Control::$_jsonresizeend
Control::$_jsonresizestart
Control::$_jsonselectstart
Control::$_layer
Control::$_left
Control::$_onaftershow
Control::$_onbeforeshow
Control::$_onshow
Control::$_parent
Control::$_parentcolor
Control::$_parentfont
Control::$_parentshowhint
Control::$_popupmenu
Control::$_showhint
Control::$_style
Control::$_top
Control::$_visible
Control::$_width

Inherited Methods

Class: CustomListView

CustomListView::__construct()
CustomListView::addColumn()
Adds a new column to the ListView.
CustomListView::addItem()
Adds a new item/row to the ListView.
CustomListView::clearSelected()
Removes the selection, leaving all items unselected.
CustomListView::convertPureArrayToColumns()
Converts an array that contains strings into an array with ListColumn objects. convertPureArrayToColumns() is used after unserializing the values set by the object inspector.
CustomListView::convertPureArrayToItems()
Converts a two-dimesional array into an array of ListItem objects.
CustomListView::defaultColumns()
CustomListView::defaultItems()
CustomListView::defaultjsOnSelectionChanged()
CustomListView::defaultOnSubmit()
CustomListView::defaultSelectionType()
CustomListView::defaultSortAscending()
CustomListView::defaultSortColumnIndex()
CustomListView::deleteItem()
Delete an item by it's index.
CustomListView::deleteSelected()
Deletes all the selected items.
CustomListView::dumpContents()
CustomListView::dumpForAjax()
This is an internal method you don't need to call directly
CustomListView::dumpHeaderCode()
CustomListView::dumpJavascript()
CustomListView::dumpJsEvents()
CustomListView::init()
CustomListView::loaded()
CustomListView::readColumns()
Describes the list of ListColumn objects used for the settings of the columns.
CustomListView::readItems()
Contains the list of items displayed by the list view.
CustomListView::readjsOnSelectionChanged()
JS event occurs when the selection of the list view was changed.
CustomListView::readOnSubmit()
Occurs when the form containing the control was submitted.
CustomListView::readSelectionType()
SelectionType defines how the user can select the items in the ListView.
CustomListView::readSortAscending()
Indicates if the sorted column is in ascending order.
CustomListView::readSortColumnIndex()
Indicates the index of the column of the ListView that is sorted.
CustomListView::selectAll()
Selects all items.
CustomListView::unserialize()
CustomListView::updateControl()
Dumps required code to show information, and columns on the listview
CustomListView::writeColumns()
CustomListView::writeItems()
CustomListView::writejsOnSelectionChanged()
CustomListView::writeOnSubmit()
CustomListView::writeSelectionType()
CustomListView::writeSortAscending()
CustomListView::writeSortColumnIndex()

Class: QWidget

QWidget::__construct()
QWidget::addOtherChildren()
Override this method to add more childrens to a qwidget parent, useful if your component is built by more than one component
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()
This function uses PrepareQWJSEvent to dump the attachment for common javascript events
QWidget::dumpCommonQWidgetProperties()
Dumps to the output the code to set common properties, like enabled, font, color, etc.
QWidget::dumpHeaderCode()
QWidget::getHidden()
QWidget::PrepareQWJSEvent()
Dumps code to add an event for the widget
QWidget::setHidden()

Class: FocusControl

FocusControl::__construct()
FocusControl::dumpChildren()
Dumps all children iterating through the Controls property and calls the show method of each one.
FocusControl::readControlCount()
Returns the number of controls for which this control is the Parent.
FocusControl::readLayout()
Specifies the Layout this control uses to render its controls to the browser.
FocusControl::updateChildrenColors()
Updates the colors for all the children if parentcolor is set.
FocusControl::updateChildrenFonts()
If this control has any children that have ParentFont==true, then this function will assign the same Font property to all children Font properties.
FocusControl::updateChildrenParentProperties()
Updates all necessary properties for any children that use property values from their parent.
FocusControl::updateChildrenShowHints()
Updates the ShowHints properties for all children controls.
FocusControl::writeLayout()

Class: Control

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

Class: Component

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

Class: Persistent

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

Class: Object

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

Class Details

[line 85]
DBGrid displays and manipulates records from a dataset in a tabular grid.

Put a DBGrid object on a form to display and edit the records from a database table or query. Applications can use the data grid to insert, delete, or edit data in the database, or simply to display it.

At runtime, users can use the database paginator (DBPaginator) to move through data in the grid, and to insert, delete, and edit the data. Edits that are made in the data grid are not posted to the underlying dataset until the user moves to a different record or closes the application.

DBGrid implements the generic behavior introduced in CustomDBGrid. DBGrid publishes many of the properties inherited from CustomDBGrid, but does not introduce any new behavior.




Tags:

example:  example not found


[ Top ]


Class Variables

$_datasource = null

[line 91]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_fixedcolumns = 0

[line 767]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsondatachanged = null

[line 699]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonrowchanged = null

[line 732]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonrowsaved = null

[line 715]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_readonly = 0

[line 98]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 116]

DBGrid __construct( [ $aowner = null])



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

Parameters:

   $aowner  

[ Top ]

method commonScript [line 794]

void commonScript( )

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

It dumps the common javascript code to update the control if used inside an Ajax call




Tags:



[ Top ]

method createTableModel [line 328]

void createTableModel( )

Creates the DBGrid Table Model

This method is used to generate the qooxdoo code to create the table model required to build the grid.

You don't need to call this method directly.




Tags:



[ Top ]

method defaultFixedColumns [line 781]

void defaultFixedColumns( )



[ Top ]

method defaultjsOnDataChanged [line 713]

void defaultjsOnDataChanged( )



[ Top ]

method defaultjsOnOnRowChanged [line 747]

void defaultjsOnOnRowChanged( )



[ Top ]

method defaultjsOnOnRowSaved [line 730]

void defaultjsOnOnRowSaved( )



[ Top ]

method defaultReadOnly [line 112]

void defaultReadOnly( )



[ Top ]

method dumpContents [line 952]

void dumpContents( )



Overrides CustomListView::dumpContents() (parent method not documented)

[ Top ]

method dumpForAjax [line 1002]

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




Tags:



Overrides CustomListView::dumpForAjax() (This is an internal method you don't need to call directly)

[ Top ]

method dumpHeaderCode [line 594]

void dumpHeaderCode( )



Overrides CustomListView::dumpHeaderCode() (parent method not documented)

[ Top ]

method dumpJsEvents [line 759]

void dumpJsEvents( )

Dump Javascript events



Overrides CustomListView::dumpJsEvents() (parent method not documented)

[ Top ]

method dumpRPC [line 250]

void dumpRPC( )

Dump javascript code to attach the updateRow method to the grid using ajax

This method is used by the component to generate the required code to allow the dbgrid to update contents on the server. It uses the qooxdoo RPC engine to make all this work.

You don't need to call this method directly.




Tags:



[ Top ]

method getColumns [line 94]

void getColumns( )



[ Top ]

method getDataSource [line 687]

Datasource getDataSource( )

DataSource property allows you to link this control to a dataset containing rows of data.

To make it work, you must also assign DataField property with the name of the column you want to use




[ Top ]

method getFixedColumns [line 779]

integer getFixedColumns( )

Specifies the number of columns on the left of the grid that cannot be scrolled.

Set FixedColumns to create or get rid of nonscrolling columns. Nonscrolling columns appear at the left of the grid, and are always visible, even when the user scrolls the other columns in the grid. Use nonscrolling columns for displaying row titles or row numbers, or to implement a scroll lock that the user can set.




[ Top ]

method getjsOnClick [line 749]

void getjsOnClick( )



[ Top ]

method getjsOnDataChanged [line 711]

mixed getjsOnDataChanged( )

This event is fired whenever the contents of a cell is changed

Use this event to get notified whenever a cell value is changed, so you can react to this event.




Tags:



[ Top ]

method getjsOnDblClick [line 752]

void getjsOnDblClick( )



[ Top ]

method getjsOnRowChanged [line 745]

mixed getjsOnRowChanged( )

This event is fired whenever the active row is changed

Use this event to get notified whenever the user changes the active or selected row on the dbgrid. This event is useful to update another controls depending on the dbgrid selection.




Tags:



[ Top ]

method getjsOnRowSaved [line 728]

mixed getjsOnRowSaved( )

This event is fired whenever the contents of a row are saved

Once the DBGrid sends the signal to the server to update a row on the attached table, when it returns back to the javascript, you can get notified the row has been saved using this event.




Tags:



[ Top ]

method getReadOnly [line 110]

boolean getReadOnly( )

Indicates whether the grid is used for display only, or whether the user can edit data using the grid.

Set ReadOnly to true to prevent users from changing the data in the dataset. Set ReadOnly to false to allow users to edit data using the grid.

When ReadOnly is true, users cannot edit information on the grid.




[ Top ]

method getVisible [line 88]

void getVisible( )



[ Top ]

method init [line 126]

void init( )



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

[ Top ]

method loaded [line 693]

void loaded( )



Overrides CustomListView::loaded() (parent method not documented)

[ Top ]

method readAccessibility [line 147]

integer readAccessibility( string $method, $defaccessibility, integer $defaccesibility)

To give permission to execute certain methods



Overrides Component::readAccessibility() (Provides accessibility info to the embedded RPC engine.)

Parameters:

string   $method   Method for which we want to know the accessibility
integer   $defaccesibility   If the method is not found, this will be returned
   $defaccessibility  

[ Top ]

method setColumns [line 95]

void setColumns( $value)



Parameters:

   $value  

[ Top ]

method setDataSource [line 688]

void setDataSource( $value)



Parameters:

   $value  

[ Top ]

method setFixedColumns [line 780]

void setFixedColumns( $value)



Parameters:

   $value  

[ Top ]

method setjsOnClick [line 750]

void setjsOnClick( $value)



Parameters:

   $value  

[ Top ]

method setjsOnDataChanged [line 712]

void setjsOnDataChanged( $value)



Parameters:

   $value  

[ Top ]

method setjsOnDblClick [line 753]

void setjsOnDblClick( $value)



Parameters:

   $value  

[ Top ]

method setjsOnRowChanged [line 746]

void setjsOnRowChanged( $value)



Parameters:

   $value  

[ Top ]

method setjsOnRowSaved [line 729]

void setjsOnRowSaved( $value)



Parameters:

   $value  

[ Top ]

method setReadOnly [line 111]

void setReadOnly( $value)



Parameters:

   $value  

[ Top ]

method setVisible [line 89]

void setVisible( $value)



Parameters:

   $value  

[ Top ]

method unserialize [line 134]

void unserialize( )



Overrides CustomListView::unserialize() (parent method not documented)

[ Top ]

method updateControl [line 354]

void updateControl( )

Dumps required code to show information, and columns on the grid

This is an internal method used by the component to generate all columns and rows required to build up the control.

You don't need to call this method directly.




Tags:



Overrides CustomListView::updateControl() (Dumps required code to show information, and columns on the listview)

[ Top ]

method updateRow [line 169]

mixed updateRow( array $params, object $error)

Updates a row of the attached datasource->dataset.

This method is called everytime the user changes a row on the dbgrid to update the same row on the attached table.




Tags:



Parameters:

array   $params   Array of parameters to this method
object   $error   RPC Error object to return if anything goes wrong

[ Top ]


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