Servoy Methods Summary | |
---|---|
void | addButton( IPButton ) |
void | addLabel( String, String, String ) |
void | addSpacer( Number, String ) |
void | cancel( ) |
void | close( ) |
void | complete( ) |
Number | getCount( ) |
void | increment( ) |
Boolean | isCancelled( ) |
Boolean | isCompleted( ) |
Boolean | isEnded( ) |
Boolean | isStarted( ) |
void | setIcon( Object ) |
void | setSize( Number, Number ) |
void | setValue( Number ) |
void | start( ) |
Servoy Properties Details |
---|
borderEtched
Boolean borderEtched
Get/Set the etched border of the progress component (default = false).Returns
Boolean etched 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);
completionMessage
String completionMessage
Get/Set the completion message (default = 'Completed.'')...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);
disableCloseControl
Boolean disableCloseControl
Get set the disabled state of the control that can be used to close a dialogReturns
Boolean disabled 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);
displaysCompletionMessage
Boolean displaysCompletionMessage
Get/Set the display state of the completion message (default = true).Returns
Boolean displays 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);
displaysCount
Boolean displaysCount
Get/Set the display state of the count (default = true).Returns
Boolean displays 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);
displaysPercentage
Boolean displaysPercentage
Get/Set the display state of the percentage (default = false).Returns
Boolean displays 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);
indeterminate
Boolean indeterminate
Get/Set an indeterminate bar whilst still counting (default = false).Returns
Boolean indeterminate 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);
max
Number max
Get/Set the maximum value of the progress bar (default = 100).Returns
Number maximum int
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);
min
Number min
Get/Set the minimum value of the progress bar (default = 0).Returns
Number minimum int
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);
name
String name
Get/Set the name of the dialog (default = 'Progress').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);
orientation
Number orientation
Get/Set the orientation of the progress bar (default = horizontal = 0, vertical = 1).Returns
Number orientation int
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);
resizable
Boolean resizable
Get/Set the dialog resizables state (default = false).Returns
Boolean resizable 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);
showModal
Boolean showModal
Get/Set the modal state of the dialogReturns
Boolean modal 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);
showWaitcursor
Boolean showWaitcursor
Get/Set the waitcursor to show up (default = false).Returns
Boolean show 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);
text
String text
Get/Set the text above the progress bar.Returns
String text 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);
Servoy Methods Details |
---|
addButton
void addButton( IPButton )
Add the button to the dialog.Parameters
IPButton button the button
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);
addLabel
void addLabel( String, String, String )
Add the label to the dialog.Parameters
String text the text
String foregroundColor the foreground color
String backgroundColor the background color
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);
addSpacer
void addSpacer( Number, String )
Add the spacer to the dialog.Parameters
Number pixels the pixels
String color the color
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);
cancel
void cancel( )
Cancel the 'operation'.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);
close
void close( )
Close the dialog.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);
complete
void complete( )
Set the operation to completed.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);
getCount
Number getCount( )
Get the count.Returns
Number count int
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);
increment
void increment( )
Increment the progress bar.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);
isCancelled
Boolean isCancelled( )
Find out if the dialog is cancelled.Returns
Boolean cancelled 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);
isCompleted
Boolean isCompleted( )
Find out if the dialog is completed.Returns
Boolean completed 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);
isEnded
Boolean isEnded( )
Find out if the task has ended.Returns
Boolean ended 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);
isStarted
Boolean isStarted( )
Find out if the task has started.Returns
Boolean started 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);
setIcon
void setIcon( Object )
Set the dialog icon.Parameters
Object media path:String or media:byte[] the media
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);
setSize
void setSize( Number, Number )
Set the size of the dialog (default = minimum size needed).Parameters
Number width the width
Number height the height
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);
setValue
void setValue( Number )
Set the value of the progress bar.Parameters
Number count the count
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);
start
void start( )
Start the progress dialog.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);