background
String  background

Get/Set the background color.

Returns
String  color String

Supported Clients
SmartClient

Sample

// Add a Cancel button which fires another Servoy method
var cancelButton = plugins.it2be_progress.button();

// Do you want this button to fire a Servoy method ?
cancelButton.setMethod(show_feedback);

// Does clicking this button lead to a cancellation of the progress ?
cancelButton.cancelsProgressOperation = true;

// Give this button a label
cancelButton.label = "Cancel";

// The message to show when this button is clicked
cancelButton.messageOnClick = "Are you sure you want to cancel this operation?";

// Should the user be prompted with a confirmation dialog after clicking this button ?
cancelButton.requiresUserConfirmation = true;

// Add another button that 'simply' fires another Servoy method
var messageButton = plugins.it2be_progress.button();

// Do you want to this button to fire a Servoy method ?
messageButton.setMethod(show_feedback);

// Set the label text for the button
messageButton.label = "Fire Servoy Method.";

// The message to show when this button is clicked
messageButton.messageOnClick = "The message to display when the user clicks the button";

// Should the user be prompted with a dialog after clicking this button ?
messageButton.requiresUserConfirmation = true;

// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// When you want to add a text above the progress bar this is the way to do so
dialog.text = "This is the message for the dialog


       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
         With html formatting. 
       "

// Add an icon to the dialog (top-left)
dialog.setIcon("media:// /yourimage.gif");

// configure how you would like the Progress to be presented to and controlled by the user
// Set minimum value of the progress bar, default = 0
dialog.min = 0;
// Set maximum value of the progress bar, default = 100
dialog.max = 100;
// Set the resizable state of the dialog, default = false
dialog.resizable = true;

// add the first button
dialog.addButton(cancelButton);

// insert a spacer
dialog.addSpacer(30, "#ffffff");

// add the second button
dialog.addButton(messageButton);

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

cancelsProgressOperation
Boolean  cancelsProgressOperation

Get/Set the button is for cancelling the operation (default = false).

Returns
Boolean  cancels boolean

Supported Clients
SmartClient

Sample

// Add a Cancel button which fires another Servoy method
var cancelButton = plugins.it2be_progress.button();

// Do you want this button to fire a Servoy method ?
cancelButton.setMethod(show_feedback);

// Does clicking this button lead to a cancellation of the progress ?
cancelButton.cancelsProgressOperation = true;

// Give this button a label
cancelButton.label = "Cancel";

// The message to show when this button is clicked
cancelButton.messageOnClick = "Are you sure you want to cancel this operation?";

// Should the user be prompted with a confirmation dialog after clicking this button ?
cancelButton.requiresUserConfirmation = true;

// Add another button that 'simply' fires another Servoy method
var messageButton = plugins.it2be_progress.button();

// Do you want to this button to fire a Servoy method ?
messageButton.setMethod(show_feedback);

// Set the label text for the button
messageButton.label = "Fire Servoy Method.";

// The message to show when this button is clicked
messageButton.messageOnClick = "The message to display when the user clicks the button";

// Should the user be prompted with a dialog after clicking this button ?
messageButton.requiresUserConfirmation = true;

// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// When you want to add a text above the progress bar this is the way to do so
dialog.text = "This is the message for the dialog


       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
         With html formatting. 
       "

// Add an icon to the dialog (top-left)
dialog.setIcon("media:// /yourimage.gif");

// configure how you would like the Progress to be presented to and controlled by the user
// Set minimum value of the progress bar, default = 0
dialog.min = 0;
// Set maximum value of the progress bar, default = 100
dialog.max = 100;
// Set the resizable state of the dialog, default = false
dialog.resizable = true;

// add the first button
dialog.addButton(cancelButton);

// insert a spacer
dialog.addSpacer(30, "#ffffff");

// add the second button
dialog.addButton(messageButton);

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

foreground
String  foreground

Get/Set the foreground color.

Returns
String  color String

Supported Clients
SmartClient

Sample

// Add a Cancel button which fires another Servoy method
var cancelButton = plugins.it2be_progress.button();

// Do you want this button to fire a Servoy method ?
cancelButton.setMethod(show_feedback);

// Does clicking this button lead to a cancellation of the progress ?
cancelButton.cancelsProgressOperation = true;

// Give this button a label
cancelButton.label = "Cancel";

// The message to show when this button is clicked
cancelButton.messageOnClick = "Are you sure you want to cancel this operation?";

// Should the user be prompted with a confirmation dialog after clicking this button ?
cancelButton.requiresUserConfirmation = true;

// Add another button that 'simply' fires another Servoy method
var messageButton = plugins.it2be_progress.button();

// Do you want to this button to fire a Servoy method ?
messageButton.setMethod(show_feedback);

// Set the label text for the button
messageButton.label = "Fire Servoy Method.";

// The message to show when this button is clicked
messageButton.messageOnClick = "The message to display when the user clicks the button";

// Should the user be prompted with a dialog after clicking this button ?
messageButton.requiresUserConfirmation = true;

// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// When you want to add a text above the progress bar this is the way to do so
dialog.text = "This is the message for the dialog


       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
         With html formatting. 
       "

