com.denova.JExpress.Installer
Interface InstallPropertyNames

All Known Implementing Classes:

CustomInstaller, CustomUninstaller, JExpressPropertyStore, StatusPanel

public interface InstallPropertyNames

The list of properties available during the installation.

Author:

DeNova © 1997-2011 DeNova.com Last modified: 2011-12-12

Overview

The Variable List below consists of public static final 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	AbortIfErrorWithDefaultInstallDir If true and PromptForInstallDir is false, then abort the installation if unable to install application into the default install directory.
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	AutoDetectLanguage Set whether to automatically detect the language the user uses.
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	BackgroundColor Background color of windows and buttons.
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	CheckLicenseDuringInstall If true, then verify the license is ok during installation.
static java.lang.String	CheckLicenseDuringUpdate If true, then verify the license is ok during update.
static java.lang.String	CheckLicenseFromYourApp If true, then save license settings so app can verify license.
static java.lang.String	CheckPreVersion Check if the new version is lexicographically less than the previous version (ignoring case).
static java.lang.String	ClickFreeInstaller True if the installer should not prompt the user for any input.
static java.lang.String	ClickFreeUninstaller True if the uninstaller should not prompt the user for any input.
static java.lang.String	ClickFreeUpdater True if the updater should not prompt the user for any input.
static java.lang.String	CompressedFileSize The file size of all the distributed files compressed.
static java.lang.String	ConfigureWinRegistry If true, do not change the Windows registry.
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	DefaultLinuxParentAppDir Name of the default directoryparent of the default install directory on Linux, e.g., /usr/local
static java.lang.String	DefaultMacParentAppDir Name of the default directoryparent of the default install directory on Mac, e.g., /Applications
static java.lang.String	DefaultOtherParentAppDir Name of the default directoryparent of the default install directory on other OSes, e.g., /usr/local.
static java.lang.String	DefaultSolarisParentAppDir Name of the default directoryparent of the default install directory on Solaris, e.g., /usr/share
static java.lang.String	DefaultWindowsParentAppDir Name of the parent of the default install directory on Windows, e.g., Program files as defined in Registry.
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 Cross Platform installer.
static java.lang.String	FailIfNoLicenseServer If true, then fail if unable to connect to license server.
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	InitialUserName The initial user name that started the installer.
static java.lang.String	InstallAsAdmin If true, require the installer run as administrator on Windows.
static java.lang.String	InstallationStarted True if CopyCheq acknowledged that the installation has started.
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	JavaAppFilesSigned True if the JavaApp EXEs are signed.
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	LAFTheme Name of the theme for the look and feel, if applicable.
static java.lang.String	LicenseAccount The following settings only have values if installer checks license and only after the license has been verified.
static java.lang.String	LicenseAppRight
static java.lang.String	LicenseEndUser The end user's email of the license as defined in CopyCheq service.
static java.lang.String	LicenseError The last error message after checking with CopyCheq service.
static java.lang.String	LicenseIdCode The ID code of the license as defined in CopyCheq service.
static java.lang.String	LicenseName
static java.lang.String	LicensePrimaryContact The primary contact's email of the license as defined in CopyCheq service.
static java.lang.String	LicenseProduct
static java.lang.String	LicenseRight
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	LookAndFeelInterface Name of the look and feel interface.
static java.lang.String	MainClassname Main classname of your application.
static java.lang.String	MenuAllUsers If true, configue a Windows menu for all users.
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	MenuAutoStartup Add this menu item to the login startup procedure.
static java.lang.String	MenuAutoUpdate If true *and* AutoupdateEveryStartup true, then configure menu to auto-update.
static java.lang.String	MenuCommandLineArguments The command line arguments defined in JExpress for a menu item.
static java.lang.String	MenuDesktopShortcut Add desktop shortcut for this 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	MenuInstallAsService If true, install a Windows menu as a service -- not used yet.
static java.lang.String	MenuLongName The name for the menu on a Windows system.
static java.lang.String	MenuRunAsAdmin If true, require a Windows menu run as administrator.
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	MenuStartAfterInstall If true, start the menu at the end of installation.
static java.lang.String	MenuToStart The menu to tell the user to start your app on Windows if TellUserHowToStart is true.
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	MinimizedImageFilename Filename for the minimized image used during the installation.
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	OnDemandDesktopShortcut Add desktop shortcut for the auto-update on demand menu.
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	PackJarFile If true, pack all distribution files using Pack 200.
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	PreviousApplicationDir Name of the directory where user installed the application previously.
static java.lang.String	PreviousVersion Previous version installed.
static java.lang.String	ProgressBarColor Color of the progress bar.
static java.lang.String	PromptForInstallDir If true, then the user is prompted for the install directory.
static java.lang.String	PromptUserBeforeUninstalling True if the uninstaller should prompt the user before uninstalling.
static java.lang.String	ProxyHost The host for the proxy server.
static java.lang.String	ProxyPassword The user name's password the proxy server.
static java.lang.String	ProxyPort The prot for the proxy server.
static java.lang.String	ProxyUserName The user name for the proxy server.
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	SaveFilePermissions If true and installer built on unix and installed on unix, then file permissions are set on target installed machine.
static java.lang.String	SaveInstallEnvironment Save the install directory and version, if true.
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	SetLastModifiedDate If true, then the original file's last modified date is set when installing files.
static java.lang.String	ShowFinalPanel If true, always show the Final panel.
static java.lang.String	ShowFrame Show the frame and title.
static java.lang.String	ShowWelcomePanel If true, then show the Welcome panel with details about the product.
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 or the installer was created as a silent only installer.
static java.lang.String	SilentUninstaller True if the uninstaller should be silent.
static java.lang.String	SilentUpdater True if the updater should be silent.
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	StartAppName Name of app to start at the end of installation.
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	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	TestPropertiesFilename Contains the test properties filename passed on the command line.
static java.lang.String	TextColor Color of the text.
static java.lang.String	TextFileExtensions File extensions that designate a file as plain text.
static java.lang.String	TotalBytesNeeded Deprecated. use UncompressedTotalSize.
static java.lang.String	TotalCompressedFiles The total files distributed.
static java.lang.String	TrackConversions If you want to track conversion points for your software with DeNova's Convert, then this property returns true.
static java.lang.String	UncompressedTotalSize The total size of all the distributed files uncompressed.
static java.lang.String	UninstallerArgs Deprecated. use clickFreeUninstaller, silentUninstaller, and promptUserBeforeUninstalling Property's value is a String.
static java.lang.String	UninstallerIconPath Full path for the uninstaller's icon filename on Windows.
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	UserRequestedSilentInstall True iff user started the installer with the silent command line switch.
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

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

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

