A C D E F G H I J K N O P R S T U V W

A

abort() - Method in interface com.install4j.api.InstallerContext

Deprecated. return false in a custom action in order to perform a rollback and close the installer.

activated() - Method in class com.install4j.api.CustomScreen

Called by the framework when the screen is activated.

addInstallerEventListener(InstallerEventListener) - Method in interface com.install4j.api.InstallerWizardContext

Add a listener to receive application events.

appendToPath(String) - Static method in class com.install4j.api.windows.WinEnvVars

Appends one or more directories to the PATH environment variable.

appendToUserPath(String) - Static method in class com.install4j.api.windows.WinEnvVars

Appends one or more directories to the user specific PATH environment variable on Windows NT/2000/XP.

askContinue(File) - Method in interface com.install4j.api.ProgressInterface

Asks the user whether to continue after the specified file could not be installed.

askOverwrite(File) - Method in interface com.install4j.api.ProgressInterface

Asks the user whether the specified file should be overwritten.

askRetry(File) - Method in interface com.install4j.api.ProgressInterface

Asks the user whether the installer should retry to overwrite the specified file.

C

cancel() - Method in class com.install4j.api.CustomScreen

Called when the user clicks the "Cancel" button for this screen.

cancel() - Method in class com.install4j.api.InstallAction

Override this method to react to the user canceling the installation.

canValidate() - Method in class com.install4j.api.DirectoryValidator

If you wish to validate directory selections of the user, return true here.

com.install4j.api - package com.install4j.api

This package contains classes that can be used to develop custom actions and custom screens for install4j installers.

com.install4j.api.launcher - package com.install4j.api.launcher

This package contains classes that can be user in your launcher to use services provided by install4j.

com.install4j.api.windows - package com.install4j.api.windows

This package contains classes with static utility methods for accessing Windows system services.

Context - Interface in com.install4j.api

The basic installation and uninstallation context.

Controller - Class in com.install4j.api.launcher

This class allows you to control the splash screen of an install4j launcher from your Java code.

Controller.ConnectionException - Exception in com.install4j.api.launcher

The exception thrown by methods of the Controller class to indicate that a splash screen operation was not successful.

create(String, String, File, File) - Static method in class com.install4j.api.windows.WinAssociations

Creates a file assocation.

createKey(int, String) - Static method in class com.install4j.api.windows.WinRegistry

Creates a registry key.

createShellLink(File, File, File) - Static method in class com.install4j.api.windows.WinFileSystem

Creates a shell link.

createShellLink(File, File, File, String) - Static method in class com.install4j.api.windows.WinFileSystem

Creates a shell link.

createStartMenuEntry(InstallerContext, String, File, File) - Static method in class com.install4j.api.windows.WinFileSystem

Creates an additional start menu entry if start menu creation is enabled by the installer context.

CustomAction - Class in com.install4j.api

The base class for all actions.

CustomAction() - Constructor for class com.install4j.api.CustomAction

CustomScreen - Class in com.install4j.api

All custom screens must be derived from this class.

CustomScreen() - Constructor for class com.install4j.api.CustomScreen

CustomTaskSetup - Interface in com.install4j.api

The interface that provides information about custom tasks.

D

deactivated() - Method in class com.install4j.api.CustomScreen

Called by the framework when the screen is deactivated.

DEFAULT_MODE - Static variable in class com.install4j.api.FileOptions

The default file mode on Unix and Mac OS X.

deleteKey(int, String, boolean) - Static method in class com.install4j.api.windows.WinRegistry

Deletes a registry key.

deleteValue(int, String, String) - Static method in class com.install4j.api.windows.WinRegistry

Deletes a registry value.

DirectoryValidator - Class in com.install4j.api

If you define a directory validatory derived from this class on the "Advanced tasks" tab in the install4j GUI it will be instantiated and used to modify the behavior of the the "Installation location" screen of the installer.

DirectoryValidator() - Constructor for class com.install4j.api.DirectoryValidator

E

EVENT_AFTER_INSTALLATION - Static variable in class com.install4j.api.InstallerEvent

This event type notifies listeners that the installer has just finished the installation.

EVENT_BEFORE_INSTALLATION - Static variable in class com.install4j.api.InstallerEvent

This event type notifies listeners that the installer is just about to begin the installation.

EVENT_CANCELED - Static variable in class com.install4j.api.InstallerEvent

This event type notifies listeners that the installer has been canceled and is just about to exit.

