Interface WizardContext


  • public interface WizardContext
    The wizard context allows you to modify the GUI installer or uninstaller. It is returned by Context.getWizardContext() and is only functional if the installer or uninstaller is running in GUI mode.
    See Also:
    Context.getWizardContext()
    • Method Detail

      • setControlButtonEnabled

        void setControlButtonEnabled​(ControlButtonType controlButtonType,
                                     boolean enabled)
        Change the enabled status of control buttons on the current screen. This setting applies only to the currently displayed screen.
        Parameters:
        controlButtonType - the type of the control buttons
        enabled - if the buttons should be enabled or not
      • setControlButtonVisible

        void setControlButtonVisible​(ControlButtonType controlButtonType,
                                     boolean visible)
        Change the visibility of control buttons on the current screen. This setting applies only to the currently displayed screen.
        Parameters:
        controlButtonType - the type of the control buttons
        visible - if the buttons should be visible or not
      • pressControlButton

        void pressControlButton​(ControlButtonType controlButtonType)
        Perform the action associated with a particular control button.
        Parameters:
        controlButtonType - the type of the control button
      • focusControlButton

        void focusControlButton​(ControlButtonType controlButtonType)
        Transfer the focus to a particular control button. If there are multiple control buttons of the specified type, the first one will be used.
        Parameters:
        controlButtonType - the type of the control button
      • setControlButtonText

        void setControlButtonText​(ControlButtonType controlButtonType,
                                  java.lang.String text)
        Set the test of control buttons on the current screen. This setting applies only to the currently displayed screen.
        Parameters:
        controlButtonType - the type of the control buttons
        text - the new text
      • setNextButtonEnabled

        @Deprecated
        void setNextButtonEnabled​(boolean enabled)
        Change the enabled status of the "Next" button at the bottom of the current screen. This setting applies only to the currently displayed screen.
        Parameters:
        enabled - if the button should be enabled or not
      • setBackButtonEnabled

        @Deprecated
        void setBackButtonEnabled​(boolean enabled)
        Change the enabled status of the "Back" button at the bottom of the current screen. This setting applies only to the currently displayed screen.
        Parameters:
        enabled - if the button should be enabled or not
      • setCancelButtonEnabled

        @Deprecated
        void setCancelButtonEnabled​(boolean enabled)
        Change the enabled status of the "Cancel" button at the bottom of the current screen. This setting applies only to the currently displayed screen.
        Parameters:
        enabled - if the button should be enabled or not
      • setNextButtonVisible

        @Deprecated
        void setNextButtonVisible​(boolean visible)
        Change the visibility of the "Next" button at the bottom of the current screen. This setting applies only to the currently displayed screen.
        Parameters:
        visible - if the button should be visible or not
      • setBackButtonVisible

        @Deprecated
        void setBackButtonVisible​(boolean visible)
        Change the visibility of the "Back" button at the bottom of the current screen. This setting applies only to the currently displayed screen.
        Parameters:
        visible - if the button should be visible or not
      • setCancelButtonVisible

        @Deprecated
        void setCancelButtonVisible​(boolean visible)
        Change the visibility of the "Cancel" button at the bottom of the current screen. This setting applies only to the currently displayed screen.
        Parameters:
        visible - if the button should be visible or not
      • setWizardIndex

        void setWizardIndex​(WizardIndex wizardIndex)
        Install a wizard index on the left side of the window to show overall installation progress. See WizardIndex for more information. The first step in the wizard index will be highlighted immediately. This setting is not restricted to the current screen, it remains active for subsequent screens. Is is suggested to increase the window width of your installer, if you use wizard indices.
        Parameters:
        wizardIndex - the new wizard index or null if the current wizard index should be removed.
      • setWizardIndexKey

        void setWizardIndexKey​(java.lang.String key)
        Change the highlighted step in the currently installed wizard index. If no wizard index is set, this has no effect.
        Parameters:
        key - the index key of the step that should be highlighted. If the key cannot be found in the current wizard index, no step will be highlighted.
      • getStyleManager

        StyleManager getStyleManager()
        Get the style manager. This is useful if you need to nest styles or if you have to reference styles from screens or form components.
        Returns:
        the style manager
      • setWindowSize

        void setWindowSize​(int width,
                           int height)
        Sets the size of the application window. This can also be called before any window is shown.
        Parameters:
        width - the width of the window
        height - the height of the window
      • setWindowTitle

        void setWindowTitle​(java.lang.String title)
        Sets the title of the application window. This can also be called before any window is shown. For installer variables in the title, live binding will replace them whenever they change.
        Parameters:
        title - the title