Child pages
  • JSMethod

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Rev: 1381948887907

...

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#codecode
The full source code of this method (including doc and function declaration).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#showInMenushowInMenu
Flag that tells if the method appears or not in the "Methods" menu of Servoy Client.

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Object[]
Table Cell (td)
#getArgumentsgetArguments()
Gets the argument array for this method if that is set for the specific action this method is taken from.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getNamegetName()
The name of the method.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getScopeNamegetScopeName()
Get scope name
Table Body (tbody)
Table Row (tr)
Table Cell (td)
UUID
Table Cell (td)
#getUUIDgetUUID()
Returns the UUID of the method object

HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
idcode
Table Row (tr)
idname
Table Cell (td)
code
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The full source code of this method (including doc and function declaration).
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 method = form.newMethod('function original() { application.output("Original function."); }');
application.output('original method name: ' + method.getName());
application.output('original method code: ' + method.code);
method.code = 'function changed() { application.output("This is another function."); }';
method.showInMenu = false;
var button = form.newButton('Click me!', 10, 10, 100, 30, method);

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idshowInMenu
Table Row (tr)
idname
Table Cell (td)
showInMenu
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Flag that tells if the method appears or not in the "Methods" menu of Servoy Client.
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 method = form.newMethod('function original() { application.output("Original function."); }');
application.output('original method name: ' + method.getName());
application.output('original method code: ' + method.code);
method.code = 'function changed() { application.output("This is another function."); }';
method.showInMenu = false;
var button = form.newButton('Click me!', 10, 10, 100, 30, method);

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idgetArguments
Table Row (tr)
idname
Table Cell (td)
getArguments
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object[]
Span
stylefont-weight: bold;
getArguments
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the argument array for this method if that is set for the specific action this method is taken from.
Will return null by default. This is only for reading, you can't alter the arguments through this array,
for that you need to create a new object through solutionModel.wrapMethodWithArguments(..) and assign it again.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Object[]

...

- Array of the arguments, null if not specified.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var frm = solutionModel.getForm("myForm");
var button = frm.getButton("button");
// get the arguments from the button.
// NOTE: string arguments will be returned with quotes (comp.onAction.getArguments()[0] == '\'foo\' evals to true)
var arguments = button.onAction.getArguments();
if (arguments && arguments.length > 1 && arguments[1] == 10) {

...

	// change the value and assign it back to the onAction.
	arguments[1] = 50;
	button.onAction = solutionModel.wrapMethodWithArguments(button.onAction,arguments);
}

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetName
Table Row (tr)
idname
Table Cell (td)
getName
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the method.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String

...

- A String holding the name of this method.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var method = form.newMethod('function original() { application.output("Original function."); }');
application.output('original method name: ' + method.getName());
application.output('original method code: ' + method.code);
method.code = 'function changed() { application.output("This is another function."); }';
method.showInMenu = false;
var button = form.newButton('Click me!', 10, 10, 100, 30, method);

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetScopeName
Table Row (tr)
idname
Table Cell (td)
getScopeName
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getScopeName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get scope name
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 methods = solutionModel.getGlobalMethods();

...


for (var x in methods)

...

	application.output(methods[x].getName() + ' is defined in scope ' + methods[x].getScopeName());

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetUUID
Table Row (tr)
idname
Table Cell (td)
getUUID
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
UUID
Span
stylefont-weight: bold;
getUUID
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the UUID of the method object
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
UUID
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var method = form.newMethod('function original() { application.output("Original function."); }');
application.output(method.getUUID().toString());

...

Table Row (tr)
classlastDetailRow
Table Cell (td)