Child pages
  • JSRenderEvent

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{hidden} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden} {sub-section:description|text=}{sub-section}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[JSRecord]{td}{td}[#getRecord]\() Returns the record of the element that is being rendered.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getRecordIndex]\() Returns the record index of the element that is being rendered.{td}{tr}{tbody}{tbody}{tr}{td}[Renderable]{td}{td}[#getRenderable]\() Returns the element that is being rendered.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#hasFocus]\() Returns whether or not the element that is being rendered has focus.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#isRecordSelected]\() Returns whatever or not the record of the element that is being rendered is selected.{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=getRecord|class=node}{tr:id=name}{td}h6.getRecord{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSRecord]{span}{span:id=iets|style=float: left; font-weight: bold;}getRecord{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getRecord_des|trigger=button|text=}{sub-section}{sub-section:getRecord_des|trigger=none|class=sIndent}
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryReturns the record of the element that is being rendered.Returns the record index of the element that is being rendered.Returns the element that is being rendered.Returns whether or not the element that is being rendered has focus.Returns whatever or not the record of the element that is being rendered is selected.

functionservoy sDetail2100%height:30px2Methods DetailsgetRecordname

getRecord()

dessIndent
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.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getRecord_snc|trigger=button|text=}{sub-section}{sub-section:getRecord_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getRecord_prs|trigger=button|text=}{sub-section}{sub-section:getRecord_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getRecord_ret|trigger=button|text=}{sub-section}{sub-section:getRecord_ret|trigger=none|class=sIndent}[JSRecord] -- Record of the element that is being rendered{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getRecord_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRecord_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getRecord_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRecord_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getRecord_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRecord_sam|trigger=none}{code:language=javascript} // type the record returned from the call with JSDoc, fill in the right server/tablename /** @type {JSRecord<db:/servername/tablename>} */ var record = event.getRecord(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getRecordIndex|class=node}{tr:id=name}{td}h6.getRecordIndex{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getRecordIndex{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getRecordIndex_des|trigger=button|text=}{sub-section}{sub-section:getRecordIndex_des|trigger=none|class=sIndent}
ret

Returns

sIndent Record of the element that is being rendered
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRowgetRecordIndexname

getRecordIndex()

dessIndent
Returns the record index of the element that is being rendered.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getRecordIndex_snc|trigger=button|text=}{sub-section}{sub-section:getRecordIndex_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getRecordIndex_prs|trigger=button|text=}{sub-section}{sub-section:getRecordIndex_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getRecordIndex_ret|trigger=button|text=}{sub-section}{sub-section:getRecordIndex_ret|trigger=none|class=sIndent}[Number] -- record index of the element that is being rendered{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getRecordIndex_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRecordIndex_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getRecordIndex_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRecordIndex_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getRecordIndex_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRecordIndex_sam|trigger=none}{code:language=javascript} event.getRecordIndex() {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getRenderable|class=node}{tr:id=name}{td}h6.getRenderable{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Renderable]{span}{span:id=iets|style=float: left; font-weight: bold;}getRenderable{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getRenderable_des|trigger=button|text=}{sub-section}{sub-section:getRenderable_des|trigger=none|class=sIndent}
ret

Returns

sIndent record index of the element that is being rendered
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRowgetRenderablename

getRenderable()

dessIndent
Returns the element that is being rendered.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getRenderable_snc|trigger=button|text=}{sub-section}{sub-section:getRenderable_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getRenderable_prs|trigger=button|text=}{sub-section}{sub-section:getRenderable_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getRenderable_ret|trigger=button|text=}{sub-section}{sub-section:getRenderable_ret|trigger=none|class=sIndent}[Renderable] -- Renderable the element that is being rendered{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getRenderable_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRenderable_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getRenderable_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRenderable_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getRenderable_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRenderable_sam|trigger=none}{code:language=javascript} event.getRenderable(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=hasFocus|class=node}{tr:id=name}{td}h6.hasFocus{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}hasFocus{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:hasFocus_des|trigger=button|text=}{sub-section}{sub-section:hasFocus_des|trigger=none|class=sIndent}
ret

Returns

sIndent Renderable the element that is being rendered
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRowhasFocusname

hasFocus()

dessIndent
Returns whether or not the element that is being rendered has focus.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:hasFocus_snc|trigger=button|text=}{sub-section}{sub-section:hasFocus_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:hasFocus_prs|trigger=button|text=}{sub-section}{sub-section:hasFocus_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:hasFocus_ret|trigger=button|text=}{sub-section}{sub-section:hasFocus_ret|trigger=none|class=sIndent}[Boolean] -- true if the element that is being rendered has the focus, false otherwise{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:hasFocus_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:hasFocus_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:hasFocus_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:hasFocus_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:hasFocus_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:hasFocus_sam|trigger=none}{code:language=javascript} event.hasFocus(); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isRecordSelected|class=node}{tr:id=name}{td}h6.isRecordSelected{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}isRecordSelected{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:isRecordSelected_des|trigger=button|text=}{sub-section}{sub-section:isRecordSelected_des|trigger=none|class=sIndent}
ret

Returns

sIndent true if the element that is being rendered has the focus, false otherwise
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRowisRecordSelectedname

isRecordSelected()

dessIndent
Returns whatever or not the record of the element that is being rendered is selected.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:isRecordSelected_snc|trigger=button|text=}{sub-section}{sub-section:isRecordSelected_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:isRecordSelected_prs|trigger=button|text=}{sub-section}{sub-section:isRecordSelected_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:isRecordSelected_ret|trigger=button|text=}{sub-section}{sub-section:isRecordSelected_ret|trigger=none|class=sIndent}[Boolean] -- true if the record of the element that is being rendered is selected{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:isRecordSelected_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isRecordSelected_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:isRecordSelected_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isRecordSelected_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:isRecordSelected_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isRecordSelected_sam|trigger=none}{code:language=javascript} event.isRecordSelected() {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
ret

Returns

sIndent true if the record of the element that is being rendered is selected
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow