de.espirit.firstspirit.client.gui.applications.browser
Interface BrowserApplicationConfiguration

All Superinterfaces:

ApplicationTabConfiguration<BrowserApplicationConfiguration>

public interface BrowserApplicationConfiguration
extends ApplicationTabConfiguration<BrowserApplicationConfiguration>

Configuration builder to configure browser applications.

Usage:

 final BrowserApplicationConfiguration config = BrowserApplicationConfiguration.GENERATOR.invoke().icon(myIcon).title("myAppTitle");
 

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:

BrowserApplication

Field Summary

static Generator<BrowserApplicationConfiguration>

GENERATOR Generator to create a browser configuration instance.

Method Summary

BrowserApplicationConfiguration	engineType(EngineType type) Sets the type of the browser engine to be used for the browser application configured with this browser configuration.
EngineType	getEngineType() Returns the type of the browser engine which should be used for the created browser application.
boolean	showAddressBar() Indicates whether the browser application tab which will be created based on this configuration should show an address bar or not.
BrowserApplicationConfiguration	showAddressBar(boolean showAddressBar) Define whether the browser application tab which will be created based on this configuration should show an address bar or not.
BrowserApplicationConfiguration	useEngineTypeDependentIcon(boolean useEngineTypeDependentIcon) Defines whether a engine type dependent icon should be used if no special icon is set.

Methods inherited from interface de.espirit.firstspirit.client.gui.applications.ApplicationTabConfiguration

appearance, getAppearance, getIdentifier, icon, identifier, openInBackground, openInBackground, title

Field Detail

GENERATOR

static final Generator<BrowserApplicationConfiguration> GENERATOR

Generator to create a browser configuration instance.

Since:

4.2.416

Method Detail

useEngineTypeDependentIcon

BrowserApplicationConfiguration useEngineTypeDependentIcon(boolean useEngineTypeDependentIcon)

Defines whether a engine type dependent icon should be used if no special icon is set.

Parameters:

useEngineTypeDependentIcon - true to use engine type dependent icon, false otherwise

Returns:

this configuration instance (builder pattern)

Since:

4.2.416

See Also:

ApplicationTabConfiguration.icon(javax.swing.Icon)

showAddressBar

BrowserApplicationConfiguration showAddressBar(boolean showAddressBar)

Define whether the browser application tab which will be created based on this configuration should show an address bar or not.

Parameters:

showAddressBar - use true to show an address bar, false otherwise

Returns:

this configuration instance (builder pattern)

Since:

4.2.416

See Also:

BrowserApplicationConfiguration.showAddressBar()

showAddressBar

boolean showAddressBar()

Indicates whether the browser application tab which will be created based on this configuration should show an address bar or not.

Returns:

true if the browser application tab should have an address bar, false otherwise

Since:

4.2.416

See Also:

BrowserApplicationConfiguration.showAddressBar(boolean)

engineType

BrowserApplicationConfiguration engineType(@NotNull
                                           EngineType type)

Sets the type of the browser engine to be used for the browser application configured with this browser configuration.

Parameters:

type - the browser engine type to be used

Returns:

this configuration instance (builder pattern)

Since:

4.2.416

See Also:

BrowserApplicationConfiguration.getEngineType()

getEngineType

EngineType getEngineType()

Returns the type of the browser engine which should be used for the created browser application.

Returns:

the specified browser engine, EngineType.DEFAULT if not specified

Since:

4.2.416

See Also:

BrowserApplicationConfiguration.engineType(EngineType)