InstallationComponentSetup (install4j API)
Keywords: com.install4j.api.InstallationComponentSetup interface

Overview | Package | Class | Tree | Deprecated | Index | Help
| install4j API
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.install4j.api
Interface InstallationComponentSetup

    public interface InstallationComponentSetup

The interface that provides information about installation components. Installation components are configured in the "Files" section in the install4j GUI. Returned by `InstallerContext.getInstallationComponents()`.

Author:
  ej-technologies GmbH

Method Summary
`java.lang.String` | `getDescription()` Returns the description for this installation components.
`boolean` | `isSelected()` Returns whether the installation components has been selected by the user.
`void` | `setSelected(boolean selected)` Sets whether the installation component should be installed or not.

Method Detail

### isSelected

    boolean isSelected()

  Returns whether the installation components has been selected by the user.

  Returns:
    `true` if the installation components has been selected.

### 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 installation phase.

  Parameters:
    `selected` - the new selection state

### getDescription

    java.lang.String getDescription()

  Returns the description for this installation components. This is the description that you have specified in the install4j GUI. The checkbox on the installation components screen displays this description.

  Returns:
    the description

Overview | Package | Class | Tree | Deprecated | Index | Help
| install4j API
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD