Index (magnolia-ui-api 5.4.8-m2 API)

A B C D E F G H I K L M N O P R S T U V

A

AbstractAction<D extends ActionDefinition> - Class in info.magnolia.ui.api.action: Abstract Action base class holding a reference to its ActionDefinition.
AbstractAction(D) - Constructor for class info.magnolia.ui.api.action.AbstractAction
AbstractActionExecutor - Class in info.magnolia.ui.api.action: Abstract base implementation of ActionExecutor.
AbstractActionExecutor(ComponentProvider) - Constructor for class info.magnolia.ui.api.action.AbstractActionExecutor
AbstractAppKeyGenerator<T> - Class in info.magnolia.ui.api.i18n: AbstractI18nKeyGenerator for apps and their parts.
AbstractAppKeyGenerator() - Constructor for class info.magnolia.ui.api.i18n.AbstractAppKeyGenerator
AbstractAvailabilityRule - Class in info.magnolia.ui.api.availability: Abstract rule class.
AbstractAvailabilityRule() - Constructor for class info.magnolia.ui.api.availability.AbstractAvailabilityRule
Action - Interface in info.magnolia.ui.api.action: An action is executed in response to user interaction with the UI.
action(String) - Method in class info.magnolia.ui.api.action.config.ActionConfig
ActionBuilder - Class in info.magnolia.ui.api.action.config: Builder for building an action definition.
ActionBuilder(String) - Constructor for class info.magnolia.ui.api.action.config.ActionBuilder
ActionConfig - Class in info.magnolia.ui.api.action.config: Config object creating builders for action definitions.
ActionConfig() - Constructor for class info.magnolia.ui.api.action.config.ActionConfig
ActionDefinition - Interface in info.magnolia.ui.api.action: Action definitions are used to configure actions in many parts of the UI.
ActionDefinitionKeyGenerator - Class in info.magnolia.ui.api.action: An I18n key generator for the actionbar actions (labels, descriptions, errors, etc.).
ActionDefinitionKeyGenerator() - Constructor for class info.magnolia.ui.api.action.ActionDefinitionKeyGenerator
ActionExecutionException - Exception in info.magnolia.ui.api.action: Exception thrown when an Action encounters an error during execution.
ActionExecutionException() - Constructor for exception info.magnolia.ui.api.action.ActionExecutionException
ActionExecutionException(String) - Constructor for exception info.magnolia.ui.api.action.ActionExecutionException
ActionExecutionException(Throwable) - Constructor for exception info.magnolia.ui.api.action.ActionExecutionException
ActionExecutionException(String, Throwable) - Constructor for exception info.magnolia.ui.api.action.ActionExecutionException
ActionExecutor - Interface in info.magnolia.ui.api.action: Responsible for executing actions, doing lookups of action definitions based on action names and evaluating if an action is available.
addApp(AppLauncherGroupEntry) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
addApp(AppLauncherGroupEntryDefinition) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
addFragmentChangedHandler(FragmentChangedHandler) - Method in interface info.magnolia.ui.api.shell.Shell
addGroup(AppLauncherGroup) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayout
addGroup(AppLauncherGroupDefinition) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherLayoutDefinition
addNodeType(String) - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
addProperty(String, Object) - Method in class info.magnolia.ui.api.message.Message
addSubApp(SubAppDescriptor) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
addSubAppView(View, String, boolean) - Method in interface info.magnolia.ui.api.app.AppView
AdmincentralEventBus - Interface in info.magnolia.ui.api.event: Defines the name of the Admincentral event bus.
AlertCallback - Interface in info.magnolia.ui.api.overlay: Callback interface for alert.
App - Interface in info.magnolia.ui.api.app: Main interface for apps.
APP - Static variable in class info.magnolia.ui.api.i18n.AbstractAppKeyGenerator
AppContext - Interface in info.magnolia.ui.api.app: Provides functionality used by an app to interact with the Magnolia shell.
AppController - Interface in info.magnolia.ui.api.app: Controls all Apps running for a single user.
AppDescriptor - Interface in info.magnolia.ui.api.app: Describes an app.
AppDescriptorKeyGenerator - Class in info.magnolia.ui.api.app: Key generator for AppDescriptor.
AppDescriptorKeyGenerator() - Constructor for class info.magnolia.ui.api.app.AppDescriptorKeyGenerator
AppDescriptorProvider - Interface in info.magnolia.ui.api.app.registry: Deprecated.
since 5.4 use DefinitionProvider and configuration sources.
AppDescriptorRegistry - Class in info.magnolia.ui.api.app.registry: The central registry for AppDescriptors.
AppDescriptorRegistry(EventBus, ModuleRegistry) - Constructor for class info.magnolia.ui.api.app.registry.AppDescriptorRegistry
AppDescriptorRegistry(EventBus) - Constructor for class info.magnolia.ui.api.app.registry.AppDescriptorRegistry: Deprecated.
since 5.4.6 - use AppDescriptorRegistry.AppDescriptorRegistry(EventBus, ModuleRegistry)
AppEventBus - Interface in info.magnolia.ui.api.app: Defines the name of the app event bus.
AppInstanceController - Interface in info.magnolia.ui.api.app: Controller for an instance of an App.
APPLAUNCHER_PREFIX - Static variable in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupDefinitionKeyGenerator
AppLauncherGroup - Class in info.magnolia.ui.api.app.launcherlayout: Defines a group of apps displayed in the app launcher including display properties of the group.
AppLauncherGroup() - Constructor for class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
AppLauncherGroupDefinition - Interface in info.magnolia.ui.api.app.launcherlayout: Defines a a group in the layout of apps in the app launcher.
AppLauncherGroupDefinitionKeyGenerator - Class in info.magnolia.ui.api.app.launcherlayout: Key generator for AppLauncherGroupDefinition.
AppLauncherGroupDefinitionKeyGenerator() - Constructor for class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupDefinitionKeyGenerator
AppLauncherGroupEntry - Class in info.magnolia.ui.api.app.launcherlayout: Entry of an app group describing an app to be part of that group.
AppLauncherGroupEntry() - Constructor for class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
AppLauncherGroupEntryDefinition - Interface in info.magnolia.ui.api.app.launcherlayout: Defines the appearance of an app in the app launcher.
AppLauncherLayout - Class in info.magnolia.ui.api.app.launcherlayout: Describes the layout in the app launcher.
AppLauncherLayout() - Constructor for class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayout
AppLauncherLayoutChangedEvent - Class in info.magnolia.ui.api.app.launcherlayout: Event dispatched when the launcher layout changes.
AppLauncherLayoutChangedEvent() - Constructor for class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutChangedEvent
AppLauncherLayoutChangedEventHandler - Interface in info.magnolia.ui.api.app.launcherlayout: Event handler for receiving events when the launcher layout changes.
AppLauncherLayoutDefinition - Interface in info.magnolia.ui.api.app.launcherlayout: Defines the layout of apps in the app launcher.
AppLauncherLayoutManager - Interface in info.magnolia.ui.api.app.launcherlayout: Manages the launcher layout displayed in the app launcher.
AppLauncherLayoutManagerImpl - Class in info.magnolia.ui.api.app.launcherlayout: Default AppLauncherLayoutManager implementation.
AppLauncherLayoutManagerImpl(AppDescriptorRegistry, EventBus, Provider<I18nizer>) - Constructor for class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManagerImpl
AppLifecycleEvent - Class in info.magnolia.ui.api.app: Event fired when the lifecycle of an app changes.
AppLifecycleEvent(AppDescriptor, AppLifecycleEventType) - Constructor for class info.magnolia.ui.api.app.AppLifecycleEvent
AppLifecycleEventHandler - Interface in info.magnolia.ui.api.app: Event handler interface for listening to AppLifecycleEvent.
AppLifecycleEventHandler.Adapter - Class in info.magnolia.ui.api.app: Simple stub so in case not all the methods need to be implemented.
AppLifecycleEventHandler.Adapter() - Constructor for class info.magnolia.ui.api.app.AppLifecycleEventHandler.Adapter
AppLifecycleEventType - Enum in info.magnolia.ui.api.app: Enumeration of events fired to signal changes to an apps lifecycle.
AppRegistryEvent - Class in info.magnolia.ui.api.app.registry: Event fired by AppDescriptorRegistry when changes are made to the apps it manages.
AppRegistryEvent(DefinitionMetadata, AppRegistryEventType) - Constructor for class info.magnolia.ui.api.app.registry.AppRegistryEvent
AppRegistryEventHandler - Interface in info.magnolia.ui.api.app.registry: Event handler interface for listening to AppRegistryEvent.
AppRegistryEventType - Enum in info.magnolia.ui.api.app.registry: Enumeration of events fired by AppDescriptorRegistry.
AppView - Interface in info.magnolia.ui.api.app: AppView interface used for displaying apps and adding and removing the subApp views.
AppView.Listener - Interface in info.magnolia.ui.api.app: Listens to events coming from the TabSheet.
askForConfirmation(String, ConfirmationHandler) - Method in interface info.magnolia.ui.api.shell.Shell
asVaadinComponent() - Method in interface info.magnolia.ui.api.view.View: Returns the Vaadin component managed by this view.
AvailabilityChecker - Interface in info.magnolia.ui.api.availability: Checks whether a set of data units complies to the criteria defined in an AvailabilityDefinition.
AvailabilityDefinition - Interface in info.magnolia.ui.api.availability: Definition of restrictions on when subject is available.
AvailabilityRule - Interface in info.magnolia.ui.api.availability: Defines the rule for additional availability restrictions.
AvailabilityRuleDefinition - Interface in info.magnolia.ui.api.availability: Defines an instance of an AvailabilityRule.

