install4j API documentation
This documentation specifies the public API that install4j provides for scripting installers and uninstallers, developing extensions and for accessing runtime services.
Getting started
Please read "API->installer API" in the documentation for an overview on how to use the API.
Packaging your own beans as regular install4j extensions is explained under "API->Extensions".
The documentation is found under doc in the installation directory and can be displayed with
the F1 keyboard shortcut in the install4j IDE.
To get started with writing your own screens, actions and form components, please have a look at the "Custom code"
example project that is located under samples/customCode in the installation directory.
Classpath for framework classes
When developing your own classes, you have to add the install4j API to your compile classpath.
Do not distribute this jar file with your application, install4j will handle this for you. i4jruntime.jar
will be automatically available on the classpath in the installer as well as for all launchers
generated by install4j. The install4j runtime is available as a Maven dependency:
Maven
<dependency>
<groupId>com.install4j</groupId>
<artifactId>install4j-runtime</artifactId>
<version>11.0.1</version>
</dependency>
<repository>
<id>ej-technologies</id>
<url>https://maven.ej-technologies.com/repository</url>
</repository>
Gradle
repositories {
maven {
url 'https://maven.ej-technologies.com/repository'
}
}
dependencies {
classpath group: 'com.install4j', name: 'install4j-runtime', version: '11.0.1'
}
If a Maven dependency is not an option, you can add the JAR files that are located under
resource/i4jruntime.jar and resource/i4jruntime-dev-additional.jar in the installation
directory. The Maven dependency combines both of these JAR files.
Some API calls, such as com.install4j.api.launcher.Variables.getCompilerVariable(...), require
the config file of an installation. If you set the system property install4j.runtimeDir to the
.install4j directory of an installation of your project, the config file will be loaded from
that directory.
Extension points
install4j provides four extension points: screens, actions, form components and styles. Please see the corresponding package overview for more information: