com.denova.JExpress.Installer
Interface InstallPropertyNames

All Known Implementing Classes:
CustomInstaller, CustomUninstaller

public interface InstallPropertyNames

The list of properties available during the installation.

Author:
DeNova Copyright © 1997-2008 DeNova All rights reserved worldwide.

Overview

The Variable List below consists of final public String (i.e., constants) that you can use to access the properties during the installation.

All of these variables return a string which can be used as the first parameter to getPropertiesList().getProperty (), getPropertiesList().setProperty(), getPropertiesList().getBooleanProperty(), and getPropertiesList().setBooleanProperty().

The type of the return value for each Property's value is included in the description of the property. In other words, the return value is not showing what the item (e.g., ApplicationDirectory) returns, but instead shows what getPropertiesList().getProperty(ApplicationDirectory) returns.

For those who are manually configuring the platform.properties files, all property names are lower/upper case. In other words, the constant ApplicationDirectory translates to applicationDirectory in the platform.properties file itself.


Field Summary
static java.lang.String AdminMenus
          Setup all menu items so all users can access them.
static java.lang.String ApplicationDirectory
          Name of the directory where user decided to install your application.
static java.lang.String ApplicationDirectoryTarget
          Name of the Target directory where user decided to store the Target files for the servlet or multiple directory installation.
static java.lang.String Author
          Author of the application.
static java.lang.String AutoupdateEveryStartup
          True if want your customers' systems updated before they start your app.
static java.lang.String AutoupdateNever
          True if you never want to autoupdate your customers.
static java.lang.String AutoupdateOnDemand
          True if you want your customer's systems automatically updated on demand.
static java.lang.String BasePath
          The base directory that all file paths are relative to.
static java.lang.String CheckGuiRunningCommand
          Command used to see if GUI is already running (only set in native installers).
static java.lang.String ConfigureWinRegistry
          If JVM installed on Windows target machine, then configure the windows registry (only set in native installers).
static java.lang.String ControlUrl
          The URL for the installer's Java Plug-in applet.
static java.lang.String CreatedMenuDirs
          A list of directories created while adding menus.
static java.lang.String CustomAfterDirectoryWizardPanelClass
          Classname(s) of any custom commands to be executed after the user is prompted to enter the installation directory, but before the files are installed.
static java.lang.String CustomAfterFilesInstalledWizardPanelClass
          Classname(s) of any custom commands to be executed after the files are installed.
static java.lang.String CustomAfterInstallWizardPanelClass
          Classname(s) of any custom commands to be executed after the installation of your application.
static java.lang.String CustomAfterLicenseWizardPanelClass
          Classname(s) of any custom command to be executed after license displayed.
static java.lang.String CustomAfterMenusWizardPanelClass
          Classname(s) of any custom command to be executed after the menus are added.
static java.lang.String CustomAfterMultipleInstallsWizardPanelClass
          Classname(s) of any custom command to be executed after user selects multiple install type.
static java.lang.String CustomAfterReadMeWizardPanelClass
          Classname(s) of any custom commands to be executed after the readme file displays.
static java.lang.String CustomAfterWelcomeWizardPanelClass
          Classname(s) of any custom commands to be executed after the welcome panel displays.
static java.lang.String CustomBeforeInstallWizardPanelClass
          Classname(s) of any custom commands to be executed before any other Java panels appear in installation, except the PasswordPanel.
static java.lang.String DefaultApplicationDirectory
          Name of the default directory where the application will be installed.
static java.lang.String DesktopShortcuts
          Add desktop shortcuts for all menu items.
static java.lang.String DownloadUrl
          URL where your application is stored on the web.
static java.lang.String ExtraParameters
           Extra parameters passed on the command line to a Pure Java installer.
static java.lang.String FileGroupsFolders
          List of folders, and the folder's associated files, used in a multiple type or servlet installation.
static java.lang.String FileGroupsTypes
          List of install types or target directories, and the type's associated folders, used in a multiple type or servlet installations.
static java.lang.String InstallButtonsPosition
          The position where the installer's buttons appear.
static java.lang.String InstallerDefaultLanguage
          Name of the default language to use if the installer doesn't support the target system's default language.
static java.lang.String InstallerExecutable
          Filename for the native executable program.
