Child pages
  • JSList

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
{div:style=}
Wiki Markup
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

GENERATOR.

Enter additional information related to this 'class' inside the {div}

{div:

macro with '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}Property Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#countDataProviderID]{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#dataIconDataProviderID]{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#dataIconType]{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#listStyleClass]{td}{tr}{tbody}{tbody}{tr}{td}[JSMethod]{td}{td}[#onAction]{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#subtext]{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#subtextDataProviderID]{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#text]{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#textDataProviderID]{td}{tr}{tbody}{table}\\ {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}[JSForm]{td}{td}[#getForm]\() Returns the list's form.{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=countDataProviderID}{tr:id=name}{td}h6.countDataProviderID{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=dataIconDataProviderID}{tr:id=name}{td}h6.dataIconDataProviderID{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=dataIconType}{tr:id=name}{td}h6.dataIconType{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=listStyleClass}{tr:id=name}{td}h6.listStyleClass{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onAction}{tr:id=name}{td}h6.onAction{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSMethod]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=subtext}{tr:id=name}{td}h6.subtext{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=subtextDataProviderID}{tr:id=name}{td}h6.subtextDataProviderID{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=text}{tr:id=name}{td}h6.text{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=textDataProviderID}{tr:id=name}{td}h6.textDataProviderID{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{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=getForm}{tr:id=name}{td}h6.getForm{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSForm]{span}{span:style=font-weight: bold;}getForm{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSForm] -- the list's form.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

'

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
countDataProviderID
This dataprovider's value will be presented as a 'count bubble' in each item of the list.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
dataIconDataProviderID
The predefined icon of this data-provider will appear on items in the list; if not specified, 'dataIconType' will be used instead.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
dataIconType
This predefined icon will appear on items in the list if 'dataIconDataProviderID' is not set.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
listStyleClass
The styleClass of the list.
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
onAction
This action will be executed when an item in the list is clicked.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
subtext
This text will appear as the secondary (smaller) text of items in the list if 'subtextDataProviderID' is not set.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
subtextDataProviderID
The text of this data-provider will appear as the secondary (smaller) text of items in the list; if not specified, 'subtext' will be used instead.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
text
This text will appear as the main text of items in the list if 'textDataProviderID' is not set.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
textDataProviderID
The text of this data-provider will appear as the main text of items in the list; if not specified, 'text' will be used instead.



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)
JSForm
Table Cell (td)
getForm()
Returns the list's form.



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

countDataProviderID

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
This dataprovider's value will be presented as a 'count bubble' in each item of the list.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var list = solutionModel.getForm('created_by_sm_1').getInsetList(solutionModel.getForm('il1');

var newList = solutionModel.newListForm('created_by_sm_3', list.dataSource, list.textDataProviderID);
newList.onAction = newList.getForm().newMethod('function aMethod(event){application.output("Hello world!");}');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddataIconDataProviderID
Table Row (tr)
idname
Table Cell (td)

dataIconDataProviderID

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The predefined icon of this data-provider will appear on items in the list; if not specified, 'dataIconType' will be used instead.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var list = solutionModel.getForm('created_by_sm_1').getInsetList(solutionModel.getForm('il1');

var newList = solutionModel.newListForm('created_by_sm_3', list.dataSource, list.textDataProviderID);
newList.onAction = newList.getForm().newMethod('function aMethod(event){application.output("Hello world!");}');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddataIconType
Table Row (tr)
idname
Table Cell (td)

dataIconType

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
This predefined icon will appear on items in the list if 'dataIconDataProviderID' is not set.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var list = solutionModel.getForm('created_by_sm_1').getInsetList(solutionModel.getForm('il1');

var newList = solutionModel.newListForm('created_by_sm_3', list.dataSource, list.textDataProviderID);
newList.onAction = newList.getForm().newMethod('function aMethod(event){application.output("Hello world!");}');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idlistStyleClass
Table Row (tr)
idname
Table Cell (td)

listStyleClass

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The styleClass of the list. Can have values from 'a' to 'e'.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var list = solutionModel.getForm('created_by_sm_1').getInsetList('il1');

var newList = solutionModel.newListForm('created_by_sm_3', list.dataSource, list.textDataProviderID);
newList.listStyleClass = 'e';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idonAction
Table Row (tr)
idname
Table Cell (td)

onAction

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
This action will be executed when an item in the list is clicked.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var list = solutionModel.getForm('created_by_sm_1').getInsetList(solutionModel.getForm('il1');

var newList = solutionModel.newListForm('created_by_sm_3', list.dataSource, list.textDataProviderID);
newList.onAction = newList.getForm().newMethod('function aMethod(event){application.output("Hello world!");}');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsubtext
Table Row (tr)
idname
Table Cell (td)

subtext

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
This text will appear as the secondary (smaller) text of items in the list if 'subtextDataProviderID' is not set.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var list = solutionModel.getForm('created_by_sm_1').getInsetList(solutionModel.getForm('il1');

var newList = solutionModel.newListForm('created_by_sm_3', list.dataSource, list.textDataProviderID);
newList.onAction = newList.getForm().newMethod('function aMethod(event){application.output("Hello world!");}');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsubtextDataProviderID
Table Row (tr)
idname
Table Cell (td)

subtextDataProviderID

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The text of this data-provider will appear as the secondary (smaller) text of items in the list; if not specified, 'subtext' will be used instead.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var list = solutionModel.getForm('created_by_sm_1').getInsetList(solutionModel.getForm('il1');

var newList = solutionModel.newListForm('created_by_sm_3', list.dataSource, list.textDataProviderID);
newList.onAction = newList.getForm().newMethod('function aMethod(event){application.output("Hello world!");}');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtext
Table Row (tr)
idname
Table Cell (td)

text

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
This text will appear as the main text of items in the list if 'textDataProviderID' is not set.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var list = solutionModel.getForm('created_by_sm_1').getInsetList(solutionModel.getForm('il1');

var newList = solutionModel.newListForm('created_by_sm_3', list.dataSource, list.textDataProviderID);
newList.onAction = newList.getForm().newMethod('function aMethod(event){application.output("Hello world!");}');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtextDataProviderID
Table Row (tr)
idname
Table Cell (td)

textDataProviderID

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The text of this data-provider will appear as the main text of items in the list; if not specified, 'text' will be used instead.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var list = solutionModel.getForm('created_by_sm_1').getInsetList(solutionModel.getForm('il1');

var newList = solutionModel.newListForm('created_by_sm_3', list.dataSource, list.textDataProviderID);
newList.onAction = newList.getForm().newMethod('function aMethod(event){application.output("Hello world!");}');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 



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)
idgetForm
Table Row (tr)
idname
Table Cell (td)

getForm

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSForm
Span
stylefont-weight: bold;
getForm
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the list's form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSForm - the list's form.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
newFormList.getForm().dataprovider = formList.getForm().dataprovider;
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Table Row (tr)
classlastDetailRow
Table Cell (td)