Class InstallerFrame

  • All Implemented Interfaces:
    Referenceable

    public final class InstallerFrame
    extends ProjectObject
    Stores configuration information for the GUI installer.
    • Constructor Detail

      • InstallerFrame

        public InstallerFrame()
    • Method Detail

      • getDisplayBelevedLogo

        public boolean getDisplayBelevedLogo()
        Whether or to display the InstallAnywhere logo using a beveled text.
      • setDisplayBelevedLogo

        public void setDisplayBelevedLogo​(boolean isBeveled)
        Whether or to display the InstallAnywhere logo using a beveled text.
      • getAllowTransparentInstallerFramesUI

        public boolean getAllowTransparentInstallerFramesUI()
        Whether or not to allow Transparent background for Installer frame.
      • setAllowTransparentInstallerFramesUI

        public void setAllowTransparentInstallerFramesUI​(boolean allowTransparentInstallerFrameUI)
        Whether or not to allow Transparent background for Installer frame.
      • setUseBackgroundImage

        public void setUseBackgroundImage​(boolean use)
        Whether or not to display an installer background image.
      • getUseBackgroundImage

        public boolean getUseBackgroundImage()
        Whether or not to display an installer background image.
      • setFitBackgroundImageHorizontally

        public void setFitBackgroundImageHorizontally​(boolean fit)
        Whether or not to scale the background image to fit the installer's width.
      • getFitBackgroundImageHorizontally

        public boolean getFitBackgroundImageHorizontally()
        Whether or not to scale the background image to fit the installer's width.
      • setFitBackgroundImageVertically

        public void setFitBackgroundImageVertically​(boolean fit)
        Whether or not to scale the background image to fit the installer's height.
      • getFitBackgroundImageVertically

        public boolean getFitBackgroundImageVertically()
        Whether or not to scale the background image to fit the installer's height.
      • getInstallerFrameWidth

        public int getInstallerFrameWidth()
        The installer frame width in pixels. Default to 600.
      • getInstallerFrameHeight

        public int getInstallerFrameHeight()
        The installer frame height in pixels. Default to 400.
      • setInstallerFrameWidth

        public void setInstallerFrameWidth​(int frameWidth)
        The installer frame width in pixels. Default to 600.
      • setInstallerFrameHeight

        public void setInstallerFrameHeight​(int frameHeight)
        The installer frame height in pixels. Default to 400.
      • setUseBorderedInstallerPanel

        public void setUseBorderedInstallerPanel​(boolean border)
        Whether or not to display the installer panel with a border.
      • getUseBorderedInstallerPanel

        public boolean getUseBorderedInstallerPanel()
        Whether or not to display the installer panel with a border.
      • getChooseCurrentFontColorIntValue

        public int getChooseCurrentFontColorIntValue()
        The current step label font color for the installer step label.
      • setChooseCurrentFontColorIntValue

        public void setChooseCurrentFontColorIntValue​(int chooseCurrentFontColorIntValue)
        The current step label font color for the installer step label.
      • getChoosePreviousFontColorIntValue

        public int getChoosePreviousFontColorIntValue()
        The previous step label font color for the installer step label.
      • setChoosePreviousFontColorIntValue

        public void setChoosePreviousFontColorIntValue​(int choosePreviousFontColorIntValue)
        The previous step label font color for the installer step label.
      • getChooseFutureFontColorIntValue

        public int getChooseFutureFontColorIntValue()
        The future step label font color for the installer step label.
      • setChooseFutureFontColorIntValue

        public void setChooseFutureFontColorIntValue​(int chooseFutureFontColorIntValue)
        The future step label font color for the installer step label.
      • getChooseCurrentFontName

        public java.lang.String getChooseCurrentFontName()
        The current step label font name for the installer step label.
      • setChooseCurrentFontName

        public void setChooseCurrentFontName​(java.lang.String chooseCurrentFontName)
        The current step label font name for the installer step label.
      • getChooseCurrentFontStyle

        public int getChooseCurrentFontStyle()
        The current step label font style for the installer step label.
      • setChooseCurrentFontStyle

        public void setChooseCurrentFontStyle​(int chooseCurrentFontStyle)
        The current step label font style for the installer step label.
      • getChooseCurrentFontSize

        public int getChooseCurrentFontSize()
        The current step label font size for the installer step label.
      • setChooseCurrentFontSize

        public void setChooseCurrentFontSize​(int chooseCurrentFontSize)
        The current step label font size for the installer step label.
      • getChoosePreviousFontName

        public java.lang.String getChoosePreviousFontName()
        The previous step label font name for the installer step label.
      • setChoosePreviousFontName

        public void setChoosePreviousFontName​(java.lang.String choosePreviousFontName)
        The previous step label font name for the installer step label.
      • getChoosePreviousFontStyle

        public int getChoosePreviousFontStyle()
        The previous step label font style for the installer step label.
      • setChoosePreviousFontStyle

        public void setChoosePreviousFontStyle​(int choosePreviousFontStyle)
        The previous step label font style for the installer step label.
      • getChoosePreviousFontSize

        public int getChoosePreviousFontSize()
        The previous step label font size for the installer step label.
      • setChoosePreviousFontSize

        public void setChoosePreviousFontSize​(int choosePreviousFontSize)
        The previous step label font size for the installer step label.
      • getChooseFutureFontName

        public java.lang.String getChooseFutureFontName()
        The future step label font name for the installer step label.
      • setChooseFutureFontName

        public void setChooseFutureFontName​(java.lang.String chooseFutureFontName)
        The future step label font name for the installer step label.
      • getChooseFutureFontStyle

        public int getChooseFutureFontStyle()
        The future step label font style for the installer step label.
      • setChooseFutureFontStyle

        public void setChooseFutureFontStyle​(int chooseFutureFontStyle)
        The future step label font style for the installer step label.
      • getChooseFutureFontSize

        public int getChooseFutureFontSize()
        The future step label font size for the installer step label.
      • setChooseFutureFontSize

        public void setChooseFutureFontSize​(int chooseFutureFontSize)
        The future step label font size for the installer step label.
      • getTitleTextFontStyle

        public int getTitleTextFontStyle()
        The titles, labels and InstallAnywhere logo text color.
      • setTitleTextFontStyle

        public void setTitleTextFontStyle​(int titleTextFontStyle)
        The titles, labels and InstallAnywhere logo text color.
      • getTitleTextFontSize

        public int getTitleTextFontSize()
        The titles, labels and InstallAnywhere logo text color.
      • setTitleTextFontSize

        public void setTitleTextFontSize​(int titleTextFontSize)
        The titles, labels and InstallAnywhere logo text color.
      • getTitleTextFontName

        public java.lang.String getTitleTextFontName()
        The titles, labels and InstallAnywhere logo text color.
      • setTitleTextFontName

        public void setTitleTextFontName​(java.lang.String titleTextFontName)
        The titles, labels and InstallAnywhere logo text color.
      • setTitleTextColorRGB

        public void setTitleTextColorRGB​(int color)
        The titles, labels and InstallAnywhere logo text color.
      • getFontName

        public java.lang.String getFontName()
        The installer font face name
      • setFontName

        public void setFontName​(java.lang.String fontName)
        The installer font face name
      • getFontStyle

        public int getFontStyle()
        The installer font face style
      • setFontStyle

        public void setFontStyle​(int fontStyle)
        The installer font face name
      • getFontSize

        public int getFontSize()
        The installer font size
      • setFontSize

        public void setFontSize​(int fontSize)
        The installer set font size
      • setFontColorRGB

        public void setFontColorRGB​(int color)
        Installer font color.
      • getTitleTextColorRGB

        public int getTitleTextColorRGB()
        The titles, labels and InstallAnywhere logo text color.
      • getFontColorRGB

        public int getFontColorRGB()
        installer font color.
      • getProgressBarColorRGB

        public int getProgressBarColorRGB()
        Progress bar settings.
      • setProgressBarColorRGB

        public void setProgressBarColorRGB​(int progressBarColorRGB)
        Progress bar settings.
      • isUseProgressBarColor

        public boolean isUseProgressBarColor()
        Progress bar settings.
      • setUseProgressBarColor

        public void setUseProgressBarColor​(boolean useProgressBarColor)
        Progress bar settings.
      • isInnerInstallFrameBorder

        public boolean isInnerInstallFrameBorder()
        inner installer frame border settings.
      • setInnerInstallFrameBorder

        public void setInnerInstallFrameBorder​(boolean innerInstallFrameBorder)
        inner installer frame border settings.
      • getUseSystemTitleTextColorRGB

        public boolean getUseSystemTitleTextColorRGB()
        Whether or not use the system default color for the titles, labels and InstallAnywhere logo text.
      • getUseSystemFontColorRGB

        public boolean getUseSystemFontColorRGB()
        Whether or not use the system default color for installer font
      • setUseSystemTitleTextColorRGB

        public void setUseSystemTitleTextColorRGB​(boolean useSystemTitleTextColorRGB)
        Whether or not use the system default color for the titles, labels and InstallAnywhere logo text.
      • setUseSystemFontColorRGB

        public void setUseSystemFontColorRGB​(boolean useSystemFontColorRGB)
        Whether or not use the system default color for installer font
      • getBackgrdImageOrientationForBidi

        public BiDiImageOrientation getBackgrdImageOrientationForBidi()
        The background image orientation when running the installer on Right-To-Left locales.

        It can be LEFT_TO_RIGHT or RIGHT_TO_LEFT. Default to RIGHT_TO_LEFT.
      • setBackgrdImageOrientationForBidi

        public void setBackgrdImageOrientationForBidi​(BiDiImageOrientation bidiOrient)
        The background image orientation when running the installer on Right-To-Left locales.

        It can be LEFT_TO_RIGHT or RIGHT_TO_LEFT. Default to RIGHT_TO_LEFT.
      • getInstallPanelBackgroundSettings

        public BackgroundColorConfig getInstallPanelBackgroundSettings()
        The background color settings for the install panel.
      • setInstallPanelBackgroundSettings

        public void setInstallPanelBackgroundSettings​(BackgroundColorConfig installPanelBackgroundSettings)
        The background color settings for the install panel.
      • getRuntimePanelDisplayButtonBehavior

        public int getRuntimePanelDisplayButtonBehavior()
        returns the choice of default/customized color of runtime display buttons
      • setRuntimePanelDisplayButtonBehavior

        public void setRuntimePanelDisplayButtonBehavior​(int runtimePanelDisplayButtonBehavior)
        settings to set the choice of default/customized color of runtime display buttons
      • getRuntimePanelDisplayButtonColor

        public int getRuntimePanelDisplayButtonColor()
        returns the customized color of runtime display buttons
      • setRuntimePanelDisplayButtonColor

        public void setRuntimePanelDisplayButtonColor​(int runtimePanelDisplayButtonColor)
        settings to set the choice of customized color of runtime display buttons
      • getRuntimePanelHoverButtonBehavior

        public int getRuntimePanelHoverButtonBehavior()
        returns the choice of default/customized color of runtime hover buttons
      • setRuntimePanelHoverButtonBehavior

        public void setRuntimePanelHoverButtonBehavior​(int runtimePanelHoverButtonBehavior)
        settings to set the choice of default/customized color of runtime hover buttons
      • getRuntimePanelHoverButtonColor

        public int getRuntimePanelHoverButtonColor()
        settings to set the choice of customized color of runtime hover buttons
      • setRuntimePanelHoverButtonColor

        public void setRuntimePanelHoverButtonColor​(int runtimePanelHoverButtonColor)
        settings to set the choice of customized color of runtime hover buttons
      • getRuntimePanelSelectedButtonBehavior

        public int getRuntimePanelSelectedButtonBehavior()
        returns the choice of default/customized color of runtime selected buttons
      • setRuntimePanelSelectedButtonBehavior

        public void setRuntimePanelSelectedButtonBehavior​(int runtimePanelSelectedButtonBehavior)
        settings to set the choice of default/customized color of runtime selected buttons
      • getRuntimePanelSelectedButtonColor

        public int getRuntimePanelSelectedButtonColor()
        settings to set the choice of customized color of runtime selected buttons
      • setRuntimePanelSelectedButtonColor

        public void setRuntimePanelSelectedButtonColor​(int runtimePanelSelectedButtonColor)
        settings to set the choice of customized color of runtime selected buttons
      • getRuntimePanelDisabledButtonBehavior

        public int getRuntimePanelDisabledButtonBehavior()
        returns the choice of default/customized color of runtime disabled buttons
      • setRuntimePanelDisabledButtonBehavior

        public void setRuntimePanelDisabledButtonBehavior​(int runtimePanelDisabledButtonBehavior)
        settings to set the choice of default/customized color of runtime disabled buttons
      • getRuntimePanelDisabledButtonColor

        public int getRuntimePanelDisabledButtonColor()
        settings to set the choice of customized color of runtime disabled buttons
      • setRuntimePanelDisabledButtonColor

        public void setRuntimePanelDisabledButtonColor​(int runtimePanelDisabledButtonColor)
        settings to set the choice of customized color of runtime disabled buttons
      • getIaCurrentThemeName

        public java.lang.String getIaCurrentThemeName()
        settings to get the current IA theme.
      • setIaCurrentThemeName

        public void setIaCurrentThemeName​(java.lang.String iaCurrentThemeName)
        settings to set the current IA theme.
      • getIaCurrentThemeLocation

        public java.lang.String getIaCurrentThemeLocation()
        settings to get the current IA theme location.
      • setIaCurrentThemeLocation

        public void setIaCurrentThemeLocation​(java.lang.String iaCurrentThemeLocation)
        settings to set the current IA theme location.
      • getBaseThemeOfUnsavedTheme

        public java.lang.String getBaseThemeOfUnsavedTheme()
      • setBaseThemeOfUnsavedTheme

        public void setBaseThemeOfUnsavedTheme​(java.lang.String baseThemeOfUnsavedTheme)
      • isInstallerStepsScaleHeight

        public boolean isInstallerStepsScaleHeight()
        Installer steps Image scale height property
      • setInstallerStepsScaleHeight

        public void setInstallerStepsScaleHeight​(boolean installerStepsScaleHeight)
        Installer steps Image scale height property
      • isShowStatusMessage

        public boolean isShowStatusMessage()
        Inner Installer frame status message property
      • setShowStatusMessage

        public void setShowStatusMessage​(boolean showStatusMessage)
        Inner Installer frame status message property
      • isShowProgressBar

        public boolean isShowProgressBar()
        Inner Installer frame progress bar property
      • setShowProgressBar

        public void setShowProgressBar​(boolean showProgressBar)
        Inner Installer frame progress bar property
      • isShowIndeterminateProgressBar

        public boolean isShowIndeterminateProgressBar()
        Inner Installer frame Indeterminate progress bar property
      • setShowIndeterminateProgressBar

        public void setShowIndeterminateProgressBar​(boolean showIndeterminateProgressBar)
        Inner Installer frame Indeterminate progress bar property
      • getInstallerStepsSettings

        public InstallerStepsSettings getInstallerStepsSettings()
        The installer steps settings, like the panel background and the label icons.
      • getMaintModeTitle

        public java.lang.String getMaintModeTitle()
        Maintenance Mode title
      • setMaintModeTitle

        public void setMaintModeTitle​(java.lang.String MaintModeTitle)
        Maintenance Mode title
      • setProgressPanelBackgroundImage

        public void setProgressPanelBackgroundImage​(java.lang.String path)
        The background image to be displayed in the install progress panel.
      • getProgressPanelBackgroundImage

        public java.lang.String getProgressPanelBackgroundImage()
        The background image to be displayed in the install progress panel.