B

baseClass() - Method in enum info.magnolia.ui.api.app.registry.DefinitionTypes
broadcastMessage(Message) - Method in interface info.magnolia.ui.api.app.AppContext

C

ChooseDialogCallback - Interface in info.magnolia.ui.api.app: Called on choose dialog completion.
ChooseDialogEventBus - Interface in info.magnolia.ui.api.event: Defines the name of the choose dialog event bus.
clone() - Method in class info.magnolia.ui.api.message.Message
close() - Method in interface info.magnolia.ui.api.app.SubAppContext
close() - Method in interface info.magnolia.ui.api.overlay.OverlayCloser
closeSubApp(String) - Method in interface info.magnolia.ui.api.app.AppContext
closeSubAppView(String) - Method in interface info.magnolia.ui.api.app.AppView
CommandActionDefinition - Class in info.magnolia.ui.api.action: A basic action definition useful for actions that delegates to commands.
CommandActionDefinition() - Constructor for class info.magnolia.ui.api.action.CommandActionDefinition
ConfiguredActionDefinition - Class in info.magnolia.ui.api.action: Simple implementation of ActionDefinition.
ConfiguredActionDefinition() - Constructor for class info.magnolia.ui.api.action.ConfiguredActionDefinition
ConfiguredAppDescriptor - Class in info.magnolia.ui.api.app.registry: Simple implementation of AppDescriptor.
ConfiguredAppDescriptor() - Constructor for class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
ConfiguredAppDescriptorManager - Class in info.magnolia.ui.api.app.registry: Deprecated.
since 5.4, replaced by RegistryBasedObservingManager, within JcrConfigurationSource
ConfiguredAppDescriptorManager() - Constructor for class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorManager: Deprecated.
ConfiguredAppDescriptorProvider - Class in info.magnolia.ui.api.app.registry: Deprecated.
since 5.4 use DefinitionProvider and configuration sources.
ConfiguredAppDescriptorProvider(Node) - Constructor for class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorProvider: Deprecated.
ConfiguredAppLauncherGroupDefinition - Class in info.magnolia.ui.api.app.launcherlayout: Default implementation of AppLauncherGroupDefinition.
ConfiguredAppLauncherGroupDefinition() - Constructor for class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
ConfiguredAppLauncherGroupEntryDefinition - Class in info.magnolia.ui.api.app.launcherlayout: Default implementation of AppLauncherGroupEntryDefinition used for configuration in the repository.
ConfiguredAppLauncherGroupEntryDefinition() - Constructor for class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupEntryDefinition
ConfiguredAppLauncherLayoutDefinition - Class in info.magnolia.ui.api.app.launcherlayout: Default implementation of AppLauncherLayoutDefinition used for configuration in the repository.
ConfiguredAppLauncherLayoutDefinition() - Constructor for class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherLayoutDefinition
ConfiguredAvailabilityDefinition - Class in info.magnolia.ui.api.availability: Simple implementation for AvailabilityDefinition.
ConfiguredAvailabilityDefinition() - Constructor for class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
ConfiguredAvailabilityRuleDefinition - Class in info.magnolia.ui.api.availability: Default implementation of AvailabilityRuleDefinition.
ConfiguredAvailabilityRuleDefinition() - Constructor for class info.magnolia.ui.api.availability.ConfiguredAvailabilityRuleDefinition
ConfiguredSubAppDescriptor - Class in info.magnolia.ui.api.app.registry: Simple implementation for SubAppDescriptor.
ConfiguredSubAppDescriptor() - Constructor for class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
ConfirmationCallback - Interface in info.magnolia.ui.api.overlay: Callback interface for confirmations.
ConfirmationHandler - Interface in info.magnolia.ui.api.shell: Called after the user has answered a confirmation dialog issued by Shell.askForConfirmation(String, ConfirmationHandler).
containsApp(String) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayout
ContentChangedEvent - Class in info.magnolia.ui.api.event: Event fired when content is changed in a workspace.
ContentChangedEvent(Object) - Constructor for class info.magnolia.ui.api.event.ContentChangedEvent
ContentChangedEvent(Object, boolean) - Constructor for class info.magnolia.ui.api.event.ContentChangedEvent
ContentChangedEvent.Handler - Interface in info.magnolia.ui.api.event: Handles ContentChangedEvent events.
createAction(String, Object...) - Method in class info.magnolia.ui.api.action.AbstractActionExecutor: Creates an action using the implementation configured for the given action definition.
createI18NURI(Node, Locale) - Method in interface info.magnolia.ui.api.i18n.I18NAuthoringSupport

D