static java.lang.String InstallerExtraFiles
          Filename(s) of programs used during a native installation (only set in native installers).
static java.lang.String InstallImageFilename
          Filename for the image used during the installation.
static java.lang.String InstallImagePosition
          The position where the installer's image appears.
static java.lang.String InstallJvmParameters
          Parameters used to launch JVM for any menus created by installer.
static java.lang.String InstallLicenseFilename
          Filename for license.
static java.lang.String InstallPasswordDigest
          Password.
static java.lang.String InstallReadmeFilename
          Readme filename.
static java.lang.String InstallSuccessful
          Install successful is set to true if the installer successfully installed all files.
static java.lang.String InstallType
          The install type the user selected when multiple install types configured.
static java.lang.String InstallUserClasspath
          Classpath on target system relative to the application's directory.
static java.lang.String IsServlet
          True if this is a servlet installer.
static java.lang.String JvmClasspathSwitch
          Switch(es) used when starting JVM to launch installer (only set in native installers).
static java.lang.String JvmCommandName
          Name of program that starts jvm (only set in native installers).
static java.lang.String JvmExtraParameters
          Extra parameters used on the JVM's command line to start the installer (only set in native installers).
static java.lang.String JvmHomeDir
          JVM's home directory as determined by native installer.
static java.lang.String JvmMaxVersion
          Maximum version number of JVM required on target system (only set in native installers).
static java.lang.String JvmMinVersion
          Minimum version number of JVM required on target system (only set in native installers).
static java.lang.String JvmName
          Type of JVM installed, i.e., JRE, JDK (only set in native installers).
static java.lang.String JvmRequiredVersion
          Required version number of JVM required on target system (only set in native installers).
static java.lang.String JvmSelfExtractor
          Name of the self extracting archive for the JVM (only set in native installers).
static java.lang.String JvmVersion
          Version number of JVM to be installed with native installers (only set in native installers).
static java.lang.String LoaderClasspath
          Classpath for the installer (only set in native installers).
static java.lang.String LoaderJavaCommand
          Main classname for installer (only set in native installers).
static java.lang.String MainClassname
          Main classname of your application.
static java.lang.String MenuArguments
          The full list of arguments after the menu has been constructed during installation.
static java.lang.String MenuAssociatedInstallType
           
static java.lang.String MenuCommandLineArguments
          The command line arguments defined in JExpress for a menu item.
static java.lang.String MenuExecutableFile
          The executable filename for a menu.
static java.lang.String MenuIconName
          The filename for the icon file(s).
static java.lang.String MenuLongName
          The name for the menu on a Windows system.
static java.lang.String MenusAttributeName
          Details about menus for your application.
static java.lang.String MenuShortName
          The name for the script on a Unix system.
static java.lang.String MenuUseJavaCommandPrefix
          True if the menu is a Java command.
static java.lang.String MenuUseJavaConsole
          True if the menu uses a Java console.
static java.lang.String MenuUseSwing
          True if the menu uses Swing 1 point 1.
static java.lang.String MultipleComponents
          If this is a multiple component installer, then this property returns true.
static java.lang.String MultipleFileGroups
          True if there are multiple install types.
static java.lang.String MultipleInstallTypes
          If this is a multiple install type installer and the user may select one or more install types, then this property returns true.
static java.lang.String NativeJvmHomeDir
          JVM's home directory that installer is using (only set in native installers).
static java.lang.String NativeJvmInstalled
          True if native installer installed the JVM (only set in native installers).
static java.lang.String NativeJvmInstalledInTemp
          If JVM is intended to be installed in subdirectory of applicationDirectory, then returns true (only set in native installers).
static java.lang.String NextInstallTypes
          List of the remaining install types the user selected when multiple install types configured.
static java.lang.String OldApplicationDirectory
          The directory where the user last selected they wanted your application installed.
static java.lang.String PackageCopyright
          Copyright notice for your application.
static java.lang.String PackageCreated
          Date installer created.
static java.lang.String PackageName
          Name of product being installed.
static java.lang.String PackageVersion
          Version number of your application.
static java.lang.String PredefinedJvmInstallDir
          The predefined directory where the JVM is to be installed if one isn't found on the target system (only set in native installers).See JExpress' manual for more details about setting this property.
