Package com.install4j.api.context

Interface InstallationComponentSetup

public interface InstallationComponentSetup
This interface provides information about installation components. Installation components are configured on the "Installation Components" tab in the install4j IDE.

Objects of this type are returned by Context.getInstallationComponents() and Context.getInstallationComponentById(String)

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    The ID of the installation component.
    String
    getName()
    Returns the name of this installation components.
    boolean
    isChangeable()
    Returns whether the selection state of the installation component can be changed by the user or not.
    boolean
    isDownloaded()
    Returns whether the installation component is downloaded.
    boolean
    isHidden()
    Returns whether the installation component is hidden from the user.
    boolean
    isSelected()
    Returns whether the installation components have been selected by the user.
    void
    setChangeable(boolean changeable)
    Sets whether the selection state of the installation component can be changed by the user or not.
    void
    setHidden(boolean hidden)
    Sets whether the installation component is hidden.
    void
    setSelected(boolean selected)
    Sets whether the installation component should be installed or not.

  • Method Details

    • isSelected

      boolean isSelected()
      Returns whether the installation components have been selected by the user.
      Returns:
      true or false.

    • setSelected

      void setSelected(boolean selected)
      Sets whether the installation component should be installed or not. This method only has an effect when called before the "Install files" action.
      Parameters:
      selected - the new selection state

    • isChangeable

      boolean isChangeable()
      Returns whether the selection state of the installation component can be changed by the user or not.
      Returns:
      true or false.

    • setChangeable

      void setChangeable(boolean changeable)
      Sets whether the selection state of the installation component can be changed by the user or not.
      Parameters:
      changeable - the new state

    • isHidden

      boolean isHidden()
      Returns whether the installation component is hidden from the user. This only affects the display in the component tree.
      Returns:
      true or false.

    • setHidden

      void setHidden(boolean hidden)
      Sets whether the installation component is hidden. This only affects the display in the component tree.
      Parameters:
      hidden - the new state

    • getName

      String getName()
      Returns the name of this installation components. This is the name that you have specified in the install4j IDE. The checkbox in the installation component tree displays this name.
      Returns:
      the name

    • getId

      String getId()
      The ID of the installation component. You can display component IDs in the install4j IDE.
      Returns:
      the ID

    • isDownloaded

      boolean isDownloaded()
      Returns whether the installation component is downloaded.
      Returns:
      true or false.