Package com.zerog.ia.auto.project

Class InstallerUI

  • public final class InstallerUI
extends java.lang.Object
    The installer UI settings, like supported UI modes, installer frame settings and splash screen settings.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Vector<Billboard> getBillboards()
      The Vector of billboards the installer should display during the install phase of the installation.
      DefaultUIMode getDefaultUIMode()
      The default UI mode settings for the installer and uninstaller.
      InstallerFrame getInstallerFrame()
      The installer UI frame settings.
      java.util.Vector<java.lang.String> getInstallerSteps()
      The Vector of labels for the installer steps.
      java.lang.String getInstallProgressImage()
      The path of the image file to be displayed in the installer progress panel.
      InstallProgressImageOption getInstallProgressImageOption()
      Type of image to be displayed in the install progress panel, which is displayed during the install phase of the installation.
      int getInstallProgressLabelIndex()
      The index of the label to be displayed during the install phase of the installation.
      InstallProgressLabelOption getInstallProgressLabelOption()
      Type of label to be displayed during the install phase of the installation.
      java.lang.String getSplashScreenConsolePrompt()
      The text for the prompt on the Choose Locale console.
      java.lang.String getSplashScreenConsoleTitle()
      The text for the title of the Choose Locale console.
      java.lang.String getSplashScreenGUIConfirm()
      The text for splash screen button that confirms the installer locale setting.
      java.lang.String getSplashScreenGUIInstructions()
      The text that appears to describe how to choose a locale on the splash screen.
      java.lang.String getSplashScreenGUITitle()
      The text that displays in the titlebar of the installer splash screen.
      java.lang.String getSplashScreenImage()
      The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at default 100% or less than 125%.
      java.lang.String getSplashScreenImage1()
      The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at 150% or between 125% to 175%.
      java.lang.String getSplashScreenImage2()
      The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at 200% or higher than 175% to maximum DPI settings.
      java.lang.String getStepsPanelImage()
      The path of the image file to be displayed in the installer steps panel.
      boolean getSupportsConsoleUI()
      Whether or not the installer should support console user interface.
      boolean getSupportsGUI()
      Whether or not the installer should support graphical user interface.
      boolean getSupportsSilentUI()
      Whether or not the installer should support silent installation.
      void setInstallProgressImage​(java.lang.String path)
      The path of the image file to be displayed in the installer progress panel.
      void setInstallProgressImageOption​(InstallProgressImageOption option)
      Type of image to be displayed in the install progress panel, which is displayed during the install phase of the installation.
      void setInstallProgressLabelIndex​(int index)
      The index of the label to be displayed during the install phase of the installation.
      void setInstallProgressLabelOption​(InstallProgressLabelOption option)
      The type of label to be displayed during the install phase of the installation.
      void setSplashScreenConsolePrompt​(java.lang.String splashScreenConsolePrompt)
      The text for the prompt on the Choose Locale console.
      void setSplashScreenConsoleTitle​(java.lang.String splashScreenConsoleTitle)
      The text for the title of the Choose Locale console.
      void setSplashScreenGUIConfirm​(java.lang.String splashScreenGUIConfirm)
      The text for splash screen button that confirms the installer locale setting.
      void setSplashScreenGUIInstructions​(java.lang.String splashScreenGUIInstructions)
      The text that appears to describe how to choose a locale on the splash screen.
      void setSplashScreenGUITitle​(java.lang.String splashScreenGUITitle)
      The text that displays in the titlebar of the installer splash screen.
      void setSplashScreenImage​(java.lang.String path)
      The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at default 100% or less than 125%.
      void setSplashScreenImage1​(java.lang.String path)
      The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at 150% or between 125% to 175%.
      void setSplashScreenImage2​(java.lang.String path)
      The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at 200% or higher than 175% to maximum DPI settings.
      void setStepsPanelImage​(java.lang.String path)
      The path of the image file to be displayed in the installer steps panel.
      void setSupportsConsoleUI​(boolean support)
      Whether or not the installer should support console user interface.
      void setSupportsGUI​(boolean support)
      Whether or not the installer should support graphical user interface.
      void setSupportsSilentUI​(boolean support)
      Whether or not the installer should support silent installation.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • setSupportsGUI

        public void setSupportsGUI​(boolean support)
        Whether or not the installer should support graphical user interface.

      • getSupportsGUI

        public boolean getSupportsGUI()
        Whether or not the installer should support graphical user interface.

      • setSupportsConsoleUI

        public void setSupportsConsoleUI​(boolean support)
        Whether or not the installer should support console user interface.

      • getSupportsConsoleUI

        public boolean getSupportsConsoleUI()
        Whether or not the installer should support console user interface.

      • setSupportsSilentUI

        public void setSupportsSilentUI​(boolean support)
        Whether or not the installer should support silent installation.

      • getSupportsSilentUI

        public boolean getSupportsSilentUI()
        Whether or not the installer should support silent installation.

      • getInstallProgressImageOption

        public InstallProgressImageOption getInstallProgressImageOption()
        Type of image to be displayed in the install progress panel, which is displayed during the install phase of the installation.

      • setInstallProgressImageOption

        public void setInstallProgressImageOption​(InstallProgressImageOption option)
        Type of image to be displayed in the install progress panel, which is displayed during the install phase of the installation.

      • getInstallerSteps

        public java.util.Vector<java.lang.String> getInstallerSteps()
        The Vector of labels for the installer steps.

        By default the labels are auto populated when saving the project. The installer steps settings can be found under InstallerStepsSettings.

      • getInstallProgressLabelIndex

        public int getInstallProgressLabelIndex()
        The index of the label to be displayed during the install phase of the installation.

        The label index is only used when the installProgressLabelOption property is set to InstallProgressLabelOption.DEFINED. The index is based on the Vector of installer steps labels.

        See Also:
        getInstallProgressLabelOption(), getInstallerSteps()

      • setInstallProgressLabelIndex

        public void setInstallProgressLabelIndex​(int index)
        The index of the label to be displayed during the install phase of the installation.

        The label index is only used when the installProgressLabelOption property is set to InstallProgressLabelOption.DEFINED. The index is based on the Vector of installer steps labels.

        See Also:
        #setInstallProgressImageOption(int), getInstallerSteps()

      • getInstallProgressLabelOption

        public InstallProgressLabelOption getInstallProgressLabelOption()
        Type of label to be displayed during the install phase of the installation.

        The label can be defined (InstallProgressLabelOption.DEFINED) or can be the same of the previous panels (InstallProgressLabelOption.SAME_AS_PREVIOUS). When using a defined label, the label index should be defined with setInstallProgressLabelIndex(int)

      • setInstallProgressLabelOption

        public void setInstallProgressLabelOption​(InstallProgressLabelOption option)
        The type of label to be displayed during the install phase of the installation.

        The label can be defined (InstallProgressLabelOption.DEFINED) or can be the same of the previous panels (InstallProgressLabelOption.SAME_AS_PREVIOUS). When using a defined label, the label index should be defined with setInstallProgressLabelIndex(int)

      • getSplashScreenConsolePrompt

        public java.lang.String getSplashScreenConsolePrompt()
        The text for the prompt on the Choose Locale console. (Default: CHOOSE LOCALE BY NUMBER)

      • setSplashScreenConsolePrompt

        public void setSplashScreenConsolePrompt​(java.lang.String splashScreenConsolePrompt)
        The text for the prompt on the Choose Locale console. (Default: CHOOSE LOCALE BY NUMBER)

      • getSplashScreenConsoleTitle

        public java.lang.String getSplashScreenConsoleTitle()
        The text for the title of the Choose Locale console. (Default: Choose Locale...)

      • setSplashScreenConsoleTitle

        public void setSplashScreenConsoleTitle​(java.lang.String splashScreenConsoleTitle)
        The text for the title of the Choose Locale console. (Default: Choose Locale...)

      • getSplashScreenGUIConfirm

        public java.lang.String getSplashScreenGUIConfirm()
        The text for splash screen button that confirms the installer locale setting. (Default: OK)

      • setSplashScreenGUIConfirm

        public void setSplashScreenGUIConfirm​(java.lang.String splashScreenGUIConfirm)
        The text for splash screen button that confirms the installer locale setting. (Default: OK)

      • getSplashScreenGUITitle

        public java.lang.String getSplashScreenGUITitle()
        The text that displays in the titlebar of the installer splash screen. Blank by default.

        The title can be text, an InstallAnywhere variable, or a user-defined variable; however, only $INSTALLER_TITLE$ and $PRODUCT_NAME$ are automatically resolved in the splash screen. All other variables must have their value assigned when the installer is invoked in order to be correctly resolved in the splash screen.

      • setSplashScreenGUITitle

        public void setSplashScreenGUITitle​(java.lang.String splashScreenGUITitle)
        The text that displays in the titlebar of the installer splash screen. Blank by default.

        The title can be text, an InstallAnywhere variable, or a user-defined variable; however, only $INSTALLER_TITLE$ and $PRODUCT_NAME$ are automatically resolved in the splash screen. All other variables must have their value assigned when the installer is invoked in order to be correctly resolved in the splash screen.

      • getSplashScreenGUIInstructions

        public java.lang.String getSplashScreenGUIInstructions()
        The text that appears to describe how to choose a locale on the splash screen. Blank by default.

      • setSplashScreenGUIInstructions

        public void setSplashScreenGUIInstructions​(java.lang.String splashScreenGUIInstructions)
        The text that appears to describe how to choose a locale on the splash screen. Blank by default.

      • getDefaultUIMode

        public DefaultUIMode getDefaultUIMode()
        The default UI mode settings for the installer and uninstaller.

      • getBillboards

        public java.util.Vector<Billboard> getBillboards()
        The Vector of billboards the installer should display during the install phase of the installation.

      • setSplashScreenImage

        public void setSplashScreenImage​(java.lang.String path)
        The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at default 100% or less than 125%.

      • getSplashScreenImage

        public java.lang.String getSplashScreenImage()
        The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at default 100% or less than 125%.

      • setSplashScreenImage1

        public void setSplashScreenImage1​(java.lang.String path)
        The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at 150% or between 125% to 175%.

      • getSplashScreenImage1

        public java.lang.String getSplashScreenImage1()
        The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at 150% or between 125% to 175%.

      • setSplashScreenImage2

        public void setSplashScreenImage2​(java.lang.String path)
        The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at 200% or higher than 175% to maximum DPI settings.

      • getSplashScreenImage2

        public java.lang.String getSplashScreenImage2()
        The path of the default image file to be displayed in the splash screen dialog when custom scaling is set at 200% or higher than 175% to maximum DPI settings.

      • setStepsPanelImage

        public void setStepsPanelImage​(java.lang.String path)
        The path of the image file to be displayed in the installer steps panel.

      • getStepsPanelImage

        public java.lang.String getStepsPanelImage()
        The path of the image file to be displayed in the installer steps panel.

      • setInstallProgressImage

        public void setInstallProgressImage​(java.lang.String path)
        The path of the image file to be displayed in the installer progress panel.

      • getInstallProgressImage

        public java.lang.String getInstallProgressImage()
        The path of the image file to be displayed in the installer progress panel.