de.espirit.firstspirit.client.gui.applications
Interface ApplicationService

All Known Subinterfaces:

MultiApplication

public interface ApplicationService

Client service to open tab applications. (only available inside java-client!)

Example:

 servicesBroker = specialistsBroker.requestSpecialist(ServicesBroker.TYPE);
 appService = servicesBroker.getService(ApplicationService.class);
 app = appService.openApplication(BrowserApplication.TYPE, config).getApplication();

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:

ServicesBroker.getService(Class)

Method Summary

<T,C extends ApplicationTabConfiguration<?>> ApplicationTab<T>	getApplication(ApplicationType<T,C> type, Object tabIdentifier) Returns an application specified by the given type and tabIdentifier or null if it doesn't exists.
boolean	isVisible() Indicates whether the application area (split pane in javaclient) is visible or not.
<T,C extends ApplicationTabConfiguration<?>> ApplicationTab<T>	openApplication(ApplicationType<T,C> type, C configuration) Opens a client application of specified type with the given configuration in a new tab and returns the tab control interface.
void	setVisible(boolean visible) Sets the visibility of the application area (split pane in javaclient).

Method Detail

openApplication

<T,C extends ApplicationTabConfiguration<?>> ApplicationTab<T> openApplication(ApplicationType<T,C> type,
                                                                               @Nullable
                                                                               C configuration)
                                  throws IllegalArgumentException,
                                         LicenseException

Opens a client application of specified type with the given configuration in a new tab and returns the tab control interface. Access the application with ApplicationTab.getApplication().

Type Parameters:

T - application interface.

C - configuration interface.

Parameters:

type - application type.

configuration - the configuration for the created application tab - maybe null

Returns:

the created application tab of the specified type

Throws:

IllegalArgumentException - if the given application type is unknown.

LicenseException - thrown if the license parameters are insufficient

Since:

4.2.416

See Also:

ApplicationService.getApplication(ApplicationType, Object)

getApplication

@Nullable
<T,C extends ApplicationTabConfiguration<?>> ApplicationTab<T> getApplication(ApplicationType<T,C> type,
                                                                                       Object tabIdentifier)

Returns an application specified by the given type and tabIdentifier or null if it doesn't exists.

Parameters:

tabIdentifier - the identifier associated with the application

type - the type belonginig to the application specified by given tabIdentifier

Returns:

the application specified by given type and tabIdentifier or null

Since:

4.2.416

See Also:

ApplicationTabConfiguration.getIdentifier(), ApplicationService.openApplication(ApplicationType, ApplicationTabConfiguration)

isVisible

boolean isVisible()

Indicates whether the application area (split pane in javaclient) is visible or not.

Returns:

true if the application area is visible , false otherwise

Since:

4.2.416

See Also:

ApplicationService.setVisible(boolean)

setVisible

void setVisible(boolean visible)

Sets the visibility of the application area (split pane in javaclient).

Parameters:

visible - true to show application area, false otherwise

Since:

4.2.416

See Also:

ApplicationTab.setSelected(), ApplicationService.isVisible()