EVENT_FINISHED - Static variable in class com.install4j.api.InstallerEvent

This event type notifies listeners that the installer has completed is just about to exit.

EVENT_START - Static variable in class com.install4j.api.InstallerEvent

This event type notifies listeners that the installer has been initialized and the wizard is just about to be shown.

exists(String) - Static method in class com.install4j.api.windows.WinAssociations

Checks whether a file association already exists.

F

fatalError(Throwable) - Static method in class com.install4j.api.Util

This method can be invoked if you encounter a non-recoverable and non-expected error in your custom code.

FileOptions - Class in com.install4j.api

An object that contains options for the installation of a file.

FileOptions() - Constructor for class com.install4j.api.FileOptions

Initializes a FileOptions instance.

FileOptions(String, int, boolean) - Constructor for class com.install4j.api.FileOptions

Initializes a FileOptions instance.

FileOptions(long) - Constructor for class com.install4j.api.FileOptions

Initializes a FileOptions instance.

FileOptions(long, int) - Constructor for class com.install4j.api.FileOptions

Initializes a FileOptions instance.

FileOptions(long, String, int, boolean, boolean) - Constructor for class com.install4j.api.FileOptions

Initializes a FileOptions instance.

FOLDER_APPDATA - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies the file system directory that serves as a common repository for application-specific data.

FOLDER_DESKTOP - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies the file system directory used to physically store file objects on the desktop.

FOLDER_DOCS - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies the file system directory used to physically store a user's common repository of documents.

FOLDER_FAVORITES - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies the file system directory that serves as a common repository for the user's favorite items.

FOLDER_FONTS - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies a virtual folder containing fonts.

FOLDER_LOCAL_APPDATA - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies the file system directory that serves as a data repository for local applications.

FOLDER_PROGRAMS - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies the file system directory that contains the user's program groups.

FOLDER_SENDTO - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies the file system directory that contains Send To menu items.

FOLDER_STARTMENU - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies the file system directory containing Start menu items.

FOLDER_STARTUP - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies the file system directory that corresponds to the user's Startup program group.

FOLDER_TEMPLATES - Static variable in class com.install4j.api.windows.WinFileSystem

Identifies the file system directory that serves as a common repository for document templates.

G

getAddOnApplicationId() - Method in interface com.install4j.api.Context

Returns the add on application id.

getApplicationId() - Method in interface com.install4j.api.Context

Returns the application id.

getCommonFilesDirectory() - Static method in class com.install4j.api.windows.WinFileSystem

Returns a folder for components that are shared across applications.

getCustomScreenOfClass(Class) - Method in interface com.install4j.api.InstallerWizardContext

Get the registered custom screen of a given class.

getCustomScreens() - Method in interface com.install4j.api.InstallerWizardContext

Get a list of all registered custom screens.

getCustomTasks() - Method in interface com.install4j.api.InstallerContext

Returns all custom tasks for this installer.

getDefaultInstallationDirectory() - Method in class com.install4j.api.StartupHandler

This method will be called if prepareInstaller returns true to determine if a different installation directory should be suggested in the installation location screen.

getDescription() - Method in interface com.install4j.api.CustomTaskSetup

Returns the description for this custom task.

getDescription() - Method in interface com.install4j.api.InstallationComponentSetup

Returns the description for this installation components.

getenv(String) - Static method in class com.install4j.api.windows.WinEnvVars

Returns a single environment variable.

getenv() - Static method in class com.install4j.api.windows.WinEnvVars

Returns all environment variables.

getExecutable(String) - Static method in class com.install4j.api.windows.WinAssociations

Retrieves the executable associated with an extension.

getFileTime() - Method in class com.install4j.api.FileOptions

Returns the file time.

getFrame() - Method in class com.install4j.api.CustomScreen

Returns the frame of the installer wizard.

getId() - Method in interface com.install4j.api.CustomTaskSetup

Returns the ID of this custom task.

getInstallationComponents() - Method in interface com.install4j.api.InstallerContext

Returns all installation components for this installer.

getInstallationDirectory() - Method in interface com.install4j.api.Context

Retrieves the installation directory selected by the user, or the default installation directory if the user has not yet made a selection.

getInstallationDirectory(File, String) - Method in class com.install4j.api.DirectoryValidator

After the user selection for the installation directory has been accepted, this method will be queried to obtain the actual installation directory.

