Package de.hybris.platform.cockpit.session

Interface ConfigurableBrowserArea

All Superinterfaces:

CockpitEventAcceptor, CockpitEventProducer, FocusablePerspectiveArea, UIBrowserArea, UICockpitArea, UIComponent

All Known Implementing Classes:

DefaultConfigurableBrowserArea

public interface ConfigurableBrowserArea
extends UIBrowserArea

Browser area which supports creation of multiple Cockpit browser types, configured using Spring.

Method Summary

Modifier and Type	Method	Description
<T extends BrowserModel> T	createBrowser(java.lang.String browserId, java.lang.Class<T> expectedClass)	Creates a browser with the specified ID if it is supported.
BrowserModel	getBrowserModel(java.lang.String browserCode)	Returns the browser with the code browserCode.
java.lang.String	getDefaultBrowserId()	Returns the Spring bean ID of this area's default browser.
java.util.List<java.lang.String>	getSupportedBrowserIds()	Returns all browser IDs supported by this browser area.
boolean	isBrowserSupported(java.lang.String browserId)	Returns whether this browser area supports creation of browsers with the specified ID.
void	setDefaultBrowserId(java.lang.String id)	Sets the Spring bean ID of this area's default browser.
void	setSupportedBrowserIds(java.util.List<java.lang.String> browserIds)	Sets the browsers supported by this browser area.

Methods inherited from interface de.hybris.platform.cockpit.events.CockpitEventAcceptor

onCockpitEvent

Methods inherited from interface de.hybris.platform.cockpit.events.CockpitEventProducer

addCockpitEventAcceptor, removeCockpitEventAcceptor

Methods inherited from interface de.hybris.platform.cockpit.session.FocusablePerspectiveArea

getManagingPerspective, isFocused, setFocus

Methods inherited from interface de.hybris.platform.cockpit.session.UIBrowserArea

addBrowserAreaListener, addVisibleBrowser, addVisibleBrowser, close, closeOthers, duplicateBrowser, getBrowsers, getDefaultBrowserViewMapping, getFocusedBrowser, getMultiSelectActions, getMultiSelectContextActions, getMultiSelectContextActionsRegistry, getPreviousBrowser, getVisibleBrowsers, hide, initBrowsers, isBrowserMinimized, isClosable, isMinimizable, isSaveQueryAvailable, isSplitModeActive, isSplittable, removeBrowserAreaListener, replaceBrowser, saveQuery, setFocusedBrowser, setMultiSelectActions, setMultiSelectContextActions, setMultiSelectContextActionsRegistry, setSplitModeActive, setSplittable, show, updateActivation, updateActiveItems, updateSelectedItems

Methods inherited from interface de.hybris.platform.cockpit.session.UICockpitArea

getPerspective, initialize, setPerspective, update

Methods inherited from interface de.hybris.platform.cockpit.session.UIComponent

getLabel, getViewURI

Method Detail

isBrowserSupported

boolean isBrowserSupported(java.lang.String browserId)

Returns whether this browser area supports creation of browsers with the specified ID.

Supported browsers are those which have been configured by a call to setSupportedBrowserIds(List)

Parameters:

browserId - browser ID

Returns:

true if browser with the specified id can be created, false otherwise

See Also:

createBrowser(String, Class)

createBrowser

<T extends BrowserModel> T createBrowser(java.lang.String browserId,
                                         java.lang.Class<T> expectedClass)

Creates a browser with the specified ID if it is supported.

Note: isBrowserSupported(String) should be called before calling this method in order to assure that a browser with the specified code can be created.

Type Parameters:

T - type of browser model

Parameters:

browserId - browser Spring bean ID

expectedClass - expected browser type

Returns:

browser model of type T

See Also:

isBrowserSupported(String)

setSupportedBrowserIds

void setSupportedBrowserIds(java.util.List<java.lang.String> browserIds)

Sets the browsers supported by this browser area.

Parameters:

browserIds - list containing Spring bean IDs of all supported browsers

getSupportedBrowserIds

java.util.List<java.lang.String> getSupportedBrowserIds()

Returns all browser IDs supported by this browser area.

Returns:

list containing Spring bean IDs of all supported browsers

setDefaultBrowserId

void setDefaultBrowserId(java.lang.String id)

Sets the Spring bean ID of this area's default browser.

Note: The corresponding Spring bean should be declared in the "prototype" scope.

Parameters:

id - bean ID of the default browser

getDefaultBrowserId

java.lang.String getDefaultBrowserId()

Returns the Spring bean ID of this area's default browser.

Returns:

bean ID of the default browser

getBrowserModel

BrowserModel getBrowserModel(java.lang.String browserCode)

Returns the browser with the code browserCode.

Parameters:

browserCode - code of the browser

Returns:

browser with the specified code or null if no browser is found