decodeFragment(String, String) - Static method in class info.magnolia.ui.api.location.DefaultLocation: Decodes application/x-www-form-urlencoded fragment string using a specified encoding scheme if necessary.
decodeFragment(String) - Static method in class info.magnolia.ui.api.location.DefaultLocation: Decodes a fragment using the character encoding from the AggregationState.
DefaultLocation - Class in info.magnolia.ui.api.location: Default location implementation.
DefaultLocation() - Constructor for class info.magnolia.ui.api.location.DefaultLocation
DefaultLocation(String, String) - Constructor for class info.magnolia.ui.api.location.DefaultLocation
DefaultLocation(String, String, String) - Constructor for class info.magnolia.ui.api.location.DefaultLocation
DefaultLocation(String, String, String, String) - Constructor for class info.magnolia.ui.api.location.DefaultLocation
DefaultLocation(String) - Constructor for class info.magnolia.ui.api.location.DefaultLocation
definition() - Method in class info.magnolia.ui.api.action.config.ActionBuilder
DefinitionTypes - Enum in info.magnolia.ui.api.app.registry: DefinitionType types used in UI API module.
deriveLocalisedPropertyName(String, Locale) - Method in interface info.magnolia.ui.api.i18n.I18NAuthoringSupport
description(String) - Method in class info.magnolia.ui.api.action.config.ActionBuilder
dispatch(AppLifecycleEventHandler) - Method in class info.magnolia.ui.api.app.AppLifecycleEvent
dispatch(AppLauncherLayoutChangedEventHandler) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutChangedEvent
dispatch(AppRegistryEventHandler) - Method in class info.magnolia.ui.api.app.registry.AppRegistryEvent
dispatch(SubAppLifecycleEventHandler) - Method in class info.magnolia.ui.api.app.SubAppLifecycleEvent
dispatch(ContentChangedEvent.Handler) - Method in class info.magnolia.ui.api.event.ContentChangedEvent
dispatch(LocationChangedEvent.Handler) - Method in class info.magnolia.ui.api.location.LocationChangedEvent
dispatch(LocationChangeRequestedEvent.Handler) - Method in class info.magnolia.ui.api.location.LocationChangeRequestedEvent
dispatch(FragmentChangedHandler) - Method in class info.magnolia.ui.api.shell.FragmentChangedEvent

E

enterFullScreenMode() - Method in interface info.magnolia.ui.api.shell.Shell
equals(Object) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorProvider: Deprecated.
equals(Object) - Method in class info.magnolia.ui.api.location.DefaultLocation
execute(String, Object...) - Method in class info.magnolia.ui.api.action.AbstractActionExecutor
execute() - Method in interface info.magnolia.ui.api.action.Action: Executes the action.
execute(String, Object...) - Method in interface info.magnolia.ui.api.action.ActionExecutor: Creates a new instance of the action for the supplied name and executes it.
exitFullScreenMode() - Method in interface info.magnolia.ui.api.shell.Shell
extractAppName(String) - Static method in class info.magnolia.ui.api.location.DefaultLocation
extractAppType(String) - Static method in class info.magnolia.ui.api.location.DefaultLocation
extractParameter(String) - Static method in class info.magnolia.ui.api.location.DefaultLocation
extractSubAppId(String) - Static method in class info.magnolia.ui.api.location.DefaultLocation

F

focusCurrentApp() - Method in interface info.magnolia.ui.api.app.AppController
FragmentChangedEvent - Class in info.magnolia.ui.api.shell: Fired when a URI fragment has changed.
FragmentChangedEvent(String) - Constructor for class info.magnolia.ui.api.shell.FragmentChangedEvent
FragmentChangedHandler - Interface in info.magnolia.ui.api.shell: Called when a URI fragment of Shell has changed.

G

