Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Interfaces

Interface and Description
info.magnolia.ui.api.app.registry.AppDescriptorProvider since 5.4 use DefinitionProvider and configuration sources.
info.magnolia.ui.dialog.registry.DialogDefinitionProvider since 5.4 use DefinitionProvider.
info.magnolia.ui.admincentral.shellapp.pulse.item.registry.ItemViewDefinitionProvider since 5.4 just use DefinitionProvider

Deprecated Classes

Class and Description
info.magnolia.ui.form.config.BasicTextCodeFieldBuilder Since 5.4, use CodeFieldBuilder.
info.magnolia.ui.form.field.definition.BasicTextCodeFieldDefinition Since 5.4, use CodeFieldDefinition.
info.magnolia.ui.form.field.factory.BasicTextCodeFieldFactory Since 5.4, use CodeFieldFactory.
info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorManager since 5.4, replaced by RegistryBasedObservingManager, within JcrConfigurationSource
info.magnolia.ui.api.app.registry.ConfiguredAppDescriptorProvider since 5.4 use DefinitionProvider and configuration sources.
info.magnolia.ui.dialog.registry.ConfiguredDialogDefinitionManager since 5.4, replaced by RegistryBasedObservingManager, within JcrConfigurationSource
info.magnolia.ui.dialog.registry.ConfiguredDialogDefinitionProvider since 5.4 use DefinitionProvider and configuration sources.
info.magnolia.ui.form.fieldtype.registry.ConfiguredFieldTypeDefinitionManager since 5.4, replaced by RegistryBasedObservingManager, within JcrConfigurationSource
info.magnolia.ui.mediaeditor.registry.ConfiguredMediaEditorDefinitionManager since 5.4, replaced by RegistryBasedObservingManager, within JcrConfigurationSource
info.magnolia.ui.admincentral.shellapp.pulse.message.registry.ConfiguredMessageViewDefinitionManager since 5.4, replaced by RegistryBasedObservingManager, within JcrConfigurationSource
info.magnolia.ui.admincentral.shellapp.pulse.message.registry.ConfiguredMessageViewDefinitionProvider since 5.4 use DefinitionProvider and configuration sources.
info.magnolia.ui.vaadin.gwt.client.layout.CssRule since 5.3.10, not needed anymore.
info.magnolia.ui.framework.action.DeactivationAction since 5.1 use ActivationAction directly.
info.magnolia.ui.framework.action.DeactivationActionDefinition since 5.1 use ActivationActionDefinition directly.
info.magnolia.ui.workbench.thumbnail.JcrThumbnailItemIdProvider since 5.3.10 should be avoided since it does not lazy load the items.
info.magnolia.ui.contentapp.detail.action.RestorePreviousVersionAction since 5.3.4, please use RestoreItemPreviousVersionAction instead.
info.magnolia.ui.contentapp.detail.action.RestorePreviousVersionActionDefinition since 5.3.4, please use RestoreItemPreviousVersionActionDefinition instead.
info.magnolia.ui.workbench.thumbnail.ThumbnailContainer since 5.3.10 in favor of info.magnolia.ui.workbench.thumbnail.data.DelegatingThumbnailContainer, this container should be avoided as it loads the items eagerly.

Deprecated Fields