PreviousApplicationDir

static final java.lang.String PreviousApplicationDir

Name of the directory where user installed the application previously. The previous installation must have had SetInstallEnvironment true. Set by the installer in the WelcomePanel. Property's value is a String.

See Also:

Constant Field Values

PreviousVersion

static final java.lang.String PreviousVersion

Previous version installed. The previous installation must have had SetInstallEnvironment true. Set by the installer in the WelcomePanel. Property's value is a String.

See Also:

Constant Field Values

AutoupdateEveryStartup

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

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

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

OnDemandDesktopShortcut

static final java.lang.String OnDemandDesktopShortcut

Add desktop shortcut for the auto-update on demand menu.

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

See Also:

Constant Field Values

CheckGuiRunningCommand

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

static final java.lang.String ConfigureWinRegistry

If true, do not change the Windows registry. The Windows registry is updated with the uninstall details on Windows Vista/7 even if this setting is false because otherwise Win Vista/7 reports that that the installation didn't finish correctly.

Property's value is a boolean.

See Also:

Constant Field Values

InstallAsAdmin

static final java.lang.String InstallAsAdmin

If true, require the installer run as administrator on Windows. Important: Do not change this label unless you change defs.h, too.

Property's value is a boolean.

See Also:

Constant Field Values

InitialUserName

static final java.lang.String InitialUserName

The initial user name that started the installer.

Property's value is a string.

See Also:

Constant Field Values

PromptForInstallDir

static final java.lang.String PromptForInstallDir

If true, then the user is prompted for the install directory. Otherwise, the default install directory is used, if possible. If any errors happen while trying to use the default directory, then the user is prompted for the directory.

Property's value is a boolean.

See Also:

Constant Field Values

AbortIfErrorWithDefaultInstallDir

static final java.lang.String AbortIfErrorWithDefaultInstallDir

If true and PromptForInstallDir is false, then abort the installation if unable to install application into the default install directory.

Property's value is a boolean.

See Also:

Constant Field Values

ShowWelcomePanel

static final java.lang.String ShowWelcomePanel

If true, then show the Welcome panel with details about the product.

Property's value is a boolean.

See Also:

Constant Field Values

ShowFinalPanel

static final java.lang.String ShowFinalPanel

If true, always show the Final panel. If false and there are errors, then show the Final panel.

