PHP Class Grido\Components\Columns\Editable

Author: Jakub Kopřiva ([email protected])
Author: Petr Bugyík
Inheritance: extends Column
Show file Open project: o5/grido

Protected Properties

Property Type Description
$editable boolean
$editableCallback for custom handling with edited data; function($id, $newValue, $oldValue, Editable $column) }
$editableControl Custom control for inline editing
$editableDisabled boolean
$editableRowCallback for getting row; function($row, Columns\Editable $column) }
$editableValueCallback for custom value; function($row, Columns\Editable $column) }

Public Methods

Method Description
disableEditable ( ) : Editable
getCellPrototype ( mixed $row = NULL ) : Nette\Utils\Html Returns cell prototype ( html tag).
getEditableCallback ( ) : callback
getEditableControl ( ) Returns control for editation.
getEditableRowCallback ( ) : callback
getEditableValueCallback ( ) : callback
getHeaderPrototype ( ) : Nette\Utils\Html Returns header cell prototype ( html tag).
handleEditable ( $id, $newValue, $oldValue )
handleEditableControl ( $value )
isEditable ( ) : boolean
isEditableDisabled ( ) : boolean
setEditable ( callback $callback = NULL, Nette\Forms\IControl $control = NULL ) : Editable Sets column as editable.
setEditableCallback ( callback $callback ) : Editable Sets editable callback.
setEditableControl ( Nette\Forms\IControl $control ) : Editable Sets control for inline editation.
setEditableRowCallback ( callback $callback ) : Editable Sets editable row callback - it's required when used editable collumn with customRenderCallback
setEditableValueCallback ( callback $callback ) : Editable Sets editable value callback.

Protected Methods

Method Description
setClientSideOptions ( )

Method Details

disableEditable() public method

public disableEditable ( ) : Editable
return Editable

getCellPrototype() public method

Returns cell prototype ( html tag).
public getCellPrototype ( mixed $row = NULL ) : Nette\Utils\Html
$row mixed
return Nette\Utils\Html

getEditableCallback() public method

public getEditableCallback ( ) : callback
return callback

getEditableControl() public method

Returns control for editation.
public getEditableControl ( )

getEditableRowCallback() public method

getEditableValueCallback() public method

getHeaderPrototype() public method

Returns header cell prototype ( html tag).
public getHeaderPrototype ( ) : Nette\Utils\Html
return Nette\Utils\Html

handleEditable() public method

public handleEditable ( $id, $newValue, $oldValue )

handleEditableControl() public method

public handleEditableControl ( $value )

isEditable() public method

public isEditable ( ) : boolean
return boolean

isEditableDisabled() public method

public isEditableDisabled ( ) : boolean
return boolean

setClientSideOptions() protected method

protected setClientSideOptions ( )

setEditable() public method

Sets column as editable.
public setEditable ( callback $callback = NULL, Nette\Forms\IControl $control = NULL ) : Editable
$callback callback function($id, $newValue, $oldValue, Columns\Editable $column) }
$control Nette\Forms\IControl
return Editable

setEditableCallback() public method

Sets editable callback.
public setEditableCallback ( callback $callback ) : Editable
$callback callback function($id, $newValue, $oldValue, Columns\Editable $column) }
return Editable

setEditableControl() public method

Sets control for inline editation.
public setEditableControl ( Nette\Forms\IControl $control ) : Editable
$control Nette\Forms\IControl
return Editable

setEditableRowCallback() public method

Sets editable row callback - it's required when used editable collumn with customRenderCallback
public setEditableRowCallback ( callback $callback ) : Editable
$callback callback for getting row; function($id, Columns\Editable $column) }
return Editable

setEditableValueCallback() public method

Sets editable value callback.
public setEditableValueCallback ( callback $callback ) : Editable
$callback callback for custom value; function($row, Columns\Editable $column) }
return Editable

Property Details

$editable protected property

protected bool $editable
return boolean

$editableCallback protected property

for custom handling with edited data; function($id, $newValue, $oldValue, Editable $column) }
protected $editableCallback

$editableControl protected property

Custom control for inline editing
protected $editableControl

$editableDisabled protected property

protected bool $editableDisabled
return boolean

$editableRowCallback protected property

for getting row; function($row, Columns\Editable $column) }
protected $editableRowCallback

$editableValueCallback protected property

for custom value; function($row, Columns\Editable $column) }
protected $editableValueCallback