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



Method Summary
JSComponent[]
getComponents()
Returns a array of all the IBaseSMComponents that a footer has.
JSButton
newButton(text, x, jsmethod)
Creates a new button on the footer.
Boolean
removeComponent(name)
Removes a named component from the footer.



Property Details

sticky

Flag to set a set the footer sticky so it will not scroll out of view.

Returns

Boolean

Sample

var form = solutionModel.newForm('newForm1', myDatasource);
var footer = form.newFooter()
footer.sticky = false // default: true
 

styleClass

The Cascading Style Sheet (CSS) class name applied to the part.

Returns

String

Sample

var body = form.newPart(JSPart.BODY, 320);
body.styleClass = 'myBody';
 



Method Details

getComponents

JSComponent[]
getComponents
()
Returns a array of all the IBaseSMComponents that a footer has.

Returns

JSComponent[] - an array of all the JSComponents on the footer.

Sample

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]);
 

newButton

JSButton
newButton
(text, x, jsmethod)
Creates a new button on the footer.

Parameters

{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

Returns

JSButton - a new JSCalendar element

Sample

var form = solutionModel.getForm('myform')
var footer = form.getForm('myform').newFooter()
footer.newButton('myvar', form.getMethod('doit'));
forms['newForm1'].controller.show();
 

removeComponent

Boolean
removeComponent
(name)
Removes a named component from the footer.

Parameters

{String} name - the specified name of the component to remove

Returns

Boolean - true is the component has been successfully removed; false otherwise

Sample

var form = solutionModel.getForm("myForm");
var footer = form.getFooter();
footer.removeComponent('myfield1')