Package com.install4j.api.context
Interface ProgressInterface
- All Known Subinterfaces:
Console,UnattendedProgressInterface
- All Known Implementing Classes:
DefaultUnattendedProgressInterface
public interface ProgressInterface
The user notification interface during installation. It displays progress
and messages and can ask questions relevant for installation purposes
in custom actions.
Status messages and progress are only displayed if the progress interface is used by an action and the containing screen offers its own progress interface, like the "Installation" screen or the customizable "Display progress" screen.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intReturned byaskOverwriteif the user hits "All".static final intReturned byaskOverwriteif the user hits "Never".static final intReturned byaskOverwriteif the user hits "No".static final intReturned byaskOverwriteif the user hits "Yes".static final intReturned byaskRetryif the user hits "Cancel".static final intReturned byaskRetryif the user hits "No".static final intReturned byaskRetryif the user hits "Yes". -
Method Summary
Modifier and TypeMethodDescriptionbooleanaskContinue(File file) Asks the user whether to continue after the specified file could not be installed.intaskOverwrite(File file) Asks the user whether the specified file should be overwritten.intAsks the user whether the installer should retry to overwrite the specified file.intRetrieves the current progress valuedefault booleanReturns if alerts are shown.default booleanReturns if the installer application has been started in the "Unattended mode with progress dialog" execution mode, either because the "Default execution mode" property of the installer application was set accordingly or because-splash <title>"were passed as command line arguments.voidsetDetailMessage(String message) Sets the detail message on the progress screen.voidsetIndeterminateProgress(boolean indeterminateProgress) Indicate that an action is performed whose duration is not known.voidsetPercentCompleted(int value) Sets the completion percentage of the current action.voidsetSecondaryPercentCompleted(int value) Sets the completion percentage of a secondary task, like the unpacking of a JAR file that was packed with Pack200.voidsetStatusMessage(String message) Sets the status message on the progress screen.voidshowFailure(String message) Shows an error dialog with the specified message.
-
Field Details
-
OVERWRITE_NO
static final int OVERWRITE_NOReturned byaskOverwriteif the user hits "No".- See Also:
-
OVERWRITE_YES
static final int OVERWRITE_YESReturned byaskOverwriteif the user hits "Yes".- See Also:
-
OVERWRITE_ALL
static final int OVERWRITE_ALLReturned byaskOverwriteif the user hits "All".- See Also:
-
OVERWRITE_NEVER
static final int OVERWRITE_NEVERReturned byaskOverwriteif the user hits "Never".- See Also:
-
RETRY_NO
static final int RETRY_NOReturned byaskRetryif the user hits "No".- See Also:
-
RETRY_YES
static final int RETRY_YESReturned byaskRetryif the user hits "Yes".- See Also:
-
RETRY_CANCEL
static final int RETRY_CANCELReturned byaskRetryif the user hits "Cancel".- See Also:
-
-
Method Details
-
setStatusMessage
Sets the status message on the progress screen.Note: Has no effect if not called from an action or if the containing screen doesn't display progress.
- Parameters:
message- the new message.
-
setDetailMessage
Sets the detail message on the progress screen. This message is shown below the status message.Note: Has no effect if not called from an action or if the containing screen doesn't display progress.
- Parameters:
message- the new message.
-
setPercentCompleted
void setPercentCompleted(int value) Sets the completion percentage of the current action.Note: Has no effect if not called from an action or if the containing screen doesn't display progress.
- Parameters:
value- a value between 0 and 100.
-
getPercentCompleted
int getPercentCompleted()Retrieves the current progress value- Returns:
- the current progress value between 0 and 100. Always returns 0 if not called from an action or if the containing screen doesn't display progress.
-
setSecondaryPercentCompleted
void setSecondaryPercentCompleted(int value) Sets the completion percentage of a secondary task, like the unpacking of a JAR file that was packed with Pack200.Note: Has no effect if not called from an action or if the containing screen doesn't display progress.
- Parameters:
value- a value between 0 and 100.
-
setIndeterminateProgress
void setIndeterminateProgress(boolean indeterminateProgress) Indicate that an action is performed whose duration is not known.Note: Has no effect if not called from an action or if the containing screen doesn't display progress.
- Parameters:
indeterminateProgress- passtrueto switch on indeterminate progress feedback andfalseto switch it off again. When you switch it off, the previously set percentage will be shown in the progress bar.
-
showFailure
Shows an error dialog with the specified message.- Parameters:
message- the error message
-
askOverwrite
Asks the user whether the specified file should be overwritten.- Parameters:
file- the file in question.- Returns:
- one of the
OVERWRITE_*constants. - Throws:
UserCanceledException- if the user cancels the question
-
askRetry
Asks the user whether the installer should retry to overwrite the specified file.- Parameters:
file- the file in question.- Returns:
- one of the
RETRY_*constants - Throws:
UserCanceledException- if the user cancels the question
-
askContinue
Asks the user whether to continue after the specified file could not be installed.- Parameters:
file- the file in question.- Returns:
trueif the user wants to continue the installation.- Throws:
UserCanceledException- if the user cancels the question
-
isUnattendedProgressDialog
default boolean isUnattendedProgressDialog()Returns if the installer application has been started in the "Unattended mode with progress dialog" execution mode, either because the "Default execution mode" property of the installer application was set accordingly or because-splash <title>"were passed as command line arguments. -
isAlertsShown
default boolean isAlertsShown()Returns if alerts are shown. This will return false if the installer application was started in the "Unattended mode with progress dialog" execution mode as explained forisUnattendedProgressDialog()unless the "Show alerts" property was also set or-alertswas also passed as a command line argument.
-