DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'


Method 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.

Method Details
getRecord
JSRecord
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
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
Number
getRecordIndex
()
Returns the record index of the element that is being rendered.
Returns
Number – record index of the element that is being rendered
Sample
event.getRecordIndex()

getRenderable
Renderable
getRenderable
()
Returns the element that is being rendered.
Returns
Renderable – Renderable the element that is being rendered
Sample
event.getRenderable();

hasFocus
Boolean
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
Sample
event.hasFocus();

isRecordSelected
Boolean
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
Sample
event.isRecordSelected()