Deprecated API
Contents
- Terminally Deprecated
- Interfaces
- Classes
- Exception Classes
- Annotation Interfaces
- Fields
- Methods
- Constructors
- Enum Constants
- Annotation Interface Elements
-
Terminally Deprecated ElementsElementDescriptionUse
Avatar.setImageHandler(DownloadHandler)insteadBoard is deprecated and will be removed in Vaadin 26. Consider using Dashboard as an alternative.Board Row is deprecated and will be removed in Vaadin 26. Consider using Dashboard as an alternative.UseAxis.setExtremes(Instant, Instant)instead.UseAxis.setExtremes(Instant, Instant, boolean)instead.UseAxis.setExtremes(Instant, Instant, boolean, boolean)instead.UseStyle#setLineHeight(String)instead.usePlotOptionsOrganization.getLink().Link.setColor(Color)instead.usePlotOptionsOrganization.getLink().Link.setRadius(Number)instead.UsePlotOptionsTreemap.setAllowTraversingTree(Boolean)instead.UsePlotOptionsTreemap.setAllowTraversingTree(Boolean)instead.This property is deprecated and should not be used in new code. UseTime.setTimezone(String)instead.This property is deprecated and should not be used in new code. UseTime.setTimezone(String)instead.This property is deprecated and should not be used in new code. UseTime.setTimezone(String)instead.This property is deprecated and should not be used in new code. UseTime.setTimezone(String)instead.UseContextMenuElementinstead.UseContextMenuElement.getMenuItem(String)instead.UseContextMenuElement.getMenuItems()instead.Pre v25.0, this method returned either the editor overlay, when the editor was displayed as a dialog, or the Crud itself, when the editor was displayed inline. Since v25.0, the overlay is not accessible as a separate element anymore, and, regardless whether the editor is displayed as a dialog or inline, all editor-related controls can be queried through the Crud element itself. To specifically access the editor fields, useCrudElement.getForm()instead. To access the editor buttons, useCrudElement.getEditorSaveButton(),CrudElement.getEditorCancelButton(), andCrudElement.getEditorDeleteButton().UseDialog.getRole()insteaduseDialog.getModality()insteaduseDialog.setModality(ModalityMode)insteadUseDialog.setRole(String)insteadUseAbstractColumn.getFooterText()orAbstractColumn.getFooterComponent()directlyuseAnchor(DownloadHandler, String)insteaduseAnchor.setHref(DownloadHandler)insteaduseHtmlObject(DownloadHandler)insteaduseHtmlObject(DownloadHandler,Param...)insteaduseHtmlObject(DownloadHandler,String)insteaduseHtmlObject(DownloadHandler,String, Param...)insteaduseHtmlObject.setData(DownloadHandler)insteaduseIFrame.setSrc(DownloadHandler)insteaduseImage(DownloadHandler, String)insteaduseImage.setSrc(DownloadHandler)insteadUseSvgIcon(DownloadHandler)insteadUseSvgIcon(DownloadHandler, String)insteadUseSvgIcon.setSrc(DownloadHandler)insteadUseSvgIcon.setSrc(DownloadHandler, String)insteaduseMapBase.addClickListener(ComponentEventListener)insteadUseMapVariant.NO_BORDERinstead.useMenuBarButtonElement.openSubMenu()orMenuBarButtonElement.getSubMenu()retrieve the submenu for this button, and then useMenuBarSubMenuElement.getMenuItems()to retrieve the items.useMenuBarButtonElement.openSubMenu()orMenuBarItemElement.openSubMenu()to access submenus for specific buttons or itemsuseMenuBarButtonElement.openSubMenu()to open a submenuuseMenuBarButtonElement.openSubMenu()to open a submenu and then useMenuBarSubMenuElement.getMenuItems()to retrieve the items.useMenuBarButtonElement.openSubMenu()orMenuBarItemElement.openSubMenu()to open a submenu and then useMenuBarSubMenuElement.getMenuItems()to retrieve the items.useMenuBarItemElement.openSubMenu()orMenuBarItemElement.getSubMenu()retrieve the submenu for this item, and then useMenuBarSubMenuElement.getMenuItems()to retrieve the items.UsePopover.getRole()insteadUsePopover.setRole(String)insteadUseUploadHandlerinsteadUseUploadHandlerinsteadUseUploadHandlerinsteadUseFileFactoryinsteadUseUploadHandlerinsteadUseUploadHandlerinsteadUseUploadHandlerinsteaduseUpload(UploadHandler)insteaduseTransferProgressListenerwithUploadHandlerimplementing theTransferProgressAwareHandlerinterface.useTransferProgressListenerwithUploadHandlerimplementing theTransferProgressAwareHandlerinterface.useTransferProgressListenerwithUploadHandlerimplementing theTransferProgressAwareHandlerinterface.useTransferProgressListenerwithUploadHandlerimplementing theTransferProgressAwareHandlerinterface.com.vaadin.flow.component.upload.Upload.addSucceededListener(ComponentEventListener<SucceededEvent>) useTransferProgressListenerwithUploadHandlerimplementing theTransferProgressAwareHandlerinterface.useUpload.setUploadHandler(UploadHandler)insteadWebpack is not used anymore, this method is obsolete and have no replacements.used internally only for testing, to be removed without a replacement.useUploadHandlerinsteaduseDownloadHandlerinsteaduseUploadHandlerinsteadAntPathRequestMatcheris deprecated and marked for removal. This method is deprecated without direct replacement; usePathPatternRequestMatcherinstead.AntPathRequestMatcheris deprecated and marked for removal. This method is deprecated without direct replacement; usePathPatternRequestMatcherinstead.usehttp.with(new VaadinStatelessSecurityConfigurer(), customizer)instead.UseVaadinSecurityConfigurerinstead. It follows the Spring's SecurityConfigurer pattern and we recommend use it to configure Spring Security with Vaadin:
Read more details in Security Configurer documentation.@Configuration @EnableWebSecurity @Import(VaadinAwareSecurityContextHolderStrategyConfiguration.class) public class SecurityConfig { @Bean SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { return http.with(VaadinSecurityConfigurer.vaadin(), configurer -> {}).build(); } }AntPathRequestMatcher is deprecated and will be removed, useVaadinWebSecurity.pathMatchers(String...)instead.AntPathRequestMatcher is deprecated and will be removed, useVaadinWebSecurity.routePathMatchers(String...)instead.base url will not be translated to the theme url anymorebase url will not be translated to the theme url anymoreNo translation of the url will be done in 25use the standardizedNonNullinsteaduse the standardizedNullableinsteadtesters for commercial components have been moved to a separated class to avoid class loading issues when using only Vaadin free tier. Make the test class implementCommercialTestWrappersand useCommercialTestWrappers.test(Chart)instead.
-
Deprecated InterfacesInterfaceDescriptionPolymer template support is deprecated - we recommend you to use
LitTemplateinstead. Read more details from the Vaadin blog.Polymer template support is deprecated - we recommend you to useLitTemplateinstead. Read more details from the Vaadin blog.UseUploadHandlerinsteadUseFileFactoryinsteaduseUploadHandlerinstead
-
Deprecated ClassesClassDescriptionBoard is deprecated and will be removed in Vaadin 26. Consider using Dashboard as an alternative.Board Row is deprecated and will be removed in Vaadin 26. Consider using Dashboard as an alternative.Use
ContextMenuElementinstead.UseUploadHandlerinsteadUseUploadHandlerinsteadUseUploadHandlerinsteadUseUploadHandlerinsteadUseUploadHandlerinsteadUseBrowserLiveReloadAccessorinsteadPolymer template support is deprecated - we recommend you to useLitTemplateinstead. Read more details from the Vaadin blog.useUploadHandlerinsteaduseDownloadHandlerinsteadFor browser information users should parse the user-agent using a parsing library like ua-parser/uap-javaUseVaadinSecurityConfigurerinstead. It follows the Spring's SecurityConfigurer pattern and we recommend use it to configure Spring Security with Vaadin:
Read more details in Security Configurer documentation.@Configuration @EnableWebSecurity @Import(VaadinAwareSecurityContextHolderStrategyConfiguration.class) public class SecurityConfig { @Bean SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { return http.with(VaadinSecurityConfigurer.vaadin(), configurer -> {}).build(); } }
-
Deprecated Exception ClassesException ClassDescription
-
Deprecated Annotation InterfacesAnnotation InterfaceDescriptionAs of Vaadin 25, this annotation is deprecated. The theming system has been reworked to use
CssImportto load one or more stylesheets and use mechanisms native to HTML, CSS and React (e.g.@import url("morestyles.css")in CSS).use the standardizedNonNullinsteaduse the standardizedNullableinstead
-
Deprecated Fields
-
Deprecated MethodsMethodDescriptionThis operation, along with
CollaborationBinder.setBean(Object), is not supported by the collaboration binder. Instead ofCollaborationBinder.setBean(Object), you can provide the bean for populating the fields usingCollaborationBinder.setTopic(java.lang.String, com.vaadin.flow.function.SerializableSupplier<BEAN>), and write the values back to the bean usingBinder.writeBean(BEAN).This operation is not supported by the collaboration binder. You can instead provide the bean for populating the fields usingCollaborationBinder.setTopic(java.lang.String, com.vaadin.flow.function.SerializableSupplier<BEAN>)to avoid overriding currently edited values. If you explicitly want to reset the field values for every user currently editing the fields, you can useCollaborationBinder.reset(BEAN).This operation is not supported by the collaboration binder. You can instead provide the bean for populating the fields usingCollaborationBinder.setTopic(java.lang.String, com.vaadin.flow.function.SerializableSupplier<BEAN>), and write the values back to the bean usingBinder.writeBean(BEAN).UseAvatar.setImageHandler(DownloadHandler)insteadUseAxis.setExtremes(Instant, Instant)instead.UseAxis.setExtremes(Instant, Instant, boolean)instead.UseAxis.setExtremes(Instant, Instant, boolean, boolean)instead.UseChartModel.getZooming()instead. The zooming configuration provides more comprehensive zoom options including mouse wheel support.UseChartModel.setZooming(Zooming)instead. The zooming configuration provides more comprehensive zoom options including mouse wheel support.UseStyle#setLineHeight(String)instead.usePlotOptionsOrganization.getLink().Link.setColor(Color)instead.usePlotOptionsOrganization.getLink().Link.setRadius(Number)instead.UsePlotOptionsTreemap.setAllowTraversingTree(Boolean)instead.UsePlotOptionsTreemap.setAllowTraversingTree(Boolean)instead.This property is deprecated and should not be used in new code. UseTime.setTimezone(String)instead.This property is deprecated and should not be used in new code. UseTime.setTimezone(String)instead.This property is deprecated and should not be used in new code. UseTime.setTimezone(String)instead.This property is deprecated and should not be used in new code. UseTime.setTimezone(String)instead.does not work so don't useUseContextMenuElement.getMenuItem(String)instead.UseContextMenuElement.getMenuItems()instead.This method should not be used outside.Pre v25.0, this method returned either the editor overlay, when the editor was displayed as a dialog, or the Crud itself, when the editor was displayed inline. Since v25.0, the overlay is not accessible as a separate element anymore, and, regardless whether the editor is displayed as a dialog or inline, all editor-related controls can be queried through the Crud element itself. To specifically access the editor fields, useCrudElement.getForm()instead. To access the editor buttons, useCrudElement.getEditorSaveButton(),CrudElement.getEditorCancelButton(), andCrudElement.getEditorDeleteButton().Since v24.8Component styling can be done entirely with normal "light DOM" CSS.UseDialog.getRole()insteaduseDialog.getModality()insteaduseDialog.setModality(ModalityMode)insteadUseDialog.setRole(String)insteadThis method should not be used outside.Grid.getDefaultColumnFactory()should be used instead.Grid.setPartNameGenerator(com.vaadin.flow.function.SerializableFunction<T, java.lang.String>)should be used instead.UseAbstractColumn.getFooterText()orAbstractColumn.getFooterComponent()directlyUseAbstractColumn.getHeaderText()orAbstractColumn.getHeaderComponent()useAnchor.setHref(DownloadHandler)insteaduseHtmlObject.setData(DownloadHandler)insteaduseIFrame.setSrc(DownloadHandler)insteaduseImage.setSrc(DownloadHandler)insteadUseSvgIcon.setSrc(DownloadHandler)insteadUseSvgIcon.setSrc(DownloadHandler, String)insteaduseIcon.getImg()insteaduseIcon.Options.setImg(DownloadHandler)insteaduseMapBase.addClickListener(ComponentEventListener)insteaduseMenuBarButtonElement.openSubMenu()orMenuBarButtonElement.getSubMenu()retrieve the submenu for this button, and then useMenuBarSubMenuElement.getMenuItems()to retrieve the items.useMenuBarButtonElement.openSubMenu()orMenuBarItemElement.openSubMenu()to access submenus for specific buttons or itemsuseMenuBarButtonElement.openSubMenu()to open a submenuuseMenuBarButtonElement.openSubMenu()to open a submenu and then useMenuBarSubMenuElement.getMenuItems()to retrieve the items.useMenuBarButtonElement.openSubMenu()orMenuBarItemElement.openSubMenu()to open a submenu and then useMenuBarSubMenuElement.getMenuItems()to retrieve the items.useMenuBarItemElement.openSubMenu()orMenuBarItemElement.getSubMenu()retrieve the submenu for this item, and then useMenuBarSubMenuElement.getMenuItems()to retrieve the items.UsePopover.getRole()insteadUsePopover.setRole(String)insteadsince v24 the RichTextEditor uses the HTML value by default. UseRichTextEditor.getValue()instead.since 24.5, useValidationUtil.validateMaxConstraint(String, Comparable, Comparable)instead.since 24.5, useValidationUtil.validateRequiredConstraint(String, boolean, Object, Object)instead.since 24.5, useValidationUtil.validateMinConstraint(String, Comparable, Comparable)instead.since 24.0, useTabs.add(Tab...)instead.since 24.0, useTabs.addTabAsFirst(Tab)instead.since 24.0, useTabs.addTabAtIndex(int, Tab)instead.since 24.0, useTabs.getTabAt(int)instead.since 24.5, useTabs.getTabCount()instead.since 24.0, useTabs.indexOf(Tab)instead.since 24.0, useTabs.remove(Tab...)instead.since 24.0, useTabs.replace(Tab, Tab)instead.Since v24.8not supportednot supportednot supporteduseTransferProgressListenerwithUploadHandlerimplementing theTransferProgressAwareHandlerinterface.useTransferProgressListenerwithUploadHandlerimplementing theTransferProgressAwareHandlerinterface.useTransferProgressListenerwithUploadHandlerimplementing theTransferProgressAwareHandlerinterface.useTransferProgressListenerwithUploadHandlerimplementing theTransferProgressAwareHandlerinterface.com.vaadin.flow.component.upload.Upload.addSucceededListener(ComponentEventListener<SucceededEvent>) useTransferProgressListenerwithUploadHandlerimplementing theTransferProgressAwareHandlerinterface.since 24.4. UseUpload.fireUpdateProgress(long, long, String)useUpload.setUploadHandler(UploadHandler)insteadsince 24.9 and will be removed in Vaadin 26. UseDataCommunicator.computeViewportRange(int, int)instead.since 24.9 and will be removed in Vaadin 26. UseDataCommunicator.setViewportRange(int, int)instead.Webpack is not used anymore, this method is obsolete and have no replacements.used internally only for testing, to be removed without a replacement.useWebBrowser.getUserAgent()method to get user-agent stringuse a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()use a parsing library like ua-parser/uap-java to parse the user agent fromWebBrowser.getUserAgent()AntPathRequestMatcheris deprecated and marked for removal. This method is deprecated without direct replacement; usePathPatternRequestMatcherinstead.AntPathRequestMatcheris deprecated and marked for removal. This method is deprecated without direct replacement; usePathPatternRequestMatcherinstead.usehttp.with(new VaadinStatelessSecurityConfigurer(), customizer)instead.AntPathRequestMatcher is deprecated and will be removed, useVaadinWebSecurity.pathMatchers(String...)instead.AntPathRequestMatcher is deprecated and will be removed, useVaadinWebSecurity.routePathMatchers(String...)instead.base url will not be translated to the theme url anymorebase url will not be translated to the theme url anymoreNo translation of the url will be done in 25This method is deprecated. Use$instead to find elements in the shadow root.testers for commercial components have been moved to a separated class to avoid class loading issues when using only Vaadin free tier. Make the test class implementCommercialTestWrappersand useCommercialTestWrappers.test(Chart)instead.
-
Deprecated ConstructorsConstructorDescriptionuse
Anchor(DownloadHandler, String)insteaduseHtmlObject(DownloadHandler)insteaduseHtmlObject(DownloadHandler,Param...)insteaduseHtmlObject(DownloadHandler,String)insteaduseHtmlObject(DownloadHandler,String, Param...)insteaduseImage(DownloadHandler, String)insteadUseSvgIcon(DownloadHandler)insteadUseSvgIcon(DownloadHandler, String)insteadsince 24.4. UseFileRejectedEvent(Upload, String, String)since 24.4. UseProgressUpdateEvent(Upload, long, long, String)useUpload(UploadHandler)insteaduseFrontendTools(FrontendToolsSettings)instead, as it simplifies configuring the frontend tools and gives the default values to configuration parameters.
-
Deprecated Enum Constants
-
Deprecated Annotation Interface ElementsAnnotation Interface ElementDescriptionComponent styling can be done entirely with normal "light DOM" CSS.