Class UISessionImpl
java.lang.Object
de.hybris.platform.cockpit.session.impl.UISessionImpl
- All Implemented Interfaces:
UISession,org.springframework.beans.factory.Aware,org.springframework.context.ApplicationContextAware
-
Field Summary
Fields inherited from interface de.hybris.platform.cockpit.session.UISession
PERSPECTIVE_ATTRIBUTE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddSessionListener(UISessionListener listener) Adds a session listener.voidprotected org.zkoss.zk.ui.sys.IdGeneratorprotected voidprotected voidprotected voidprotected voidReturns all available perspectives.Returns the current product cockpit perspective bean.Returns the isocode of the current data language.Returns service, which handles all page refresh requirements.Returns the isocode of the current session language.protected List<UISessionListener>getListeners(boolean create) getPerspective(String uid) getUser()Returns the current ui session user.voidbooleanbooleanbooleanbooleanvoidAssigns specified user to this session.voidlogout()voidregisters additional perspectivesvoidregisterPerspectiveContainer(org.zkoss.zk.ui.Component comp) voidremoveSessionListener(UISessionListener listener) Removes session listener.voidsendGlobalEvent(CockpitEvent event) Processes given event.voidsendGlobalEvent(CockpitEvent event, boolean immediate) Processes given event.voidsetApplicationContext(org.springframework.context.ApplicationContext appCtx) voidsetAvailablePerspectives(List<UICockpitPerspective> availablePerspectives) voidsetCachePerspectivesEnabled(boolean cachePerspectivesEnabled) voidsetCockpitTypeService(TypeService cockpitTypeService) voidsetCommonI18NService(CommonI18NService commonI18NService) voidsetCurrentPerspective(UICockpitPerspective perspective) Changes the current product perspective bean.voidsetCurrentPerspective(UICockpitPerspective perspective, Map<String, ? extends Object> params) voidsetDragOverPerspectivesEnabled(boolean dragOverPerspEnabled) voidsetGlobalDataLanguageIso(String globalDataLanguageIso) voidsetInitialSessionListeners(Collection<UISessionListener> listeners) voidsetJasperReportsRefresh(JasperReportsRefresh jasperReportsRefresh) voidsetLabelService(LabelService labelService) voidsetLocalizationService(LocalizationService localizationService) voidsetModelService(ModelService modelService) voidsetNewItemService(NewItemService newItemService) voidsetPushContainers(List<PushCreationContainer> pushContainers) voidsetRequestHandler(RequestHandler reqHandler) voidsetSavedQueryService(SavedQueryService savedQueryService) voidsetSearchService(SearchService searchService) voidsetSelectedCatalogVersions(List<CatalogVersionModel> catalogVersions) voidsetSendEventsImmediately(boolean immediately) booleansetSessionAttribute(String key, Object value) voidsetSessionService(SessionService sessionService) voidsetSystemService(SystemService systemService) voidsetUiAccessRightService(UIAccessRightService accessRightService) voidsetUiConfigurationService(UIConfigurationService configurationService) voidsetUndoManager(UndoManager undoManager) voidChanges the current session user.voidsetUserByUID(String uid) Changes the current session user.voidsetUsingTestIDs(boolean value) Deprecated.since 6.3, this property should be set in 'local.properties'.voidsetValueHandlerRegistry(ObjectValueHandlerRegistry objectValueRegistry) protected void
-
Constructor Details
-
UISessionImpl
public UISessionImpl()
-
-
Method Details
-
getSelectedCatalogVersions
- Specified by:
getSelectedCatalogVersionsin interfaceUISession
-
setSelectedCatalogVersions
- Specified by:
setSelectedCatalogVersionsin interfaceUISession
-
getAvailablePerspectives
Description copied from interface:UISessionReturns all available perspectives.- Specified by:
getAvailablePerspectivesin interfaceUISession
-
setAvailablePerspectives
-
setSendEventsImmediately
public void setSendEventsImmediately(boolean immediately) -
updateRestrictedPerspectives
protected void updateRestrictedPerspectives() -
registerPerspectiveContainer
public void registerPerspectiveContainer(org.zkoss.zk.ui.Component comp) -
getCurrentPerspective
Description copied from interface:UISessionReturns the current product cockpit perspective bean.- Specified by:
getCurrentPerspectivein interfaceUISession
-
setCurrentPerspective
Description copied from interface:UISessionChanges the current product perspective bean. Accepts one out ofUISession.getAvailablePerspectives(). TriggersUISessionListener.perspectiveChanged(UICockpitPerspective, UICockpitPerspective).- Specified by:
setCurrentPerspectivein interfaceUISession- Parameters:
perspective- the new perspective bean
-
setCurrentPerspective
public void setCurrentPerspective(UICockpitPerspective perspective, Map<String, ? extends Object> params) - Specified by:
setCurrentPerspectivein interfaceUISession
-
firePerspectiveChanged
-
getListeners
-
setInitialSessionListeners
-
addSessionListener
Description copied from interface:UISessionAdds a session listener.- Specified by:
addSessionListenerin interfaceUISession- Parameters:
listener- the new listener
-
removeSessionListener
Description copied from interface:UISessionRemoves session listener.- Specified by:
removeSessionListenerin interfaceUISession- Parameters:
listener- the listener to remove
-
clearSessionListeners
public void clearSessionListeners() -
fireAfterLogin
protected void fireAfterLogin() -
fireBeforeLogout
protected void fireBeforeLogout() -
fireDataLanguageChanged
protected void fireDataLanguageChanged() -
getLanguageIso
Description copied from interface:UISessionReturns the isocode of the current session language. UseUISession.getLocale()instead, if you want the locale before creating your own locale object- Specified by:
getLanguageIsoin interfaceUISession- Returns:
- current language iso code.
-
getSupportedLanguageIsoCodes
-
getUser
Description copied from interface:UISessionReturns the current ui session user. -
setUser
Description copied from interface:UISessionChanges the current session user. -
setUserByUID
Description copied from interface:UISessionChanges the current session user. This method accepts a user id and fetches the user object automatically.- Specified by:
setUserByUIDin interfaceUISession
-
login
Description copied from interface:UISessionAssigns specified user to this session. -
logout
public void logout() -
getSystemService
- Specified by:
getSystemServicein interfaceUISession
-
setSystemService
-
setNewItemService
-
getNewItemService
- Specified by:
getNewItemServicein interfaceUISession
-
setCockpitTypeService
- Parameters:
cockpitTypeService- the cockpitTypeService to set
-
setValueHandlerRegistry
-
setLabelService
-
getLabelService
- Specified by:
getLabelServicein interfaceUISession
-
setSessionService
-
getValueHandlerRegistry
- Specified by:
getValueHandlerRegistryin interfaceUISession
-
setGlobalDataLanguageIso
- Specified by:
setGlobalDataLanguageIsoin interfaceUISession
-
getGlobalDataLanguageIso
Description copied from interface:UISessionReturns the isocode of the current data language. UseUISession.getGlobalDataLocale()instead, if you want the locale before creating your own locale object- Specified by:
getGlobalDataLanguageIsoin interfaceUISession- Returns:
- current data language iso code.
-
getSearchService
- Specified by:
getSearchServicein interfaceUISession
-
setSearchService
-
getSavedQueryService
- Specified by:
getSavedQueryServicein interfaceUISession
-
setSavedQueryService
-
getUndoManager
- Specified by:
getUndoManagerin interfaceUISession
-
setUndoManager
-
sendGlobalEvent
Description copied from interface:UISessionProcesses given event. It will be dispatched to the current perspective.- Specified by:
sendGlobalEventin interfaceUISession- Parameters:
event- the event to be processedimmediate- force to send event immediately (not "on later")
-
sendGlobalEvent
Description copied from interface:UISessionProcesses given event. It will be dispatched to the current perspective.- Specified by:
sendGlobalEventin interfaceUISession- Parameters:
event- the event to be processed
-
initSession
public void initSession() -
registerAdditionalPerspectives
public void registerAdditionalPerspectives()registers additional perspectives -
createIdGenerator
protected org.zkoss.zk.ui.sys.IdGenerator createIdGenerator() -
isUsingTestIDs
public boolean isUsingTestIDs()- Specified by:
isUsingTestIDsin interfaceUISession
-
setUsingTestIDs
Deprecated.since 6.3, this property should be set in 'local.properties'. -
getPerspective
- Specified by:
getPerspectivein interfaceUISession- Throws:
IllegalArgumentException
-
setModelService
-
getModelService
- Specified by:
getModelServicein interfaceUISession
-
isPerspectiveAvailable
- Specified by:
isPerspectiveAvailablein interfaceUISession
-
getRequestHandler
- Specified by:
getRequestHandlerin interfaceUISession
-
setRequestHandler
- Specified by:
setRequestHandlerin interfaceUISession
-
getPushContainers
- Specified by:
getPushContainersin interfaceUISession
-
setPushContainers
- Specified by:
setPushContainersin interfaceUISession
-
setDragOverPerspectivesEnabled
public void setDragOverPerspectivesEnabled(boolean dragOverPerspEnabled) -
isDragOverPerspectivesEnabled
public boolean isDragOverPerspectivesEnabled()- Specified by:
isDragOverPerspectivesEnabledin interfaceUISession
-
setCachePerspectivesEnabled
public void setCachePerspectivesEnabled(boolean cachePerspectivesEnabled) -
isCachePerspectivesEnabled
public boolean isCachePerspectivesEnabled()- Specified by:
isCachePerspectivesEnabledin interfaceUISession
-
setUiConfigurationService
-
getUiConfigurationService
- Specified by:
getUiConfigurationServicein interfaceUISession
-
setUiAccessRightService
-
getUiAccessRightService
- Specified by:
getUiAccessRightServicein interfaceUISession
-
setSessionAttribute
- Specified by:
setSessionAttributein interfaceUISession
-
getGlobalDataLocale
- Specified by:
getGlobalDataLocalein interfaceUISession- Returns:
- the locale for the currently selected data language
-
getLocale
-
setCommonI18NService
-
setLocalizationService
-
getLocalizationService
-
setJasperReportsRefresh
-
getJasperReportsRefresh
Description copied from interface:UISessionReturns service, which handles all page refresh requirements. Currently used for Jasper reports only- Specified by:
getJasperReportsRefreshin interfaceUISession
-
getTypeService
- Specified by:
getTypeServicein interfaceUISession
-
setApplicationContext
public void setApplicationContext(org.springframework.context.ApplicationContext appCtx) throws org.springframework.beans.BeansException - Specified by:
setApplicationContextin interfaceorg.springframework.context.ApplicationContextAware- Throws:
org.springframework.beans.BeansException
-