de.hybris.platform.cscockpit.session.impl

Class OrderedConfigurableBrowserArea

java.lang.Object

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

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

de.hybris.platform.cscockpit.session.impl.OrderedConfigurableBrowserArea

All Implemented Interfaces:

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

public class OrderedConfigurableBrowserArea
extends DefaultConfigurableBrowserArea

Browser area that supports browsers in a specific order. As browsers are added or removed they appear at their appropriate position relative to other browsers.

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 and Description
OrderedConfigurableBrowserArea()

Method Summary

Modifier and Type	Method and Description
protected boolean	addBrowser(BrowserModel browserModel) Adds the BrowserModel b if not already added, registers this AbstractBrowserArea instance as BrowserModelListener and calls b.setArea(this) .
protected boolean	addBrowser(int index, BrowserModel browserModel)
boolean	addHiddenBrowser(BrowserModel browserModel) Adds the BrowserModel b if not already added, registers this AbstractBrowserArea instance as BrowserModelListener, calls b.setArea(this) and removes b from the visible browsers if possible i.e.
void	addNotificationListener(java.lang.String key, CockpitEventAcceptor acceptor)
boolean	addVisibleBrowser(BrowserModel browserModel) Same as addVisibleBrowser(b, false).
boolean	addVisibleBrowser(BrowserModel browserModel, boolean replaceInactive)
boolean	addVisibleBrowser(int index, BrowserModel browserModel)
protected java.lang.String	buildFullName(AddressModel address)
void	close(BrowserModel browserModel)
void	closeOthers(BrowserModel browserModel)
<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	createNewDefaultBrowser() Creates a new default browser model for this area
protected ModelService	getModelService()
void	hide(BrowserModel browserModel) Convenience method for hiding a BrowserModel.
void	initialize(java.util.Map<java.lang.String,java.lang.Object> stringObjectMap)
protected boolean	isShowAsClosable(BrowserModel browserModel)
protected void	notifyNotificationListeners(CockpitEvent event)
void	onCockpitEvent(CockpitEvent event)
boolean	providesDefaultBrowser()
protected boolean	removeBrowser(BrowserModel browserModel) Removes the BrowserModel b, de-registers this AbstractBrowserArea instance as BrowserModelListener, calls b.setArea(null) and removes b from the visible browsers (if present).
void	removeNotificationListener(java.lang.String key)
void	replaceBrowser(BrowserModel browserModel, BrowserModel browserModel1) Replaces oldBrowser with newBrowser i.e.
void	replaceBrowser(int index, BrowserModel browserModel) Replaces the visible browser with index index with newBrowser.
void	setModelService(ModelService modelService)
void	show(BrowserModel browserModel) Convenience method for displaying a BrowserModel.
protected void	sortBrowserModels()
protected void	updateUserRecordOnDefaultPaymentAddressChange(UserModel user, AddressModel address)

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

createInitiallyOpenedBrowsers, getBrowserListener, getBrowserModel, getDefaultBrowserId, getSupportedBrowserIds, isBrowserSupported, saveQuery, setDefaultBrowserId, setSupportedBrowserIds

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

addBrowserAreaListener, addCockpitEventAcceptor, checkShowInspector, checkShowInspector, closeInspector, closeInspector, closeInspectorInComponent, 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, initBrowsers, isBrowserMinimized, isClosable, isFocused, isInfoAreaOpen, isMinimizable, isOpenInspectorOnSelect, isPossibleAddContextSubTypes, isSaveQueryAvailable, isShowCreateDefaultBrowserButton, isSplitModeActive, isSplittable, openInspector, openInspectorInArea, openInspectorInDiv, removeBrowserAreaListener, removeCockpitEventAcceptor, resetBrowserView, setAdditionalToolbarActions, setDefaultBrowserClass, setDefaultBrowserViewMapping, setFocus, setFocusedBrowser, setInfoAreaContainerId, setInspectorRenderer, setMultiSelectActions, setMultiSelectContextActions, setMultiSelectContextActionsRegistry, setOpenInspectorOnSelect, setPerspective, setPossibleAddContextSubTypes, setShowCreateDefaultBrowserButton, setSplitModeActive, setSplitModeActiveDirectly, setSplittable, setViewURI, 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.session.UIBrowserArea