getInstallationDirectory(File, File) - Method in class com.install4j.api.InstallationHandler

Will be queried for each file in the distribution tree that is about to be installed.

getInstallerContext() - Method in class com.install4j.api.CustomScreen

Returns the InstallerWizardContext that the framework has associated with this custom screen in setInstallerContext.

getInstallerContext() - Method in class com.install4j.api.DirectoryValidator

Returns the InstallerContext that the framework has associated with this validator in setInstallerContext.

getInstallerContext() - Method in class com.install4j.api.InstallationHandler

Returns the InstallerContext that the framework has associated with this handler in setInstallerContext.

getInstallerFile() - Method in interface com.install4j.api.InstallerContext

Returns the current media file.

getInstallerLanguage() - Static method in class com.install4j.api.Util

Return the language of the installer.

getJavaHome() - Method in interface com.install4j.api.JVMSelector.JVMLocation

Returns the base directory of a Java installation.

getJVMLocations() - Static method in class com.install4j.api.JVMSelector

Returns JVMs found in standard locations.

getMediaName() - Method in interface com.install4j.api.InstallerContext

Get the name of the current media set.

getMode() - Method in class com.install4j.api.FileOptions

Returns the unix access mode.

getOverwrite() - Method in class com.install4j.api.FileOptions

Returns the overwrite mode.

getParentWindow() - Static method in class com.install4j.api.Util

Get the window of the installer.

getPercentOfTotalInstallation() - Method in class com.install4j.api.CustomAction

Should return the x percentage points of the installation progress bar that this action wants to reserve for itself.

getProgramFilesDirectory() - Static method in class com.install4j.api.windows.WinFileSystem

Returns the program files directory of the current Windows installation.

getProgramGroup() - Method in interface com.install4j.api.InstallerContext

Retrieves the name of the program group selected by the user or the default program group if the user has not yet made a selection.

getRelativeFileName() - Method in interface com.install4j.api.ServiceSetup

Returns the relative executable file name of the service with regard to the installation directory.

getServiceSetups() - Method in interface com.install4j.api.InstallerContext

Returns all services that can be installed by this installation together with their installation parameters.

getSpecialFolder(int, boolean) - Static method in class com.install4j.api.windows.WinFileSystem

Returns Windows-specific directories like the start menu or the desktop.

getStandardApplicationsDirectory() - Static method in class com.install4j.api.Util

Returns the standard directory for installing applications.

getSubKeyNames(int, String) - Static method in class com.install4j.api.windows.WinRegistry

Retrieves the sub keys of a registry key.

getSubTitle() - Method in class com.install4j.api.CustomScreen

Returns the subtitle of this custom screen which is displayed at the top of the installer wizard just below the title of the screen.

getSystemDirectory() - Static method in class com.install4j.api.windows.WinFileSystem

Returns the system directory.

getTitle() - Method in class com.install4j.api.CustomScreen

Returns the title of this custom screen which is displayed at the top of the installer wizard.

getType() - Method in class com.install4j.api.InstallerEvent

Get the type of the event.

getUserVariableValue(String) - Method in interface com.install4j.api.Context

Gets the value of a user variable as it was defined for this media file at the compile time.

getValue() - Method in class com.install4j.api.windows.WinRegistry.ExpandString

getValue(int, String, String) - Static method in class com.install4j.api.windows.WinRegistry

Retrieves a registry value.

getVersion() - Method in interface com.install4j.api.JVMSelector.JVMLocation

Returns the version of the JVM.

getWindowsDirectory() - Static method in class com.install4j.api.windows.WinFileSystem

Returns the "indows directory.

gotoCustomScreen(CustomScreen) - Method in interface com.install4j.api.InstallerWizardContext

Programmatically switch to a custom screen in the installer.

gotoStandardScreen(String) - Method in interface com.install4j.api.InstallerWizardContext

Programmatically switch to a standard screen in the installer.

H

hide() - Static method in class com.install4j.api.launcher.Controller

Programmatically hide the splash screen.

HKEY_CLASSES_ROOT - Static variable in class com.install4j.api.windows.WinRegistry

Identifies the root registry key HKEY_CLASSES_ROOT.

HKEY_CURRENT_CONFIG - Static variable in class com.install4j.api.windows.WinRegistry

Identifies the root registry key HKEY_CURRENT_CONFIG.

HKEY_CURRENT_USER - Static variable in class com.install4j.api.windows.WinRegistry

