@Retention(value=RUNTIME) @Target(value=TYPE) @Inherited @Documented public @interface Route
The route template of the navigation target is composed of the values of
RoutePrefix annotated on the
ParentLayout class values, starting from the root parent and joined
together using slash delimiter to form a path form string.
There is also
RouteAlias annotation which may be declared in addition
to this annotation and may be used multiple times.
|Modifier and Type||Optional Element and Description|
Ignore route prefixes from parent layouts and only use the path defined in this annotation.
Sets the parent component for the route target component.
Marks if this Route should be registered during the initial route registration on servlet startup.
Sets the route template suffix value of the annotated class.
public static final String NAMING_CONVENTION
public abstract String value
If no value is provided, the path will be derived from the class name of the component. The derived name will be in lower case and trailing "View" will be removed. Also, MainView or Main names will be mapped to root (value will be "").
This value accepts also parameter template segments which can be defined
using following format:
Note for framework developers: do not use the value directly, but use the
RouteUtil.resolve(Class, Route), so that naming
convention based values are dealt correctly.
public abstract Class<? extends RouterLayout> layout
When navigating between components that use the same layout, the same
component instance is reused. Default layout target is the
but the layout should not be a custom
UI is a special
class used to know where the route stack ends and no parent layouts should
All layout stacks will be appended to the
UI as it represents
the Body element.
public abstract boolean absolute
trueto ignore parent layout prefixes,
Copyright © 2021. All rights reserved.