install4j API documentation


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 GUI.

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

Author:
ej-technologies GmbH

Method Summary
 java.lang.String getId()
          The ID of the installation component.
 java.lang.String getName()
          Returns the name of 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 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

getName

java.lang.String getName()
Returns the name of this installation components. This is the name that you have specified in the install4j GUI. The check box in the installation component tree displays this name.

Returns:
the name

getId

java.lang.String getId()
The ID of the installation component. The ID of an installation component is displayed in the install4j GUI in the top-right corner of the component details panel.

Returns:
the ID