Child pages
  • JSInsetList

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
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.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

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)
headerDataProviderID
The text of this data-provider will appear on top of the inset list; if not specified, 'headerText' will be used instead.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
headerStyleClass
The styleClass of the list header.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
headerText
This text will appear on top of the inset list if 'headerDataProviderID' 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)
String
Table Cell (td)
name
The name of this inset 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)
relationName
Name of the relation to be used by the inset list.
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.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
x
The x coordinate of the component on the form.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
y
The y coordinate of the component on the 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)
idheaderDataProviderID
Table Row (tr)
idname
Table Cell (td)

headerDataProviderID

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The text of this data-provider will appear on top of the inset list; if not specified, 'headerText' 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 insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idheaderStyleClass
Table Row (tr)
idname
Table Cell (td)

headerStyleClass

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The styleClass of the list header. 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 newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.headerStyleClass = 'e';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idheaderText
Table Row (tr)
idname
Table Cell (td)

headerText

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
This text will appear on top of the inset list if 'headerDataProviderID' 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 insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';
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)
idname
Table Row (tr)
idname
Table Cell (td)

name

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of this inset 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 insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';
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)
idrelationName
Table Row (tr)
idname
Table Cell (td)

relationName

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Name of the relation to be used by the inset 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 insetList = jsform.getInsetList('il1');

var newInsetList = jsform.newInsetList(8,insetList.dataSource,insetList.relationName,insetList.headerText,insetList.textDataProviderID);
newInsetList.name = 'il2';
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)
 
Table Body (tbody)
idx
Table Row (tr)
idname
Table Cell (td)

x

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The x coordinate of the component on the form.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
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);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idy
Table Row (tr)
idname
Table Cell (td)

y

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The y coordinate of the component on the form.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
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);
Table Row (tr)
classlastDetailRow
Table Cell (td)