publish
plugins.it2be_progress info


Servoy Properties Summary
String build
Date buildDate
String component
String licensee
String typeLicensed
Number version
String versionLicensed


Servoy Methods Summary
IPButton button( )
IPDialog dialog( )
void executeMethod( Function, Array<Object> )
void executeMethod( Function )
Boolean register( String )
void showWaitcursor( Boolean )


Servoy Properties Details


build
String  build
Returns the current version (major, minor, build)
Returns
String  build String

Supported Clients
SmartClient


buildDate
Date  buildDate
Returns date release date
Returns
Date  date Date

Supported Clients
SmartClient


component
String  component
Returns the component name
Returns
String  name String

Supported Clients
SmartClient


licensee
String  licensee
Returns the licensee
Returns
String  licensee String

Supported Clients
SmartClient


typeLicensed
String  typeLicensed
Returns the type that is valid for this license
Returns
String  type String

Supported Clients
SmartClient


version
Number  version
Returns the current version (major, minor)
Returns
Number  version Double

Supported Clients
SmartClient


versionLicensed
String  versionLicensed
Returns the version that is valid for this license
Returns
String  license String

Supported Clients
SmartClient

Servoy Methods Details


button
IPButton  button( )
Create a button for the Progress dialog.
Returns
IPButton  button IPButton

Supported Clients
SmartClient

Sample
// Run a plain dialog with no added buttons
// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// Configure how you would like the Progress to be presented to and controlled by the user
// See tooltips for default settings
dialog.min = 250;
dialog.max = 350;
dialog.name = "Progress demo";
dialog.completionMessage = "Progress without buttons is complete.";
dialog.displaysPercentage = true;

// Show a wait cursor on the dialog and the main window
dialog.showWaitcursor = true;

// Make sure the progress bar starts at the first value (only necessary when minimum is set beyond 0)
dialog.setValue(dialog.min);

// Start the progress before we start our Servoy work
dialog.start();

// We cannot change any progress atributes after we invoke start()

// The work itself must take place in another method for UI thread reasons
// this MUST be the last statement in this Servoy Method
var array = new Array(dialog.min, dialog.max, dialog);

// The arguments we pass to the Servoy method are the min, max, and the progress instance itself
// The monitored method will work just like any other Servoy Method with this next call
plugins.it2be_progress.executeMethod(execute_job, array);


dialog
IPDialog  dialog( )
Create a Progress dialog.
Returns
IPDialog  dialog IPDialog

Supported Clients
SmartClient

Sample
// Run a plain dialog with no added buttons
// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// Configure how you would like the Progress to be presented to and controlled by the user
// See tooltips for default settings
dialog.min = 250;
dialog.max = 350;
dialog.name = "Progress demo";
dialog.completionMessage = "Progress without buttons is complete.";
dialog.displaysPercentage = true;

// Show a wait cursor on the dialog and the main window
dialog.showWaitcursor = true;

// Make sure the progress bar starts at the first value (only necessary when minimum is set beyond 0)
dialog.setValue(dialog.min);

// Start the progress before we start our Servoy work
dialog.start();

// We cannot change any progress atributes after we invoke start()

// The work itself must take place in another method for UI thread reasons
// this MUST be the last statement in this Servoy Method
var array = new Array(dialog.min, dialog.max, dialog);

// The arguments we pass to the Servoy method are the min, max, and the progress instance itself
// The monitored method will work just like any other Servoy Method with this next call
plugins.it2be_progress.executeMethod(execute_job, array);


executeMethod
void  executeMethod( Function, Array<Object> )
Execute the callback method (with optional arguments) using the Progress dialog facilities.
Parameters
Function  method  the method
Array<Object>  arguments  the arguments

Returns
void  

Supported Clients
SmartClient

Sample
// Run a plain dialog with no added buttons
// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// Configure how you would like the Progress to be presented to and controlled by the user
// See tooltips for default settings
dialog.min = 250;
dialog.max = 350;
dialog.name = "Progress demo";
dialog.completionMessage = "Progress without buttons is complete.";
dialog.displaysPercentage = true;

// Show a wait cursor on the dialog and the main window
dialog.showWaitcursor = true;

// Make sure the progress bar starts at the first value (only necessary when minimum is set beyond 0)
dialog.setValue(dialog.min);

// Start the progress before we start our Servoy work
dialog.start();

// We cannot change any progress atributes after we invoke start()

// The work itself must take place in another method for UI thread reasons
// this MUST be the last statement in this Servoy Method
var array = new Array(dialog.min, dialog.max, dialog);

// The arguments we pass to the Servoy method are the min, max, and the progress instance itself
// The monitored method will work just like any other Servoy Method with this next call
plugins.it2be_progress.executeMethod(execute_job, array);


executeMethod
void  executeMethod( Function )
Execute the callback method (with optional arguments) using the Progress dialog facilities.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient

Sample
// Run a plain dialog with no added buttons
// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// Configure how you would like the Progress to be presented to and controlled by the user
// See tooltips for default settings
dialog.min = 250;
dialog.max = 350;
dialog.name = "Progress demo";
dialog.completionMessage = "Progress without buttons is complete.";
dialog.displaysPercentage = true;

// Show a wait cursor on the dialog and the main window
dialog.showWaitcursor = true;

// Make sure the progress bar starts at the first value (only necessary when minimum is set beyond 0)
dialog.setValue(dialog.min);

// Start the progress before we start our Servoy work
dialog.start();

// We cannot change any progress atributes after we invoke start()

// The work itself must take place in another method for UI thread reasons
// this MUST be the last statement in this Servoy Method
var array = new Array(dialog.min, dialog.max, dialog);

// The arguments we pass to the Servoy method are the min, max, and the progress instance itself
// The monitored method will work just like any other Servoy Method with this next call
plugins.it2be_progress.executeMethod(execute_job, array);


register
Boolean  register( String )
Register your runtime license (use the Components Manager to request your license string)
Parameters
String  license  the license

Returns
Boolean  result boolean

Supported Clients
SmartClient

Sample
// You have to register your plug-in(s) and beans before you start using them
// One way to do so is create an 'onOpenSolution' method and add the 'register(.)' method(s) there
plugins.it2be_progress.register("Insert the license string(s) from your '*_runtime_license.txt' file here!");


showWaitcursor
void  showWaitcursor( Boolean )
Show/hide the wait cursor 'attached' to the main window.
Parameters
Boolean  show  the show

Returns
void  

Supported Clients
SmartClient

Sample
// Run a plain dialog with no added buttons
// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// Configure how you would like the Progress to be presented to and controlled by the user
// See tooltips for default settings
dialog.min = 250;
dialog.max = 350;
dialog.name = "Progress demo";
dialog.completionMessage = "Progress without buttons is complete.";
dialog.displaysPercentage = true;

// Show a wait cursor on the dialog and the main window
dialog.showWaitcursor = true;

// Make sure the progress bar starts at the first value (only necessary when minimum is set beyond 0)
dialog.setValue(dialog.min);

// Start the progress before we start our Servoy work
dialog.start();

// We cannot change any progress atributes after we invoke start()

// The work itself must take place in another method for UI thread reasons
// this MUST be the last statement in this Servoy Method
var array = new Array(dialog.min, dialog.max, dialog);

// The arguments we pass to the Servoy method are the min, max, and the progress instance itself
// The monitored method will work just like any other Servoy Method with this next call
plugins.it2be_progress.executeMethod(execute_job, array);