// Add an icon to the dialog (top-left)
dialog.setIcon("media:// /yourimage.gif");

// configure how you would like the Progress to be presented to and controlled by the user
// Set minimum value of the progress bar, default = 0
dialog.min = 0;
// Set maximum value of the progress bar, default = 100
dialog.max = 100;
// Set the resizable state of the dialog, default = false
dialog.resizable = true;

// add the first button
dialog.addButton(cancelButton);

// insert a spacer
dialog.addSpacer(30, "#ffffff");

// add the second button
dialog.addButton(messageButton);

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

label
String  label

Get/Set the label text (default = 'Press me'.

Returns
String  label String

Supported Clients
SmartClient

Sample

// Add a Cancel button which fires another Servoy method
var cancelButton = plugins.it2be_progress.button();

// Do you want this button to fire a Servoy method ?
cancelButton.setMethod(show_feedback);

// Does clicking this button lead to a cancellation of the progress ?
cancelButton.cancelsProgressOperation = true;

// Give this button a label
cancelButton.label = "Cancel";

// The message to show when this button is clicked
cancelButton.messageOnClick = "Are you sure you want to cancel this operation?";

// Should the user be prompted with a confirmation dialog after clicking this button ?
cancelButton.requiresUserConfirmation = true;

// Add another button that 'simply' fires another Servoy method
var messageButton = plugins.it2be_progress.button();

// Do you want to this button to fire a Servoy method ?
messageButton.setMethod(show_feedback);

// Set the label text for the button
messageButton.label = "Fire Servoy Method.";

// The message to show when this button is clicked
messageButton.messageOnClick = "The message to display when the user clicks the button";

// Should the user be prompted with a dialog after clicking this button ?
messageButton.requiresUserConfirmation = true;

// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// When you want to add a text above the progress bar this is the way to do so
dialog.text = "This is the message for the dialog


       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
         With html formatting. 
       "

// Add an icon to the dialog (top-left)
dialog.setIcon("media:// /yourimage.gif");

// configure how you would like the Progress to be presented to and controlled by the user
// Set minimum value of the progress bar, default = 0
dialog.min = 0;
// Set maximum value of the progress bar, default = 100
dialog.max = 100;
// Set the resizable state of the dialog, default = false
dialog.resizable = true;

// add the first button
dialog.addButton(cancelButton);

// insert a spacer
dialog.addSpacer(30, "#ffffff");

// add the second button
dialog.addButton(messageButton);

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

messageOnClick
String  messageOnClick

Get/Set the message on click.

Returns
String  message String

Supported Clients
SmartClient

Sample

// Add a Cancel button which fires another Servoy method
var cancelButton = plugins.it2be_progress.button();

// Do you want this button to fire a Servoy method ?
cancelButton.setMethod(show_feedback);

// Does clicking this button lead to a cancellation of the progress ?
cancelButton.cancelsProgressOperation = true;

// Give this button a label
cancelButton.label = "Cancel";

// The message to show when this button is clicked
cancelButton.messageOnClick = "Are you sure you want to cancel this operation?";

// Should the user be prompted with a confirmation dialog after clicking this button ?
cancelButton.requiresUserConfirmation = true;

// Add another button that 'simply' fires another Servoy method
var messageButton = plugins.it2be_progress.button();

// Do you want to this button to fire a Servoy method ?
messageButton.setMethod(show_feedback);

// Set the label text for the button
messageButton.label = "Fire Servoy Method.";

// The message to show when this button is clicked
messageButton.messageOnClick = "The message to display when the user clicks the button";

// Should the user be prompted with a dialog after clicking this button ?
messageButton.requiresUserConfirmation = true;

// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// When you want to add a text above the progress bar this is the way to do so
dialog.text = "This is the message for the dialog


       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
         With html formatting. 
       "

// Add an icon to the dialog (top-left)
dialog.setIcon("media:// /yourimage.gif");

// configure how you would like the Progress to be presented to and controlled by the user
// Set minimum value of the progress bar, default = 0
dialog.min = 0;
// Set maximum value of the progress bar, default = 100
dialog.max = 100;
// Set the resizable state of the dialog, default = false
dialog.resizable = true;

// add the first button
dialog.addButton(cancelButton);

// insert a spacer
dialog.addSpacer(30, "#ffffff");

// add the second button
dialog.addButton(messageButton);

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

requiresUserConfirmation
Boolean  requiresUserConfirmation

Get/Set the button is for user confirmation (default = false).

Returns
Boolean  requires boolean

Supported Clients
SmartClient

Sample

// Add a Cancel button which fires another Servoy method
var cancelButton = plugins.it2be_progress.button();

// Do you want this button to fire a Servoy method ?
cancelButton.setMethod(show_feedback);

// Does clicking this button lead to a cancellation of the progress ?
cancelButton.cancelsProgressOperation = true;

// Give this button a label
cancelButton.label = "Cancel";

// The message to show when this button is clicked
cancelButton.messageOnClick = "Are you sure you want to cancel this operation?";

// Should the user be prompted with a confirmation dialog after clicking this button ?
cancelButton.requiresUserConfirmation = true;

// Add another button that 'simply' fires another Servoy method
var messageButton = plugins.it2be_progress.button();

// Do you want to this button to fire a Servoy method ?
messageButton.setMethod(show_feedback);

// Set the label text for the button
messageButton.label = "Fire Servoy Method.";

// The message to show when this button is clicked
messageButton.messageOnClick = "The message to display when the user clicks the button";

// Should the user be prompted with a dialog after clicking this button ?
messageButton.requiresUserConfirmation = true;

// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// When you want to add a text above the progress bar this is the way to do so
dialog.text = "This is the message for the dialog


       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
         With html formatting. 
       "

// Add an icon to the dialog (top-left)
dialog.setIcon("media:// /yourimage.gif");

// configure how you would like the Progress to be presented to and controlled by the user
// Set minimum value of the progress bar, default = 0
dialog.min = 0;
// Set maximum value of the progress bar, default = 100
dialog.max = 100;
// Set the resizable state of the dialog, default = false
dialog.resizable = true;

// add the first button
dialog.addButton(cancelButton);

// insert a spacer
dialog.addSpacer(30, "#ffffff");

// add the second button
dialog.addButton(messageButton);

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

targetDisplayName
String  targetDisplayName

Get/Set the target display name.

Returns
String  name String

Supported Clients
SmartClient

Sample

// Add a Cancel button which fires another Servoy method
var cancelButton = plugins.it2be_progress.button();

// Do you want this button to fire a Servoy method ?
cancelButton.setMethod(show_feedback);

// Does clicking this button lead to a cancellation of the progress ?
cancelButton.cancelsProgressOperation = true;

// Give this button a label
cancelButton.label = "Cancel";

// The message to show when this button is clicked
cancelButton.messageOnClick = "Are you sure you want to cancel this operation?";

// Should the user be prompted with a confirmation dialog after clicking this button ?
cancelButton.requiresUserConfirmation = true;

// Add another button that 'simply' fires another Servoy method
var messageButton = plugins.it2be_progress.button();

// Do you want to this button to fire a Servoy method ?
messageButton.setMethod(show_feedback);

// Set the label text for the button
messageButton.label = "Fire Servoy Method.";

// The message to show when this button is clicked
messageButton.messageOnClick = "The message to display when the user clicks the button";

// Should the user be prompted with a dialog after clicking this button ?
messageButton.requiresUserConfirmation = true;

// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// When you want to add a text above the progress bar this is the way to do so
dialog.text = "This is the message for the dialog


       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
         With html formatting. 
       "

// Add an icon to the dialog (top-left)
dialog.setIcon("media:// /yourimage.gif");

// configure how you would like the Progress to be presented to and controlled by the user
// Set minimum value of the progress bar, default = 0
dialog.min = 0;
// Set maximum value of the progress bar, default = 100
dialog.max = 100;
// Set the resizable state of the dialog, default = false
dialog.resizable = true;

// add the first button
dialog.addButton(cancelButton);

// insert a spacer
dialog.addSpacer(30, "#ffffff");

// add the second button
dialog.addButton(messageButton);

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

setMethod
void  setMethod( Function )

Set the callback method.

Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient

Sample

// Add a Cancel button which fires another Servoy method
var cancelButton = plugins.it2be_progress.button();

// Do you want this button to fire a Servoy method ?
cancelButton.setMethod(show_feedback);

// Does clicking this button lead to a cancellation of the progress ?
cancelButton.cancelsProgressOperation = true;

// Give this button a label
cancelButton.label = "Cancel";

// The message to show when this button is clicked
cancelButton.messageOnClick = "Are you sure you want to cancel this operation?";

// Should the user be prompted with a confirmation dialog after clicking this button ?
cancelButton.requiresUserConfirmation = true;

// Add another button that 'simply' fires another Servoy method
var messageButton = plugins.it2be_progress.button();

// Do you want to this button to fire a Servoy method ?
messageButton.setMethod(show_feedback);

// Set the label text for the button
messageButton.label = "Fire Servoy Method.";

// The message to show when this button is clicked
messageButton.messageOnClick = "The message to display when the user clicks the button";

// Should the user be prompted with a dialog after clicking this button ?
messageButton.requiresUserConfirmation = true;

// Create the Progress component responsible for the UI
var dialog = plugins.it2be_progress.dialog();

// When you want to add a text above the progress bar this is the way to do so
dialog.text = "This is the message for the dialog


       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
         With html formatting. 
       "

// Add an icon to the dialog (top-left)
dialog.setIcon("media:// /yourimage.gif");

// configure how you would like the Progress to be presented to and controlled by the user
// Set minimum value of the progress bar, default = 0
dialog.min = 0;
// Set maximum value of the progress bar, default = 100
dialog.max = 100;
// Set the resizable state of the dialog, default = false
dialog.resizable = true;

// add the first button
dialog.addButton(cancelButton);

// insert a spacer
dialog.addSpacer(30, "#ffffff");

// add the second button
dialog.addButton(messageButton);

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