getAccess() - Method in interface info.magnolia.ui.api.availability.AvailabilityDefinition: Returns the AccessDefinition object for this subject.
getAccess() - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
getActionDefinition(String) - Method in interface info.magnolia.ui.api.action.ActionExecutor: Performs a lookup for an action definition by name.
getActions() - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
getActions() - Method in interface info.magnolia.ui.api.app.SubAppDescriptor
getActiveSubAppContext() - Method in interface info.magnolia.ui.api.app.AppContext
getActiveSubAppView() - Method in interface info.magnolia.ui.api.app.AppView
getApp() - Method in interface info.magnolia.ui.api.app.AppInstanceController
getAppClass() - Method in interface info.magnolia.ui.api.app.AppDescriptor
getAppClass() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
getAppContext() - Method in interface info.magnolia.ui.api.app.SubAppContext
getAppDescriptor() - Method in interface info.magnolia.ui.api.app.AppContext
getAppDescriptor() - Method in class info.magnolia.ui.api.app.AppLifecycleEvent
getAppDescriptor() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
getAppDescriptor(String) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayout
getAppDescriptor() - Method in interface info.magnolia.ui.api.app.registry.AppDescriptorProvider: Deprecated.
getAppDescriptor(String) - Method in class info.magnolia.ui.api.app.registry.AppDescriptorRegistry: Deprecated.
since 5.4 - use AbstractRegistry.getProvider(String) method instead.
getAppDescriptor() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorProvider: Deprecated.
getAppDescriptorMetadata() - Method in class info.magnolia.ui.api.app.registry.AppRegistryEvent
getAppGroupEntry(String) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayout
getAppLocation(String) - Method in interface info.magnolia.ui.api.app.AppController
getAppName() - Method in class info.magnolia.ui.api.location.DefaultLocation
getAppName() - Method in interface info.magnolia.ui.api.location.Location
getApps() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
getApps() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupDefinition
getApps() - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
getAppType() - Method in class info.magnolia.ui.api.location.DefaultLocation
getAppType() - Method in interface info.magnolia.ui.api.location.Location
getAuthoringLocale() - Method in interface info.magnolia.ui.api.app.SubAppContext
getAuthorLocale() - Method in interface info.magnolia.ui.api.i18n.I18NAuthoringSupport: Deprecated.
I18nAuthoringSupport is an instance singleton, and should not be used to sync UI state of a specific user. Since 5.3.9, use SubAppContext#getAuthoringLocale().
getAvailability() - Method in interface info.magnolia.ui.api.action.ActionDefinition
getAvailability() - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
getAvailableLocales(Item) - Method in interface info.magnolia.ui.api.i18n.I18NAuthoringSupport
getAvailableLocales(Node) - Method in interface info.magnolia.ui.api.i18n.I18NAuthoringSupport
getBasePropertyName() - Method in interface info.magnolia.ui.api.i18n.I18NAwareHandler: Returns the property base name that the I18NAuthoringSupport should use.
getCaption() - Method in interface info.magnolia.ui.api.app.SubApp
getCatalog() - Method in class info.magnolia.ui.api.action.CommandActionDefinition
getColor() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
getColor() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupDefinition
getColor() - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
getCommand() - Method in class info.magnolia.ui.api.action.CommandActionDefinition
getCssClass() - Method in interface info.magnolia.ui.api.overlay.MessageStyleType
getCssClass() - Method in enum info.magnolia.ui.api.overlay.OverlayLayer.ModalityDomain
getCssClass() - Method in enum info.magnolia.ui.api.overlay.OverlayLayer.ModalityLevel
getCurrentApp() - Method in interface info.magnolia.ui.api.app.AppController
getCurrentAppLocation() - Method in interface info.magnolia.ui.api.app.AppController
getCurrentLocation() - Method in interface info.magnolia.ui.api.app.AppInstanceController
getDefaultLocale(Item) - Method in interface info.magnolia.ui.api.i18n.I18NAuthoringSupport
getDefaultLocale(Node) - Method in interface info.magnolia.ui.api.i18n.I18NAuthoringSupport
getDefaultLocation() - Method in interface info.magnolia.ui.api.app.AppInstanceController
getDefaultSubAppDescriptor() - Method in interface info.magnolia.ui.api.app.AppContext
getDefinition() - Method in class info.magnolia.ui.api.action.AbstractAction
getDelay() - Method in class info.magnolia.ui.api.action.CommandActionDefinition: Defines the delay (in seconds) after which the command should start, if asynchronous.
getDescription() - Method in interface info.magnolia.ui.api.action.ActionDefinition
getDescription() - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
getErrorMessage() - Method in interface info.magnolia.ui.api.action.ActionDefinition
getErrorMessage() - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
getEventType() - Method in class info.magnolia.ui.api.app.AppLifecycleEvent
getEventType() - Method in class info.magnolia.ui.api.app.registry.AppRegistryEvent
getFailureMessage() - Method in interface info.magnolia.ui.api.action.ActionDefinition
getFailureMessage() - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
getFragment(Location) - Method in interface info.magnolia.ui.api.location.LocationHistoryMapper: Returns the text representation of the location or null if the location isn't handled.
getFragment() - Method in class info.magnolia.ui.api.shell.FragmentChangedEvent
getFragment() - Method in interface info.magnolia.ui.api.shell.Shell
getGroup(String) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayout
getGroups() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayout
getGroups() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutDefinition
getGroups() - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherLayoutDefinition
getI18nBasename() - Method in interface info.magnolia.ui.api.action.ActionDefinition
getI18nBasename() - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
getI18nBasename() - Method in interface info.magnolia.ui.api.app.AppDescriptor
getI18nBasename() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
getIcon() - Method in interface info.magnolia.ui.api.action.ActionDefinition
getIcon() - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
getIcon() - Method in interface info.magnolia.ui.api.app.AppDescriptor
getIcon() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
getIcon() - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
getIcon() - Method in interface info.magnolia.ui.api.app.SubAppDescriptor
getIconCharacter() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
getIconClass() - Method in interface info.magnolia.ui.api.overlay.MessageStyleType
getIconFont() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
getId() - Method in class info.magnolia.ui.api.message.Message
getImplementationClass() - Method in interface info.magnolia.ui.api.action.ActionDefinition
getImplementationClass() - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
getImplementationClass() - Method in interface info.magnolia.ui.api.availability.AvailabilityRuleDefinition
getImplementationClass() - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityRuleDefinition
getInstanceId() - Method in interface info.magnolia.ui.api.app.SubAppContext
getItemId() - Method in class info.magnolia.ui.api.event.ContentChangedEvent
getLabel() - Method in interface info.magnolia.ui.api.action.ActionDefinition
getLabel() - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
getLabel() - Method in interface info.magnolia.ui.api.app.AppContext
getLabel() - Method in interface info.magnolia.ui.api.app.AppDescriptor
getLabel() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
getLabel() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupDefinition
getLabel() - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
getLabel() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
getLabel() - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
getLabel() - Method in interface info.magnolia.ui.api.app.SubAppDescriptor
getLayoutForCurrentUser() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManager: Deprecated.
since 5.4. Please use AppLauncherLayoutManager.getLayoutForUser(User) instead.
getLayoutForCurrentUser() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManagerImpl: Deprecated.
getLayoutForUser(User) - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManager: Returns the AppLauncherLayout for the specified user.
getLayoutForUser(User) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManagerImpl
getLocale() - Method in interface info.magnolia.ui.api.i18n.I18NAwareHandler
getLocation() - Method in interface info.magnolia.ui.api.app.SubAppContext
getLocation(String) - Method in interface info.magnolia.ui.api.location.LocationHistoryMapper: Returns the location represented by the fragment or null if the fragment is invalid or does not match a supported location.
getMessage() - Method in class info.magnolia.ui.api.message.Message
getName() - Method in interface info.magnolia.ui.api.action.ActionDefinition
getName() - Method in class info.magnolia.ui.api.action.config.ActionBuilder
getName() - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
getName() - Method in interface info.magnolia.ui.api.app.AppContext
getName() - Method in interface info.magnolia.ui.api.app.AppDescriptor
getName() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
getName() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupDefinition
getName() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
getName() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntryDefinition
getName() - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
getName() - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupEntryDefinition
getName() - Method in interface info.magnolia.ui.api.app.registry.AppDescriptorProvider: Deprecated.
getName() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
getName() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorProvider: Deprecated.
getName() - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
getName() - Method in interface info.magnolia.ui.api.app.SubAppDescriptor
getName() - Method in enum info.magnolia.ui.api.overlay.OverlayLayer.ModalityLevel
getNewLocation() - Method in class info.magnolia.ui.api.location.LocationChangedEvent
getNewLocation() - Method in class info.magnolia.ui.api.location.LocationChangeRequestedEvent: Returns the location we may navigate to, or null on window close.
getNodeTypes() - Method in interface info.magnolia.ui.api.availability.AvailabilityDefinition: Unless this is empty the subject is available only for these node types.
getNodeTypes() - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
getParameter() - Method in class info.magnolia.ui.api.location.DefaultLocation
getParameter() - Method in interface info.magnolia.ui.api.location.Location
getParams() - Method in class info.magnolia.ui.api.action.CommandActionDefinition
getPermissions() - Method in interface info.magnolia.ui.api.app.AppDescriptor
getPermissions() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupDefinition
getPermissions() - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
getPermissions() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
getPropertNames() - Method in class info.magnolia.ui.api.message.Message
getProperty(String) - Method in class info.magnolia.ui.api.message.Message
getRules() - Method in interface info.magnolia.ui.api.availability.AvailabilityDefinition: Returns the collection of availability rule definitions for this subject.
getRules() - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
getSender() - Method in class info.magnolia.ui.api.message.Message
getSubApp() - Method in interface info.magnolia.ui.api.app.SubAppContext
getSubAppClass() - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
getSubAppClass() - Method in interface info.magnolia.ui.api.app.SubAppDescriptor
getSubAppDescriptor() - Method in interface info.magnolia.ui.api.app.SubAppContext
getSubAppDescriptor() - Method in class info.magnolia.ui.api.app.SubAppLifecycleEvent
getSubAppId() - Method in interface info.magnolia.ui.api.app.SubApp
getSubAppId() - Method in interface info.magnolia.ui.api.app.SubAppContext
getSubAppId() - Method in class info.magnolia.ui.api.location.DefaultLocation
getSubAppId() - Method in interface info.magnolia.ui.api.location.Location
getSubApps() - Method in interface info.magnolia.ui.api.app.AppDescriptor
getSubApps() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
getSubAppViewContainer(String) - Method in interface info.magnolia.ui.api.app.AppView: Get the view of the container of a SubApp.
getSubject() - Method in class info.magnolia.ui.api.message.Message
getSuccessMessage() - Method in interface info.magnolia.ui.api.action.ActionDefinition
getSuccessMessage() - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
getTheme() - Method in interface info.magnolia.ui.api.app.AppDescriptor
getTheme() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
getTimestamp() - Method in class info.magnolia.ui.api.message.Message
getTimeToWait() - Method in class info.magnolia.ui.api.action.CommandActionDefinition: Defines how long (in milliseconds) the UI should remain blocked until notifying user that the action will complete in the background, if asynchronous.
getType() - Method in class info.magnolia.ui.api.message.Message
getView() - Method in interface info.magnolia.ui.api.app.App
getView() - Method in interface info.magnolia.ui.api.app.AppContext
getView() - Method in interface info.magnolia.ui.api.app.SubApp
getView() - Method in class info.magnolia.ui.api.message.Message
getWarning() - Method in class info.magnolia.ui.api.location.LocationChangeRequestedEvent: Returns the warning message to show the user before allowing the location change, or null if none has been set.
getWhere() - Method in class info.magnolia.ui.api.location.LocationController: Returns the current location.
goTo(Location) - Method in class info.magnolia.ui.api.location.LocationController: Request a change to a new location.
goToWithoutChecks(Location) - Method in class info.magnolia.ui.api.location.LocationController

