Package de.hybris.platform.cockpit.session.impl

Class DefaultConfigurableBrowserArea

java.lang.Object

de.hybris.platform.cockpit.session.impl.AbstractBrowserArea

de.hybris.platform.cockpit.session.impl.DefaultConfigurableBrowserArea

All Implemented Interfaces:

CockpitEventAcceptor, CockpitEventProducer, ConfigurableBrowserArea, FocusablePerspectiveArea, UIBrowserArea, UICockpitArea, UIComponent

public class DefaultConfigurableBrowserArea
extends AbstractBrowserArea
implements ConfigurableBrowserArea

Default implementation of the ConfigurableBrowserArea interface.

See Also:

• ConfigurableBrowserArea

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserArea

AbstractBrowserArea.MySessionListener

Field Summary

Fields inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserArea

BROWSER_TAB_COMPONENT, browsers, COCKPIT_ID_BROWSERAREA_TAB_PREFIX, componentMap, INFO_AREA_CONTAINER, initialized, mySessionListener, RESULT_GRID_RENDERER, visibleBrowsers

Constructor Summary

Constructors

Constructor	Description
DefaultConfigurableBrowserArea()

Method Summary

Modifier and Type	Method	Description
<T extends BrowserModel> T	createBrowser(String browserId, Class<T> expectedClass)	Creates a browser with the specified ID if it is supported.
protected List<BrowserModel>	createInitiallyOpenedBrowsers()
BrowserModel	createNewDefaultBrowser()	Creates a new default browser model for this area
BrowserModelListener	getBrowserListener()
BrowserModel	getBrowserModel(String browserCode)	Returns the browser with the code browserCode.
String	getDefaultBrowserId()	Returns the Spring bean ID of this area's default browser.
List<String>	getSupportedBrowserIds()	Returns all browser IDs supported by this browser area.
void	initialize(Map<String,Object> params)
boolean	isBrowserSupported(String browserId)	Returns whether this browser area supports creation of browsers with the specified ID.
boolean	providesDefaultBrowser()
void	saveQuery(BrowserModel browserModel)
void	setDefaultBrowserId(String id)	Sets the Spring bean ID of this area's default browser.
void	setSupportedBrowserIds(List<String> browserIds)	Sets the browsers supported by this browser area.

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserArea

addBrowser, addBrowser, addBrowserAreaListener, addCockpitEventAcceptor, addHiddenBrowser, addVisibleBrowser, addVisibleBrowser, addVisibleBrowser, checkShowInspector, checkShowInspector, close, closeInspector, closeInspector, closeInspectorInComponent, closeOthers, computeTabLabel, createAndAddTabPopup, createBrowserView, duplicateBrowser, fireBrowserAdded, fireBrowserChanged, fireBrowserClosed, fireBrowserFocused, fireBrowserMinimized, fireBrowserOpened, fireBrowserQuerySaved, fireBrowsersClosed, fireItemActivated, fireItemsDropped, fireSelectionChanged, fireSplitmodeChanged, getAdditionalToolbarActions, getBrowserAreaListeners, getBrowsers, getContainerComponent, getCorrespondingContentBrowser, getDefaultBrowserClass, getDefaultBrowserViewMapping, getFocusedBrowser, getHiddenBrowsers, getInfoArea, getInfoArea, getInfoAreaContainerId, getInspectorRenderer, getLabel, getManagingPerspective, getMultiSelectActions, getMultiSelectContextActions, getMultiSelectContextActionsRegistry, getPerspective, getPreviousBrowser, getViewURI, getVisibleBrowsers, hide, initBrowsers, isBrowserMinimized, isClosable, isFocused, isInfoAreaOpen, isMinimizable, isOpenInspectorOnSelect, isPossibleAddContextSubTypes, isSaveQueryAvailable, isShowAsClosable, isShowCreateDefaultBrowserButton, isSplitModeActive, isSplittable, onCockpitEvent, openInspector, openInspectorInArea, openInspectorInDiv, removeBrowser, removeBrowserAreaListener, removeCockpitEventAcceptor, replaceBrowser, replaceBrowser, resetBrowserView, setAdditionalToolbarActions, setDefaultBrowserClass, setDefaultBrowserViewMapping, setFocus, setFocusedBrowser, setInfoAreaContainerId, setInspectorRenderer, setMultiSelectActions, setMultiSelectContextActions, setMultiSelectContextActionsRegistry, setOpenInspectorOnSelect, setPerspective, setPossibleAddContextSubTypes, setShowCreateDefaultBrowserButton, setSplitModeActive, setSplitModeActiveDirectly, setSplittable, setViewURI, show, update, updateActivation, updateActiveItems, updateInfoArea, updateInfoArea, updateSelectedItems

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, setFocusedBrowser, setMultiSelectActions, setMultiSelectContextActions, setMultiSelectContextActionsRegistry, setSplitModeActive, setSplittable, show, updateActivation, updateActiveItems, updateSelectedItems

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