Identifies the root registry key HKEY_CURRENT_USER.

HKEY_LOCAL_MACHINE - Static variable in class com.install4j.api.windows.WinRegistry

Identifies the root registry key HKEY_LOCAL_MACHINE.

HKEY_USERS - Static variable in class com.install4j.api.windows.WinRegistry

Identifies the root registry key HKEY_USERS.

I

InstallAction - Class in com.install4j.api

All install actions must be derived from this class.

InstallAction() - Constructor for class com.install4j.api.InstallAction

InstallationComponentSetup - Interface in com.install4j.api

The interface that provides information about installation components.

InstallationHandler - Class in com.install4j.api

If you define an installation handler derived from this class on the "Advanced tasks" tab in the install4j GUI it will be instantiated and queried before the installation of each file.

InstallationHandler() - Constructor for class com.install4j.api.InstallationHandler

InstallerContext - Interface in com.install4j.api

The extended context provided during installation.

installerEvent(InstallerEvent) - Method in class com.install4j.api.CustomScreen

InstallerEvent - Class in com.install4j.api

This class represents an application event and is dispatched to listeners of type InstallerEventListener.

InstallerEvent(InstallerWizardContext, int) - Constructor for class com.install4j.api.InstallerEvent

Constructor.

installerEvent(InstallerEvent) - Method in interface com.install4j.api.InstallerEventListener

Called when an application event is fired.

InstallerEventListener - Interface in com.install4j.api

The interface that must be implemented by classes who are interested in application events.

InstallerWizardContext - Interface in com.install4j.api

The installer environment context that can be used to retrieve information about the installation process and to perform screen change and file installation operations.

installFile(File, File) - Method in interface com.install4j.api.InstallerContext

Installs a file.

installFile(File, File, FileOptions) - Method in interface com.install4j.api.InstallerContext

Installs a file.

installFile(File, File, FileOptions, ProgressInterface, int, int) - Method in interface com.install4j.api.InstallerContext

Installs a file.

isAdminUser() - Method in interface com.install4j.api.Context

Checks whether the current user has administration privileges.

isCancelVisible() - Method in class com.install4j.api.CustomScreen

Returns whether the "Cancel" button is visible or not for this screen.

isCreateDesktopIcon() - Method in interface com.install4j.api.InstallerContext

Returns whether the installer will create a desktop icon.

isCreateMenu() - Method in interface com.install4j.api.InstallerContext

Returns whether start menu entries should be created.

isCreateMenuAllUsers() - Method in interface com.install4j.api.InstallerContext

Returns whether the start menu entries should be made for all users.

isCreateQuickLaunchIcon() - Method in interface com.install4j.api.InstallerContext

Returns whether the installer will create a quick launch icon.

isDontUninstall() - Method in class com.install4j.api.FileOptions

Returns whether the file will not be uninstalled.

isFillHorizontal() - Method in class com.install4j.api.CustomScreen

Returns whether this screen wants to grow in the horizontal direction.

isFillVertical() - Method in class com.install4j.api.CustomScreen

Returns whether this screen wants to grow in the vertical direction.

isFinishScreen() - Method in class com.install4j.api.CustomScreen

Returns whether this is a screen that finished the wizard.

isHpux() - Static method in class com.install4j.api.Util

Returns whether the platform is HP UX.

isInstall() - Method in interface com.install4j.api.ServiceSetup

Returns whether the service will be installed.

isJDK() - Method in interface com.install4j.api.JVMSelector.JVMLocation

Returns whether this a JDK installation.

isLinux() - Static method in class com.install4j.api.Util

Returns whether the platform is Linux.

isMacOS() - Static method in class com.install4j.api.Util

Returns whether the platform is Mac OS X.

isNextVisible() - Method in class com.install4j.api.CustomScreen

Returns whether the "Next" button is visible or not for this screen.

isPreviousVisible() - Method in class com.install4j.api.CustomScreen

Returns whether the "Back" button is visible or not for this screen.

isSelected() - Method in interface com.install4j.api.CustomTaskSetup

Returns whether the custom task has been selected by the user.

isSelected() - Method in interface com.install4j.api.InstallationComponentSetup

Returns whether the installation components has been selected by the user.

isShared() - Method in class com.install4j.api.FileOptions

Returns whether the file will be installed as a shared file on Windows.

isSolaris() - Static method in class com.install4j.api.Util

Returns whether the platform is Solaris.