H

handleCurrentFragment() - Method in class info.magnolia.ui.api.location.LocationHistoryHandler: Handle the current history fragment.
hashCode() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorProvider: Deprecated.
hashCode() - Method in class info.magnolia.ui.api.location.DefaultLocation
hasProperty(String) - Method in class info.magnolia.ui.api.message.Message

I

i18n(String) - Method in class info.magnolia.ui.api.action.config.ActionBuilder
I18NAuthoringSupport - Interface in info.magnolia.ui.api.i18n: Allows authors to create components with locale-dependent controls.
I18NAwareHandler - Interface in info.magnolia.ui.api.i18n: Interface for locale-dependent property.
i18nize(HasComponents, Locale) - Method in interface info.magnolia.ui.api.i18n.I18NAuthoringSupport: Deprecated.
since 5.4.2 without a substitute - the i18n-ready components should now take of switching the language on their own.
icon(String) - Method in class info.magnolia.ui.api.action.config.ActionBuilder
implementation(Class<? extends Action>) - Method in class info.magnolia.ui.api.action.config.ActionBuilder
info.magnolia.ui.api.action - package info.magnolia.ui.api.action
info.magnolia.ui.api.action.config - package info.magnolia.ui.api.action.config
info.magnolia.ui.api.app - package info.magnolia.ui.api.app
info.magnolia.ui.api.app.launcherlayout - package info.magnolia.ui.api.app.launcherlayout
info.magnolia.ui.api.app.registry - package info.magnolia.ui.api.app.registry
info.magnolia.ui.api.availability - package info.magnolia.ui.api.availability
info.magnolia.ui.api.context - package info.magnolia.ui.api.context
info.magnolia.ui.api.event - package info.magnolia.ui.api.event
info.magnolia.ui.api.i18n - package info.magnolia.ui.api.i18n
info.magnolia.ui.api.location - package info.magnolia.ui.api.location
info.magnolia.ui.api.message - package info.magnolia.ui.api.message
info.magnolia.ui.api.overlay - package info.magnolia.ui.api.overlay
info.magnolia.ui.api.shell - package info.magnolia.ui.api.shell
info.magnolia.ui.api.view - package info.magnolia.ui.api.view
isAppDescriptorRegistered(String) - Method in class info.magnolia.ui.api.app.registry.AppDescriptorRegistry: Deprecated.
since 5.4 - use AbstractRegistry.getProvider(String) method instead.
isAppStarted(String) - Method in interface info.magnolia.ui.api.app.AppController
isAsynchronous() - Method in class info.magnolia.ui.api.action.CommandActionDefinition: Defines whether this action should try to run asynchronously, e.g.
isAvailable(Collection<?>) - Method in class info.magnolia.ui.api.availability.AbstractAvailabilityRule
isAvailable(AvailabilityDefinition, List<Object>) - Method in interface info.magnolia.ui.api.availability.AvailabilityChecker
isAvailable(Collection<?>) - Method in interface info.magnolia.ui.api.availability.AvailabilityRule: Returns true if the availability subject (e.g.
isAvailableForItem(Object) - Method in class info.magnolia.ui.api.availability.AbstractAvailabilityRule: This method defines the actual evaluation logic for one item.
isCleared() - Method in class info.magnolia.ui.api.message.Message
isClientGroup() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
isClientGroup() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupDefinition
isClientGroup() - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
isClosable() - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
isClosable() - Method in interface info.magnolia.ui.api.app.SubAppDescriptor
isCloseable() - Method in interface info.magnolia.ui.api.app.SubApp
isDefaultLocale(Locale, Item) - Method in interface info.magnolia.ui.api.i18n.I18NAuthoringSupport
isEnabled() - Method in interface info.magnolia.ui.api.app.AppDescriptor
isEnabled() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
isEnabled() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntryDefinition
isEnabled() - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupEntryDefinition
isEnabled() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
isItemContentChanged() - Method in class info.magnolia.ui.api.event.ContentChangedEvent
isMultiple() - Method in interface info.magnolia.ui.api.availability.AvailabilityDefinition: If true, the subject is available for multiple item selection.
isMultiple() - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
isNodes() - Method in interface info.magnolia.ui.api.availability.AvailabilityDefinition: If true the subject is available for nodes.
isNodes() - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
isNotifyUser() - Method in class info.magnolia.ui.api.action.CommandActionDefinition: Defines whether the action should notify the user in the Pulse, if asynchronous and if it completes in the background.
isParallel() - Method in class info.magnolia.ui.api.action.CommandActionDefinition: Defines whether the command may be executed in parallel for multiple items, if asynchronous.
isPermanent() - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
isPermanent() - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupDefinition
isPermanent() - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
isProperties() - Method in interface info.magnolia.ui.api.availability.AvailabilityDefinition: If true the subject is available for properties.
isProperties() - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
isRoot() - Method in interface info.magnolia.ui.api.availability.AvailabilityDefinition: If true the subject is available when there's no selection.
isRoot() - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
isWritePermissionRequired() - Method in interface info.magnolia.ui.api.availability.AvailabilityDefinition: If true the subject is only available if write permission is granted for the item on which availability is evaluated.
isWritePermissionRequired() - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition

K

keysFor(List<String>, ActionDefinition, AnnotatedElement) - Method in class info.magnolia.ui.api.action.ActionDefinitionKeyGenerator: Will generate keys for the message bundle in the following form <app-name>.<sub-app-name>.actions.<action-name>[.name of getter or field annotated with I18nText].
keysFor(List<String>, AppDescriptor, AnnotatedElement) - Method in class info.magnolia.ui.api.app.AppDescriptorKeyGenerator
keysFor(List<String>, AppLauncherGroupDefinition, AnnotatedElement) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupDefinitionKeyGenerator
keysFor(List<String>, SubAppDescriptor, AnnotatedElement) - Method in class info.magnolia.ui.api.app.SubAppDescriptorKeyGenerator

L

label(String) - Method in class info.magnolia.ui.api.action.config.ActionBuilder
Location - Interface in info.magnolia.ui.api.location: Represents a location within the application, such as the open view and the selected item.
LOCATION_TYPE_APP - Static variable in interface info.magnolia.ui.api.location.Location
LOCATION_TYPE_SHELL_APP - Static variable in interface info.magnolia.ui.api.location.Location
locationChanged(Location) - Method in interface info.magnolia.ui.api.app.App: Called when the location changes and the app is already running.
locationChanged(Location) - Method in interface info.magnolia.ui.api.app.SubApp
LocationChangedEvent - Class in info.magnolia.ui.api.location: Event fired when a location change occurs.
LocationChangedEvent(Location) - Constructor for class info.magnolia.ui.api.location.LocationChangedEvent
LocationChangedEvent.Handler - Interface in info.magnolia.ui.api.location: Handler interface for LocationChangedEvent.
LocationChangeRequestedEvent - Class in info.magnolia.ui.api.location: Event fired when a location change is about to happen usually in response to user interaction.
LocationChangeRequestedEvent(Location) - Constructor for class info.magnolia.ui.api.location.LocationChangeRequestedEvent
LocationChangeRequestedEvent.Handler - Interface in info.magnolia.ui.api.location: Handler interface for LocationChangeRequestedEvent.
LocationController - Class in info.magnolia.ui.api.location: Manages the user's location in the application and controls location changes.
LocationController(EventBus, Shell) - Constructor for class info.magnolia.ui.api.location.LocationController
LocationHistoryHandler - Class in info.magnolia.ui.api.location: Monitors the browser history for location changes and calls the LocationController to initiate location changes accordingly, also listens for location change events on the EventBus and updates the browser history to match.
LocationHistoryHandler(LocationHistoryMapper, Shell) - Constructor for class info.magnolia.ui.api.location.LocationHistoryHandler
LocationHistoryMapper - Interface in info.magnolia.ui.api.location: Maps Locations to/from fragments, used to configure a LocationHistoryHandler.
log - Variable in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorProvider: Deprecated.

M

mayStop() - Method in interface info.magnolia.ui.api.app.AppInstanceController
Message - Class in info.magnolia.ui.api.message: Models a message.
Message() - Constructor for class info.magnolia.ui.api.message.Message
Message(long) - Constructor for class info.magnolia.ui.api.message.Message
Message(MessageType, String, String) - Constructor for class info.magnolia.ui.api.message.Message
MESSAGE_VIEW - Static variable in class info.magnolia.ui.api.message.Message
MessageStyleType - Interface in info.magnolia.ui.api.overlay: Provides access to the css class and icon classname for a message.
MessageType - Enum in info.magnolia.ui.api.message: The type of message.

N

NAME - Static variable in interface info.magnolia.ui.api.app.AppEventBus
NAME - Static variable in interface info.magnolia.ui.api.app.SubAppEventBus
NAME - Static variable in interface info.magnolia.ui.api.event.AdmincentralEventBus
NAME - Static variable in interface info.magnolia.ui.api.event.ChooseDialogEventBus
newMetadataBuilder() - Method in class info.magnolia.ui.api.app.registry.AppDescriptorRegistry
NotificationCallback - Interface in info.magnolia.ui.api.overlay: Callback interface for when a user clicks on the link in a notification.
NOWHERE - Static variable in interface info.magnolia.ui.api.location.Location

O

onAppFocused(AppLifecycleEvent) - Method in class info.magnolia.ui.api.app.AppLifecycleEventHandler.Adapter
onAppFocused(AppLifecycleEvent) - Method in interface info.magnolia.ui.api.app.AppLifecycleEventHandler
onAppLayoutChanged(AppLauncherLayoutChangedEvent) - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutChangedEventHandler
onAppRegistered(AppRegistryEvent) - Method in interface info.magnolia.ui.api.app.registry.AppRegistryEventHandler
onAppReregistered(AppRegistryEvent) - Method in interface info.magnolia.ui.api.app.registry.AppRegistryEventHandler
onAppStarted(AppLifecycleEvent) - Method in class info.magnolia.ui.api.app.AppLifecycleEventHandler.Adapter
onAppStarted(AppLifecycleEvent) - Method in interface info.magnolia.ui.api.app.AppLifecycleEventHandler
onAppStopped(AppLifecycleEvent) - Method in class info.magnolia.ui.api.app.AppLifecycleEventHandler.Adapter
onAppStopped(AppLifecycleEvent) - Method in interface info.magnolia.ui.api.app.AppLifecycleEventHandler
onAppUnregistered(AppRegistryEvent) - Method in interface info.magnolia.ui.api.app.registry.AppRegistryEventHandler
onCancel() - Method in interface info.magnolia.ui.api.app.ChooseDialogCallback
onCancel() - Method in interface info.magnolia.ui.api.overlay.ConfirmationCallback
onCancel() - Method in interface info.magnolia.ui.api.shell.ConfirmationHandler
onClose(String) - Method in interface info.magnolia.ui.api.app.AppView.Listener
onConfirm() - Method in interface info.magnolia.ui.api.shell.ConfirmationHandler
onContentChanged(ContentChangedEvent) - Method in interface info.magnolia.ui.api.event.ContentChangedEvent.Handler
onFocus(String) - Method in interface info.magnolia.ui.api.app.AppView.Listener
onFragmentChanged(FragmentChangedEvent) - Method in interface info.magnolia.ui.api.shell.FragmentChangedHandler
onItemChosen(String, Object) - Method in interface info.magnolia.ui.api.app.ChooseDialogCallback
onLinkClicked() - Method in interface info.magnolia.ui.api.overlay.NotificationCallback
onLocationChanged(LocationChangedEvent) - Method in interface info.magnolia.ui.api.location.LocationChangedEvent.Handler
onLocationChangeRequested(LocationChangeRequestedEvent) - Method in interface info.magnolia.ui.api.location.LocationChangeRequestedEvent.Handler
onLocationUpdate(Location) - Method in interface info.magnolia.ui.api.app.AppInstanceController
onOk() - Method in interface info.magnolia.ui.api.overlay.AlertCallback
onSubAppBlurred(SubAppLifecycleEvent) - Method in class info.magnolia.ui.api.app.SubAppLifecycleEventHandler.Adapter
onSubAppBlurred(SubAppLifecycleEvent) - Method in interface info.magnolia.ui.api.app.SubAppLifecycleEventHandler
onSubAppFocused(SubAppLifecycleEvent) - Method in class info.magnolia.ui.api.app.SubAppLifecycleEventHandler.Adapter
onSubAppFocused(SubAppLifecycleEvent) - Method in interface info.magnolia.ui.api.app.SubAppLifecycleEventHandler
onSubAppStarted(SubAppLifecycleEvent) - Method in class info.magnolia.ui.api.app.SubAppLifecycleEventHandler.Adapter
onSubAppStarted(SubAppLifecycleEvent) - Method in interface info.magnolia.ui.api.app.SubAppLifecycleEventHandler
onSubAppStopped(SubAppLifecycleEvent) - Method in class info.magnolia.ui.api.app.SubAppLifecycleEventHandler.Adapter
onSubAppStopped(SubAppLifecycleEvent) - Method in interface info.magnolia.ui.api.app.SubAppLifecycleEventHandler
onSuccess() - Method in interface info.magnolia.ui.api.overlay.ConfirmationCallback
openAlert(MessageStyleType, View, String, AlertCallback) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Deprecated.
since 5.3, you should probably pass the dialog title via OverlayLayer.openAlert(MessageStyleType, String, View, String, AlertCallback).
openAlert(MessageStyleType, String, String, String, AlertCallback) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Opens an alert dialog of given type, with given title and body.
openAlert(MessageStyleType, String, View, String, AlertCallback) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Opens an alert dialog of given type, with given title and body.
openChooseDialog(UiContext, String, ChooseDialogCallback) - Method in interface info.magnolia.ui.api.app.App: Open a dialog which enables a user to choose an item from the app.
openChooseDialog(UiContext, String, String, ChooseDialogCallback) - Method in interface info.magnolia.ui.api.app.App
openChooseDialog(String, UiContext, String, ChooseDialogCallback) - Method in interface info.magnolia.ui.api.app.AppController
openChooseDialog(String, UiContext, String, String, ChooseDialogCallback) - Method in interface info.magnolia.ui.api.app.AppController
openConfirmation(MessageStyleType, View, String, String, boolean, ConfirmationCallback) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Deprecated.
since 5.3, you should probably pass the dialog title via OverlayLayer.openConfirmation(MessageStyleType, String, View, String, String, boolean, ConfirmationCallback).
openConfirmation(MessageStyleType, String, String, String, String, boolean, ConfirmationCallback) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Opens a confirmation dialog of given type, with given title and body.
openConfirmation(MessageStyleType, String, View, String, String, boolean, ConfirmationCallback) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Opens a confirmation dialog of given type, with given title and body.
openNotification(MessageStyleType, boolean, View) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Notification indicator is a message banner that only shows a message to user.
openNotification(MessageStyleType, boolean, String) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Notification indicator is a message banner that only shows a message to user.
openNotification(MessageStyleType, boolean, String, String, NotificationCallback) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Notification indicator is a message banner that only shows a message to user.
openOverlay(View) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Open an Overlay on top of the OverlayLayer implementer.
openOverlay(View, OverlayLayer.ModalityLevel) - Method in interface info.magnolia.ui.api.overlay.OverlayLayer: Open an Overlay on top of the OverlayLayer implementer.
openOverlayOnView(View, View, OverlayLayer.ModalityDomain, OverlayLayer.ModalityLevel) - Method in interface info.magnolia.ui.api.shell.Shell: Open an Overlay on top of a specific View.
openSubApp(Location) - Method in interface info.magnolia.ui.api.app.AppContext
OverlayCloser - Interface in info.magnolia.ui.api.overlay: Callback for closing an overlay.
OverlayLayer - Interface in info.magnolia.ui.api.overlay: Implementers can open overlay views (with a degree of modality) over their display area.
OverlayLayer.ModalityDomain - Enum in info.magnolia.ui.api.overlay: The available locations of modality for opening a modal.
OverlayLayer.ModalityLevel - Enum in info.magnolia.ui.api.overlay: The available levels of modality.

P

pushToClient() - Method in interface info.magnolia.ui.api.shell.Shell

R

register(DefinitionProvider<AppDescriptor>) - Method in class info.magnolia.ui.api.app.registry.AppDescriptorRegistry
register(LocationController, EventBus, Location) - Method in class info.magnolia.ui.api.location.LocationHistoryHandler: Initialize this location history handler.
registerApps(List<String>) - Method in interface info.magnolia.ui.api.shell.Shell

S

sendGroupMessage(String, Message) - Method in interface info.magnolia.ui.api.app.AppContext
sendLocalMessage(Message) - Method in interface info.magnolia.ui.api.app.AppContext
sendUserMessage(String, Message) - Method in interface info.magnolia.ui.api.app.AppContext
setAccess(AccessDefinition) - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
setActions(Map<String, ActionDefinition>) - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
setActiveSubAppView(String) - Method in interface info.magnolia.ui.api.app.AppView
setApp(App) - Method in interface info.magnolia.ui.api.app.AppInstanceController
setAppClass(Class<? extends App>) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
setAppComponentProvider(ComponentProvider) - Method in interface info.magnolia.ui.api.app.AppInstanceController
setAppContext(AppContext) - Method in interface info.magnolia.ui.api.app.SubAppContext
setAppDescriptor(AppDescriptor) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
setAppLogo(String, String) - Method in interface info.magnolia.ui.api.app.AppView
setAppName(String) - Method in interface info.magnolia.ui.api.app.AppView
setAppName(String) - Method in class info.magnolia.ui.api.location.DefaultLocation
setApps(List<AppLauncherGroupEntry>) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
setApps(List<AppLauncherGroupEntryDefinition>) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
setAppType(String) - Method in class info.magnolia.ui.api.location.DefaultLocation
setAsynchronous(boolean) - Method in class info.magnolia.ui.api.action.CommandActionDefinition
setAuthoringLocale(Locale) - Method in interface info.magnolia.ui.api.app.SubAppContext
setAvailability(AvailabilityDefinition) - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
setCatalog(String) - Method in class info.magnolia.ui.api.action.CommandActionDefinition
setCleared(boolean) - Method in class info.magnolia.ui.api.message.Message
setClientGroup(boolean) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
setClientGroup(boolean) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
setClosable(boolean) - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
setCloseTimeout(int) - Method in interface info.magnolia.ui.api.overlay.OverlayCloser
setColor(String) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
setColor(String) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
setCommand(String) - Method in class info.magnolia.ui.api.action.CommandActionDefinition
setDelay(int) - Method in class info.magnolia.ui.api.action.CommandActionDefinition
setDescription(String) - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
setEnabled(boolean) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
setEnabled(boolean) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupEntryDefinition
setEnabled(boolean) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
setErrorMessage(String) - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
setFailureMessage(String) - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
setFragment(String) - Method in interface info.magnolia.ui.api.shell.Shell
setGroups(List<AppLauncherGroup>) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayout
setGroups(List<AppLauncherGroupDefinition>) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherLayoutDefinition
setI18nBasename(String) - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
setI18nBasename(String) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
setI18NPropertyName(String) - Method in interface info.magnolia.ui.api.i18n.I18NAwareHandler: Deprecated.
since 5.4.2 without concrete replacement - should not be needed any longer.
setIcon(String) - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
setIcon(String) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
setIcon(String) - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
setIconCharacter(String) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
setIconFont(String) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
setId(String) - Method in class info.magnolia.ui.api.message.Message
setImplementationClass(Class<? extends Action>) - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
setImplementationClass(Class<? extends AvailabilityRule>) - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityRuleDefinition
setInstanceId(String) - Method in interface info.magnolia.ui.api.app.SubAppContext
setLabel(String) - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
setLabel(String) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
setLabel(String) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
setLabel(String) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
setLabel(String) - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
setLayout(AppLauncherLayoutDefinition) - Method in interface info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManager: Called to update the launcher layout when it has been changed in the repository.
setLayout(AppLauncherLayoutDefinition) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManagerImpl
setListener(AppView.Listener) - Method in interface info.magnolia.ui.api.app.AppView
setLocale(Locale) - Method in interface info.magnolia.ui.api.i18n.I18NAwareHandler
setLocation(Location) - Method in interface info.magnolia.ui.api.app.SubAppContext
setMessage(String) - Method in class info.magnolia.ui.api.message.Message
setMultiple(boolean) - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
setName(String) - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
setName(String) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
setName(String) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroupEntry
setName(String) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
setName(String) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupEntryDefinition
setName(String) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
setName(String) - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
setNodes(boolean) - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
setNodeTypes(Collection<String>) - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
setNotifyUser(boolean) - Method in class info.magnolia.ui.api.action.CommandActionDefinition
setParallel(boolean) - Method in class info.magnolia.ui.api.action.CommandActionDefinition
setParameter(String) - Method in class info.magnolia.ui.api.location.DefaultLocation
setParams(Map<String, Object>) - Method in class info.magnolia.ui.api.action.CommandActionDefinition
setPermanent(boolean) - Method in class info.magnolia.ui.api.app.launcherlayout.AppLauncherGroup
setPermanent(boolean) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
setPermissions(AccessDefinition) - Method in class info.magnolia.ui.api.app.launcherlayout.ConfiguredAppLauncherGroupDefinition
setPermissions(AccessDefinition) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
setProperties(boolean) - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
setRoot(boolean) - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
setRules(Collection<? extends AvailabilityRuleDefinition>) - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
setSender(String) - Method in class info.magnolia.ui.api.message.Message
setSubApp(SubApp) - Method in interface info.magnolia.ui.api.app.SubAppContext
setSubAppClass(Class<? extends SubApp>) - Method in class info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
setSubAppId(String) - Method in class info.magnolia.ui.api.location.DefaultLocation
setSubApps(Map<String, SubAppDescriptor>) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
setSubject(String) - Method in class info.magnolia.ui.api.message.Message
setSuccessMessage(String) - Method in class info.magnolia.ui.api.action.ConfiguredActionDefinition
setTheme(String) - Method in interface info.magnolia.ui.api.app.AppView
setTheme(String) - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
setTimeToWait(int) - Method in class info.magnolia.ui.api.action.CommandActionDefinition
setType(MessageType) - Method in class info.magnolia.ui.api.message.Message
setUserMenu(View) - Method in interface info.magnolia.ui.api.shell.Shell
setView(String) - Method in class info.magnolia.ui.api.message.Message
setView(View) - Method in interface info.magnolia.ui.api.view.Viewport: Sets the view to display replacing a previous view if there is one.
setViewport(Viewport) - Method in interface info.magnolia.ui.api.app.AppController
setWarning(String) - Method in class info.magnolia.ui.api.location.LocationChangeRequestedEvent: Set a message to warn the user that it might be unwise to navigate away from the current location, i.e.
setWritePermissionRequired(boolean) - Method in class info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition
Shell - Interface in info.magnolia.ui.api.shell: Decouples the presenters and the Vaadin application.
showConfirmationMessage(String) - Method in interface info.magnolia.ui.api.app.AppContext
showError(String, Exception) - Method in interface info.magnolia.ui.api.shell.Shell
showNotification(String) - Method in interface info.magnolia.ui.api.shell.Shell
start(Location) - Method in interface info.magnolia.ui.api.app.App: Called when the app is started.
start(Location) - Method in interface info.magnolia.ui.api.app.AppInstanceController
start() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorManager: Deprecated.
start(Location) - Method in interface info.magnolia.ui.api.app.SubApp
stop() - Method in interface info.magnolia.ui.api.app.App: Called when the user stops the app.
stop() - Method in interface info.magnolia.ui.api.app.AppInstanceController
stop() - Method in interface info.magnolia.ui.api.app.SubApp
stopApp(String) - Method in interface info.magnolia.ui.api.app.AppController
stopCurrentApp() - Method in interface info.magnolia.ui.api.app.AppController
SubApp - Interface in info.magnolia.ui.api.app: Sub apps represents a view open in a tab within an app.
SubAppContext - Interface in info.magnolia.ui.api.app: Provides functionality used by a sub app to interact with the Magnolia shell.
SubAppDescriptor - Interface in info.magnolia.ui.api.app: Describes a sub app.
SubAppDescriptorKeyGenerator - Class in info.magnolia.ui.api.app: Key generator for SubAppDescriptor.
SubAppDescriptorKeyGenerator() - Constructor for class info.magnolia.ui.api.app.SubAppDescriptorKeyGenerator
SubAppEventBus - Interface in info.magnolia.ui.api.app: Defines the name of the sub app event bus.
SubAppLifecycleEvent - Class in info.magnolia.ui.api.app: SubAppLifecycleEvent is fired on initiation, termination and activation/de-activation of a sub-app (the exact list of supported lifecycle phases is provided by SubAppLifecycleEvent.Type).
SubAppLifecycleEvent(SubAppDescriptor, SubAppLifecycleEvent.Type) - Constructor for class info.magnolia.ui.api.app.SubAppLifecycleEvent
SubAppLifecycleEvent.Type - Enum in info.magnolia.ui.api.app: List of supported sub-app lifecycle phases.
SubAppLifecycleEventHandler - Interface in info.magnolia.ui.api.app: Handles SubAppLifecycleEvent.
SubAppLifecycleEventHandler.Adapter - Class in info.magnolia.ui.api.app: Simple stub so that only required methods need to be implemented in an actual listener.
SubAppLifecycleEventHandler.Adapter() - Constructor for class info.magnolia.ui.api.app.SubAppLifecycleEventHandler.Adapter
supportsLocation(Location) - Method in interface info.magnolia.ui.api.app.SubApp

T

toString() - Method in class info.magnolia.ui.api.action.CommandActionDefinition
toString() - Method in class info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorProvider: Deprecated.
toString() - Method in class info.magnolia.ui.api.location.DefaultLocation
toString() - Method in enum info.magnolia.ui.api.message.MessageType
type() - Method in class info.magnolia.ui.api.app.registry.AppDescriptorRegistry

U

UiContext - Interface in info.magnolia.ui.api.context: Represents a UI context and allows components, views and presenters to interact with the context that contains them.
unregister(String) - Method in class info.magnolia.ui.api.app.registry.AppDescriptorRegistry
unregisterAndRegister(Collection<DefinitionMetadata>, Collection<DefinitionProvider<AppDescriptor>>) - Method in class info.magnolia.ui.api.app.registry.AppDescriptorRegistry
updateCaption(String, String) - Method in interface info.magnolia.ui.api.app.AppView
updateSubAppLocation(SubAppContext, Location) - Method in interface info.magnolia.ui.api.app.AppContext

V

valueOf(String) - Static method in enum info.magnolia.ui.api.app.AppLifecycleEventType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum info.magnolia.ui.api.app.registry.AppRegistryEventType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum info.magnolia.ui.api.app.registry.DefinitionTypes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum info.magnolia.ui.api.app.SubAppLifecycleEvent.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum info.magnolia.ui.api.message.MessageType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum info.magnolia.ui.api.overlay.OverlayLayer.ModalityDomain: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum info.magnolia.ui.api.overlay.OverlayLayer.ModalityLevel: Returns the enum constant of this type with the specified name.
values() - Static method in enum info.magnolia.ui.api.app.AppLifecycleEventType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum info.magnolia.ui.api.app.registry.AppRegistryEventType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum info.magnolia.ui.api.app.registry.DefinitionTypes: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum info.magnolia.ui.api.app.SubAppLifecycleEvent.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum info.magnolia.ui.api.message.MessageType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum info.magnolia.ui.api.overlay.OverlayLayer.ModalityDomain: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum info.magnolia.ui.api.overlay.OverlayLayer.ModalityLevel: Returns an array containing the constants of this enum type, in the order they are declared.
View - Interface in info.magnolia.ui.api.view: Represents a region of the user interface.
Viewport - Interface in info.magnolia.ui.api.view: Implemented by displays that can be given a View to show.

A B C D E F G H I K L M N O P R S T U V