| Modifier and Type | Interface and Description |
|---|---|
interface |
Focusable<T extends Component>
Represents a component that can gain and lose focus.
|
interface |
HasComponents
A component to which the user can add and remove child components.
|
interface |
HasEnabled
A generic interface for components and other user interface objects that may
be enabled or disabled.
|
interface |
HasHelper
Mixin interface for field components that have helper text as property and
slots for inserting components.
|
interface |
HasLabel
A component that supports label definition.
|
interface |
HasOrderedComponents<T extends Component>
A component which the children components are ordered, so the index of each
child matters for the layout.
|
interface |
HasSize
Any component implementing this interface supports setting the size of the
component using
HasSize.setWidth(String) and HasSize.setHeight(String). |
interface |
HasStyle
Represents
Component which has class attribute and inline styles. |
interface |
HasText
A component that supports text content.
|
interface |
HasTheme
Represents
Component which has theme attribute. |
interface |
HasValueAndElement<E extends HasValue.ValueChangeEvent<V>,V>
A component that has a value.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractCompositeField<C extends Component,S extends AbstractCompositeField<C,S,T>,T>
An abstract field class that is backed by a composite component.
|
class |
AbstractField<C extends AbstractField<C,T>,T>
An abstract implementation of a field, or a
Component allowing user
input. |
class |
AbstractSinglePropertyField<C extends AbstractField<C,T>,T>
Abstract field that is based on a single element property.
|
class |
Component
|
class |
Composite<T extends Component>
A composite encapsulates a
Component tree to allow creation of new
components by composing existing components. |
class |
Html
A component which encapsulates a given HTML fragment with a single root
element.
|
class |
HtmlComponent
Base class for a
Component that represents a single built-in HTML
element. |
class |
HtmlContainer
Base class for a
Component that represents a single built-in HTML
element that can contain child components or text. |
class |
Text
A component which encapsulates the given text in a text node.
|
class |
UI
The topmost component in any component hierarchy.
|
| Modifier and Type | Method and Description |
|---|---|
default G |
PropertyDescriptor.get(HasElement hasElement)
Gets the property value for the given component.
|
default void |
PropertyDescriptor.set(HasElement hasElement,
S value)
Sets the property value for the given component.
|
| Modifier and Type | Method and Description |
|---|---|
List<HasElement> |
UIInternals.getActiveRouterTargetsChain()
Gets the currently active router target and parent layouts.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractTemplate<M extends TemplateModel> |
class |
PolymerTemplate<M extends TemplateModel>
Component for an HTML element declared as a polymer component.
|
| Modifier and Type | Class and Description |
|---|---|
class |
WebComponentUI
Custom UI for use with WebComponents served from the server.
|
class |
WebComponentWrapper
Wrapper component for a web component that exposes
ClientCallable
methods that the client-side components expect to be available. |
| Modifier and Type | Method and Description |
|---|---|
default <T extends HasElement> |
Instantiator.createRouteTarget(Class<T> routeTargetType,
NavigationEvent event)
Creates an instance of a navigation target or router layout.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
RouterLayout
Implementations of this interface represent a parent for a navigation target
components via the
Route.layout() parameter. |
| Modifier and Type | Class and Description |
|---|---|
class |
InternalServerError
This is a basic default error view shown on exceptions during navigation.
|
class |
RouteNotFoundError
This is a basic default error view shown on routing exceptions.
|
class |
RouterLink
A link that handles navigation internally using
Router instead of
loading a new page in the browser. |
| Modifier and Type | Method and Description |
|---|---|
static <C extends HasElement> |
HighlightConditions.always()
Always highlight.
|
static <C extends HasElement> |
HighlightConditions.locationPrefix(String prefix)
Highlight if the navigation path starts with
prefix. |
static <C extends HasElement> |
HighlightConditions.never()
Never highlight.
|
static <C extends HasElement> |
HighlightActions.none()
An action which does nothing, regardless of the highlight state.
|
static <C extends HasElement> |
HighlightActions.toggleAttribute(String attribute)
An action which toggles the target's
attribute based on its
highlight state. |
static <C extends HasElement> |
HighlightActions.toggleTheme(String theme)
An action which toggles
theme on the target based on its
highlight state. |
| Modifier and Type | Method and Description |
|---|---|
List<HasElement> |
AfterNavigationEvent.getActiveChain()
Get the active chain that we have after navigation.
|
List<HasElement> |
LocationChangeEvent.getRouteTargetChain()
Gets the chain of route targets that will be nested inside the UI,
starting from the most deeply nested component.
|
| Modifier and Type | Method and Description |
|---|---|
static List<BeforeEnterObserver> |
EventUtil.collectBeforeEnterObserversFromChainElement(HasElement element,
Collection<? extends HasElement> childrenExclusions)
Collect before enter observer instances in the
element's
hierarchy. |
default void |
RouterLayout.removeRouterLayoutContent(HasElement oldContent)
Removes content that should no longer be shown in this router layout.
|
default void |
RouterLayout.showRouterLayoutContent(HasElement content)
Shows the content of the layout which is the router target component
annotated with a
@Route. |
| Modifier and Type | Method and Description |
|---|---|
static List<BeforeEnterObserver> |
EventUtil.collectBeforeEnterObservers(Collection<? extends HasElement> oldChain,
Collection<? extends HasElement> newChain)
Collect before enter observer instances based on what will be attached
when a new view chain is applied.
|
static List<BeforeEnterObserver> |
EventUtil.collectBeforeEnterObservers(Collection<? extends HasElement> oldChain,
Collection<? extends HasElement> newChain)
Collect before enter observer instances based on what will be attached
when a new view chain is applied.
|
static List<BeforeEnterObserver> |
EventUtil.collectBeforeEnterObserversFromChain(Collection<? extends HasElement> chain,
Collection<? extends HasElement> childrenExclusions)
Collect before enter observer instances based on what will be attached
when a new view chain is applied.
|
static List<BeforeEnterObserver> |
EventUtil.collectBeforeEnterObserversFromChain(Collection<? extends HasElement> chain,
Collection<? extends HasElement> childrenExclusions)
Collect before enter observer instances based on what will be attached
when a new view chain is applied.
|
static List<BeforeEnterObserver> |
EventUtil.collectBeforeEnterObserversFromChainElement(HasElement element,
Collection<? extends HasElement> childrenExclusions)
Collect before enter observer instances in the
element's
hierarchy. |
static List<LocaleChangeObserver> |
EventUtil.collectLocaleChangeObservers(List<HasElement> components)
Collect all Components implementing
LocaleChangeObserver
connected to the tree of all given Components in list. |
static void |
EventUtil.informLocaleChangeObservers(UI ui,
List<HasElement> components)
Inform components implementing
LocaleChangeObserver about locale
change. |
| Constructor and Description |
|---|
LocationChangeEvent(Router router,
UI ui,
NavigationTrigger trigger,
Location location,
List<HasElement> routeTargetChain)
Creates a new location change event.
|
| Modifier and Type | Method and Description |
|---|---|
static LocationChangeEvent |
RouterUtil.createEvent(NavigationEvent event,
List<HasElement> routeTargetChain)
Deprecated.
Create a new location change event for given navigation event and chain.
|
Copyright © 2000–2025 Vaadin Ltd. All rights reserved.