View Source

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

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

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

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

headerDataProviderID
The text of this data-provider will appear on top of the inset list; if not specified, 'headerText' will be used instead.

headerStyleClass
The styleClass of the list header.

headerText
This text will appear on top of the inset list if 'headerDataProviderID' is not set.

listStyleClass
The styleClass of the list.

name
The name of this inset list.

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

relationName
Name of the relation to be used by the inset list.

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

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.

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

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.

x
The x coordinate of the component on the form.

y
The y coordinate of the component on the form.

Property Details

countDataProviderID

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

Returns

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

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

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

headerDataProviderID

The text of this data-provider will appear on top of the inset list; if not specified, 'headerText' will be used instead.

Returns

Sample

var insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';

headerStyleClass

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

Returns

Sample

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.headerStyleClass = 'e';

headerText

This text will appear on top of the inset list if 'headerDataProviderID' is not set.

Returns

Sample

var insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';

listStyleClass

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

Returns

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

name

The name of this inset list.

Returns

Sample

var insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';

onAction

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

Returns

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

relationName

Name of the relation to be used by the inset list.

Returns

Sample

var insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';

subtext

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

Returns

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

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

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

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

x

The x coordinate of the component on the form.

Returns

Sample

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.x = 90;
newInsetList.y = 90;
application.output('location of newInsetList: ' + newInsetList.x + ', ' + newInsetList.y);

y

The y coordinate of the component on the form.

Returns

Sample

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.x = 90;
newInsetList.y = 90;
application.output('location of newInsetList: ' + newInsetList.x + ', ' + newInsetList.y);