isStartOnBoot() - Method in interface com.install4j.api.ServiceSetup

Returns whether the service will be started on bootup.

isUnattended() - Method in interface com.install4j.api.Context

Returns whether the installer or uninstaller is running unattended or if it displays a graphical wizard.

isWindows() - Static method in class com.install4j.api.Util

Returns whether the platform is Windows.

isWindows9X() - Static method in class com.install4j.api.Util

Returns whether the platform is Windows 9X (95, 98, ME).

isWindowsNT() - Static method in class com.install4j.api.Util

Returns whether the platform is Windows NT (not Windows 2000 and XP).

J

JVMSelector - Class in com.install4j.api

With this class, you can retrieve the installed JVMs on Windows, Linux and Unix systems.

JVMSelector.JVMLocation - Interface in com.install4j.api

The interface providing information about a JVM.

K

keyExists(int, String) - Static method in class com.install4j.api.windows.WinRegistry

Checks if a registry key exists.

N

next() - Method in class com.install4j.api.CustomScreen

Called when the user clicks the "Next" button for this screen.

O

OVERWRITE_ALL - Static variable in interface com.install4j.api.ProgressInterface

Returned from askOverwrite if the user hits "All".

OVERWRITE_ALWAYS - Static variable in class com.install4j.api.FileOptions

Indicates that if the destination file exists it will be replaced in any case.

OVERWRITE_ALWAYS_ASK - Static variable in class com.install4j.api.FileOptions

Indicates that if the destination file exists and has not been installed by a previous run of the installer the user will be asked whether to replace the file.

OVERWRITE_ALWAYS_ASK_INCLUDING_UPDATE - Static variable in class com.install4j.api.FileOptions

Indicates that the user will be asked whether to replace the file even if it was installed by a previous run of the installer.

OVERWRITE_IF_NEWER - Static variable in class com.install4j.api.FileOptions

Indicates that if the destination file exists it will be replaced if the source file is newer.

OVERWRITE_IF_NEWER_OTHERWISE_ASK - Static variable in class com.install4j.api.FileOptions

Indicates that if the destination file exists it will be replaced if the source file is newer.

OVERWRITE_NEVER - Static variable in class com.install4j.api.FileOptions

Indicates that if the destination file exists it won't be replaced in any case.

OVERWRITE_NEVER - Static variable in interface com.install4j.api.ProgressInterface

Returned from askOverwrite if the user hits "Never".

OVERWRITE_NO - Static variable in interface com.install4j.api.ProgressInterface

Returned from askOverwrite if the user hits "No".

OVERWRITE_YES - Static variable in interface com.install4j.api.ProgressInterface

Returned from askOverwrite if the user hits "Yes".

P

performAction(InstallerWizardContext, ProgressInterface) - Method in class com.install4j.api.InstallAction

Override this method to perform the custom action in the installation wizard.

performAction(Context, ProgressInterface) - Method in class com.install4j.api.UninstallAction

Override this method to perform the custom action in the uninstallation wizard.

performFirstRunAction() - Method in class com.install4j.api.InstallAction

Override this method to perform the custom action for archive media files.

performUnattendedAction(InstallerContext) - Method in class com.install4j.api.InstallAction

Override this method to perform the custom action for unattended installations.

prepareInstaller(InstallerContext) - Method in class com.install4j.api.StartupHandler

This method will be called before the installer is started.

prepareUninstaller(Context) - Method in class com.install4j.api.StartupHandler

This method will be called before the uninstaller is started.

prependToPath(String) - Static method in class com.install4j.api.windows.WinEnvVars

Prepends one or more directories to the PATH environment variable.

prependToUserPath(String) - Static method in class com.install4j.api.windows.WinEnvVars

Prepends one or more directories to the user specific PATH environment variable on Windows NT/2000/XP.

previous() - Method in class com.install4j.api.CustomScreen

Called when the user clicks the "Back" button for this screen.

ProgressInterface - Interface in com.install4j.api

The user notification interface during installation.

R

rebootAfterFinish() - Method in interface com.install4j.api.Context

Microsoft Windows only: if your custom code makes changes that requires a reboot after the wizard has finished, you can invoke this method.

registerStartupListener(StartupNotification.Listener) - Static method in class com.install4j.api.launcher.StartupNotification

Register a listener to receive startup events in single instance mode on Microsoft Windows.

registerUninstallFile(File) - Method in interface com.install4j.api.InstallerContext

