Class InstallerStepsSettings


  • public final class InstallerStepsSettings
    extends java.lang.Object
    The installer steps settings, like the steps image icons and the installer steps panel decoration.
    • Method Detail

      • setInstallerStepsAdditions

        public void setInstallerStepsAdditions​(InstallerStepsAdditions type)
        The type of additions (decoration) to be displayed in the installer steps panel.

        It can be NO_DECORATION to not display a panel, USE_IMAGES to hide the text labels and only display an image or USE_LABELS to display the text labels.

      • getInstallerStepsAdditions

        public InstallerStepsAdditions getInstallerStepsAdditions()
        The type of additions (decoration) to be displayed in the installer steps panel.

        It can be NO_DECORATION to not display a panel, USE_IMAGES to hide the text labels and only display an image or USE_LABELS to display the text labels.

      • setUseBeveledInstallerStepsPanel

        public void setUseBeveledInstallerStepsPanel​(boolean bevel)
        Whether or not to display a beveled border around the installer steps panel.
      • getUseBeveledInstallerStepsPanel

        public boolean getUseBeveledInstallerStepsPanel()
        Whether or not to display a beveled border around the installer steps panel.
      • setResizeInstallerStepsPanel

        public void setResizeInstallerStepsPanel​(boolean value)
        Whether or not to resize image or list of installer steps according to the width of the installer frame.
      • getResizeInstallerStepsPanel

        public boolean getResizeInstallerStepsPanel()
        Whether or not to resize image or list of installer steps according to the width of the installer frame.
      • setAllowLabelTextToWrap

        public void setAllowLabelTextToWrap​(boolean value)
        Whether or not to allow the text of the labels to wrap.
      • getAllowLabelTextToWrap

        public boolean getAllowLabelTextToWrap()
        Whether or not to allow the text of the labels to wrap.
      • getAllowVerticalScroll

        public boolean getAllowVerticalScroll()
        Whether or not to allow the vertical scrool bar for installer steps.
      • setAllowVerticalScroll

        public void setAllowVerticalScroll​(boolean allowVerticalScroll)
        Whether or not to allow the vertical scrool bar for installer steps.
      • setUseBackgroundImageInInstallerSteps

        public void setUseBackgroundImageInInstallerSteps​(boolean use)
        Whether or not to display a background image behind the list of installer steps.
        See Also:
        setInstallerStepsBackgroundImage(String)
      • getUseBackgroundImageInInstallerSteps

        public boolean getUseBackgroundImageInInstallerSteps()
        Whether or not to display a background image behind the list of installer steps.
        See Also:
        getInstallerStepsBackgroundImage()
      • getUseSystemBackgroundColorForInstallerSteps

        public boolean getUseSystemBackgroundColorForInstallerSteps()
        Whether or not use the system default background color behind the list of installer steps.
      • setUseSystemBackgroundColorForInstallerSteps

        public void setUseSystemBackgroundColorForInstallerSteps​(boolean useSystemBackgroundColorForInstallLabels)
        Whether or not use the system default background color behind the list of installer steps.
      • getInstallerStepsBackgroundSettings

        public BackgroundColorConfig getInstallerStepsBackgroundSettings()
        The background color settings for the installer steps panel.
      • setInstallerStepsBackgroundSettings

        public void setInstallerStepsBackgroundSettings​(BackgroundColorConfig installStepsBackgroundSettings)
        The background color settings for the installer steps panel.
      • getShowInstallerStepLabel

        public boolean getShowInstallerStepLabel()
        returns the settings to show/hide the installer step label
      • setShowInstallerStepLabel

        public void setShowInstallerStepLabel​(boolean showInstallerStepLabels)
        Settings to show/hide the installer step label
      • isDisplayFramelessWindow

        public boolean isDisplayFramelessWindow()
        returns the settings to show/hide the title bar for installer
      • setDisplayFramelessWindow

        public void setDisplayFramelessWindow​(boolean displayFramelessWindow)
        Settings to show/hide the title bar for installer
      • getInstallerStepTopOffSetValue

        public int getInstallerStepTopOffSetValue()
        returns the offset value from top of the installer frame
      • setInstallerStepTopOffSetValue

        public void setInstallerStepTopOffSetValue​(int installerStepTopOffSetValue)
        Settings to set the offset from the top of the installer frame
      • getAutoPopulateInstallerSteps

        public boolean getAutoPopulateInstallerSteps()
        Whether or not to automatically create a list of labels that match the current set of panel actions each time the project is saved. Default to true.
      • setAutoPopulateInstallerSteps

        public void setAutoPopulateInstallerSteps​(boolean AutoPopulateInstallerSteps)
        Whether or not to automatically create a list of labels that match the current set of panel actions each time the project is saved. Default to true.
      • setInstallerStepsBackgroundImage

        public void setInstallerStepsBackgroundImage​(java.lang.String path)
        The background image to be displayed in the installer steps panel.
      • getInstallerStepsBackgroundImage

        public java.lang.String getInstallerStepsBackgroundImage()
        The background image to be displayed in the installer steps panel.
      • setActiveStepIcon

        public void setActiveStepIcon​(java.lang.String path)
        The icon image to be displayed preceding the text labels of the step current in execution.
      • getActiveStepIcon

        public java.lang.String getActiveStepIcon()
        The icon image to be displayed preceding the text labels of the step current in execution.
      • setCompletedStepIcon

        public void setCompletedStepIcon​(java.lang.String path)
        The icon image to be displayed preceding the text labels of the steps already executed.
      • getCompletedStepIcon

        public java.lang.String getCompletedStepIcon()
        The icon image to be displayed preceding the text labels of the steps already executed.
      • setUpcomingStepIcon

        public void setUpcomingStepIcon​(java.lang.String path)
        The icon image to be displayed preceding the text labels of the steps not executed yet.
      • getUpcomingStepIcon

        public java.lang.String getUpcomingStepIcon()
        The icon image to be displayed preceding the text labels of the steps not executed yet.