Property's value is a boolean.

See Also:

Constant Field Values

SaveInstallEnvironment

static final java.lang.String SaveInstallEnvironment

Save the install directory and version, if true. If it finds data from a previous install, defaults the application directory to the same directory name as the previous install. If true and used on Windows, then the registry will be updated with the version and application directory. Must be true for CheckPreVersion to work.

Property's value is a boolean. Default is false.

See Also:

Constant Field Values

CheckPreVersion

static final java.lang.String CheckPreVersion

Check if the new version is lexicographically less than the previous version (ignoring case). If it is, JExpress warns the user and asks what they want to do. SaveInstallEnvironment must also be true for the check to work. Windows registry is updated if true.

Property's value is a boolean. Default is false.

See Also:

Constant Field Values

CustomAfterDirectoryWizardPanelClass

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

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

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

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

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

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

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

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

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

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

DefaultWindowsParentAppDir

static final java.lang.String DefaultWindowsParentAppDir

Name of the parent of the default install directory on Windows, e.g., Program files as defined in Registry.

Property's value is a String.

See Also:

Constant Field Values

DefaultMacParentAppDir

static final java.lang.String DefaultMacParentAppDir

Name of the default directoryparent of the default install directory on Mac, e.g., /Applications

Property's value is a String.

See Also:

Constant Field Values

DefaultLinuxParentAppDir

static final java.lang.String DefaultLinuxParentAppDir

Name of the default directoryparent of the default install directory on Linux, e.g., /usr/local

Property's value is a String.

See Also:

Constant Field Values

DefaultSolarisParentAppDir

static final java.lang.String DefaultSolarisParentAppDir

Name of the default directoryparent of the default install directory on Solaris, e.g., /usr/share

Property's value is a String.

See Also:

Constant Field Values

DefaultOtherParentAppDir

static final java.lang.String DefaultOtherParentAppDir

Name of the default directoryparent of the default install directory on other OSes, e.g., /usr/local.

Property's value is a String.

See Also:

Constant Field Values

AutoDetectLanguage

static final java.lang.String AutoDetectLanguage

Set whether to automatically detect the language the user uses. If auto detect false, then default language is used. Default is true.

Property's value is a boolean.

See Also:

Constant Field Values

InstallerDefaultLanguage

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

LookAndFeelInterface

static final java.lang.String LookAndFeelInterface

Name of the look and feel interface.

Property's value is a String.

See Also:

Constant Field Values

LAFTheme

static final java.lang.String LAFTheme

Name of the theme for the look and feel, if applicable.

Property's value is a String.

See Also:

Constant Field Values

DownloadUrl

static final java.lang.String DownloadUrl

URL where your application is stored on the web. Used for autoupdates.

Can be passed on command line with a -d switch. Java web start installers automatically overwrite the JExpress build project's setting.

Property's value is a String.

See Also:

Constant Field Values

ExtraParameters

static final java.lang.String ExtraParameters

Extra parameters passed on the command line to a Cross Platform installer. The extra parameter(s) must be at the end of the command line and they must be preceeded by -p and a space.

You can also add extra arguments to Java Web Start installers through the JNLP file.

Only Cross Platform and Java Web Start installers support passing extra parameters on the command line.

Property's value is a String.

See Also:

Constant Field Values

FileGroupsFolders

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

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

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

MinimizedImageFilename

static final java.lang.String MinimizedImageFilename

Filename for the minimized image used during the installation.

Property's value is a String.

See Also:

Constant Field Values

InstallImagePosition

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

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

BackgroundColor

static final java.lang.String BackgroundColor

Background color of windows and buttons.

Property's value is a String.

See Also:

Constant Field Values

ProgressBarColor

static final java.lang.String ProgressBarColor

Color of the progress bar.

Property's value is a String.

See Also:

Constant Field Values

TextColor

static final java.lang.String TextColor

Color of the text.

Property's value is a String.

See Also:

Constant Field Values

InstallerExecutable

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MenuToStart

static final java.lang.String MenuToStart

The menu to tell the user to start your app on Windows if TellUserHowToStart is true.

Property's value is a String.

See Also:

Constant Field Values

CreatedMenuDirs

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

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

static final java.lang.String MenuExecutableFile

The executable filename for a menu.

Property's value is a String.

See Also:

Constant Field Values

MenuIconName

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

static final java.lang.String MenuAssociatedInstallType

See Also:

Constant Field Values

MenuLongName

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

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

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

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

MenusAttributeName

static final java.lang.String MenusAttributeName