addBrowserAreaListener, duplicateBrowser, getBrowsers, getDefaultBrowserViewMapping, getFocusedBrowser, getMultiSelectActions, getMultiSelectContextActions, getMultiSelectContextActionsRegistry, getPreviousBrowser, getVisibleBrowsers, initBrowsers, isBrowserMinimized, isClosable, isMinimizable, isSaveQueryAvailable, isSplitModeActive, isSplittable, removeBrowserAreaListener, setFocusedBrowser, setMultiSelectActions, setMultiSelectContextActions, setMultiSelectContextActionsRegistry, setSplitModeActive, setSplittable, 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

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

Constructor Detail

OrderedConfigurableBrowserArea

public OrderedConfigurableBrowserArea()

Method Detail

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

sortBrowserModels

protected void sortBrowserModels()

providesDefaultBrowser

public boolean providesDefaultBrowser()

Overrides:

providesDefaultBrowser in class DefaultConfigurableBrowserArea

initialize

public void initialize(java.util.Map<java.lang.String,java.lang.Object> stringObjectMap)

Specified by:

initialize in interface UICockpitArea

Specified by:

initialize in interface UIComponent

Overrides:

initialize in class DefaultConfigurableBrowserArea

replaceBrowser

public void replaceBrowser(BrowserModel browserModel,
                           BrowserModel browserModel1)

Description copied from class: AbstractBrowserArea

Replaces oldBrowser with newBrowser i.e. closes oldBrowser and opens newBrowser. If oldBrowser was focused newBrowser will get focus after replacement has taken place.

Note: Calling this method will cause the view to be reset.

Specified by:

replaceBrowser in interface UIBrowserArea

Overrides:

replaceBrowser in class AbstractBrowserArea

Parameters:

browserModel - the old browser which is to be closed

browserModel1 - the new browser which is to be opened

See Also:

AbstractBrowserArea.update(), AbstractBrowserArea.setFocusedBrowser(BrowserModel), AbstractBrowserArea.addVisibleBrowser(BrowserModel), AbstractBrowserArea.removeBrowser(BrowserModel)

replaceBrowser

public void replaceBrowser(int index,
                           BrowserModel browserModel)

Description copied from class: AbstractBrowserArea

Replaces the visible browser with index index with newBrowser.

Overrides:

replaceBrowser in class AbstractBrowserArea

Parameters:

index - index of the visible browser to replace

browserModel - the new browser which is to be opened

closeOthers

public void closeOthers(BrowserModel browserModel)

Specified by:

closeOthers in interface UIBrowserArea

Overrides:

closeOthers in class AbstractBrowserArea

close

public void close(BrowserModel browserModel)

Specified by:

close in interface UIBrowserArea

Overrides:

close in class AbstractBrowserArea

hide

public void hide(BrowserModel browserModel)

Description copied from class: AbstractBrowserArea

Convenience method for hiding a BrowserModel. Does the same thing as addHiddenBrowser(b) with the addition that the remaining visible BrowserModel gets focus and AbstractBrowserArea.update() is called if necessary.

Specified by:

hide in interface UIBrowserArea

Overrides:

hide in class AbstractBrowserArea

Parameters:

browserModel - the BrowserModel to hide

See Also:

AbstractBrowserArea.addHiddenBrowser(BrowserModel), AbstractBrowserArea.setFocusedBrowser(BrowserModel), AbstractBrowserArea.update()

show

public void show(BrowserModel browserModel)

Description copied from class: AbstractBrowserArea

Convenience method for displaying a BrowserModel. Does the same thing as addVisibleBrowser(b, true) with the addition that b is given focus and AbstractBrowserArea.update() is called if necessary.

Specified by:

show in interface UIBrowserArea

Overrides:

show in class AbstractBrowserArea

Parameters:

browserModel - the BrowserModel to show

See Also:

AbstractBrowserArea.addVisibleBrowser(BrowserModel, boolean), AbstractBrowserArea.setFocusedBrowser(BrowserModel), AbstractBrowserArea.update()

addHiddenBrowser

public boolean addHiddenBrowser(BrowserModel browserModel)

Description copied from class: AbstractBrowserArea

Adds the BrowserModel b if not already added, registers this AbstractBrowserArea instance as BrowserModelListener, calls b.setArea(this) and removes b from the visible browsers if possible i.e. if isMinimizable(b) returns true. If calling this method causes b to be minimized any registered BrowserAreaListeners will be notified.

Note: This method will not reset the view so you might want to call AbstractBrowserArea.update().

Overrides:

addHiddenBrowser in class AbstractBrowserArea