Field and Description
info.magnolia.ui.form.field.AbstractCustomMultiField.i18nContentSupport since 5.3.5 (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
info.magnolia.ui.framework.action.AbstractVersionAction.nodeAdapter since 5.3.4 - define and inject AbstractJcrNodeAdapter in your subclass.

Deprecated Methods

Method and Description
info.magnolia.ui.admincentral.usermenu.UserMenuViewImpl.addAction(String, String)
info.magnolia.ui.admincentral.usermenu.UserMenuView.addAction(String, String) since 5.2.4 icons are supported in user menu so one should use UserMenuView.addAction(String, String, String).
info.magnolia.ui.form.field.definition.CompositeFieldDefinition.addFieldName(String)
info.magnolia.ui.vaadin.richtext.MagnoliaRichTextFieldConfig.addPlugin(String, String) Since 5.3.4, use MagnoliaRichTextFieldConfig.addExternalPlugin(String, String) and CKEditorConfig.addToExtraPlugins(String) separately. However, do not use CKEditorConfig.addToExtraPlugins(String) if you're using a custom CKEditor config.js file — otherwise you won't be able to override config.extraPlugins there.
info.magnolia.ui.form.config.FieldConfig.basicTextCode(String) Since 5.4, use FieldConfig.code(String) instead.
info.magnolia.ui.admincentral.shellapp.pulse.task.action.AbstractTaskAction.canExecuteTask(Task) since 5.4, use availability rules to check the allowed statuses.
info.magnolia.ui.admincentral.shellapp.pulse.item.detail.PulseItemCategoryNavigator.createSubRowNavigator(SimpleTranslator, PulseItemCategory...) since 5.4 use the plain constructor PulseItemCategoryNavigator.PulseItemCategoryNavigator(SimpleTranslator, boolean, boolean, PulseItemCategory...) instead.
info.magnolia.ui.admincentral.shellapp.pulse.item.detail.PulseItemCategoryNavigator.createTopRowNavigator(SimpleTranslator, PulseItemCategory...) since 5.4 use the plain constructor PulseItemCategoryNavigator.PulseItemCategoryNavigator(SimpleTranslator, boolean, boolean, PulseItemCategory...) instead.
info.magnolia.ui.vaadin.integration.jcr.DefaultPropertyUtil.createTypedValue(String, String) since 5.1. use DefaultPropertyUtil.createTypedValue(Class, String) instead.
info.magnolia.security.app.action.AbstractDeleteGroupOrRoleAction.executeAfterConfirmation() since 5.2.2 instead of use AbstractDeleteGroupOrRoleAction.onPreExecute()
info.magnolia.ui.form.fieldtype.registry.FieldTypeDefinitionRegistry.get(String) since 5.4 - use the AbstractRegistry.getProvider(String) method instead and fetch definition from its result.
info.magnolia.ui.mediaeditor.registry.MediaEditorRegistry.get(String) since 5.4 - use the AbstractRegistry.getProvider(String) method instead and fetch definition from the result.
info.magnolia.ui.api.app.registry.AppDescriptorRegistry.getAppDescriptor(String) since 5.4 - use AbstractRegistry.getProvider(String) method instead.
info.magnolia.ui.api.i18n.I18NAuthoringSupport.getAuthorLocale() 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().
info.magnolia.ui.framework.i18n.DefaultI18NAuthoringSupport.getAuthorLocale()
info.magnolia.ui.dialog.registry.DialogDefinitionRegistry.getDialogDefinition(String) since 5.4 use AbstractRegistry.getProvider(String)
info.magnolia.ui.form.field.definition.CompositeFieldDefinition.getFieldsName()
info.magnolia.security.app.action.DeleteFolderAction.getGroupsOrRoles(Group) since 5.3.6 - will be removed without replacement
info.magnolia.security.app.action.DeleteFolderAction.getGroupsOrRoles(User) since 5.3.6 - will be removed without replacement
info.magnolia.ui.form.AbstractFormItem.getI18nBasename() since 5.1. You should use I18nizer mechanism instead.
info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition.getI18nBasename() since 5.1. Use I18nizer mechanism instead.
info.magnolia.security.app.action.AbstractDeleteGroupOrRoleAction.getItem() since 5.2.2 instead of use AbstractMultiItemAction.getCurrentItem()
info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManagerImpl.getLayoutForCurrentUser()
info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManager.getLayoutForCurrentUser() since 5.4. Please use AppLauncherLayoutManager.getLayoutForUser(User) instead.
info.magnolia.ui.workbench.container.AbstractJcrContainer.getMainNodeType() since 5.1. All node types declared in the workbench definition are equal, meaning that their position doesn't matter when it comes to which ones are used in a query. The discriminating factor is the hideInList boolean property. If that property is true, then the node will be excluded from the query.
info.magnolia.ui.form.AbstractFormItem.getMessage(String) since 5.1. You should use I18nizer mechanism instead.
info.magnolia.ui.form.FormItem.getMessages()
info.magnolia.ui.form.AbstractFormItem.getMessages()
info.magnolia.ui.framework.message.MessagesManager.getMessagesForUser(String) since 5.3.9 - potentially dangerous since it returns the whole set of messages for the user which could be large. The MessagesManager.getMessageBatch(String, java.util.List, java.util.Map, int, int) should be used instead because it allows to set the limit and offset parameters.
info.magnolia.ui.contentapp.detail.action.AbstractItemActionDefinition.getNodeType() since 5.3 because the property has been used for availability purposes only and so should be defined in AvailabilityDefinition. The existing configuration entries are handled by migration tasks.
info.magnolia.ui.dialog.registry.DialogDefinitionProvider.getPresenterClass() since 5.4, get the DialogDefinition first, and get the presenter class from it.
info.magnolia.ui.dialog.registry.DialogDefinitionRegistry.getPresenterClass(String) since 5.4, get the DialogDefinition first, and get the presenter class from it.
info.magnolia.ui.vaadin.richtext.MagnoliaRichTextFieldConfig.getServerPlugins() Since 5.3.4, renamed to MagnoliaRichTextFieldConfig.getExternalPlugins().
info.magnolia.ui.api.app.registry.AppDescriptorRegistry.isAppDescriptorRegistered(String) since 5.4 - use AbstractRegistry.getProvider(String) method instead.
info.magnolia.ui.vaadin.integration.jcr.DefaultPropertyUtil.newDefaultProperty(int, Object) since 5.1. use DefaultPropertyUtil.newDefaultProperty(Class, String) instead.
info.magnolia.ui.vaadin.integration.jcr.DefaultPropertyUtil.newDefaultProperty(String, String) since 5.1. use DefaultPropertyUtil.newDefaultProperty(Class, String) instead.
info.magnolia.ui.workbench.WorkbenchView.Listener.onSearch(String) since 5.4 - the functionality provided by this method is now a responsibility of SearchContentToolPresenter.
info.magnolia.ui.vaadin.layout.LazyThumbnailLayout.ThumbnailSelectionListener.onThumbnailSelected(Object) since 5.3.9 - more generic LazyThumbnailLayout.ThumbnailSelectionListener.onThumbnailsSelected(java.util.Set) should be used.
info.magnolia.ui.api.overlay.OverlayLayer.openAlert(MessageStyleType, View, String, AlertCallback) since 5.3, you should probably pass the dialog title via OverlayLayer.openAlert(MessageStyleType, String, View, String, AlertCallback).
info.magnolia.ui.api.overlay.OverlayLayer.openConfirmation(MessageStyleType, View, String, String, boolean, ConfirmationCallback) since 5.3, you should probably pass the dialog title via OverlayLayer.openConfirmation(MessageStyleType, String, View, String, String, boolean, ConfirmationCallback).
info.magnolia.ui.dialog.registry.DialogDefinitionRegistry.register(DialogDefinitionProvider) since 5.4
info.magnolia.ui.framework.i18n.DefaultI18NAuthoringSupport.setAuthorLocale(Locale)
info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition.setI18nBasename(String) since 5.1. Use I18nizer mechanism instead.
info.magnolia.ui.form.field.factory.FieldFactory.setI18nContentSupport(I18nContentSupport) This is deprecated since 5.3.4; i18nContentSupport was never used within any FieldFactory, rightfully so. If any, I18NAuthoringSupport is the one that should be used.
info.magnolia.ui.form.field.factory.AbstractFieldFactory.setI18nContentSupport(I18nContentSupport) This is deprecated since 5.3.4; i18nContentSupport was never used within any FieldFactory, rightfully so. If any, I18NAuthoringSupport is the one that should be used.
info.magnolia.ui.contentapp.detail.action.AbstractItemActionDefinition.setNodeType(String) since 5.3 because the property has been used for availability purposes only and so should be defined in AvailabilityDefinition. The existing configuration entries are handled by migration tasks.
info.magnolia.ui.vaadin.form.Form.setShowAllEnabled(boolean) as of 5.1.1, please get the tabsheet through Form.getContent() and set the show all behavior there, along with its i18nized caption.
info.magnolia.ui.framework.app.AppControllerImpl.startIfNotAlreadyRunning(String, Location)

Deprecated Constructors

Constructor and Description
info.magnolia.ui.form.field.AbstractCustomMultiField(D, FieldFactoryFactory, I18nContentSupport, ComponentProvider, Item) since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
info.magnolia.security.app.action.AbstractDeleteGroupOrRoleAction(D, JcrItemAdapter, CommandsManager, EventBus, UiContext, SimpleTranslator) since 5.3.6 instead of use AbstractDeleteGroupOrRoleAction.AbstractDeleteGroupOrRoleAction(info.magnolia.ui.framework.action.DeleteActionDefinition, info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter, info.magnolia.commands.CommandsManager, info.magnolia.event.EventBus, info.magnolia.ui.api.context.UiContext, info.magnolia.i18nsystem.SimpleTranslator, info.magnolia.cms.security.SecuritySupport)
info.magnolia.security.app.action.AbstractDeleteGroupOrRoleAction(D, JcrItemAdapter, EventBus, UiContext, SimpleTranslator) since 5.2.2 instead of use AbstractDeleteGroupOrRoleAction.AbstractDeleteGroupOrRoleAction(info.magnolia.ui.framework.action.DeleteActionDefinition, info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter, info.magnolia.commands.CommandsManager, info.magnolia.event.EventBus, info.magnolia.ui.api.context.UiContext, info.magnolia.i18nsystem.SimpleTranslator, info.magnolia.cms.security.SecuritySupport)
info.magnolia.ui.framework.action.AbstractVersionAction(D, LocationController, UiContext, FormDialogPresenter, AbstractJcrNodeAdapter, SimpleTranslator) since 5.3.4 - use AbstractVersionAction(D, LocationController, UiContext, FormDialogPresenter, SimpleTranslator) instead.
info.magnolia.ui.vaadin.gwt.client.actionbar.widget.ActionbarItemWidget(ActionbarItem, VActionbarGroup, EventBus, Icon)
info.magnolia.ui.framework.app.AppInstanceControllerImpl(ModuleRegistry, AppController, LocationController, Shell, MessagesManager, AppDescriptor, AppLauncherLayoutManager, SystemMonitor, I18nizer, SimpleTranslator) since 5.4. Use AppInstanceControllerImpl.AppInstanceControllerImpl(ModuleRegistry, AppController, LocationController, Shell, MessagesManager, AppDescriptor, AppLauncherLayoutManager, SystemMonitor, I18nizer, SimpleTranslator, Context) instead.
info.magnolia.ui.admincentral.shellapp.applauncher.AppLauncherShellApp(Shell, AppLauncherView, AppController, AppLauncherLayoutManager, EventBus, EventBus) since 5.4 - use the c-tor which injects the Context instead.
info.magnolia.ui.form.field.definition.BasicTextCodeFieldDefinition()
info.magnolia.ui.form.field.factory.BasicTextCodeFieldFactory(D, Item)
info.magnolia.ui.form.field.CompositeField(CompositeFieldDefinition, FieldFactoryFactory, I18nContentSupport, ComponentProvider, Item) since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
info.magnolia.ui.form.field.factory.CompositeFieldFactory(D, Item, FieldFactoryFactory, I18nContentSupport, ComponentProvider) since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
info.magnolia.security.app.action.DeleteGroupAction(DeleteGroupActionDefinition, JcrItemAdapter, CommandsManager, EventBus, UiContext, SimpleTranslator) since 5.3.6 instead of use DeleteGroupAction.DeleteGroupAction(DeleteGroupActionDefinition, info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter, info.magnolia.commands.CommandsManager, info.magnolia.event.EventBus, info.magnolia.ui.api.context.UiContext, info.magnolia.i18nsystem.SimpleTranslator, info.magnolia.cms.security.SecuritySupport)
info.magnolia.security.app.action.DeleteGroupAction(DeleteGroupActionDefinition, JcrItemAdapter, EventBus, UiContext, SimpleTranslator) since 5.2.2 instead of use DeleteGroupAction.DeleteGroupAction(DeleteGroupActionDefinition, info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter, info.magnolia.commands.CommandsManager, info.magnolia.event.EventBus, info.magnolia.ui.api.context.UiContext, info.magnolia.i18nsystem.SimpleTranslator)
info.magnolia.security.app.action.DeleteRoleAction(DeleteRoleActionDefinition, JcrItemAdapter, CommandsManager, EventBus, UiContext, SimpleTranslator) since 5.3.6 instead of use DeleteRoleAction.DeleteRoleAction(DeleteRoleActionDefinition, info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter, info.magnolia.commands.CommandsManager, info.magnolia.event.EventBus, info.magnolia.ui.api.context.UiContext, info.magnolia.i18nsystem.SimpleTranslator, info.magnolia.cms.security.SecuritySupport)
info.magnolia.security.app.action.DeleteRoleAction(DeleteRoleActionDefinition, JcrItemAdapter, EventBus, UiContext, SimpleTranslator) since 5.2.2 instead of use DeleteRoleAction.DeleteRoleAction(DeleteRoleActionDefinition, info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter, info.magnolia.commands.CommandsManager, info.magnolia.event.EventBus, info.magnolia.ui.api.context.UiContext, info.magnolia.i18nsystem.SimpleTranslator)
info.magnolia.ui.framework.app.embedded.EmbeddedPageViewImpl(AppContext)
info.magnolia.ui.admincentral.shellapp.favorites.FavoritesForm(JcrNewNodeAdapter, JcrNewNodeAdapter, Map, FavoritesView.Listener, Shell, SimpleTranslator)
info.magnolia.ui.dialog.formdialog.FormBuilder(FieldFactoryFactory, I18NAuthoringSupport, ComponentProvider) since 5.3.9 - use FormBuilder.FormBuilder(FieldFactoryFactory, I18NAuthoringSupport, UiContext, ComponentProvider) instead.
info.magnolia.ui.dialog.formdialog.FormBuilder(FieldFactoryFactory, I18nContentSupport, I18NAuthoringSupport, ComponentProvider) since 5.3.4 - use FormBuilder.FormBuilder(FieldFactoryFactory, I18NAuthoringSupport, UiContext, ComponentProvider) instead.
info.magnolia.ui.dialog.formdialog.FormDialogPresenterImpl(DialogDefinitionRegistry, FormBuilder, ComponentProvider, DialogActionExecutor, FormView, I18nizer, SimpleTranslator) since version 5.3.1, use FormDialogPresenterImpl.FormDialogPresenterImpl(DialogDefinitionRegistry, FormBuilder, ComponentProvider, DialogActionExecutor, FormView, I18nizer, SimpleTranslator, AvailabilityChecker, ContentConnector) instead.
info.magnolia.ui.dialog.formdialog.ItemFormView(SimpleTranslator, I18NAuthoringSupport)
info.magnolia.ui.form.field.LinkField(LinkFieldDefinition, AppController, UiContext, ComponentProvider)
info.magnolia.ui.form.field.MultiField(MultiValueFieldDefinition, FieldFactoryFactory, I18nContentSupport, ComponentProvider, Item) since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
info.magnolia.ui.form.field.factory.MultiValueFieldFactory(MultiValueFieldDefinition, Item, FieldFactoryFactory, I18nContentSupport, ComponentProvider) since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
info.magnolia.ui.admincentral.shellapp.pulse.PulsePresenter(PulseDefinition, EventBus, PulseView, ShellImpl, ComponentProvider) since 5.4 - admincentralEventBus is not needed.
info.magnolia.ui.contentapp.browser.action.RestoreVersionAction(RestoreVersionActionDefinition, AppContext, LocationController, UiContext, FormDialogPresenter, AbstractJcrNodeAdapter, SimpleTranslator, VersionManager, EventBus) since 5.3.5 - use RestoreVersionAction.RestoreVersionAction(RestoreVersionActionDefinition, AppContext, LocationController, UiContext, FormDialogPresenter, AbstractJcrNodeAdapter, SimpleTranslator, VersionManager, EventBus, VersionConfig) instead.
info.magnolia.security.app.dialog.action.SaveRoleDialogAction(SaveDialogActionDefinition, Item, EditorValidator, EditorCallback) since 5.2.1 - use SaveRoleDialogAction.SaveRoleDialogAction(info.magnolia.ui.admincentral.dialog.action.SaveDialogActionDefinition, com.vaadin.data.Item, info.magnolia.ui.form.EditorValidator, info.magnolia.ui.form.EditorCallback, info.magnolia.cms.security.SecuritySupport) instead.
info.magnolia.ui.contentapp.browser.action.ShowVersionsAction(ShowVersionsActionDefinition, AppContext, LocationController, UiContext, FormDialogPresenter, AbstractJcrNodeAdapter, SimpleTranslator) since 5.3.5 - use ShowVersionsAction(D, AppContext, LocationController, UiContext, FormDialogPresenter, AbstractJcrNodeAdapter, SimpleTranslator) instead.
info.magnolia.ui.form.field.SwitchableField(SwitchableFieldDefinition, FieldFactoryFactory, I18nContentSupport, ComponentProvider, Item) since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
info.magnolia.ui.form.field.factory.SwitchableFieldFactory(SwitchableFieldDefinition, Item, FieldFactoryFactory, I18nContentSupport, ComponentProvider) since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
info.magnolia.ui.contentapp.field.WorkbenchFieldFactory(WorkbenchFieldDefinition, Item, WorkbenchPresenter, EventBus) since 5.3.4, replaced with WorkbenchFieldFactory.WorkbenchFieldFactory(WorkbenchFieldDefinition, Item, WorkbenchPresenter, ContentConnector, EventBus, EventBus). Constructor should not be called explicitly, but rather use IoC anyway.
info.magnolia.security.app.dialog.field.WorkspaceAccessFieldFactory(D, Item, UiContext, ChooseDialogPresenter, SimpleTranslator) since 5.3.1. ComponentProvider has to be injected in order to create the choose-dialog specific component provider, with proper bindings for e.g. ContentConnector or ImageProvider.