|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
The list of properties available during the installation.
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 |
public static final java.lang.String ApplicationDirectory
Property's value is a String.
public static final java.lang.String ApplicationDirectoryTarget
Do not use ApplicationDirectoryTarget. Use the property name based on your project.
public static final java.lang.String AutoupdateEveryStartup
Property's value is a boolean.
public static final java.lang.String AutoupdateNever
Property's value is a boolean.
public static final java.lang.String AutoupdateOnDemand
Property's value is a boolean.
public static final java.lang.String CheckGuiRunningCommand
Property's value is a String.
public static final java.lang.String ConfigureWinRegistry
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.
public static final java.lang.String ControlUrl
Property's value is a String.
public static final java.lang.String CustomAfterDirectoryWizardPanelClass
Property's value is a String.
public static final java.lang.String CustomAfterFilesInstalledWizardPanelClass
Property's value is a String.
public static final java.lang.String CustomAfterInstallWizardPanelClass
Property's value is a String.
public static final java.lang.String CustomAfterLicenseWizardPanelClass
Property's value is a String.
public static final java.lang.String CustomAfterMenusWizardPanelClass
Property's value is a String.
public static final java.lang.String CustomAfterMultipleInstallsWizardPanelClass
Property's value is a String.
public static final java.lang.String CustomAfterReadMeWizardPanelClass
Property's value is a String.
public static final java.lang.String CustomAfterWelcomeWizardPanelClass
Property's value is a String.
public static final java.lang.String CustomBeforeInstallWizardPanelClass
Property's value is a String.
public static final java.lang.String DefaultApplicationDirectory
Property's value is a String.
public static final java.lang.String InstallerDefaultLanguage
Property's value is a String.
public static final java.lang.String DownloadUrl
Property's value is a String.
public static final java.lang.String ExtraParameters
Property's value is a String.
public static final java.lang.String FileGroupsFolders
Returns a FileGroup.
public static final java.lang.String FileGroupsTypes
Returns a FileGroupsListEditor.
public static final java.lang.String InstallImageFilename
Property's value is a String.
public static final java.lang.String InstallImagePosition
Property's value is a String(North, South, East, or West) .
public static final java.lang.String InstallButtonsPosition
Property's value is a String (North, South, East, or West) .
public static final java.lang.String InstallerExecutable
Property's value is a String.
public static final java.lang.String InstallerExtraFiles
Property's value is a String.
public static final java.lang.String InstallJvmParameters
Property's value is a String.
public static final java.lang.String InstallLicenseFilename
Property's value is a String.
public static final java.lang.String InstallPasswordDigest
Property's value is a String.
public static final java.lang.String InstallReadmeFilename
Property's value is a String.
public static final java.lang.String InstallSuccessful
Property's value is a boolean.
public static final java.lang.String InstallType
Property's value is a String.
public static final java.lang.String SelectedInstallTypes
Property's value is a String.
public static final java.lang.String NextInstallTypes
Property's value is a String.
public static final java.lang.String SingleInstallType
Property's value is a boolean.
public static final java.lang.String MultipleInstallTypes
Property's value is a boolean.
public static final java.lang.String MultipleComponents
Property's value is a boolean.
public static final java.lang.String InstallUserClasspath
Property's value is a String.
public static final java.lang.String IsServlet
Property's value is a boolean.
public static final java.lang.String JvmClasspathSwitch
Property's value is a String.
public static final java.lang.String JvmCommandName
Property's value is a String.
public static final java.lang.String JvmExtraParameters
Property's value is a String.
public static final java.lang.String JvmHomeDir
Property's value is a String.
public static final java.lang.String JvmMaxVersion
Property's value is a String.
public static final java.lang.String JvmMinVersion
Property's value is a String.
public static final java.lang.String JvmName
Property's value is a String.
public static final java.lang.String JvmRequiredVersion
Property's value is a String.
public static final java.lang.String JvmSelfExtractor
Property's value is a String.
public static final java.lang.String JvmVersion
Property's value is a String.
public static final java.lang.String LoaderClasspath
Property's value is a String.
public static final java.lang.String LoaderJavaCommand
Property's value is a String.
public static final java.lang.String MainClassname
Property's value is a String.
public static final java.lang.String Submenu
Property's value is a String.
public static final java.lang.String CreatedMenuDirs
Property's value is a String.
public static final java.lang.String MenuCommandLineArguments
Property's value is a String.
public static final java.lang.String MenuExecutableFile
Property's value is a String.
public static final java.lang.String MenuIconName
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.
public static final java.lang.String MenuAssociatedInstallType
public static final java.lang.String MenuLongName
If blank, then no menu item is created on Windows.
Property's value is a String.
public static final java.lang.String MenuShortName
If blank, then no script is created on Unix.
Property's value is a String.
public static final java.lang.String MenuUseJavaCommandPrefix
Property's value is a boolean.
public static final java.lang.String MenuUseJavaConsole
Property's value is a boolean.
public static final java.lang.String MenuUseSwing
Property's value is a boolean.
public static final java.lang.String MenusAttributeName
Returns a PropertyList.
public static final java.lang.String MenuArguments
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
public static final java.lang.String MultipleFileGroups
Property's value is a boolean.
public static final java.lang.String NativeJvmHomeDir
Property's value is a String.
public static final java.lang.String NativeJvmInstalled
Property's value is a boolean.
public static final java.lang.String NativeJvmInstalledInTemp
Property's value is a boolean.
public static final java.lang.String PredefinedJvmInstallDir
Property's value is a String.
public static final java.lang.String OldApplicationDirectory
public static final java.lang.String Author
Property's value is a String.
public static final java.lang.String PackageCopyright
Property's value is a String.
public static final java.lang.String PackageCreated
Property's value is a String.
public static final java.lang.String PackageName
Property's value is a String.
public static final java.lang.String PackageVersion
Property's value is a String.
public static final java.lang.String RelativeFileMap
Property's value is a String.
public static final java.lang.String BasePath
Property's value is a String.
public static final java.lang.String SafePackageName
Property's value is a String.
public static final java.lang.String SearchForJvm
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.
public static final java.lang.String SilentConfigFilename
Property's value is a String.
public static final java.lang.String SilentInstall
Property's value is a boolean.
public static final java.lang.String StartDirectory
Property's value is a String.
public static final java.lang.String StartGuiCommand
Property's value is a String.
public static final java.lang.String SystemSecurityPolicyFilename
Property's value is a String.
public static final java.lang.String TextFileExtensions
Property's value is a String.
public static final java.lang.String TotalBytesNeeded
Returns a long.
public static final java.lang.String UninstallerPathname
Property's value is a String.
public static final java.lang.String UninstallerArgs
Property's value is a String.
public static final java.lang.String UnzipExecutable
Property's value is a String.
public static final java.lang.String UserSecurityPolicyFilename
Property's value is a String.
public static final java.lang.String WebSite
Property's value is a String.
public static final java.lang.String DesktopShortcuts
Property's value is a boolean; defaults to false.
public static final java.lang.String AdminMenus
Property's value is a boolean; defaults to false.
public static final java.lang.String StartupScripts
Property's value is a boolean; defaults to false.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||