Child pages
  • JSRenderEvent

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Wiki Markup
{div:style=display: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.\\		\\		Enter additional information related to this 'class' inside the \{div} macro with 'id=description'{div}
{div:id=description}{div}\\ 

{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}{tr:id=name}{td}h6.getRecord{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSRecord]{span}{span:style=font-weight: bold;}getRecord{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSRecord] -- Record of the element that is being rendered{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{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}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getRecordIndex}{tr:id=name}{td}h6.getRecordIndex{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getRecordIndex{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the record index of the element that is being rendered.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- record index of the element that is being rendered{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
event.getRecordIndex()
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getRenderable}{tr:id=name}{td}h6.getRenderable{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Renderable]{span}{span:style=font-weight: bold;}getRenderable{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the element that is being rendered.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Renderable] -- Renderable the element that is being rendered{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
event.getRenderable();
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=hasFocus}{tr:id=name}{td}h6.hasFocus{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}hasFocus{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns whether or not the element that is being rendered has focus.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if the element that is being rendered has the focus, false otherwise{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
event.hasFocus();
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isRecordSelected}{tr:id=name}{td}h6.isRecordSelected{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}isRecordSelected{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns whatever or not the record of the element that is being rendered is selected.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if the record of the element that is being rendered is selected{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
event.isRecordSelected()
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}