static java.lang.String RelativeFileMap
          The file map of the distribution fields.
static java.lang.String SafePackageName
          Name of your package that can be used to create filenames and/or directories on various systems.
static java.lang.String SearchForJvm
           Determines if and where the native installer searches for the correct JVM (only set in native installers).
static java.lang.String SelectedInstallTypes
          List of all the install types the user selected when multiple install types configured.
static java.lang.String SilentConfigFilename
          Contains the filename passed on the command line if the user specified a filename instead of a directory name for a silent install.
static java.lang.String SilentInstall
          True iff user started the installer with the silent command line switch.
static java.lang.String SingleInstallType
          If this is a multiple install type installer and the user may only select one install type, then this property returns true.
static java.lang.String StartDirectory
          Directory where user originally started the installation.
static java.lang.String StartGuiCommand
          Command to start GUI (only set in native installers).
static java.lang.String StartupScripts
          Add all menu items to the startup procedure.
static java.lang.String Submenu
          The name of the submenu for the menus.
static java.lang.String SystemSecurityPolicyFilename
          System security filename for Java 1.2 (only set in native installers).
static java.lang.String TextFileExtensions
          File extensions that designate a file as plain text.
static java.lang.String TotalBytesNeeded
          The total bytes needed for all the applications' files.
static java.lang.String UninstallerArgs
          Command line argument for the uninstaller.
static java.lang.String UninstallerPathname
          Full path for the uninstaller JAR filename.
static java.lang.String UnzipExecutable
          Filename used to create self extracting native installer (only set in native installers).
static java.lang.String UserSecurityPolicyFilename
          Filename for security policy for Java 1.2 (only set in native installers).
static java.lang.String WebSite
          URL for your web site.
 

Field Detail

ApplicationDirectory

public static final java.lang.String ApplicationDirectory
Name of the directory where user decided to install your application.

Property's value is a String.

See Also:
Constant Field Values

ApplicationDirectoryTarget

public static final java.lang.String ApplicationDirectoryTarget
Name of the Target directory where user decided to store the Target files for the servlet or multiple directory installation. For example, if the name you supplied for a servlet's target directory is Classes, then the property for the associated directory is applicationDirectoryClasses.

Do not use ApplicationDirectoryTarget. Use the property name based on your project.

See Also:
Constant Field Values

AutoupdateEveryStartup

public static final java.lang.String AutoupdateEveryStartup
True if want your customers' systems updated before they start your app.

Property's value is a boolean.

See Also:
Constant Field Values

AutoupdateNever

public static final java.lang.String AutoupdateNever
True if you never want to autoupdate your customers.

Property's value is a boolean.

See Also:
Constant Field Values

AutoupdateOnDemand

public static final java.lang.String AutoupdateOnDemand
True if you want your customer's systems automatically updated on demand.

Property's value is a boolean.

See Also:
Constant Field Values

CheckGuiRunningCommand

