public class RouteUtil extends Object
For internal use only. May be renamed or removed in a future release.
Modifier | Constructor and Description |
---|---|
protected |
RouteUtil() |
Modifier and Type | Method and Description |
---|---|
static List<Class<? extends RouterLayout>> |
getParentLayouts(Class<?> component,
String path)
Deprecated.
|
static List<Class<? extends RouterLayout>> |
getParentLayouts(VaadinContext context,
Class<?> component,
String path)
Get parent layouts for navigation target according to the
Route
or RouteAlias annotation. |
static List<Class<? extends RouterLayout>> |
getParentLayoutsForNonRouteTarget(Class<?> navigationTarget)
Collect possible route parent layouts for a navigation target that is not
annotated with
Route nor RouteAlias , but may still
contain ParentLayout . |
static String |
getRouteAliasPath(Class<?> component,
RouteAlias alias)
Get the actual route path including all parent layout
RoutePrefix . |
static String |
getRoutePath(Class<?> component,
Route route)
Deprecated.
Use
getRoutePath(VaadinContext, Class) instead |
static String |
getRoutePath(VaadinContext context,
Class<?> component)
Get the actual route path including all parent layout
RoutePrefix . |
static Class<? extends RouterLayout> |
getTopParentLayout(Class<?> component,
String path)
Deprecated.
Use
getTopParentLayout(VaadinContext, Class, String)
instead |
static Class<? extends RouterLayout> |
getTopParentLayout(VaadinContext context,
Class<?> component,
String path)
Get the top most parent layout for navigation target according to the
Route or RouteAlias annotation. |
static String |
resolve(Class<?> component,
Route route)
Deprecated.
Use
resolve(VaadinContext, Class) or
RoutePathProvider directly instead |
static String |
resolve(VaadinContext context,
Class<?> component)
Gets the effective route path value of the annotated class.
|
static void |
updateRouteRegistry(RouteRegistry registry,
Set<Class<?>> addedClasses,
Set<Class<?>> modifiedClasses,
Set<Class<?>> deletedClasses)
Updates route registry as necessary when classes have been added /
modified / deleted.
|
@Deprecated public static List<Class<? extends RouterLayout>> getParentLayouts(Class<?> component, String path)
getParentLayouts(VaadinContext, Class, String)
Route
or RouteAlias
annotation.component
- navigation target to get parents forpath
- path used to get navigation target so we know which annotation
to handlepublic static List<Class<? extends RouterLayout>> getParentLayouts(VaadinContext context, Class<?> component, String path)
Route
or RouteAlias
annotation.context
- a Vaadin contextcomponent
- navigation target to get parents forpath
- path used to get navigation target so we know which annotation
to handle@Deprecated public static String getRoutePath(Class<?> component, Route route)
getRoutePath(VaadinContext, Class)
insteadRoutePrefix
.component
- navigation target component to get route path forroute
- route annotation to checkpublic static String getRoutePath(VaadinContext context, Class<?> component)
RoutePrefix
.context
- a Vaadin contextcomponent
- navigation target component to get route path forpublic static String getRouteAliasPath(Class<?> component, RouteAlias alias)
RoutePrefix
.component
- navigation target component to get route path foralias
- route alias annotation to checkpublic static List<Class<? extends RouterLayout>> getParentLayoutsForNonRouteTarget(Class<?> navigationTarget)
Route
nor RouteAlias
, but may still
contain ParentLayout
. Mainly error navigation targets.navigationTarget
- route to check parent layouts for@Deprecated public static Class<? extends RouterLayout> getTopParentLayout(Class<?> component, String path)
getTopParentLayout(VaadinContext, Class, String)
insteadRoute
or RouteAlias
annotation. Also handles non route
targets with ParentLayout
.component
- navigation target to get top most parent forpath
- path used to get navigation target so we know which annotation
to handle or null for error views.public static Class<? extends RouterLayout> getTopParentLayout(VaadinContext context, Class<?> component, String path)
Route
or RouteAlias
annotation. Also handles non route
targets with ParentLayout
.component
- navigation target to get top most parent forpath
- path used to get navigation target so we know which annotation
to handle or null for error views.@Deprecated public static String resolve(Class<?> component, Route route)
resolve(VaadinContext, Class)
or
RoutePathProvider
directly insteadcomponent
- the component where the route points toroute
- the annotationpublic static String resolve(VaadinContext context, Class<?> component)
context
- a Vaadin contexxtcomponent
- the component where the route points topublic static void updateRouteRegistry(RouteRegistry registry, Set<Class<?>> addedClasses, Set<Class<?>> modifiedClasses, Set<Class<?>> deletedClasses)
registry
- route registryaddedClasses
- added classesmodifiedClasses
- modified classesdeletedClasses
- deleted classesCopyright © 2000–2023 Vaadin Ltd. All rights reserved.