Docs For Class atkDGEvent

POST_LOAD	Event will be triggered at the end of the call to atkDataGrid::loadRecords, after the records are loaded.
POST_RENDER	Event will be triggered at the end of the call to atkDataGrid::render, after all component and the grid itself have been rendered.
PRE_LOAD	Event will be triggered at the start of the call to atkDataGrid::loadRecords, before the records are loaded.
PRE_RENDER	Event will be triggered at the start of the call to atkDataGrid::render, before the grid or any of it's components have been rendered.

[ Top ]

Property Summary

int	$m_event	Event identifier.
atkDataGrid	$m_grid	Grid.

[ Top ]

Method Summary

atkDGEvent	__construct()	Constructs a new event
string	getEvent()	Returns the event identifier.
atkDataGrid	getGrid()	Returns the grid for this event.

[ Top ]

Properties

int $m_event [line 64]

Event identifier.

API Tags:

Access:

private

[ Top ]

atkDataGrid $m_grid [line 57]

Grid.

API Tags:

Access:

private

[ Top ]

Methods

Constructor __construct [line 72]

atkDGEvent __construct(
atkDataGrid
$grid, string
$event 
)

Constructs a new event

Parameters:

atkDataGrid	$grid:	grid
string	$event:	event identifier

API Tags:

Access:

public

[ Top ]

getEvent [line 93]

string getEvent(
)

Returns the event identifier.

API Tags:

Return:	event
Access:	public

[ Top ]

getGrid [line 83]

atkDataGrid getGrid(
)

Returns the grid for this event.

API Tags:

Return:	grid
Access:	public

[ Top ]

Constants

POST_LOAD = "postLoad" [line 50]

Event will be triggered at the end of the call to atkDataGrid::loadRecords, after the records are loaded.

[ Top ]

POST_RENDER = "postRender" [line 38]

Event will be triggered at the end of the call to atkDataGrid::render, after all component and the grid itself have been rendered.

[ Top ]

PRE_LOAD = "preLoad" [line 44]

Event will be triggered at the start of the call to atkDataGrid::loadRecords, before the records are loaded.

[ Top ]

PRE_RENDER = "preRender" [line 32]

Event will be triggered at the start of the call to atkDataGrid::render, before the grid or any of it's components have been rendered.

[ Top ]