public static final java.lang.String CheckGuiRunningCommand
Command used to see if GUI is already running (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

ConfigureWinRegistry

public static final java.lang.String ConfigureWinRegistry
If JVM installed on Windows target machine, then configure the windows registry (only set in native installers).

It is strongly advised that you set this property to true. Although later versions of the JVM on Windows do not require the registry be configured, it does operate more reliably when the registry has the JVM's properties. The JVM can stop operating or give inconsistent results when running your application when the registry isn't properly configured.

Property's value is a boolean.

See Also:
Constant Field Values

ControlUrl

public static final java.lang.String ControlUrl
The URL for the installer's Java Plug-in applet.

Property's value is a String.

See Also:
Constant Field Values

CustomAfterDirectoryWizardPanelClass

public static final java.lang.String CustomAfterDirectoryWizardPanelClass
Classname(s) of any custom commands to be executed after the user is prompted to enter the installation directory, but before the files are installed.

Property's value is a String.

See Also:
Constant Field Values

CustomAfterFilesInstalledWizardPanelClass

public static final java.lang.String CustomAfterFilesInstalledWizardPanelClass
Classname(s) of any custom commands to be executed after the files are installed.

Property's value is a String.

See Also:
Constant Field Values

CustomAfterInstallWizardPanelClass

public static final java.lang.String CustomAfterInstallWizardPanelClass
Classname(s) of any custom commands to be executed after the installation of your application.

Property's value is a String.

See Also:
Constant Field Values

CustomAfterLicenseWizardPanelClass

public static final java.lang.String CustomAfterLicenseWizardPanelClass
Classname(s) of any custom command to be executed after license displayed.

Property's value is a String.

See Also:
Constant Field Values

CustomAfterMenusWizardPanelClass

public static final java.lang.String CustomAfterMenusWizardPanelClass
Classname(s) of any custom command to be executed after the menus are added.

Property's value is a String.

See Also:
Constant Field Values

CustomAfterMultipleInstallsWizardPanelClass

public static final java.lang.String CustomAfterMultipleInstallsWizardPanelClass
Classname(s) of any custom command to be executed after user selects multiple install type. Only used if multiple install types selected.

Property's value is a String.

See Also:
Constant Field Values

CustomAfterReadMeWizardPanelClass

public static final java.lang.String CustomAfterReadMeWizardPanelClass
Classname(s) of any custom commands to be executed after the readme file displays.

Property's value is a String.

See Also:
Constant Field Values

CustomAfterWelcomeWizardPanelClass

public static final java.lang.String CustomAfterWelcomeWizardPanelClass
Classname(s) of any custom commands to be executed after the welcome panel displays.

Property's value is a String.

See Also:
Constant Field Values

CustomBeforeInstallWizardPanelClass

public static final java.lang.String CustomBeforeInstallWizardPanelClass
Classname(s) of any custom commands to be executed before any other Java panels appear in installation, except the PasswordPanel. If you're creating a native installer, these classes will be invoked after the JVM is detected, and potentially installed.

Property's value is a String.

See Also:
Constant Field Values

DefaultApplicationDirectory

public static final java.lang.String DefaultApplicationDirectory
Name of the default directory where the application will be installed.

Property's value is a String.

See Also:
Constant Field Values

InstallerDefaultLanguage

public static final java.lang.String InstallerDefaultLanguage
Name of the default language to use if the installer doesn't support the target system's default language.

Property's value is a String.

See Also:
Constant Field Values

DownloadUrl

public static final java.lang.String DownloadUrl
URL where your application is stored on the web. Used for autoupdates.

Property's value is a String.

See Also:
Constant Field Values

ExtraParameters

public static final java.lang.String ExtraParameters
Extra parameters passed on the command line to a Pure Java installer. The extra parameter(s) must be at the end of the command line and they must be preceeded by -p and a space. Only Pure Java installers support passing extra parameters on the command line.

Property's value is a String.

See Also:
Constant Field Values

FileGroupsFolders

public static final java.lang.String FileGroupsFolders
List of folders, and the folder's associated files, used in a multiple type or servlet installation. If you'd like to create a custom panel to manage multiple install types, then please review these additional docs.

Returns a FileGroup.

See Also:
Constant Field Values

FileGroupsTypes

public static final java.lang.String FileGroupsTypes
List of install types or target directories, and the type's associated folders, used in a multiple type or servlet installations. If you'd like to create a custom panel to manage multiple install types, then please review the additional docs.

Returns a FileGroupsListEditor.

See Also:
Constant Field Values

InstallImageFilename

public static final java.lang.String InstallImageFilename
Filename for the image used during the installation.

Property's value is a String.

See Also:
Constant Field Values

InstallImagePosition

public static final java.lang.String InstallImagePosition
The position where the installer's image appears.

Property's value is a String(North, South, East, or West) .

See Also:
Constant Field Values

InstallButtonsPosition

public static final java.lang.String InstallButtonsPosition
The position where the installer's buttons appear.

Property's value is a String (North, South, East, or West) .

See Also:
Constant Field Values

InstallerExecutable

public static final java.lang.String InstallerExecutable
Filename for the native executable program. This Property's value is only available when building your installer(s), not during installation.

Property's value is a String.

See Also:
Constant Field Values

InstallerExtraFiles

public static final java.lang.String InstallerExtraFiles
Filename(s) of programs used during a native installation (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

InstallJvmParameters

public static final java.lang.String InstallJvmParameters
Parameters used to launch JVM for any menus created by installer.

Property's value is a String.

See Also:
Constant Field Values

InstallLicenseFilename

public static final java.lang.String InstallLicenseFilename
Filename for license. Blank if you don't want to require they agree to license during installation.

Property's value is a String.

See Also:
Constant Field Values

InstallPasswordDigest

public static final java.lang.String InstallPasswordDigest
Password. Blank if no password required for the installation.

Property's value is a String.

See Also:
Constant Field Values

InstallReadmeFilename

public static final java.lang.String InstallReadmeFilename
Readme filename. Blank if no readme file to be displayed during installation.

Property's value is a String.

See Also:
Constant Field Values

InstallSuccessful

public static final java.lang.String InstallSuccessful
Install successful is set to true if the installer successfully installed all files. Defaults to true.

Property's value is a boolean.

See Also:
Constant Field Values

InstallType

public static final java.lang.String InstallType
The install type the user selected when multiple install types configured. If multiple install types can be selected, then this is the first install type that was selected from the list of possibilities.

Property's value is a String.

See Also:
Constant Field Values

SelectedInstallTypes

public static final java.lang.String SelectedInstallTypes
List of all the install types the user selected when multiple install types configured. This list does not change, even after the install types have been processed by the installer.

Property's value is a String.

See Also:
Constant Field Values

NextInstallTypes

public static final java.lang.String NextInstallTypes
List of the remaining install types the user selected when multiple install types configured. If you want the complete list of install types/components the user selected, then use the selectedInstallTypes property.

Property's value is a String.

See Also:
Constant Field Values

SingleInstallType

public static final java.lang.String SingleInstallType
If this is a multiple install type installer and the user may only select one install type, then this property returns true. The default is to allow a user to only select one install type.

Property's value is a boolean.

See Also:
Constant Field Values

MultipleInstallTypes

public static final java.lang.String MultipleInstallTypes
If this is a multiple install type installer and the user may select one or more install types, then this property returns true.

Property's value is a boolean.

See Also:
Constant Field Values

MultipleComponents

public static final java.lang.String MultipleComponents
If this is a multiple component installer, then this property returns true.

Property's value is a boolean.

See Also:
Constant Field Values

InstallUserClasspath

public static final java.lang.String InstallUserClasspath
Classpath on target system relative to the application's directory.

Property's value is a String.

See Also:
Constant Field Values

IsServlet

public static final java.lang.String IsServlet
True if this is a servlet installer.

Property's value is a boolean.

See Also:
Constant Field Values

JvmClasspathSwitch

public static final java.lang.String JvmClasspathSwitch
Switch(es) used when starting JVM to launch installer (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

JvmCommandName

public static final java.lang.String JvmCommandName
Name of program that starts jvm (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

JvmExtraParameters

public static final java.lang.String JvmExtraParameters
Extra parameters used on the JVM's command line to start the installer (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

JvmHomeDir

public static final java.lang.String JvmHomeDir
JVM's home directory as determined by native installer. This field should always be blank in the platform.properties file.

Property's value is a String.

See Also:
Constant Field Values

JvmMaxVersion

public static final java.lang.String JvmMaxVersion
Maximum version number of JVM required on target system (only set in native installers). Only used if jvmRequiredVersion is blank; if jvmMaxVersion is blank, then any JVM that is the jvmMinVersion or later is acceptable.

Property's value is a String.

See Also:
Constant Field Values

JvmMinVersion

public static final java.lang.String JvmMinVersion
Minimum version number of JVM required on target system (only set in native installers). Only used if jvmRequiredVersion is blank.

Property's value is a String.

See Also:
Constant Field Values

JvmName

public static final java.lang.String JvmName
Type of JVM installed, i.e., JRE, JDK (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

JvmRequiredVersion

public static final java.lang.String JvmRequiredVersion
Required version number of JVM required on target system (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

JvmSelfExtractor

public static final java.lang.String JvmSelfExtractor
Name of the self extracting archive for the JVM (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

JvmVersion

public static final java.lang.String JvmVersion
Version number of JVM to be installed with native installers (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

LoaderClasspath

public static final java.lang.String LoaderClasspath
Classpath for the installer (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

LoaderJavaCommand

public static final java.lang.String LoaderJavaCommand
Main classname for installer (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

MainClassname

public static final java.lang.String MainClassname
Main classname of your application. Only set if JExpress automatically finds classes.

Property's value is a String.

See Also:
Constant Field Values

Submenu

public static final java.lang.String Submenu
The name of the submenu for the menus. If you want the menus added to a submenu, then use a forward slash to separate each level (e.g., Development/JExpress).

Property's value is a String.

See Also:
Constant Field Values

CreatedMenuDirs

public static final java.lang.String CreatedMenuDirs
A list of directories created while adding menus.

Property's value is a String.

See Also:
Constant Field Values

MenuCommandLineArguments

public static final java.lang.String MenuCommandLineArguments
The command line arguments defined in JExpress for a menu item.

Property's value is a String.

See Also:
Constant Field Values

MenuExecutableFile

public static final java.lang.String MenuExecutableFile
The executable filename for a menu.

Property's value is a String.

See Also:
Constant Field Values

MenuIconName

public static final java.lang.String MenuIconName
The filename for the icon file(s).

The basename is used to construct the full name for the Windows .ico file, the Mac OS X .icns file, and KDE's .png file

Property's value is a String.

See Also:
Constant Field Values

MenuAssociatedInstallType

public static final java.lang.String MenuAssociatedInstallType
See Also:
Constant Field Values

MenuLongName

public static final java.lang.String MenuLongName
The name for the menu on a Windows system.

If blank, then no menu item is created on Windows.

Property's value is a String.

See Also:
Constant Field Values

MenuShortName

public static final java.lang.String MenuShortName
The name for the script on a Unix system.

If blank, then no script is created on Unix.

Property's value is a String.

See Also:
Constant Field Values

MenuUseJavaCommandPrefix

public static final java.lang.String MenuUseJavaCommandPrefix
True if the menu is a Java command.

Property's value is a boolean.

See Also:
Constant Field Values

MenuUseJavaConsole

public static final java.lang.String MenuUseJavaConsole
True if the menu uses a Java console.

Property's value is a boolean.

See Also:
Constant Field Values

MenuUseSwing

public static final java.lang.String MenuUseSwing
True if the menu uses Swing 1 point 1.

Property's value is a boolean.

See Also:
Constant Field Values

MenusAttributeName

public static final java.lang.String MenusAttributeName
Details about menus for your application.

Returns a PropertyList.

See Also:
Constant Field Values

MenuArguments

public static final java.lang.String MenuArguments
The full list of arguments after the menu has been constructed during installation.

You must prepend the menu's name (as shown in JExpress' list of menus) to the beginning of this property. For example, if your menu is named "JExpress", then the property name would be "JExpressMenuArgs" (without "").

If the menu was a java command, then the list includes the full path to the jvm, the classpath switch, etc.

Property's value is a String. Use StringConversion.fromList() to convert into a list of arguments

See Also:
Constant Field Values

MultipleFileGroups

public static final java.lang.String MultipleFileGroups
True if there are multiple install types.

Property's value is a boolean.

See Also:
Constant Field Values

NativeJvmHomeDir

public static final java.lang.String NativeJvmHomeDir
JVM's home directory that installer is using (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

NativeJvmInstalled

public static final java.lang.String NativeJvmInstalled
True if native installer installed the JVM (only set in native installers).

Property's value is a boolean.

See Also:
Constant Field Values

NativeJvmInstalledInTemp

public static final java.lang.String NativeJvmInstalledInTemp
If JVM is intended to be installed in subdirectory of applicationDirectory, then returns true (only set in native installers).

Property's value is a boolean.

See Also:
Constant Field Values

PredefinedJvmInstallDir

public static final java.lang.String PredefinedJvmInstallDir
The predefined directory where the JVM is to be installed if one isn't found on the target system (only set in native installers).See JExpress' manual for more details about setting this property.

Property's value is a String.

See Also:
Constant Field Values

OldApplicationDirectory

public static final java.lang.String OldApplicationDirectory
The directory where the user last selected they wanted your application installed. This field is usually blank as it is used internally to one of the standard panels.

See Also:
Constant Field Values

Author

public static final java.lang.String Author
Author of the application.

Property's value is a String.

See Also:
Constant Field Values

PackageCopyright

public static final java.lang.String PackageCopyright
Copyright notice for your application.

Property's value is a String.

See Also:
Constant Field Values

PackageCreated

public static final java.lang.String PackageCreated
Date installer created.

Property's value is a String.

See Also:
Constant Field Values

PackageName

public static final java.lang.String PackageName
Name of product being installed.

Property's value is a String.

See Also:
Constant Field Values

PackageVersion

public static final java.lang.String PackageVersion
Version number of your application.

Property's value is a String.

See Also:
Constant Field Values

RelativeFileMap

public static final java.lang.String RelativeFileMap
The file map of the distribution fields. Only available in multiple install types and multiple directory installers.

Property's value is a String.

See Also:
Constant Field Values

BasePath

public static final java.lang.String BasePath
The base directory that all file paths are relative to. If this field is blank, then all file paths are absolute. The base directory is similar to "ant's" basedir.

Property's value is a String.

See Also:
Constant Field Values

SafePackageName

public static final java.lang.String SafePackageName
Name of your package that can be used to create filenames and/or directories on various systems.

Property's value is a String.

See Also:
Constant Field Values

SearchForJvm

public static final java.lang.String SearchForJvm
Determines if and where the native installer searches for the correct JVM (only set in native installers).

Defaults to "all" which means that the native installer searches all likely places to find the JVM. If it's set to "registry or path", then the native installer searches only the registry on a Windows system and only the path on a Unix system. If it's set to "no" or "none", then it does not search the system for the JVM, but simply installs the JVM in a new directory.

Do not use the "" around the values. The values must be exact matches.

Property's value is a String.

See Also:
Constant Field Values

SilentConfigFilename

public static final java.lang.String SilentConfigFilename
Contains the filename passed on the command line if the user specified a filename instead of a directory name for a silent install. The file must contain the applicationDirectory property, or the file is ignored and the installation is not silent.

Property's value is a String.

See Also:
Constant Field Values

SilentInstall

public static final java.lang.String SilentInstall
True iff user started the installer with the silent command line switch.

Property's value is a boolean.

See Also:
Constant Field Values

StartDirectory

public static final java.lang.String StartDirectory
Directory where user originally started the installation.

Property's value is a String.

See Also:
Constant Field Values

StartGuiCommand

public static final java.lang.String StartGuiCommand
Command to start GUI (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

SystemSecurityPolicyFilename

public static final java.lang.String SystemSecurityPolicyFilename
System security filename for Java 1.2 (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

TextFileExtensions

public static final java.lang.String TextFileExtensions
File extensions that designate a file as plain text.

Property's value is a String.

See Also:
Constant Field Values

TotalBytesNeeded

public static final java.lang.String TotalBytesNeeded
The total bytes needed for all the applications' files. The full installation usually requires a little more space to accommodate the manifest, launch scripts, etc.

Returns a long.

See Also:
Constant Field Values

UninstallerPathname

public static final java.lang.String UninstallerPathname
Full path for the uninstaller JAR filename.

Property's value is a String.

See Also:
Constant Field Values

UninstallerArgs

public static final java.lang.String UninstallerArgs
Command line argument for the uninstaller. Valid arguments are -q or -n. A -q argument will make the uninstaller quiet. A -n switch will make the uninstaller skip prompting the user if it's ok to uninstall or not. The custom class that sets this property must be included before "After menus added".

Property's value is a String.

See Also:
Constant Field Values

UnzipExecutable

public static final java.lang.String UnzipExecutable
Filename used to create self extracting native installer (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

UserSecurityPolicyFilename

public static final java.lang.String UserSecurityPolicyFilename
Filename for security policy for Java 1.2 (only set in native installers).

Property's value is a String.

See Also:
Constant Field Values

WebSite

public static final java.lang.String WebSite
URL for your web site.

Property's value is a String.

See Also:
Constant Field Values

DesktopShortcuts

public static final java.lang.String DesktopShortcuts
Add desktop shortcuts for all menu items.

Property's value is a boolean; defaults to false.

See Also:
Constant Field Values

AdminMenus

public static final java.lang.String AdminMenus
Setup all menu items so all users can access them.

Property's value is a boolean; defaults to false.

See Also:
Constant Field Values

StartupScripts

public static final java.lang.String StartupScripts
Add all menu items to the startup procedure.

Property's value is a boolean; defaults to false.

See Also:
Constant Field Values