Parameters:

browserModel - the AbstractBrowser to add

Returns:

true if the view needs to be updated due to changes made

See Also:

AbstractBrowserArea.addBrowser(BrowserModel), AbstractBrowserArea.hide(BrowserModel)

addVisibleBrowser

public boolean addVisibleBrowser(BrowserModel browserModel)

Description copied from class: AbstractBrowserArea

Same as addVisibleBrowser(b, false).

Note: This method will not reset the view so you might want to call AbstractBrowserArea.update().

Overrides:

addVisibleBrowser in class AbstractBrowserArea

Parameters:

browserModel - the BrowserModel to add

Returns:

true if the view needs to be updated due to changes made

See Also:

AbstractBrowserArea.addVisibleBrowser(BrowserModel, boolean), AbstractBrowserArea.update(), AbstractBrowserArea.show(BrowserModel)

addVisibleBrowser

public boolean addVisibleBrowser(BrowserModel browserModel,
                                 boolean replaceInactive)

Specified by:

addVisibleBrowser in interface UIBrowserArea

Overrides:

addVisibleBrowser in class AbstractBrowserArea

Parameters:

browserModel - the BrowserModel to add

replaceInactive - if true the BrowserModel which has no focus will be replaced with b , if false b will be inserted as the second browser

Returns:

true if the view needs to be updated due to changes made

See Also:

AbstractBrowserArea.addBrowser(BrowserModel), BrowserAreaListener.browserAdded(BrowserModel), BrowserAreaListener.browserMinimized(BrowserModel), BrowserAreaListener.browserOpened(BrowserModel), AbstractBrowserArea.update(), AbstractBrowserArea.show(BrowserModel)

addVisibleBrowser

public boolean addVisibleBrowser(int index,
                                 BrowserModel browserModel)

Specified by:

addVisibleBrowser in interface UIBrowserArea

Overrides:

addVisibleBrowser in class AbstractBrowserArea

removeBrowser

protected boolean removeBrowser(BrowserModel browserModel)

Description copied from class: AbstractBrowserArea

Removes the BrowserModel b, de-registers this AbstractBrowserArea instance as BrowserModelListener, calls b.setArea(null) and removes b from the visible browsers (if present). If b is null, nothing is done and false is returned.

Overrides:

removeBrowser in class AbstractBrowserArea

Parameters:

browserModel - the BrowserModel to remove

Returns:

true if the view needs to be updated due to the changes made

See Also:

AbstractBrowserArea.close(BrowserModel)

addBrowser

protected boolean addBrowser(int index,
                             BrowserModel browserModel)

Overrides:

addBrowser in class AbstractBrowserArea

addBrowser

protected boolean addBrowser(BrowserModel browserModel)

Description copied from class: AbstractBrowserArea

Adds the BrowserModel b if not already added, registers this AbstractBrowserArea instance as BrowserModelListener and calls b.setArea(this) .

Overrides:

addBrowser in class AbstractBrowserArea

Parameters:

browserModel - the AbstractBrowser to add

Returns:

true if a new browser was added (i.e. if b was not previously present)

createNewDefaultBrowser

public BrowserModel createNewDefaultBrowser()

Description copied from class: AbstractBrowserArea

Creates a new default browser model for this area

Overrides:

createNewDefaultBrowser in class DefaultConfigurableBrowserArea

Returns:

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

createBrowser

public <T extends BrowserModel> T createBrowser(java.lang.String browserId,
                                                java.lang.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

Overrides:

createBrowser in class DefaultConfigurableBrowserArea

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)

isShowAsClosable

protected boolean isShowAsClosable(BrowserModel browserModel)

Overrides:

isShowAsClosable in class AbstractBrowserArea

onCockpitEvent

public void onCockpitEvent(CockpitEvent event)

Specified by:

onCockpitEvent in interface CockpitEventAcceptor

Overrides:

onCockpitEvent in class AbstractBrowserArea

updateUserRecordOnDefaultPaymentAddressChange

protected void updateUserRecordOnDefaultPaymentAddressChange(UserModel user,
                                                             AddressModel address)

buildFullName

protected java.lang.String buildFullName(AddressModel address)

addNotificationListener

public void addNotificationListener(java.lang.String key,
                                    CockpitEventAcceptor acceptor)

removeNotificationListener

public void removeNotificationListener(java.lang.String key)

notifyNotificationListeners

protected void notifyNotificationListeners(CockpitEvent event)