Class AbstractBrowserArea
java.lang.Object
de.hybris.platform.cockpit.session.impl.AbstractBrowserArea
- All Implemented Interfaces:
CockpitEventAcceptor,CockpitEventProducer,FocusablePerspectiveArea,UIBrowserArea,UICockpitArea,UIComponent
- Direct Known Subclasses:
BrowserArea,CatalogBrowserArea,DefaultConfigurableBrowserArea,DefaultSearchBrowserArea,LiveEditBrowserArea,UrlBrowserArea
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringprotected final List<BrowserModel>protected static final Stringprotected final Map<BrowserModel,AbstractContentBrowser> static final Stringprotected booleanprotected final UISessionListenerstatic final Stringprotected final List<BrowserModel> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanaddBrowser(int index, BrowserModel browserModel) protected booleanaddBrowser(BrowserModel browserModel) Adds theBrowserModelbif not already added, registers thisAbstractBrowserAreainstance asBrowserModelListenerand callsb.setArea(this).voidaddBrowserAreaListener(BrowserAreaListener listener) voidaddCockpitEventAcceptor(CockpitEventAcceptor acceptor) booleanaddHiddenBrowser(BrowserModel browserModel) Adds theBrowserModelbif not already added, registers thisAbstractBrowserAreainstance asBrowserModelListener, callsb.setArea(this)and removesbfrom the visible browsers if possible i.e.booleanaddVisibleBrowser(int index, BrowserModel browserModel) booleanaddVisibleBrowser(BrowserModel browserModel) Same asaddVisibleBrowser(b, false).booleanaddVisibleBrowser(BrowserModel browserModel, boolean replaceInactive) Deprecated.protected voidcheckShowInspector(org.zkoss.zkex.zul.LayoutRegion parentRegion, ListProvider<TypedObject> listProvider) protected voidcheckShowInspector(org.zkoss.zkex.zul.LayoutRegion parentRegion, ListProvider<TypedObject> listProvider, boolean closeEditor) voidclose(BrowserModel browserModel) voidTries to close inspector area if present.voidcloseInspector(String divId) Tries to close inspector area if present.protected voidcloseInspectorInComponent(org.zkoss.zk.ui.Component infoArea) voidcloseOthers(BrowserModel browserModel) computeTabLabel(String label) protected voidcreateAndAddTabPopup(org.zkoss.zul.Tab tab, BrowserModel browserModel) protected org.zkoss.zk.ui.ComponentcreateBrowserView(org.zkoss.zkex.zul.Borderlayout parent, BrowserModel browserModel) Creates a new default browser model for this areavoidduplicateBrowser(BrowserModel browserModel) Creates a newBrowserModelinstance by cloningband adds it to the "visible" browsers, thus potentially causing a previously visible browser to be minimized (since there is a limit to how many browsers can be visible at the same time).protected voidfireBrowserAdded(BrowserModel browserModel) protected voidfireBrowserChanged(BrowserModel browserModel) protected voidfireBrowserClosed(BrowserModel browserModel) protected voidfireBrowserFocused(BrowserModel browserModel) protected voidfireBrowserMinimized(BrowserModel browserModel) protected voidfireBrowserOpened(BrowserModel browserModel) protected voidfireBrowserQuerySaved(BrowserModel browserModel) protected voidfireBrowsersClosed(List<BrowserModel> browsers) protected voidfireItemActivated(TypedObject activeItem) protected voidfireItemsDropped(BrowserModel browser, Collection<TypedObject> items) protected voidfireSelectionChanged(BrowserModel browserModel) protected voidabstract BrowserModelListenerprotected org.zkoss.zk.ui.AbstractComponentgetCorrespondingContentBrowser(BrowserModel browserModel) org.zkoss.zk.ui.Componentorg.zkoss.zk.ui.ComponentgetInfoArea(String divId) protected Stringprotected InspectorRenderergetLabel()voidhide(BrowserModel browserModel) Convenience method for hiding aBrowserModel.voidinitBrowsers(org.zkoss.zkex.zul.Borderlayout container) voidinitialize(Map<String, Object> params) booleanisBrowserMinimized(BrowserModel browserModel) Returns whether theBrowserModelbis minimized (hidden) or not.booleanisClosable(BrowserModel browserModel) booleanprotected booleanbooleanisMinimizable(BrowserModel browserModel) booleanbooleanbooleanprotected booleanisShowAsClosable(BrowserModel browserModel) booleanbooleanbooleanvoidonCockpitEvent(CockpitEvent event) voidopenInspector(TypedObject item) Tries to open the inspector area if present.protected voidopenInspectorInArea(TypedObject item, org.zkoss.zk.ui.Component infoArea) voidopenInspectorInDiv(TypedObject item, String divId) booleanprotected booleanremoveBrowser(BrowserModel browser) Removes theBrowserModelb, de-registers thisAbstractBrowserAreainstance asBrowserModelListener, callsb.setArea(null)and removesbfrom the visible browsers (if present).voidremoveBrowserAreaListener(BrowserAreaListener listener) voidvoidreplaceBrowser(int index, BrowserModel newBrowser) Replaces the visible browser with indexindexwithnewBrowser.voidreplaceBrowser(BrowserModel oldBrowser, BrowserModel newBrowser) ReplacesoldBrowserwithnewBrowseri.e.protected voidresetBrowserView(BrowserModel browserModel) voidsetAdditionalToolbarActions(ActionColumnConfiguration additionalToolbarActions) voidsetDefaultBrowserClass(String defaultBrowserClass) voidsetDefaultBrowserViewMapping(Map<String, String> defaultBrowserViewMapping) voidsetFocus(boolean focus) voidsetFocusedBrowser(BrowserModel browserModel) voidsetInfoAreaContainerId(String infoAreaContainerId) voidsetInspectorRenderer(InspectorRenderer inspectorRenderer) voidsetMultiSelectActions(ActionColumnConfiguration multiSelectActions) voidsetMultiSelectContextActions(ActionColumnConfiguration multiSelectContextActions) voidsetMultiSelectContextActionsRegistry(ContextAreaActionColumnConfigurationRegistry multiSelectContextActionsRegistry) voidsetOpenInspectorOnSelect(boolean openInspectorOnSelect) voidsetPerspective(UICockpitPerspective perspective) voidsetPossibleAddContextSubTypes(boolean possibleAddContextSubTypes) voidsetShowCreateDefaultBrowserButton(boolean showCreateDefaultBrowserButton) voidsetSplitModeActive(boolean splitmodeActivated) voidsetSplitModeActiveDirectly(boolean splitmodeActivated) voidsetSplittable(boolean splittable) voidsetViewURI(String viewURI) voidshow(BrowserModel browserModel) Convenience method for displaying aBrowserModel.voidupdate()Resets the view i.e.voidupdateActivation(BrowserModel browserModel) This method makes it possible to force the view to get the currently active item(s) from its model i.e.voidvoidupdateInfoArea(ListProvider<TypedObject> listProvider) voidupdateInfoArea(ListProvider<TypedObject> listProvider, boolean handleVisibility) voidupdateSelectedItems(BrowserModel browserModel) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface de.hybris.platform.cockpit.session.UIBrowserArea
saveQuery
-
Field Details
-
INFO_AREA_CONTAINER
- See Also:
-
RESULT_GRID_RENDERER
- See Also:
-
BROWSER_TAB_COMPONENT
- See Also:
-
browsers
-
visibleBrowsers
-
mySessionListener
-
componentMap
-
initialized
protected boolean initialized -
COCKPIT_ID_BROWSERAREA_TAB_PREFIX
- See Also:
-
-
Constructor Details
-
AbstractBrowserArea
public AbstractBrowserArea()
-
-
Method Details
-
isSaveQueryAvailable
public boolean isSaveQueryAvailable()- Specified by:
isSaveQueryAvailablein interfaceUIBrowserArea
-
getViewURI
- Specified by:
getViewURIin interfaceUIComponent
-
setViewURI
-
getBrowserAreaListeners
-
initialize
- Specified by:
initializein interfaceUICockpitArea- Specified by:
initializein interfaceUIComponent
-
getInfoArea
public org.zkoss.zk.ui.Component getInfoArea() -
getInfoAreaContainerId
-
getInfoArea
-
openInspector
Tries to open the inspector area if present.- Parameters:
item- You can specify an item that should be rendered in the inspector. If you just want to show the area, pass null.
-
openInspectorInDiv
-
openInspectorInArea
-
closeInspector
public void closeInspector()Tries to close inspector area if present. -
closeInspectorInComponent
protected void closeInspectorInComponent(org.zkoss.zk.ui.Component infoArea) -
closeInspector
Tries to close inspector area if present. -
updateInfoArea
-
updateInfoArea
-
checkShowInspector
protected void checkShowInspector(org.zkoss.zkex.zul.LayoutRegion parentRegion, ListProvider<TypedObject> listProvider) -
checkShowInspector
protected void checkShowInspector(org.zkoss.zkex.zul.LayoutRegion parentRegion, ListProvider<TypedObject> listProvider, boolean closeEditor) -
initBrowsers
public void initBrowsers(org.zkoss.zkex.zul.Borderlayout container) - Specified by:
initBrowsersin interfaceUIBrowserArea
-
getCorrespondingContentBrowser
-
getContainerComponent
protected org.zkoss.zk.ui.AbstractComponent getContainerComponent() -
resetBrowserView
-
updateActivation
This method makes it possible to force the view to get the currently active item(s) from its model i.e. synchronizing itself.- Specified by:
updateActivationin interfaceUIBrowserArea- See Also:
-
update
public void update()Resets the view i.e. completely updates the browser area view by recreating the visual components based on the heldBrowserModelinstances.- Specified by:
updatein interfaceUICockpitArea- See Also:
-
createAndAddTabPopup
-
createNewDefaultBrowser
Creates a new default browser model for this area- Returns:
- a new instance of default browser model or null, if no default is defined
-
providesDefaultBrowser
public boolean providesDefaultBrowser() -
computeTabLabel
-
createBrowserView
protected org.zkoss.zk.ui.Component createBrowserView(org.zkoss.zkex.zul.Borderlayout parent, BrowserModel browserModel) -
updateSelectedItems
- Specified by:
updateSelectedItemsin interfaceUIBrowserArea
-
updateActiveItems
public void updateActiveItems()- Specified by:
updateActiveItemsin interfaceUIBrowserArea
-
duplicateBrowser
Creates a newBrowserModelinstance by cloningband adds it to the "visible" browsers, thus potentially causing a previously visible browser to be minimized (since there is a limit to how many browsers can be visible at the same time). Calling this method will reset the view.- Specified by:
duplicateBrowserin interfaceUIBrowserArea- Parameters:
browserModel- the browser to be duplicated.- See Also:
-
getBrowsers
- Specified by:
getBrowsersin interfaceUIBrowserArea
-
getVisibleBrowsers
- Specified by:
getVisibleBrowsersin interfaceUIBrowserArea
-
getHiddenBrowsers
-
hide
Convenience method for hiding aBrowserModel. Does the same thing asaddHiddenBrowser(b)with the addition that the remaining visibleBrowserModelgets focus andupdate()is called if necessary.- Specified by:
hidein interfaceUIBrowserArea- Parameters:
browserModel- theBrowserModelto hide- See Also:
-
show
Convenience method for displaying aBrowserModel. Does the same thing asaddVisibleBrowser(b, true)with the addition thatbis given focus andupdate()is called if necessary.- Specified by:
showin interfaceUIBrowserArea- Parameters:
browserModel- theBrowserModelto show- See Also:
-
close
- Specified by:
closein interfaceUIBrowserArea
-
closeOthers
- Specified by:
closeOthersin interfaceUIBrowserArea
-
replaceBrowser
ReplacesoldBrowserwithnewBrowseri.e. closesoldBrowserand opensnewBrowser. IfoldBrowserwas focusednewBrowserwill get focus after replacement has taken place. Note: Calling this method will cause the view to be reset.- Specified by:
replaceBrowserin interfaceUIBrowserArea- Parameters:
oldBrowser- the old browser which is to be closednewBrowser- the new browser which is to be opened- See Also:
-
replaceBrowser
Replaces the visible browser with indexindexwithnewBrowser.- Parameters:
index- index of the visible browser to replacenewBrowser- the new browser which is to be opened
-
isPossibleAddContextSubTypes
public boolean isPossibleAddContextSubTypes() -
isClosable
- Specified by:
isClosablein interfaceUIBrowserArea
-
isMinimizable
- Specified by:
isMinimizablein interfaceUIBrowserArea
-
getPerspective
- Specified by:
getPerspectivein interfaceUICockpitArea
-
setPerspective
- Specified by:
setPerspectivein interfaceUICockpitArea
-
setFocusedBrowser
- Specified by:
setFocusedBrowserin interfaceUIBrowserArea
-
getFocusedBrowser
- Specified by:
getFocusedBrowserin interfaceUIBrowserArea
-
isBrowserMinimized
Returns whether theBrowserModelbis minimized (hidden) or not.- Specified by:
isBrowserMinimizedin interfaceUIBrowserArea- Parameters:
browserModel- theBrowserModel- Returns:
trueifbis minimized,falseotherwise
-
addBrowserAreaListener
- Specified by:
addBrowserAreaListenerin interfaceUIBrowserArea
-
removeBrowserAreaListener
- Specified by:
removeBrowserAreaListenerin interfaceUIBrowserArea
-
addBrowser
Adds theBrowserModelbif not already added, registers thisAbstractBrowserAreainstance asBrowserModelListenerand callsb.setArea(this).- Parameters:
browserModel- theAbstractBrowserto add- Returns:
trueif a new browser was added (i.e. ifbwas not previously present)
-
addBrowser
-
getPreviousBrowser
- Specified by:
getPreviousBrowserin interfaceUIBrowserArea
-
addHiddenBrowser
Adds theBrowserModelbif not already added, registers thisAbstractBrowserAreainstance asBrowserModelListener, callsb.setArea(this)and removesbfrom the visible browsers if possible i.e. ifisMinimizable(b)returnstrue. If calling this method causesbto be minimized any registeredBrowserAreaListeners will be notified. Note: This method will not reset the view so you might want to callupdate().- Parameters:
browserModel- theAbstractBrowserto add- Returns:
trueif the view needs to be updated due to changes made- See Also:
-
addVisibleBrowser
Same asaddVisibleBrowser(b, false). Note: This method will not reset the view so you might want to callupdate().- Parameters:
browserModel- theBrowserModelto add- Returns:
trueif the view needs to be updated due to changes made- See Also:
-
addVisibleBrowser
Deprecated.since 6.3, useaddVisibleBrowser(BrowserModel)Adds theBrowserModelb, if not already added, to the visible browsers, registers thisAbstractBrowserAreainstance asBrowserModelListenerand callsb.setArea(this). ifreplaceInactiveistrueaBrowserModelwhich has no focus will be replaced i.e. it will be minimized andbwill take its place. If calling this method causes browsers to be added, opened or minimized any registeredBrowserAreaListeners will be notified. Note: This method will not reset the view so you might want to callupdate().- Specified by:
addVisibleBrowserin interfaceUIBrowserArea- Parameters:
browserModel- theBrowserModelto addreplaceInactive- iftruetheBrowserModelwhich has no focus will be replaced withb, iffalsebwill be inserted as the second browser- Returns:
trueif the view needs to be updated due to changes made- See Also:
-
addVisibleBrowser
- Specified by:
addVisibleBrowserin interfaceUIBrowserArea
-
removeBrowser
Removes theBrowserModelb, de-registers thisAbstractBrowserAreainstance asBrowserModelListener, callsb.setArea(null)and removesbfrom the visible browsers (if present). Ifbisnull, nothing is done andfalseis returned.- Parameters:
browser- theBrowserModelto remove- Returns:
trueif the view needs to be updated due to the changes made- See Also:
-
fireSelectionChanged
-
fireBrowserClosed
-
fireBrowsersClosed
-
fireBrowserMinimized
-
fireBrowserOpened
-
fireBrowserAdded
-
fireBrowserChanged
-
fireBrowserFocused
-
fireBrowserQuerySaved
-
fireSplitmodeChanged
protected void fireSplitmodeChanged() -
fireItemActivated
-
fireItemsDropped
-
getManagingPerspective
- Specified by:
getManagingPerspectivein interfaceFocusablePerspectiveArea
-
isFocused
public boolean isFocused()- Specified by:
isFocusedin interfaceFocusablePerspectiveArea
-
setPossibleAddContextSubTypes
public void setPossibleAddContextSubTypes(boolean possibleAddContextSubTypes) -
setFocus
public void setFocus(boolean focus) - Specified by:
setFocusin interfaceFocusablePerspectiveArea
-
getBrowserListener
-
setSplitModeActiveDirectly
public void setSplitModeActiveDirectly(boolean splitmodeActivated) -
setSplitModeActive
public void setSplitModeActive(boolean splitmodeActivated) - Specified by:
setSplitModeActivein interfaceUIBrowserArea- Parameters:
splitmodeActivated- the splitmodeActivated to set
-
isSplitModeActive
public boolean isSplitModeActive()- Specified by:
isSplitModeActivein interfaceUIBrowserArea- Returns:
- the splitmodeActivated
-
setSplittable
public void setSplittable(boolean splittable) - Specified by:
setSplittablein interfaceUIBrowserArea- Parameters:
splittable- the splittable to set
-
isSplittable
public boolean isSplittable()- Specified by:
isSplittablein interfaceUIBrowserArea- Returns:
- the splittable
-
addCockpitEventAcceptor
- Specified by:
addCockpitEventAcceptorin interfaceCockpitEventProducer
-
removeCockpitEventAcceptor
- Specified by:
removeCockpitEventAcceptorin interfaceCockpitEventProducer
-
onCockpitEvent
- Specified by:
onCockpitEventin interfaceCockpitEventAcceptor
-
isInfoAreaOpen
protected boolean isInfoAreaOpen() -
getLabel
- Specified by:
getLabelin interfaceUIComponent
-
setMultiSelectActions
- Specified by:
setMultiSelectActionsin interfaceUIBrowserArea
-
getMultiSelectActions
- Specified by:
getMultiSelectActionsin interfaceUIBrowserArea
-
setMultiSelectContextActions
- Specified by:
setMultiSelectContextActionsin interfaceUIBrowserArea
-
getMultiSelectContextActions
- Specified by:
getMultiSelectContextActionsin interfaceUIBrowserArea
-
setMultiSelectContextActionsRegistry
public void setMultiSelectContextActionsRegistry(ContextAreaActionColumnConfigurationRegistry multiSelectContextActionsRegistry) - Specified by:
setMultiSelectContextActionsRegistryin interfaceUIBrowserArea- Parameters:
multiSelectContextActionsRegistry- the multiSelectContextActionsRegistry to set
-
getMultiSelectContextActionsRegistry
- Specified by:
getMultiSelectContextActionsRegistryin interfaceUIBrowserArea
-
setAdditionalToolbarActions
-
getAdditionalToolbarActions
-
getDefaultBrowserViewMapping
- Specified by:
getDefaultBrowserViewMappingin interfaceUIBrowserArea
-
setDefaultBrowserViewMapping
-
setDefaultBrowserClass
-
getDefaultBrowserClass
-
isShowAsClosable
-
setShowCreateDefaultBrowserButton
public void setShowCreateDefaultBrowserButton(boolean showCreateDefaultBrowserButton) -
isShowCreateDefaultBrowserButton
public boolean isShowCreateDefaultBrowserButton() -
setInspectorRenderer
-
getInspectorRenderer
-
setOpenInspectorOnSelect
public void setOpenInspectorOnSelect(boolean openInspectorOnSelect) -
isOpenInspectorOnSelect
public boolean isOpenInspectorOnSelect() -
setInfoAreaContainerId
-
addVisibleBrowser(BrowserModel)Adds theBrowserModelb, if not already added, to the visible browsers, registers thisAbstractBrowserAreainstance asBrowserModelListenerand callsb.setArea(this).