Registers a file for uninstallation.

remove(String) - Static method in class com.install4j.api.windows.WinAssociations

Removes a file association.

removeInstallerEventListener(InstallerEventListener) - Method in interface com.install4j.api.InstallerWizardContext

Remove a listener to receive application events.

RETRY_CANCEL - Static variable in interface com.install4j.api.ProgressInterface

Returned from askRetry if the user hits "Cancel".

RETRY_NO - Static variable in interface com.install4j.api.ProgressInterface

Returned from askRetry if the user hits "No".

RETRY_YES - Static variable in interface com.install4j.api.ProgressInterface

Returned from askRetry if the user hits "Yes".

rollback(InstallerWizardContext, ProgressInterface) - Method in class com.install4j.api.InstallAction

Override this method to perform a rollback of the performAction method.

rollbackUnattended(InstallerContext) - Method in class com.install4j.api.InstallAction

Override this method to perform a rollback of the performUnattendedAction method.

S

SCREEN_ADDITIONAL_TASKS - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the additional tasks screen for use in gotoStandardScreen().

SCREEN_COMPONENTS - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the installation components screen for use in gotoStandardScreen().

SCREEN_FINISHED - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the finished screen for use in gotoStandardScreen().

SCREEN_INSTALL - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the installation screen for use in gotoStandardScreen().

SCREEN_LICENSE - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the license screen for use in gotoStandardScreen().

SCREEN_LOCATION - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the installation location screen for use in gotoStandardScreen().

SCREEN_POST_INFO - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the post-installation information screen for use in gotoStandardScreen().

SCREEN_PRE_INFO - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the pre-installation information screen for use in gotoStandardScreen().

SCREEN_PROGRAM_GROUP - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the program group screen for use in gotoStandardScreen().

SCREEN_SERVICES - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the services screen for use in gotoStandardScreen().

SCREEN_WELCOME - Static variable in interface com.install4j.api.InstallerWizardContext

Screen ID for the welcome screen for use in gotoStandardScreen().

ServiceSetup - Interface in com.install4j.api

The interface that provides information about the installation of services.

set(String, String) - Static method in class com.install4j.api.windows.WinEnvVars

Sets a global environment variable.

set(String, String, boolean) - Static method in class com.install4j.api.windows.WinEnvVars

Sets a global environment variable.

setBackButtonEnabled(boolean) - Method in interface com.install4j.api.InstallerWizardContext

Switch the enabled status of the "Back" button at the bottom of the current screen.

setCancelButtonEnabled(boolean) - Method in interface com.install4j.api.InstallerWizardContext

Switch the enabled status of the "Cancel" button at the bottom of the current screen.

setDetailMessage(String) - Method in interface com.install4j.api.ProgressInterface

Sets the detail message on the progress screen.

setDontUninstall(boolean) - Method in class com.install4j.api.FileOptions

Sets whether the file should not be uninstalled.

setFileTime(long) - Method in class com.install4j.api.FileOptions

Sets the file time.

setIndeterminateProgress(boolean) - Method in interface com.install4j.api.ProgressInterface

Indicates that an action is performed whose duration is not known.

setInstall(boolean) - Method in interface com.install4j.api.ServiceSetup

Sets whether the service should be installed or not.

setInstallerContext(InstallerWizardContext) - Method in class com.install4j.api.CustomScreen

This method is called by the framework to set the InstallerWizardContext.

setInstallerContext(InstallerContext) - Method in class com.install4j.api.DirectoryValidator

This method is called by the framework to set the InstallerContext.

setInstallerContext(InstallerContext) - Method in class com.install4j.api.InstallationHandler

This method is called by the framework to set the InstallerContext.

setMode(int) - Method in class com.install4j.api.FileOptions

Sets the unix file mode as an integer.

setMode(String) - Method in class com.install4j.api.FileOptions

Sets the unix file mode as a String.

setNextButtonEnabled(boolean) - Method in interface com.install4j.api.InstallerWizardContext

Switch the enabled status of the "Next" button at the bottom of the current screen.

setOverwrite(int) - Method in class com.install4j.api.FileOptions

Sets the overwrite mode.

setPercentCompleted(int) - Method in interface com.install4j.api.ProgressInterface

Sets the percentage of completion of the current action.

setPreferredJVM(String) - Static method in class com.install4j.api.JVMSelector

Set the preferred JRE/JDK for your application.

setSelected(boolean) - Method in interface com.install4j.api.CustomTaskSetup