Details about menus for your application.

Returns a PropertyList.

See Also:

Constant Field Values

MenuArguments

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

MenuRunAsAdmin

static final java.lang.String MenuRunAsAdmin

If true, require a Windows menu run as administrator.

Property's value is a boolean.

See Also:

Constant Field Values

MenuInstallAsService

static final java.lang.String MenuInstallAsService

If true, install a Windows menu as a service -- not used yet.

Property's value is a boolean.

See Also:

Constant Field Values

MenuAllUsers

static final java.lang.String MenuAllUsers

If true, configue a Windows menu for all users.

Property's value is a boolean (default false).

See Also:

Constant Field Values

MenuAutoUpdate

static final java.lang.String MenuAutoUpdate

If true *and* AutoupdateEveryStartup true, then configure menu to auto-update.

Property's value is a boolean (default true).

See Also:

Constant Field Values

MenuDesktopShortcut

static final java.lang.String MenuDesktopShortcut

Add desktop shortcut for this menu item.

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

See Also:

Constant Field Values

MenuAutoStartup

static final java.lang.String MenuAutoStartup

Add this menu item to the login startup procedure.

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

See Also:

Constant Field Values

MenuStartAfterInstall

static final java.lang.String MenuStartAfterInstall

If true, start the menu at the end of installation.

Property's value is a boolean (default false).

See Also:

Constant Field Values

StartAppName

static final java.lang.String StartAppName

Name of app to start at the end of installation.

Property's value is a string.

See Also:

Constant Field Values

MultipleFileGroups

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

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

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

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

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

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

static final java.lang.String Author

Author of the application.

Property's value is a String.

See Also:

Constant Field Values

PackageName

static final java.lang.String PackageName

Name of product being installed.

Property's value is a String.

See Also:

Constant Field Values

PackageCopyright

static final java.lang.String PackageCopyright

Copyright notice for your application.

Property's value is a String.

See Also:

Constant Field Values

PackageCreated

static final java.lang.String PackageCreated

Date installer created.

Property's value is a String.

See Also:

Constant Field Values

PackageVersion

static final java.lang.String PackageVersion

Version number of your application.

Property's value is a String.

See Also:

Constant Field Values

TotalCompressedFiles

static final java.lang.String TotalCompressedFiles

The total files distributed.

Property's value is an int.

See Also:

Constant Field Values

UncompressedTotalSize

static final java.lang.String UncompressedTotalSize

The total size of all the distributed files uncompressed.

Property's value is a long.

See Also:

Constant Field Values

CompressedFileSize

static final java.lang.String CompressedFileSize

The file size of all the distributed files compressed.

Property's value is a long.

See Also:

Constant Field Values

RelativeFileMap

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

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

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

SetLastModifiedDate

static final java.lang.String SetLastModifiedDate

If true, then the original file's last modified date is set when installing files.

Property's value is a boolean.

See Also:

Constant Field Values

SearchForJvm

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

TestPropertiesFilename

static final java.lang.String TestPropertiesFilename

Contains the test properties filename passed on the command line. This is not the recommended way of testing an installer because the distribution files will not be available nor will the license or readme files. Some customers find it useful to debug their custom classes which aren't dependent on files bundled with the installer.

Property's value is a String.

See Also:

Constant Field Values

JavaAppFilesSigned

static final java.lang.String JavaAppFilesSigned

True if the JavaApp EXEs are signed.

Property's value is a boolean.

See Also:

Constant Field Values

ShowFrame

static final java.lang.String ShowFrame

Show the frame and title. For future use.

Property's value is a String.

See Also:

Constant Field Values

SilentConfigFilename

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

static final java.lang.String SilentInstall

True iff user started the installer with the silent command line switch or the installer was created as a silent only installer.

Property's value is a boolean.

See Also:

Constant Field Values

UserRequestedSilentInstall

static final java.lang.String UserRequestedSilentInstall

True iff user started the installer with the silent command line switch.

Property's value is a boolean.

See Also:

Constant Field Values

ClickFreeInstaller

static final java.lang.String ClickFreeInstaller

True if the installer should not prompt the user for any input.

Property's value is a boolean.

See Also:

Constant Field Values

SilentUninstaller

static final java.lang.String SilentUninstaller

True if the uninstaller should be silent.

Property's value is a boolean.

See Also:

Constant Field Values

ClickFreeUninstaller

static final java.lang.String ClickFreeUninstaller

True if the uninstaller should not prompt the user for any input.

Property's value is a boolean.

See Also:

Constant Field Values

