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'



Property Summary
String
countDataProviderID
This dataprovider's value will be presented as a 'count bubble' in each item of the list.
String
dataIconDataProviderID
The predefined icon of this data-provider will appear on items in the list; if not specified, 'dataIconType' will be used instead.
String
dataIconType
This predefined icon will appear on items in the list if 'dataIconDataProviderID' is not set.
String
listStyleClass
The styleClass of the list.
JSMethod
onAction
This action will be executed when an item in the list is clicked.
String
subtext
This text will appear as the secondary (smaller) text of items in the list if 'subtextDataProviderID' is not set.
String
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.
String
text
This text will appear as the main text of items in the list if 'textDataProviderID' is not set.
String
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.



Method Summary
JSForm
getForm()
Returns the list's form.



Property Details

countDataProviderID

This dataprovider's value will be presented as a 'count bubble' in each item of the list.

Returns

String

Sample

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!");}');
 

dataIconDataProviderID

The predefined icon of this data-provider will appear on items in the list; if not specified, 'dataIconType' will be used instead.

Returns

String

Sample

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!");}');
 

dataIconType

This predefined icon will appear on items in the list if 'dataIconDataProviderID' is not set.

Returns

String

Sample

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!");}');
 

listStyleClass

The styleClass of the list. Can have values from 'a' to 'e'.

Returns

String

Sample

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';
 

onAction

This action will be executed when an item in the list is clicked.

Returns

JSMethod

Sample

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!");}');
 

subtext

This text will appear as the secondary (smaller) text of items in the list if 'subtextDataProviderID' is not set.

Returns

String

Sample

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!");}');
 

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.

Returns

String

Sample

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!");}');
 

text

This text will appear as the main text of items in the list if 'textDataProviderID' is not set.

Returns

String

Sample

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!");}');
 

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.

Returns

String

Sample

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!");}');
 



Method Details

getForm

JSForm
getForm
()
Returns the list's form.

Returns

JSForm - the list's form.

Sample

newFormList.getForm().dataprovider = formList.getForm().dataprovider;