Sets whether the custom task should be selected or not.

setSelected(boolean) - Method in interface com.install4j.api.InstallationComponentSetup

Sets whether the installation component should be installed or not.

setShared(boolean) - Method in class com.install4j.api.FileOptions

Sets whether the file should be installed as shared on Windows.

setStartOnBoot(boolean) - Method in interface com.install4j.api.ServiceSetup

Sets whether the service should be started on bootup or not.

setStatusMessage(String) - Method in interface com.install4j.api.ProgressInterface

Sets the status message on the progress screen.

setUserSpecific(String, String) - Static method in class com.install4j.api.windows.WinEnvVars

Sets a user specific environment variable on NT/2000/XP.

setUserSpecific(String, String, boolean) - Static method in class com.install4j.api.windows.WinEnvVars

Sets a user specific environment variable on NT/2000/XP.

setValue(int, String, String, Object) - Static method in class com.install4j.api.windows.WinRegistry

Sets a registry value.

shouldInstall(File) - Method in class com.install4j.api.InstallationHandler

Will be queried for each file in the distribution tree that is about to be installed.

showFailure(String) - Method in interface com.install4j.api.ProgressInterface

Shows an error dialog with the specified message.

showMessage(String, int) - Static method in class com.install4j.api.Util

Show a message dialog.

showOnNext() - Method in class com.install4j.api.CustomScreen

Returns whether this screen should be shown when the user traverses screens in the forward direction.

showOnPrevious() - Method in class com.install4j.api.CustomScreen

Returns whether this screen should be shown when the user traverses screens in the backward direction.

showOptionDialog(String, String[], int) - Static method in class com.install4j.api.Util

Show an options dialog.

showUrl(URL) - Static method in class com.install4j.api.Util

Show a URL in the default browser.

StartupHandler - Class in com.install4j.api

If you define a startup handler derived from this class on the "Advanced tasks" tab in the install4j GUI it will be instantiated and queried before the installer and the uninstaller is started.

StartupHandler() - Constructor for class com.install4j.api.StartupHandler

StartupNotification - Class in com.install4j.api.launcher

This class allows you to register a listener to receive startup events in single instance mode on Microsoft Windows.

StartupNotification() - Constructor for class com.install4j.api.launcher.StartupNotification

StartupNotification.Listener - Interface in com.install4j.api.launcher

The interface for startup events in single instance mode.

startupPerformed(String) - Method in interface com.install4j.api.launcher.StartupNotification.Listener

Will be called when the executable is started again.

T

toString() - Method in class com.install4j.api.InstallerEvent

Return a verbose decription of this event.

toString() - Method in class com.install4j.api.windows.WinRegistry.ExpandString

U

UninstallAction - Class in com.install4j.api

All uninstall actions must be derived from this class.

UninstallAction() - Constructor for class com.install4j.api.UninstallAction

UserCanceledException - Exception in com.install4j.api

Installation methods throw this exception if the user cancels an operation.

UserCanceledException(String) - Constructor for exception com.install4j.api.UserCanceledException

Initializes a new instance with a message.

UserCanceledException() - Constructor for exception com.install4j.api.UserCanceledException

Initializes a new instance.

Util - Class in com.install4j.api

The class contains various utility functions to be used by custom actions and custom screens.

Util() - Constructor for class com.install4j.api.Util

V

validate(File) - Method in class com.install4j.api.DirectoryValidator

Validate the user selection for the installation directory.

W

WinAssociations - Class in com.install4j.api.windows

Collection of static methods to create and remove file associations on Microsoft Windows.

WinEnvVars - Class in com.install4j.api.windows

Handle global environment variables on Windows.

WinEnvVars() - Constructor for class com.install4j.api.windows.WinEnvVars

WinFileSystem - Class in com.install4j.api.windows

Collection of static methods to access Microsoft Windows-specific folder locations and to execute native file system operations.

WinRegistry - Class in com.install4j.api.windows

Collection of static methods to access the Microsoft Windows registry.

WinRegistry.ExpandString - Class in com.install4j.api.windows

Class to represent Strings with type REG_EXPAND_SZ

WinRegistry.ExpandString(String) - Constructor for class com.install4j.api.windows.WinRegistry.ExpandString

writeMessage(String) - Static method in class com.install4j.api.launcher.Controller

Update the status text line of the splash screen with a different message.

A C D E F G H I J K N O P R S T U V W