Package com.zerog.ia.api.pub

Class CustomCodeConsoleAction

  • public abstract class CustomCodeConsoleAction
extends com.zerog.ia.api.priv.InstallConsole

    The CustomCodeConsoleAction class is designed to allow developers to create console based steps integrated with InstallAnywhere.

    There are several services and classes that help classes that extend CustomCodeConsoleAction provide useful functionality and interaction with the installer and the console.

    For instance, IASys provides static fields that can be used to write and read from the installer's console. Please see the items below for additional information.

    See Also:
    CustomCodeConsoleProxy, IASys, InstallerResources, ConsoleUtils, PreviousRequestException

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static CustomCodeConsoleProxy consoleProxy
      The CustomCodeConsoleAction class variable provides access to designer-specified resources, system and user-defined variables, and international resources.

      • Fields inherited from class com.zerog.ia.api.priv.InstallConsole

        cccp

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void executeConsoleAction()
      The executeConsoleAction method gets called when the installer is ready to display the console action.
      java.lang.String getTitle()
      The getTitle method returns the String to be displayed on the installation step of which this Console action will be contained.
      static void setCustomCodeConsoleProxy​(CustomCodeConsoleProxy cccp)
      The CustomCodeConsoleProxy method sets the customCodeConsoleProxy variable to make it available for use in the console action.
      boolean setup()
      The setup method is called prior to the ConsoleAction being displayed.

      • Methods inherited from class com.zerog.ia.api.priv.InstallConsole

        getConsoleDetailTitle, willPrintOwnTitleToConsole

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • consoleProxy

        protected static CustomCodeConsoleProxy consoleProxy

        The CustomCodeConsoleAction class variable provides access to designer-specified resources, system and user-defined variables, and international resources.

        As a class variable, this instance is available to all methods of a CustomCodeConsoleAction implementation, not just the executeConsoleAction() method which receives an instance of CustomCodeConsoleProxy as a parameter.

        See Also:
        CustomCodeConsoleProxy

    • Constructor Detail

      • CustomCodeConsoleAction

        public CustomCodeConsoleAction()

    • Method Detail

      • setCustomCodeConsoleProxy

        public static void setCustomCodeConsoleProxy​(CustomCodeConsoleProxy cccp)

        The CustomCodeConsoleProxy method sets the customCodeConsoleProxy variable to make it available for use in the console action. This method should not be called or overridden by CustomCodeConsoleAction subclasses.

        Parameters:
        cccp - Used to initialize the consoleProxy class variable, provides access to designer-specified resources, system and user-defined variables, and international resources.
        See Also:
        CustomCodeConsoleProxy

      • setup

        public boolean setup()

        The setup method is called prior to the ConsoleAction being displayed. This is useful for performing any initialization needed by the action.

        It is important that this method return quickly so that the CustomCodeConsoleAction may be displayed when needed. If it is necessary to do lengthy processing, it should be done in a separate Thread.

        NOTE: If setup():boolean returns false, to indicate that the CustomCodeConsoleAction should not be displayed, the installation manager will proceed without calling any of the other methods in CustomCodeConsoleAction.

        Overrides:
        setup in class com.zerog.ia.api.priv.InstallConsole
        Returns:
        true if the ConsoleAction should be displayed, false otherwise. By default, this method returns true.

      • getTitle

        public java.lang.String getTitle()

        The getTitle method returns the String to be displayed on the installation step of which this Console action will be contained. By default, this method returns an empty String. Classes that extend CustomCodeConsoleAction may override this method if they wish to have a title displayed at install-time.

        Overrides:
        getTitle in class com.zerog.ia.api.priv.InstallConsole
        Returns:
        The title to be displayed for this panel.