Child pages
  • JSFooter

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)
Boolean
Table Cell (td)
sticky
Flag to set a set the footer sticky so it will not scroll out of view.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
styleClass
The Cascading Style Sheet (CSS) class name applied to the part.



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)
JSComponent[]
Table Cell (td)
getComponents()
Returns a array of all the IBaseSMComponents that a footer has.
Table Row (tr)
Table Cell (td)
JSButton
Table Cell (td)
newButton(text, x, jsmethod)
Creates a new button on the footer.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeComponent(name)
Removes a named component from the footer.



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

sticky

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Flag to set a set the footer sticky so it will not scroll out of view.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', myDatasource);
var footer = form.newFooter()
footer.sticky = false // default: true
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idstyleClass
Table Row (tr)
idname
Table Cell (td)

styleClass

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The Cascading Style Sheet (CSS) class name applied to the part.
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 body = form.newPart(JSPart.BODY, 320);
body.styleClass = 'myBody';
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)
idgetComponents
Table Row (tr)
idname
Table Cell (td)

getComponents

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSComponent[]
Span
stylefont-weight: bold;
getComponents
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a array of all the IBaseSMComponents that a footer has.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSComponent[] - an array of all the JSComponents on the footer.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm("myForm");
var footer = form.getFooter();
var components = footer.getComponents();
for (var i in components)
	application.output("Component type and name: " + components[i]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewButton-String_Number_JSMethod
Table Row (tr)
idname
Table Cell (td)

newButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSButton
Span
stylefont-weight: bold;
newButton
Span
(text, x, jsmethod)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new button on the footer.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text - the text on the button
{Number} x - the horizontal "x" position of the new element, defines the order of elements on the footer
{JSMethod} jsmethod - the method assigned to handle an onAction event
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSButton - a new JSCalendar element
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('myform')
var footer = form.getForm('myform').newFooter()
footer.newButton('myvar', form.getMethod('doit'));
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveComponent-String
Table Row (tr)
idname
Table Cell (td)

removeComponent

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeComponent
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes a named component from the footer.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the component to remove
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true is the component has been successfully removed; false otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm("myForm");
var footer = form.getFooter();
footer.removeComponent('myfield1')
Table Row (tr)
classlastDetailRow
Table Cell (td)