getPerspective, setPerspective, update

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

getLabel, getViewURI

Constructor Details

DefaultConfigurableBrowserArea

public DefaultConfigurableBrowserArea()

Method Details

getBrowserListener

public BrowserModelListener getBrowserListener()

Specified by:

getBrowserListener in class AbstractBrowserArea

saveQuery

public void saveQuery(BrowserModel browserModel)

Specified by:

saveQuery in interface UIBrowserArea

initialize

public void initialize(Map<String,Object> params)

Specified by:

initialize in interface UICockpitArea

Specified by:

initialize in interface UIComponent

Overrides:

initialize in class AbstractBrowserArea

createInitiallyOpenedBrowsers

protected List<BrowserModel> createInitiallyOpenedBrowsers()

createNewDefaultBrowser

public BrowserModel createNewDefaultBrowser()

Description copied from class: AbstractBrowserArea

Creates a new default browser model for this area

Overrides:

createNewDefaultBrowser in class AbstractBrowserArea

Returns:

a new instance of default browser model or null, if no default is defined

createBrowser

public <T extends BrowserModel> T createBrowser(String browserId,
 Class<T> expectedClass)

Description copied from interface: ConfigurableBrowserArea

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

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

Specified by:

createBrowser in interface ConfigurableBrowserArea

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:

• ConfigurableBrowserArea.isBrowserSupported(String)

providesDefaultBrowser

public boolean providesDefaultBrowser()

Overrides:

providesDefaultBrowser in class AbstractBrowserArea

isBrowserSupported

public boolean isBrowserSupported(String browserId)

Description copied from interface: ConfigurableBrowserArea

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 ConfigurableBrowserArea.setSupportedBrowserIds(List)

Specified by:

isBrowserSupported in interface ConfigurableBrowserArea

Parameters:

browserId - browser ID

Returns:

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

See Also:

• ConfigurableBrowserArea.createBrowser(String, Class)

getDefaultBrowserId

public String getDefaultBrowserId()

Description copied from interface: ConfigurableBrowserArea

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

Specified by:

getDefaultBrowserId in interface ConfigurableBrowserArea

Returns:

bean ID of the default browser

getSupportedBrowserIds

public List<String> getSupportedBrowserIds()

Description copied from interface: ConfigurableBrowserArea

Returns all browser IDs supported by this browser area.

Specified by:

getSupportedBrowserIds in interface ConfigurableBrowserArea

Returns:

list containing Spring bean IDs of all supported browsers

setDefaultBrowserId

public void setDefaultBrowserId(String id)

Description copied from interface: ConfigurableBrowserArea

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

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

Specified by:

setDefaultBrowserId in interface ConfigurableBrowserArea

Parameters:

id - bean ID of the default browser

setSupportedBrowserIds

public void setSupportedBrowserIds(List<String> browserIds)

Description copied from interface: ConfigurableBrowserArea

Sets the browsers supported by this browser area.

Specified by:

setSupportedBrowserIds in interface ConfigurableBrowserArea

Parameters:

browserIds - list containing Spring bean IDs of all supported browsers

getBrowserModel

public BrowserModel getBrowserModel(String browserCode)

Description copied from interface: ConfigurableBrowserArea

Returns the browser with the code browserCode.

Specified by:

getBrowserModel in interface ConfigurableBrowserArea

Parameters:

browserCode - code of the browser

Returns:

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