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 |
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 | Class and Description |
---|---|
class |
Accordion
Accordion is a a vertically stacked set of expandable panels.
|
class |
AccordionPanel
An accordion panel which could be opened or closed.
|
Modifier and Type | Class and Description |
---|---|
class |
AppLayout
Server-side component for the
<vaadin-app-layout> element. |
class |
DrawerToggle
Server-side component for the
<vaadin-drawer-toggle> element. |
Modifier and Type | Method and Description |
---|---|
void |
AppLayout.showRouterLayoutContent(HasElement content)
Shows the content of the layout which is the router target component
annotated with a
@Route . |
Modifier and Type | Class and Description |
---|---|
class |
Board
Vaadin Board allows creating responsive layouts in an easy way.
|
class |
Row
Row class to define rows used in a
Board instance. |
Modifier and Type | Class and Description |
---|---|
class |
Button
Server-side component for the
vaadin-button element. |
class |
GeneratedVaadinButton<R extends GeneratedVaadinButton<R>>
Description copied from corresponding location in WebComponent:
|
Modifier and Type | Class and Description |
---|---|
class |
Chart |
Modifier and Type | Class and Description |
---|---|
class |
Checkbox
Server-side component for the
vaadin-checkbox element. |
class |
CheckboxGroup<T>
Server-side component for the
vaadin-checkbox-group element. |
class |
GeneratedVaadinCheckbox<R extends GeneratedVaadinCheckbox<R,T>,T>
Description copied from corresponding location in WebComponent:
|
class |
GeneratedVaadinCheckboxGroup<R extends GeneratedVaadinCheckboxGroup<R,T>,T>
Description copied from corresponding location in WebComponent:
|
Modifier and Type | Class and Description |
---|---|
class |
ComboBox<T>
Server-side component for the
vaadin-combo-box webcomponent. |
class |
GeneratedVaadinComboBox<R extends GeneratedVaadinComboBox<R,T>,T>
Description copied from corresponding location in WebComponent:
|
Modifier and Type | Class and Description |
---|---|
class |
ConfirmDialog
Server-side component for the
<vaadin-confirm-dialog> element. |
Modifier and Type | Class and Description |
---|---|
class |
ContextMenu
Server-side component for
<vaadin-context-menu> . |
class |
ContextMenuBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>>
Base functionality for server-side components based on
<vaadin-context-menu> . |
class |
GeneratedVaadinContextMenu<R extends GeneratedVaadinContextMenu<R>>
Description copied from corresponding location in WebComponent:
|
class |
MenuItem
Item component used inside
ContextMenu and SubMenu . |
class |
MenuItemBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>>
Base class for item component used inside
ContextMenu s. |
Modifier and Type | Class and Description |
---|---|
class |
CookieConsent
Server-side component for the
vaadin-cookie-consent element,
used for showing a cookie consent banner the first time a user visits the
application, until the banner is dismissed. |
Modifier and Type | Class and Description |
---|---|
class |
Crud<E>
A component for performing CRUD
operations on a data backend (e.g entities from a database).
|
class |
CrudGrid<E>
A simple grid implementation for Crud that allows searching and sorting backed by a data provider.
|
Modifier and Type | Class and Description |
---|---|
class |
CustomField<T>
A
HasValue whose UI content can be constructed by the user, enabling
the creation of e.g. |
Modifier and Type | Class and Description |
---|---|
class |
DatePicker
Server-side component that encapsulates the functionality of the
vaadin-date-picker webcomponent. |
class |
GeneratedVaadinDatePicker<R extends GeneratedVaadinDatePicker<R,T>,T>
Description copied from corresponding location in WebComponent:
|
Modifier and Type | Class and Description |
---|---|
class |
DateTimePicker
Server-side component that encapsulates the functionality of the
vaadin-date-time-picker web component. |
Modifier and Type | Class and Description |
---|---|
class |
Details |
Modifier and Type | Class and Description |
---|---|
class |
Dialog
Server-side component for the
<vaadin-dialog> element. |
class |
GeneratedVaadinDialog<R extends GeneratedVaadinDialog<R>>
Description copied from corresponding location in WebComponent:
|
Modifier and Type | Interface and Description |
---|---|
interface |
DragSource<T extends Component>
Mixin interface that provides basic drag source API for any component.
|
interface |
DropTarget<T extends Component>
Mixin interface that provides basic drop target API for any component.
|
Modifier and Type | Class and Description |
---|---|
class |
FormLayout
Server-side component for the
<vaadin-form-layout> element. |
static class |
FormLayout.FormItem
Server-side component for the
<vaadin-form-item> element. |
class |
GeneratedVaadinFormItem<R extends GeneratedVaadinFormItem<R>>
Description copied from corresponding location in WebComponent:
|
class |
GeneratedVaadinFormLayout<R extends GeneratedVaadinFormLayout<R>>
Description copied from corresponding location in WebComponent:
|
Modifier and Type | Class and Description |
---|---|
class |
Grid<T>
Server-side component for the
<vaadin-grid> element. |
static class |
Grid.Column<T>
Server-side component for the
<vaadin-grid-column> element. |
class |
GridSelectionColumn
Server side implementation for the flow specific grid selection column.
|
Modifier and Type | Class and Description |
---|---|
class |
GridContextMenu<T>
Server-side component for
<vaadin-context-menu> to be used with
Grid . |
class |
GridMenuItem<T>
Item component used inside
GridContextMenu and GridSubMenu . |
Modifier and Type | Class and Description |
---|---|
class |
GridPro<E> |
static class |
GridPro.EditColumn<T>
Server-side component for the
<vaadin-grid-edit-column> element. |
Modifier and Type | Class and Description |
---|---|
class |
Anchor
Component representing an
<a> element. |
class |
Article
Component representing a
<article> element. |
class |
Aside
Component representing a
<aside> element. |
class |
DescriptionList
Component representing a
<dl> element. |
static class |
DescriptionList.Description
Component representing a
<dd> element. |
static class |
DescriptionList.Term
Component representing a
<dt> element. |
class |
Div
Component representing a
<div> element. |
class |
Emphasis
Component representing a
<em> element. |
class |
Footer
Component representing a
<footer> element. |
class |
H1
Component representing a
<h1> element. |
class |
H2
Component representing a
<h2> element. |
class |
H3
Component representing a
<h3> element. |
class |
H4
Component representing a
<h4> element. |
class |
H5
Component representing a
<h5> element. |
class |
H6
Component representing a
<h6> element. |
class |
Header
Component representing a
<header> element. |
class |
Hr
Component representing a
<hr> element. |
class |
IFrame
Component representing a
<iframe> element. |
class |
Image
Component representing a
<img> element. |
class |
Input
Component representing an
<input> element. |
class |
Label
Component for a
<label> element, which represents a
caption for an item in a user interface. |
class |
ListItem
Component representing a
<li> element. |
class |
Main
Component representing a
<main> element. |
class |
NativeButton
Component representing a
<button> element. |
class |
Nav
Component representing a
<nav> element. |
class |
OrderedList
Component representing a
<ol> element. |
class |
Paragraph
Component representing a
<p> element. |
class |
Pre
Component representing a
<pre> element. |
class |
Section
Component representing a
<section> element. |
class |
Span
Component representing a
<span> element. |
class |
UnorderedList
Component representing a
<ul> element. |
Modifier and Type | Class and Description |
---|---|
class |
Icon
Component for displaying an icon from the
Vaadin Icons collection.
|
class |
IronIcon
Server side component for
iron-icon element
to display an icon.
|
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 |
IronList<T>
Component that encapsulates the functionality of the
<iron-list>
webcomponent. |
Modifier and Type | Class and Description |
---|---|
class |
ListBox<T>
Server-side component for the
vaadin-list-box element. |
class |
ListBoxBase<C extends ListBoxBase<C,ITEM,VALUE>,ITEM,VALUE>
Base class for the
ListBox and MultiSelectListBox . |
class |
MultiSelectListBox<T>
Server-side component for the
vaadin-list-box element with
multi-selection. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractLogin
Abstract component for the
<vaadin-login-overlay> and
<vaadin-login-form> components. |
class |
LoginForm
Server-side component for the
<vaadin-login-form> component. |
class |
LoginOverlay
Server-side component for the
<vaadin-login-overlay> component. |
Modifier and Type | Class and Description |
---|---|
class |
MenuBar
Server-side component for the
vaadin-menu-bar element. |
Modifier and Type | Class and Description |
---|---|
class |
GeneratedVaadinNotification<R extends GeneratedVaadinNotification<R>>
Description copied from corresponding location in WebComponent:
|
class |
Notification
Server-side component for the
vaadin-notification element. |
Modifier and Type | Interface and Description |
---|---|
interface |
FlexComponent<C extends Component>
A component which implements Flexbox.
|
interface |
ThemableLayout
Common logic for
VerticalLayout and HorizontalLayout related
to dynamic theme adjustment. |
Modifier and Type | Class and Description |
---|---|
class |
FlexLayout
A layout component that implements Flexbox.
|
class |
HorizontalLayout
HorizontalLayout is a component container, which shows the subcomponents in
the order of their addition (horizontally).
|
class |
Scroller
Scroller is a component container which enables scrolling overflowing
content.
|
class |
VerticalLayout
VerticalLayout is a component container, which shows the subcomponents in the
order of their addition (vertically).
|
Modifier and Type | Method and Description |
---|---|
FlexComponent.Alignment |
VerticalLayout.getAlignSelf(HasElement container)
This is the same as
VerticalLayout.getHorizontalComponentAlignment(Component) . |
FlexComponent.Alignment |
HorizontalLayout.getAlignSelf(HasElement container)
This is the same as
HorizontalLayout.getVerticalComponentAlignment(Component) . |
default FlexComponent.Alignment |
FlexComponent.getAlignSelf(HasElement container)
Gets the individual alignment of a given element container.
|
String |
FlexLayout.getFlexBasis(HasElement elementContainer)
Gets the flex basis property of a given element container.
|
FlexLayout.FlexDirection |
FlexLayout.getFlexDirection(HasElement elementContainer)
Gets the flex direction property of a given element container.
|
default double |
FlexComponent.getFlexGrow(HasElement elementContainer)
Gets the flex grow property of a given element container.
|
double |
FlexLayout.getFlexShrink(HasElement elementContainer)
Gets the flex shrink property of a given element container.
|
int |
FlexLayout.getOrder(HasElement elementContainer)
Gets the order property of a given element container.
|
void |
VerticalLayout.setAlignSelf(FlexComponent.Alignment alignment,
HasElement... elementContainers)
This is the same as
#setHorizontalComponentAlignment(Alignment, Component...) . |
void |
HorizontalLayout.setAlignSelf(FlexComponent.Alignment alignment,
HasElement... elementContainers)
This is the same as
#setVerticalComponentAlignment(Alignment, Component...) . |
default void |
FlexComponent.setAlignSelf(FlexComponent.Alignment alignment,
HasElement... elementContainers)
Sets an alignment for individual element container inside the layout.
|
void |
FlexLayout.setFlexBasis(String width,
HasElement... elementContainers)
Sets the flex basis property of the components inside the layout.
|
default void |
FlexComponent.setFlexGrow(double flexGrow,
HasElement... elementContainers)
Sets the flex grow property of the components inside the layout.
|
void |
FlexLayout.setFlexShrink(double flexShrink,
HasElement... elementContainers)
Sets the flex shrink property of the components inside the layout.
|
void |
FlexLayout.setOrder(int order,
HasElement elementContainer)
Sets the order property of the component inside the layout.
|
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 |
GeneratedVaadinProgressBar<R extends GeneratedVaadinProgressBar<R>>
Description copied from corresponding location in WebComponent:
|
class |
ProgressBar
Server-side component for the
vaadin-progress-bar element. |
Modifier and Type | Class and Description |
---|---|
class |
GeneratedVaadinRadioButton<R extends GeneratedVaadinRadioButton<R>>
Description copied from corresponding location in WebComponent:
|
class |
GeneratedVaadinRadioGroup<R extends GeneratedVaadinRadioGroup<R,T>,T>
Description copied from corresponding location in WebComponent:
|
class |
RadioButtonGroup<T>
A single select component using radio buttons as options.
|
Modifier and Type | Class and Description |
---|---|
class |
GeneratedVaadinRichTextEditor<R extends GeneratedVaadinRichTextEditor<R,T>,T>
Description copied from corresponding location in WebComponent:
|
class |
RichTextEditor
Server-side component for the
<vaadin-rich-text-editor> component. |
Modifier and Type | Class and Description |
---|---|
class |
Select<T>
A customizable drop-down select component similar to a native browser select.
|
Modifier and Type | Class and Description |
---|---|
class |
GeneratedVaadinSelect<R extends GeneratedVaadinSelect<R,T>,T>
Description copied from corresponding location in WebComponent:
|
Modifier and Type | Class and Description |
---|---|
class |
GeneratedVaadinSplitLayout<R extends GeneratedVaadinSplitLayout<R>>
Description copied from corresponding location in WebComponent:
|
class |
SplitLayout
SplitLayout is a component based on the vaadin-split-layout
Polymer element implementing a split layout for two content elements with a
draggable splitter between them. |
Modifier and Type | Class and Description |
---|---|
class |
GeneratedVaadinTab<R extends GeneratedVaadinTab<R>>
Description copied from corresponding location in WebComponent:
|
class |
GeneratedVaadinTabs<R extends GeneratedVaadinTabs<R>>
Description copied from corresponding location in WebComponent:
|
class |
Tab
Server-side component for the
vaadin-tab element. |
class |
Tabs
Server-side component for the
vaadin-tabs element. |
Modifier and Type | Interface and Description |
---|---|
interface |
HasAutocapitalize
Mixin interface for fields with
autocapitalize attribute. |
interface |
HasAutocomplete
Mixin interface for fields with
autocomplete attribute. |
interface |
HasAutocorrect
Mixin interface for fields with
autocorrect attribute. |
interface |
HasPrefixAndSuffix
Mixin interface for text-field components that have prefix and suffix slots
for inserting components.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractNumberField<C extends AbstractNumberField<C,T>,T extends Number>
Abstract base class for components based on
vaadin-number-field
element and its subclasses. |
class |
BigDecimalField
Server-side component for the
vaadin-big-decimal-field element. |
class |
EmailField
Server-side component for the
vaadin-email-field element. |
class |
GeneratedVaadinEmailField<R extends GeneratedVaadinEmailField<R,T>,T>
Description copied from corresponding location in WebComponent:
|
class |
GeneratedVaadinNumberField<R extends GeneratedVaadinNumberField<R,T>,T>
Description copied from corresponding location in WebComponent:
|
class |
GeneratedVaadinPasswordField<R extends GeneratedVaadinPasswordField<R,T>,T>
Description copied from corresponding location in WebComponent:
|
class |
GeneratedVaadinTextArea<R extends GeneratedVaadinTextArea<R,T>,T>
Description copied from corresponding location in WebComponent:
|
class |
GeneratedVaadinTextField<R extends GeneratedVaadinTextField<R,T>,T>
Description copied from corresponding location in WebComponent:
|
class |
IntegerField
Server-side component for the
vaadin-integer-field element. |
class |
NumberField
Server-side component for the
vaadin-number-field element. |
class |
PasswordField
Server-side component for the
vaadin-password-field element. |
class |
TextArea
Server-side component for the
vaadin-text-area element. |
class |
TextField
Server-side component for the
vaadin-text-field element. |
Modifier and Type | Class and Description |
---|---|
class |
GeneratedVaadinTimePicker<R extends GeneratedVaadinTimePicker<R,T>,T>
Description copied from corresponding location in WebComponent:
|
class |
TimePicker
An input component for selecting time of day, based on
vaadin-time-picker web component. |
Modifier and Type | Class and Description |
---|---|
class |
TreeGrid<T>
A grid component for displaying hierarchical tabular data.
|
Modifier and Type | Class and Description |
---|---|
class |
GeneratedVaadinUpload<R extends GeneratedVaadinUpload<R>>
Description copied from corresponding location in WebComponent:
|
class |
GeneratedVaadinUploadFile<R extends GeneratedVaadinUploadFile<R>>
Description copied from corresponding location in WebComponent:
|
class |
Upload
Server-side component for the
vaadin-upload element. |
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 | Interface and Description |
---|---|
interface |
HasItemsAndComponents<T>
Represents a component that display a collection of items and can have
additional components between the items.
|
static interface |
HasItemsAndComponents.ItemComponent<T>
Represents a single item component that is used inside an
HasItemsAndComponents . |
Modifier and Type | Interface and Description |
---|---|
interface |
MultiSelect<C extends Component,T>
Multi selection component which allows to select and deselect multiple items.
|
interface |
SingleSelect<C extends Component,T>
Single selection component whose selection is treated as a value.
|
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 © 2020. All rights reserved.