# LauncherSetup

Import: `import com.install4j.api.context.LauncherSetup;`

```java
interface LauncherSetup
```

This interface provides information about launchers.
Launchers are configured in the "Launchers" section of the install4j GUI.

Objects of this type are returned by [`Context.getLaunchers`](Context.md#getlaunchers) and [`Context.getLauncherById`](Context.md#getlauncherbyid-string).

## Methods

| Signature | Returns | Description |
|---|---|---|
| [`getRelativeFileName()`](#getrelativefilename) | `String` | Get the relative file name for the launcher. |
| [`getId()`](#getid) | `String` | Get the ID of the launcher. |
| [`getType()`](#gettype) | `LauncherType` | Get the type of the launcher. |
| [`isExcludeFromMenu()`](#isexcludefrommenu) | `boolean` | Returns whether the launcher is excluded from menu integration. |
| [`isUninstaller()`](#isuninstaller) | `boolean` | Returns whether the launcher is the uninstaller. |
| [`getName()`](#getname) | `String` | Return the name of the launcher as configured in the install4j GUI. |

### getRelativeFileName()

```java
String getRelativeFileName()
```

Get the relative file name for the launcher.


**Returns:** the relative file name.

### getId()

```java
String getId()
```

Get the ID of the launcher. The ID of a launcher
can be displayed in the install4j GUI by invoking Launcher->Show Launcher IDs from the main
menu when the Launchers section is active.


**Returns:** the ID.

### getType()

```java
LauncherType getType()
```

Get the type of the launcher.


**Returns:** the type

### isExcludeFromMenu()

```java
boolean isExcludeFromMenu()
```

Returns whether the launcher is excluded from menu integration. This concerns start menu entries on Windows
and the creation of links on Unix that are performed by the "Create default start menu entries" action.


**Returns:** `true` or `false`.

### isUninstaller()

```java
boolean isUninstaller()
```

Returns whether the launcher is the uninstaller.


**Returns:** `true` or `false`.

### getName()

```java
String getName()
```

Return the name of the launcher as configured in the install4j GUI.


**Returns:** the name

