info.magnolia.ui.api.app.launcherlayout

Interface AppLauncherLayoutManager

All Known Implementing Classes:

AppLauncherLayoutManagerImpl

public interface AppLauncherLayoutManager

Manages the launcher layout displayed in the app launcher. Fires an AppLauncherLayoutChangedEvent on the system event bus when the layout changes.

See Also:

AppLauncherLayout, AppLauncherLayoutChangedEvent, AppLauncherLayoutChangedEventHandler

Method Summary

Modifier and Type	Method and Description
AppLauncherLayout	getLayoutForCurrentUser() Deprecated. since 5.4. Please use getLayoutForUser(User) instead.
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.

Method Detail

getLayoutForCurrentUser

@Deprecated
AppLauncherLayout getLayoutForCurrentUser()

Deprecated. since 5.4. Please use getLayoutForUser(User) instead.

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

getLayoutForUser

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

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.

Parameters:

user - user object

Returns:

app-launcher layout which corresponds to the provided user

setLayout

void setLayout(AppLauncherLayoutDefinition layout)

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