info.magnolia.ui.api.app.launcherlayout

Class AppLauncherLayoutManagerImpl

java.lang.Object

info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManagerImpl

All Implemented Interfaces:

AppLauncherLayoutManager

@Singleton
public class AppLauncherLayoutManagerImpl
extends Object
implements AppLauncherLayoutManager

Default AppLauncherLayoutManager implementation.

Constructor Summary

Constructors

Constructor and Description
AppLauncherLayoutManagerImpl(AppDescriptorRegistry appDescriptorRegistry, info.magnolia.event.EventBus systemEventBus, javax.inject.Provider<info.magnolia.i18nsystem.I18nizer> i18nizerProvider)

Method Summary

Methods

Modifier and Type	Method and Description
AppLauncherLayout	getLayoutForCurrentUser() Deprecated.
AppLauncherLayout	getLayoutForUser(info.magnolia.cms.security.User user) Returns the AppLauncherLayout for the specified user.
void	setLayout(AppLauncherLayoutDefinition layout) Called to update the launcher layout when it has been changed in the repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppLauncherLayoutManagerImpl

@Inject
public AppLauncherLayoutManagerImpl(AppDescriptorRegistry appDescriptorRegistry,
                                   @Named(value="system")
                                   info.magnolia.event.EventBus systemEventBus,
                                   javax.inject.Provider<info.magnolia.i18nsystem.I18nizer> i18nizerProvider)

Method Detail

getLayoutForCurrentUser

@Deprecated
public AppLauncherLayout getLayoutForCurrentUser()

Deprecated.

Description copied from interface: AppLauncherLayoutManager

The same functionality as AppLauncherLayoutManager.getLayoutForUser(info.magnolia.cms.security.User) provided for the user currently set in the Context.

Specified by:

getLayoutForCurrentUser in interface AppLauncherLayoutManager

getLayoutForUser

public AppLauncherLayout getLayoutForUser(info.magnolia.cms.security.User user)

Description copied from interface: AppLauncherLayoutManager

Returns the AppLauncherLayout for the specified user. The following principles apply:

• empty groups or groups where the current user doesn't have access to any of the apps are not returned;
• disabled apps, apps that the user does not have access to and apps that are not present in the AppDescriptorRegistry are not included;
• the returned object is also populated with AppDescriptor references for quick access.

Specified by:

getLayoutForUser in interface AppLauncherLayoutManager

Parameters:

user - user object

Returns:

app-launcher layout which corresponds to the provided user

setLayout

public void setLayout(AppLauncherLayoutDefinition layout)

Description copied from interface: AppLauncherLayoutManager

Called to update the launcher layout when it has been changed in the repository.

Specified by:

setLayout in interface AppLauncherLayoutManager