Child pages
  • JSRenderEvent

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay:none

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.

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
JSRecord
Table Cell (td)
getRecord()
Returns the record of the element that is being rendered.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getRecordIndex()
Returns the record index of the element that is being rendered.
Table Row (tr)
Table Cell (td)
Renderable
Table Cell (td)
getRenderable()
Returns the element that is being rendered.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
hasFocus()
Returns whether or not the element that is being rendered has focus.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
isRecordSelected()
Returns whatever or not the record of the element that is being rendered is selected.



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idgetRecord
Table Row (tr)
idname
Table Cell (td)

getRecord

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSRecord
Span
stylefont-weight: bold;
getRecord
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSRecord - Record of the element that is being rendered
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// type the record returned from the call with JSDoc, fill in the right server/tablename
/** @type {JSRecord<db:/servername/tablename>} */
var record = event.getRecord();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetRecordIndex
Table Row (tr)
idname
Table Cell (td)

getRecordIndex

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getRecordIndex
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the record index of the element that is being rendered.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - record index of the element that is being rendered
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
event.getRecordIndex()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetRenderable
Table Row (tr)
idname
Table Cell (td)

getRenderable

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Renderable
Span
stylefont-weight: bold;
getRenderable
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the element that is being rendered.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Renderable - Renderable the element that is being rendered
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
event.getRenderable();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idhasFocus
Table Row (tr)
idname
Table Cell (td)

hasFocus

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
hasFocus
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns whether or not the element that is being rendered has focus.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if the element that is being rendered has the focus, false otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
event.hasFocus();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idisRecordSelected
Table Row (tr)
idname
Table Cell (td)

isRecordSelected

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
isRecordSelected
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns whatever or not the record of the element that is being rendered is selected.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if the record of the element that is being rendered is selected
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
event.isRecordSelected()
Table Row (tr)
classlastDetailRow
Table Cell (td)