JSRenderEvent

Mar 16, 2023 06:40

Supported Clients
SmartClient WebClient

Methods Summary
JSRecord	getRecord()	Returns the record of the element that is being rendered.
Number	getRecordIndex()	Returns the record index of the element that is being rendered.
Renderable	getRenderable()	Returns the element that is being rendered.
Boolean	hasFocus()	Returns whether or not the element that is being rendered has focus.
Boolean	isRecordSelected()	Returns whatever or not the record of the element that is being rendered is selected.

Methods Details
getRecord()
Returns the record of the element that is being rendered. This is null for elements of type form when they are in table view mode.
Returns JSRecord Record of the element that is being rendered
Supported Clients SmartClient,WebClient
Sample // type the record returned from the call with JSDoc, fill in the right server/tablename /** @type {JSRecord<db:/servername/tablename>} */ var record = event.getRecord();

getRecordIndex()
Returns the record index of the element that is being rendered.
Returns Number record index of the element that is being rendered
Supported Clients SmartClient,WebClient
Sample event.getRecordIndex()

getRenderable()
Returns the element that is being rendered.
Returns Renderable Renderable the element that is being rendered
Supported Clients SmartClient,WebClient
Sample event.getRenderable();

hasFocus()
Returns whether or not the element that is being rendered has focus.
Returns Boolean true if the element that is being rendered has the focus, false otherwise
Supported Clients SmartClient,WebClient
Sample event.hasFocus();

isRecordSelected()
Returns whatever or not the record of the element that is being rendered is selected.
Returns Boolean true if the record of the element that is being rendered is selected
Supported Clients SmartClient,WebClient
Sample event.isRecordSelected()