de.espirit.firstspirit.client.gui.applications
Interface ApplicationTabConfiguration<T extends ApplicationTabConfiguration<T>>

All Known Subinterfaces:

BrowserApplicationConfiguration, MultiApplicationConfiguration, SwingApplicationConfiguration

public interface ApplicationTabConfiguration<T extends ApplicationTabConfiguration<T>>

Configuration class for application tabs.

Attention: This part of the API isn't released yet and may change during the ramp up time. It will be released with 4.2 Release 4.

Since:

4.2.416

See Also:

ApplicationTab, ApplicationService.openApplication(ApplicationType, ApplicationTabConfiguration)

Method Summary

ApplicationTabAppearance.Builder	appearance() Returns a builder to define tab appearance.
ApplicationTabAppearance	getAppearance() The appearance for the application tab.
Object	getIdentifier() Returns an identifier used to identify the application tab which will be created based on this configuration.
T	icon(Icon icon) Shortcut for ApplicationTabConfiguration.appearance().
T	identifier(Object tabIdentifier) Defines an identifier for the application tab which will be created based on this configuration.
boolean	openInBackground() Indicates whether the tab which will be created based on this configuration should be opened in background or not.
T	openInBackground(boolean openInBackground) Defines whether the application tab which will created based on this configuration will be opened in background or not.
T	title(String title) Shortcut for ApplicationTabConfiguration.appearance().

Method Detail

getIdentifier

Object getIdentifier()

Returns an identifier used to identify the application tab which will be created based on this configuration. The identifier can be used to retrieve the application tab via ApplicationService.getApplication(ApplicationType, Object)

Returns:

the application tab identifier

Since:

4.2.416

See Also:

ApplicationService.getApplication(ApplicationType, Object)

identifier

T identifier(Object tabIdentifier)

Defines an identifier for the application tab which will be created based on this configuration. The identifier can be used to retrieve the application tab via ApplicationService.getApplication(ApplicationType, Object)

Parameters:

tabIdentifier - the identifier for the application tab created based on this configuration

Returns:

this configuration instance (builder pattern)

Since:

4.2.416

See Also:

ApplicationService.getApplication(ApplicationType, Object)

title

T title(String title)

Shortcut for ApplicationTabConfiguration.appearance().title(String)

Parameters:

title - the title to be used for the created application tab

Returns:

this configuration instance (builder pattern)

Since:

4.2.416

icon

T icon(Icon icon)

Shortcut for ApplicationTabConfiguration.appearance().icon(javax.swing.Icon)

Parameters:

icon - the icon to be used for the created application tab. Preferred size 20x20 pixel

Returns:

this configuration instance (builder pattern)

Since:

4.2.416

getAppearance

@Nullable
ApplicationTabAppearance getAppearance()

The appearance for the application tab.

Returns:

tab appearance

Since:

4.2.416

See Also:

ApplicationTabConfiguration.appearance()

appearance

ApplicationTabAppearance.Builder appearance()

Returns a builder to define tab appearance.

Usage:

 ApplicationTabConfiguration config;
 config.ApplicationTabConfiguration.appearance().title("myTitle").icon(myTabIcon);
 

Returns:

the builder for the tab appearance

Since:

4.2.416

openInBackground

T openInBackground(boolean openInBackground)

Defines whether the application tab which will created based on this configuration will be opened in background or not.

Parameters:

openInBackground - true to open created tab in background, false otherwise

Returns:

this configuration instance (builder pattern)

Since:

4.2.416

See Also:

ApplicationTabConfiguration.openInBackground()

openInBackground

boolean openInBackground()

Indicates whether the tab which will be created based on this configuration should be opened in background or not.

Returns:

true if the tab created based on this configuration should be opened in background, false otherwise.

Since:

4.2.416

See Also:

ApplicationService.openApplication(ApplicationType, ApplicationTabConfiguration), ApplicationTabConfiguration.openInBackground(boolean)