PromptUserBeforeUninstalling

static final java.lang.String PromptUserBeforeUninstalling

True if the uninstaller should prompt the user before uninstalling.

Property's value is a boolean.

See Also:

Constant Field Values

ClickFreeUpdater

static final java.lang.String ClickFreeUpdater

True if the updater should not prompt the user for any input.

Property's value is a boolean.

See Also:

Constant Field Values

SilentUpdater

static final java.lang.String SilentUpdater

True if the updater should be silent.

Property's value is a boolean.

See Also:

Constant Field Values

StartDirectory

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

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

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

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

PackJarFile

static final java.lang.String PackJarFile

If true, pack all distribution files using Pack 200. Requires that installer be run with JRE 1.5 or later.

Property's value is a boolean.

See Also:

Constant Field Values

SaveFilePermissions

static final java.lang.String SaveFilePermissions

If true and installer built on unix and installed on unix, then file permissions are set on target installed machine.

Property's value is a boolean.

See Also:

Constant Field Values

TotalBytesNeeded

static final java.lang.String TotalBytesNeeded

Deprecated. use UncompressedTotalSize.

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

UninstallerIconPath

static final java.lang.String UninstallerIconPath

Full path for the uninstaller's icon filename on Windows.

Property's value is a String.

See Also:

Constant Field Values

UninstallerPathname

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

static final java.lang.String UninstallerArgs

Deprecated. use clickFreeUninstaller, silentUninstaller, and promptUserBeforeUninstalling

Property's value is a String.

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".

See Also:

Constant Field Values

UnzipExecutable

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

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

static final java.lang.String WebSite

URL for your web site.

Property's value is a String.

See Also:

Constant Field Values

CheckLicenseDuringInstall

static final java.lang.String CheckLicenseDuringInstall

If true, then verify the license is ok during installation.

See Also:

Constant Field Values

CheckLicenseDuringUpdate

static final java.lang.String CheckLicenseDuringUpdate

If true, then verify the license is ok during update.

See Also:

Constant Field Values

CheckLicenseFromYourApp

static final java.lang.String CheckLicenseFromYourApp

If true, then save license settings so app can verify license.

See Also:

Constant Field Values

FailIfNoLicenseServer

static final java.lang.String FailIfNoLicenseServer

If true, then fail if unable to connect to license server.

See Also:

Constant Field Values

LicenseAccount

static final java.lang.String LicenseAccount

The following settings only have values if installer checks license and only after the license has been verified.

See Also:

Constant Field Values

LicenseProduct

static final java.lang.String LicenseProduct

See Also:

Constant Field Values

LicenseName

static final java.lang.String LicenseName

See Also:

Constant Field Values

LicenseRight

static final java.lang.String LicenseRight

See Also:

Constant Field Values

LicenseAppRight

static final java.lang.String LicenseAppRight

See Also:

Constant Field Values

LicensePrimaryContact

static final java.lang.String LicensePrimaryContact

The primary contact's email of the license as defined in CopyCheq service.

See Also:

Constant Field Values

LicenseIdCode

static final java.lang.String LicenseIdCode

The ID code of the license as defined in CopyCheq service.

See Also:

Constant Field Values

LicenseEndUser

static final java.lang.String LicenseEndUser

The end user's email of the license as defined in CopyCheq service. Currently this is saved in the properties if the end user supplied it. In the future, we may obtain this from the user's system.

See Also:

Constant Field Values

LicenseError

static final java.lang.String LicenseError

The last error message after checking with CopyCheq service.

See Also:

Constant Field Values

InstallationStarted

static final java.lang.String InstallationStarted

True if CopyCheq acknowledged that the installation has started.

See Also:

Constant Field Values

ProxyHost

static final java.lang.String ProxyHost

The host for the proxy server. Optional. Only set if CopyCheq used.

See Also:

Constant Field Values

ProxyPort

static final java.lang.String ProxyPort

The prot for the proxy server. Optional. Only set if CopyCheq used.

See Also:

Constant Field Values

ProxyUserName

static final java.lang.String ProxyUserName

The user name for the proxy server. Optional. Only set if CopyCheq used.

See Also:

Constant Field Values

ProxyPassword

static final java.lang.String ProxyPassword

The user name's password the proxy server. Optional. Only set if CopyCheq used.

See Also:

Constant Field Values

TrackConversions

static final java.lang.String TrackConversions

If you want to track conversion points for your software with DeNova's Convert, then this property returns true.

Property's value is a boolean.

See Also:

Constant Field Values