Class \Prado\Web\UI\WebControls\TEditCommandColumn

TEditCommandColumn class

TEditCommandColumn contains the Edit command buttons for editing data items in each row.

TEditCommandColumn will create an edit button if a cell is not in edit mode. Otherwise an update button and a cancel button will be created within the cell. The button captions are specified using \Prado\Web\UI\WebControls\setEditText, \Prado\Web\UI\WebControls\setUpdateText, and \Prado\Web\UI\WebControls\setCancelText.

The buttons in the column can be set to display as hyperlinks, push or image buttons by setting the \Prado\Web\UI\WebControls\setButtonType property.

When an edit button is clicked, the datagrid will generate an \Prado\Web\UI\WebControls\onEditCommand event. When an update/cancel button is clicked, the datagrid will generate an \Prado\Web\UI\WebControls\onUpdateCommand or an \Prado\Web\UI\WebControls\onCancelCommand You can write these event handlers to change the state of specific datagrid item.

The \Prado\Web\UI\WebControls\setCausesValidation and \Prado\Web\UI\WebControls\setValidationGroup properties affect the corresponding properties of the edit and update buttons. The cancel button does not cause validation by default.

The command buttons in the column can be accessed by one of the following methods:

$datagridItem->ButtonColumnID->EditButton (or UpdateButton, CancelButton)
$datagridItem->ButtonColumnID->Controls[0]

The second method is possible because the button control created within the datagrid cell is the first child.

Class hierarchy

\Prado\Web\UI\WebControls\TEditCommandColumn

\Prado\Web\UI\WebControls\TDataGridColumn

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`getButtonType() : TButtonColumnType`
`public`	`getCancelImageUrl() : string`
`public`	`getCancelText() : string`
`public`	`getCausesValidation() : bool`
`public`	`getEditImageUrl() : string`
`public`	`getEditText() : string`
`public`	`getUpdateImageUrl() : string`
`public`	`getUpdateText() : string`
`public`	`getValidationGroup() : string`
`public`	`initializeCell(TTableCell $cell, int $columnIndex, string $itemType) : mixed` Initializes the specified cell to its initial values. This method overrides the parent implementation. It creates an update and a cancel button for cell in edit mode. Otherwise it creates an edit button.
`public`	`setButtonType(TButtonColumnType $value) : mixed`
`public`	`setCancelImageUrl(string $value) : mixed`
`public`	`setCancelText(string $value) : mixed`
`public`	`setCausesValidation(bool $value) : mixed`
`public`	`setEditImageUrl(string $value) : mixed`
`public`	`setEditText(string $value) : mixed`
`public`	`setUpdateImageUrl(string $value) : mixed`
`public`	`setUpdateText(string $value) : mixed`
`public`	`setValidationGroup(string $value) : mixed`
`protected`	`createButton(string $commandName, string $text, bool $causesValidation, string $validationGroup) : mixed` Creates a button and initializes its properties. The button type is determined by \Prado\Web\UI\WebControls\getButtonType.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAllowSorting, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEnableCellGrouping, getEventHandlers, getFooterRenderer, getFooterStyle, getFooterText, getHeaderImageUrl, getHeaderRenderer, getHeaderStyle, getHeaderText, getID, getItemStyle, getListeningToGlobalEvents, getOwner, getRequest, getResponse, getService, getSession, getSortExpression, getSubProperty, getUser, getVisible, hasEvent, hasEventHandler, hasMethod, hasProperty, initialize, initializeCell, isa, listen, loadState, publishAsset, publishFilePath, raiseEvent, saveState, setEnableCellGrouping, setFooterRenderer, setFooterText, setHeaderImageUrl, setHeaderRenderer, setHeaderText, setID, setOwner, setSortExpression, setSubProperty, setVisible, unlisten, _getZappableSleepProps, formatDataValue, getCallChain, getClassFxEvents, getDataFieldValue, getViewState, initializeCellRendererControl, initializeFooterCell, initializeHeaderCell, instanceBehavior, setViewState, filter_prado_fx

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TEditCommandColumn

Class hierarchy