| 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.
|
static class |
AbstractField.ComponentValueChangeEvent<C extends Component,V>
Value change event fired by components.
|
interface |
BlurNotifier<T extends Component>
Mixin interface to handle blur events on components.
|
static class |
BlurNotifier.BlurEvent<C extends Component>
Class that represents the DOM event "blur".
|
class |
ClickEvent<C extends Component>
Event fired when a component is clicked.
|
interface |
ClickNotifier<T extends Component>
Mixin interface for components that support adding click listeners to the
their root elements.
|
class |
ComponentEvent<T extends Component>
An event whose source is a
Component. |
class |
Composite<T extends Component>
A composite encapsulates a
Component tree to allow creation of new
components by composing existing components. |
interface |
Focusable<T extends Component>
Interface with the methods implemented by components that can gain and lose
focus.
|
interface |
FocusNotifier<T extends Component>
Mixin interface to handle focus events on components.
|
static class |
FocusNotifier.FocusEvent<C extends Component>
Class that represents the DOM event "focus".
|
interface |
HasOrderedComponents<T extends Component>
A component which the children components are ordered, so the index of each
child matters for the layout.
|
| 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 |
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 |
|---|---|
static <T extends Component> |
ComponentUtil.componentFromElement(Element element,
Class<T> componentType,
boolean mapComponent)
Creates a new component instance using the given element, maps the
component to the element and optionally maps the element to the component
(if
mapComponent is true). |
static <T extends Component> |
ComponentUtil.fireEvent(T component,
ComponentEvent<? extends T> componentEvent)
Dispatches the event to all listeners registered for the event type.
|
static <T extends Component> |
Component.from(Element element,
Class<T> componentType)
Creates a new component instance using the given element.
|
<T,C extends Component & HasUrlParameter<T>> |
UI.navigate(Class<? extends C> navigationTarget,
T parameter)
Updates this UI to show the view corresponding to the given navigation
target with the specified parameter.
|
| Modifier and Type | Method and Description |
|---|---|
default Component |
HasOrderedComponents.getComponentAt(int index)
Returns the component at the given position.
|
static Component |
ComponentUtil.getInnermostComponent(Composite<?> composite)
Returns the innermost component from a
Composite chain, i.e. |
static Component |
ComponentUtil.getInnermostComponent(Element element)
Gets the innermost mapped component for the element.
|
static Component |
ComponentUtil.getParentUsingComposite(Composite<?> composite,
Component component)
Gets the parent of the given component, which is inside the given
composite.
|
| Modifier and Type | Method and Description |
|---|---|
static Optional<Component> |
ComponentUtil.findParentComponent(Element element)
Finds the first component by traversing upwards in the element hierarchy,
starting from the given element.
|
Stream<Component> |
Composite.getChildren()
Gets the child components of this composite.
|
Stream<Component> |
Component.getChildren()
Gets the child components of this component.
|
Optional<Component> |
Component.getParent()
Gets the parent component of this component.
|
| Modifier and Type | Method and Description |
|---|---|
void |
UI.add(Component... components)
Adds the given components to the UI.
|
default void |
HasComponents.add(Component... components)
Adds the given components as children of this component.
|
static <T extends ComponentEvent<?>> |
ComponentUtil.addListener(Component component,
Class<T> eventType,
ComponentEventListener<T> listener)
Adds a listener for an event of the given type to the
component. |
StateTree.ExecutionRegistration |
UI.beforeClientResponse(Component component,
SerializableConsumer<ExecutionContext> execution)
Registers a task to be executed before the response is sent to the
client.
|
static <T> T |
ComponentUtil.getData(Component component,
Class<T> type)
Gets a data instance with the given type, or
null if there
is no such instance. |
static Object |
ComponentUtil.getData(Component component,
String key)
Gets a data instance with the given key, or
null if no data
has been set for that key. |
static Component |
ComponentUtil.getParentUsingComposite(Composite<?> composite,
Component component)
Gets the parent of the given component, which is inside the given
composite.
|
default int |
HasOrderedComponents.indexOf(Component component)
Returns the index of the given component.
|
static boolean |
ComponentUtil.isCompositeContent(Composite<?> composite,
Component component)
Checks if the given component is inside a
Composite chain, i.e. |
static void |
ComponentUtil.onComponentAttach(Component component,
boolean initialAttach)
Handles triggering the
onAttach
method and firing the AttachEvent for the given component when it
has been attached to a UI. |
static void |
ComponentUtil.onComponentDetach(Component component)
Handles triggering the
onDetach
method and firing the DetachEvent for the given component right
before it is detached from a UI. |
default void |
HasComponents.remove(Component... components)
Removes the given child components from this component.
|
default void |
HasOrderedComponents.replace(Component oldComponent,
Component newComponent)
Replaces the component in the container with another one without changing
position.
|
static <T> void |
ComponentUtil.setData(Component component,
Class<T> type,
T value)
Stores a an instance of a specific type for the given component.
|
static void |
ComponentUtil.setData(Component component,
String key,
Object value)
Stores a arbitrary value for the given component.
|
protected static void |
Component.setElement(Component component,
Element element)
Initializes the root element of a component.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
ComponentUtil.findComponents(Element element,
Consumer<Component> componentConsumer)
|
static ComponentMetaData.DependencyInfo |
ComponentUtil.getDependencies(VaadinService service,
Class<? extends Component> componentClass)
Gets the dependencies for the given class, defined using annotations (
HtmlImport, JavaScript, StyleSheet and
Uses). |
static Collection<ComponentMetaData.SynchronizedPropertyInfo> |
ComponentUtil.getSynchronizedProperties(Class<? extends Component> componentClass)
Gets the synchronized property infos of the properties that are defined
declaratively for the given class with their RPC update mode.
|
static Stream<String> |
ComponentUtil.getSynchronizedPropertyEvents(Class<? extends Component> componentClass)
Gets the name of the synchronized property event defined declaratively
for the given class.
|
void |
UI.navigate(Class<? extends Component> navigationTarget)
Updates this UI to show the view corresponding to the given navigation
target.
|
| Constructor and Description |
|---|
AttachEvent(Component source,
boolean initialAttach)
Creates a new attach event with the given component as source.
|
ClickEvent(Component source)
Creates a new server-side click event with no additional information.
|
ClickEvent(Component source,
boolean fromClient,
int screenX,
int screenY,
int clientX,
int clientY,
int clickCount,
int button,
boolean ctrlKey,
boolean shiftKey,
boolean altKey,
boolean metaKey)
Creates a new change event.
|
ComponentEventBus(Component component)
Creates an event bus for the given component.
|
CompositionEndEvent(Component source)
Creates a new server-side composition event with no additional
information.
|
CompositionEndEvent(Component source,
boolean fromClient,
String data,
String locale)
Creates a new composition event.
|
CompositionStartEvent(Component source)
Creates a new server-side composition event with no additional
information.
|
CompositionStartEvent(Component source,
boolean fromClient,
String data,
String locale)
Creates a new composition event.
|
CompositionUpdateEvent(Component source)
Creates a new server-side composition event with no additional
information.
|
CompositionUpdateEvent(Component source,
boolean fromClient,
String data,
String locale)
Creates a new composition event.
|
DetachEvent(Component source)
Creates a new detach event with the given component as source.
|
HtmlContainer(Component... components)
Creates a component with the given child components.
|
HtmlContainer(String tagName,
Component... components)
Creates a new component with the given contents and a new element with
the given tag name.
|
InputEvent(Component source,
boolean fromClient)
Creates a new input event.
|
KeyDownEvent(Component source,
boolean fromClient,
String key,
int location,
boolean ctrlKey,
boolean shiftKey,
boolean altKey,
boolean metaKey,
boolean repeat,
boolean composing)
Creates a new keyboard event.
|
KeyDownEvent(Component source,
String key)
Creates a new server-side keyboard event with no additional information.
|
KeyPressEvent(Component source,
boolean fromClient,
String key,
int location,
boolean ctrlKey,
boolean shiftKey,
boolean altKey,
boolean metaKey,
boolean repeat,
boolean composing)
Creates a new keyboard event.
|
KeyPressEvent(Component source,
String key)
Creates a new server-side keyboard event with no additional information.
|
KeyUpEvent(Component source,
boolean fromClient,
String key,
int location,
boolean ctrlKey,
boolean shiftKey,
boolean altKey,
boolean metaKey,
boolean repeat,
boolean composing)
Creates a new keyboard event.
|
KeyUpEvent(Component source,
String key)
Creates a new server-side keyboard event with no additional information.
|
| 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 | Method and Description |
|---|---|
Component |
Button.getIcon()
Gets the component that is defined as the icon of this button.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
GeneratedVaadinButton.addToPrefix(Component... components)
Adds the given components as children of this component at the slot
'prefix'.
|
protected void |
GeneratedVaadinButton.addToSuffix(Component... components)
Adds the given components as children of this component at the slot
'suffix'.
|
protected void |
GeneratedVaadinButton.remove(Component... components)
Removes the given child components from this component.
|
void |
Button.setIcon(Component icon)
Sets the given component as the icon of this button.
|
| Constructor and Description |
|---|
Button(Component icon)
Creates a button with an icon inside.
|
Button(Component icon,
ComponentEventListener<ClickEvent<Button>> clickListener)
Creates a button with an icon and a listener for click events.
|
Button(String text,
Component icon)
Creates a button with a text and an icon inside.
|
Button(String text,
Component icon,
ComponentEventListener<ClickEvent<Button>> clickListener)
Create a button with a text, an icon and a listener for click events.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Checkbox
Server-side component for the
vaadin-checkbox element. |
class |
GeneratedVaadinCheckbox<R extends GeneratedVaadinCheckbox<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 | Method and Description |
|---|---|
protected void |
GeneratedVaadinComboBox.addToPrefix(Component... components)
Adds the given components as children of this component at the slot
'prefix'.
|
protected void |
GeneratedVaadinComboBox.remove(Component... components)
Removes the given child components from this component.
|
| 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 | Method and Description |
|---|---|
protected void |
GeneratedVaadinDatePicker.addToPrefix(Component... components)
Adds the given components as children of this component at the slot
'prefix'.
|
protected void |
GeneratedVaadinDatePicker.remove(Component... components)
Removes the given child components from this component.
|
| 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 | Method and Description |
|---|---|
Stream<Component> |
Dialog.getChildren() |
| Modifier and Type | Method and Description |
|---|---|
void |
Dialog.add(Component... components)
Adds the given components into this dialog.
|
void |
Dialog.remove(Component... components) |
| Constructor and Description |
|---|
Dialog(Component... components)
Creates a dialog with given components inside.
|
| 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 | Method and Description |
|---|---|
FormLayout.FormItem |
FormLayout.addFormItem(Component field,
Component label)
Convenience method for creating and adding a new FormItem to this layout
that wraps the given field with a component as its label.
|
FormLayout.FormItem |
FormLayout.addFormItem(Component field,
String label)
Convenience method for creating and adding a new FormItem to this layout
that wraps the given field with a label.
|
protected void |
GeneratedVaadinFormItem.addToLabel(Component... components)
Adds the given components as children of this component at the slot
'label'.
|
protected void |
GeneratedVaadinFormItem.remove(Component... components)
Removes the given child components from this component.
|
void |
FormLayout.FormItem.remove(Component... components) |
| Constructor and Description |
|---|
FormItem(Component... components)
Constructs a FormItem with the given initial components to wrap.
|
FormLayout(Component... components)
Constructs a FormLayout with the given initial components.
|
| 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 | Method and Description |
|---|---|
<V extends Component> |
Grid.addComponentColumn(ValueProvider<T,V> componentProvider)
Adds a new column that shows components.
|
| Modifier and Type | Method and Description |
|---|---|
void |
HeaderRow.HeaderCell.setComponent(Component component) |
void |
FooterRow.FooterCell.setComponent(Component component) |
Grid.Column<T> |
Grid.Column.setFooter(Component footerComponent)
Sets a footer component to the column.
|
Grid.Column<T> |
Grid.Column.setHeader(Component headerComponent)
Sets a header component to the column.
|
| 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 |
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 |
Section
Component representing a
<section> element. |
class |
Span
Component representing a
<span> element. |
class |
UnorderedList
Component representing a
<ul> element. |
| Modifier and Type | Method and Description |
|---|---|
void |
Label.setFor(Component forComponent)
Sets the component that this label describes.
|
| Constructor and Description |
|---|
Article(Component... components)
Creates a new article with the given child components.
|
Aside(Component... components)
Creates a new aside with the given child components.
|
Description(Component... components)
Creates a new description with the given child components.
|
Div(Component... components)
Creates a new div with the given child components.
|
Emphasis(Component... components)
Creates a new emphasis with the given child components.
|
Footer(Component... components)
Creates a new footer with the given child components.
|
H1(Component... components)
Creates a new heading with the given child components.
|
H2(Component... components)
Creates a new heading with the given child components.
|
H3(Component... components)
Creates a new heading with the given child components.
|
H4(Component... components)
Creates a new heading with the given child components.
|
H5(Component... components)
Creates a new heading with the given child components.
|
H6(Component... components)
Creates a new heading with the given child components.
|
Header(Component... components)
Creates a new header with the given child components.
|
ListItem(Component... components)
Creates a new list item with the given child components.
|
Main(Component... components)
Creates a new main with the given child components.
|
Nav(Component... components)
Creates a new nav with the given child components.
|
Paragraph(Component... components)
Creates a new paragraph with the given child components.
|
Section(Component... components)
Creates a new section with the given child components.
|
Span(Component... components)
Creates a new span with the given child components.
|
Term(Component... components)
Creates a new term with the given child components.
|
| 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 | Class and Description |
|---|---|
class |
AbstractFieldSupport<C extends Component & HasValue<AbstractField.ComponentValueChangeEvent<C,T>,T>,T>
Encapsulates all the logic required for a typical field implementation.
|
| Modifier and Type | Method and Description |
|---|---|
void |
UIInternals.showRouteTarget(Location viewLocation,
String path,
Component target,
List<RouterLayout> layouts)
Shows a route target in the related UI.
|
| Modifier and Type | Method and Description |
|---|---|
void |
UIInternals.addComponentDependencies(Class<? extends Component> componentClass)
Adds the dependencies defined using
StyleSheet,
JavaScript or HtmlImport on the given Component class. |
| Constructor and Description |
|---|
AbstractAttachDetachEvent(Component source)
Creates a new event with the given component as source.
|
CompositionEvent(Component source)
Creates a new server-side composition event with no additional
information.
|
CompositionEvent(Component source,
boolean fromClient,
String data,
String locale)
Creates a new composition event.
|
KeyboardEvent(Component source,
boolean fromClient,
String key,
int location,
boolean ctrlKey,
boolean shiftKey,
boolean altKey,
boolean metaKey,
boolean repeat,
boolean composing)
Creates a new keyboard event.
|
KeyboardEvent(Component source,
String key)
Creates a new server-side keyboard event with no additional information.
|
| Constructor and Description |
|---|
ComponentMetaData(Class<? extends Component> componentClass)
Scans the given component class and creates a new instance based on found
annotations.
|
| 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. |
| Modifier and Type | Method and Description |
|---|---|
ComponentRenderer<? extends Component,T> |
ListBox.getItemRenderer()
Returns the item component renderer.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ListBox.setRenderer(ComponentRenderer<? extends Component,T> itemRenderer)
Sets the item renderer for this ListBox.
|
| 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 | Method and Description |
|---|---|
Stream<Component> |
Notification.getChildren() |
| Modifier and Type | Method and Description |
|---|---|
void |
Notification.add(Component... components)
Adds the given components into this notification.
|
void |
Notification.remove(Component... components)
Remove the given components from this notification.
|
| Constructor and Description |
|---|
Notification(Component... components)
Creates a notification with given components inside.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
FlexComponent<C extends Component>
A component which implements Flexbox.
|
| 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 |
VerticalLayout
VerticalLayout is a component container, which shows the subcomponents in the
order of their addition (vertically).
|
| Modifier and Type | Method and Description |
|---|---|
default void |
FlexComponent.expand(Component... componentsToExpand)
Expands the given components.
|
FlexComponent.Alignment |
VerticalLayout.getHorizontalComponentAlignment(Component component)
Gets the individual horizontal alignment of a given component.
|
FlexComponent.Alignment |
HorizontalLayout.getVerticalComponentAlignment(Component component)
Gets the individual vertical alignment of a given component.
|
default void |
FlexComponent.replace(Component oldComponent,
Component newComponent) |
void |
VerticalLayout.setHorizontalComponentAlignment(FlexComponent.Alignment alignment,
Component... componentsToAlign)
Sets a horizontal alignment for individual components inside the layout.
|
void |
HorizontalLayout.setVerticalComponentAlignment(FlexComponent.Alignment alignment,
Component... componentsToAlign)
Sets a vertical alignment for individual components inside the layout.
|
| Constructor and Description |
|---|
FlexLayout(Component... children)
Convenience constructor to create a layout with the children already
inside it.
|
HorizontalLayout(Component... children)
Convenience constructor to create a layout with the children already
inside it.
|
VerticalLayout(Component... children)
Convenience constructor to create a layout with the children already
inside it.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractTemplate<M> |
class |
PolymerTemplate<M extends TemplateModel>
Component for an HTML element declared as a polymer component.
|
| Modifier and Type | Method and Description |
|---|---|
Stream<Component> |
PolymerTemplate.getChildren()
Gets the child components of this component.
|
static Optional<Class<? extends Component>> |
TemplateInitializer.getUsesClass(Class<? extends PolymerTemplate<?>> templateType,
String tagName)
Looks for a component class with the given tag name among the classes
used by the given polymer template class.
|
| 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 | Method and Description |
|---|---|
ComponentRenderer<? extends Component,T> |
RadioButtonGroup.getItemRenderer()
Returns the item component renderer.
|
| Modifier and Type | Method and Description |
|---|---|
void |
RadioButtonGroup.setRenderer(ComponentRenderer<? extends Component,T> renderer)
Sets the item renderer for this radio button group.
|
| 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 | Method and Description |
|---|---|
Component |
SplitLayout.getPrimaryComponent()
Get the component currently set to the primary split.
|
Component |
SplitLayout.getSecondaryComponent()
Get the component currently set to the secondary split.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SplitLayout.addToPrimary(Component... components)
Sets the given components to the primary split of this layout, i.e.
|
protected void |
GeneratedVaadinSplitLayout.addToPrimary(Component... components)
Adds the given components as children of this component at the slot
'primary'.
|
void |
SplitLayout.addToSecondary(Component... components)
Sets the given components to the secondary split of this layout, i.e.
|
protected void |
GeneratedVaadinSplitLayout.addToSecondary(Component... components)
Adds the given components as children of this component at the slot
'secondary'.
|
void |
SplitLayout.remove(Component... components) |
protected void |
GeneratedVaadinSplitLayout.remove(Component... components)
Removes the given child components from this component.
|
| Constructor and Description |
|---|
SplitLayout(Component primaryComponent,
Component secondaryComponent)
Constructs a VaadinSplitLayout with the given initial components to set
to the primary and secondary splits.
|
| 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 | Method and Description |
|---|---|
void |
Tabs.add(Component... components) |
void |
Tabs.remove(Component... components)
Removes the given child components from this component.
|
void |
Tabs.replace(Component oldComponent,
Component newComponent)
Replaces the component in the container with another one without changing
position.
|
| Constructor and Description |
|---|
Tab(Component... components)
Constructs a new object with child components.
|
| Modifier and Type | Class and Description |
|---|---|
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 |
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 | Method and Description |
|---|---|
default Component |
HasPrefixAndSuffix.getPrefixComponent()
Gets the component in the prefix slot of this field.
|
default Component |
HasPrefixAndSuffix.getSuffixComponent()
Gets the component in the suffix slot of this field.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
GeneratedVaadinTextField.addToPrefix(Component... components)
Adds the given components as children of this component at the slot
'prefix'.
|
protected void |
GeneratedVaadinTextArea.addToPrefix(Component... components)
Adds the given components as children of this component at the slot
'prefix'.
|
protected void |
GeneratedVaadinTextField.addToSuffix(Component... components)
Adds the given components as children of this component at the slot
'suffix'.
|
protected void |
GeneratedVaadinTextArea.addToSuffix(Component... components)
Adds the given components as children of this component at the slot
'suffix'.
|
protected void |
GeneratedVaadinTextField.remove(Component... components)
Removes the given child components from this component.
|
protected void |
GeneratedVaadinTextArea.remove(Component... components)
Removes the given child components from this component.
|
default void |
HasPrefixAndSuffix.setPrefixComponent(Component component)
Adds the given component into this field before the content, replacing
any existing prefix component.
|
default void |
HasPrefixAndSuffix.setSuffixComponent(Component component)
Adds the given component into this field after the content, replacing any
existing suffix component.
|
| 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 | Method and Description |
|---|---|
Component |
Upload.getDropLabel()
Gets the component set as the drop label, if any.
|
Component |
Upload.getDropLabelIcon()
Gets the component set as the drop label icon, if any.
|
Component |
Upload.getUploadButton()
Gets the component set as the upload button for the upload, if any.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
GeneratedVaadinUpload.addToAddButton(Component... components)
Adds the given components as children of this component at the slot
'add-button'.
|
protected void |
GeneratedVaadinUpload.addToDropLabel(Component... components)
Adds the given components as children of this component at the slot
'drop-label'.
|
protected void |
GeneratedVaadinUpload.addToDropLabelIcon(Component... components)
Adds the given components as children of this component at the slot
'drop-label-icon'.
|
protected void |
GeneratedVaadinUpload.addToFileList(Component... components)
Adds the given components as children of this component at the slot
'file-list'.
|
protected void |
GeneratedVaadinUpload.remove(Component... components)
Removes the given child components from this component.
|
void |
Upload.setDropLabel(Component dropLabel)
Sets the component to show as a message to the user to drop files in the
upload component.
|
void |
Upload.setDropLabelIcon(Component dropLabelIcon)
Sets the component to show as the drop label icon.
|
void |
Upload.setUploadButton(Component uploadButton)
Sets the component as the actionable button inside the upload component,
that starts the upload of the selected files.
|
| Modifier and Type | Method and Description |
|---|---|
Optional<Component> |
ValueContext.getComponent()
Returns an
Optional for the Component related to value
conversion. |
| Modifier and Type | Method and Description |
|---|---|
default void |
HasItemsAndComponents.addComponents(T afterItem,
Component... components)
Adds the components after the given item.
|
default void |
HasItemsAndComponents.prependComponents(T beforeItem,
Component... components)
Adds the components before the given item.
|
| Constructor and Description |
|---|
ValueContext(Component component)
Constructor for
ValueContext. |
ValueContext(Component component,
HasValue<?,?> hasValue)
Constructor for
ValueContext. |
ValueContext(Component component,
HasValue<?,?> hasValue,
Locale locale)
Constructor for
ValueContext. |
| Modifier and Type | Class and Description |
|---|---|
class |
SortEvent<T extends Component,S extends SortOrder<?>>
Event describing a change in sorting of a
DataProvider. |
static interface |
SortEvent.SortNotifier<T extends Component,S extends SortOrder<?>>
The interface for adding and removing listeners for
SortEvents. |
| Modifier and Type | Method and Description |
|---|---|
protected Component |
ComponentDataGenerator.createComponent(T item) |
protected abstract Component |
AbstractComponentDataGenerator.createComponent(T item)
Creates a new component based on the provided item.
|
protected Component |
AbstractComponentDataGenerator.getRenderedComponent(String itemKey) |
| Modifier and Type | Method and Description |
|---|---|
ComponentRenderer<? extends Component,T> |
ComponentDataGenerator.getComponentRenderer() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
AbstractComponentDataGenerator.registerRenderedComponent(String itemKey,
Component component)
Appends the component to the container and registers it for future use
during the lifecycle of the generator.
|
| Constructor and Description |
|---|
ComponentDataGenerator(ComponentRenderer<? extends Component,T> componentRenderer,
ValueProvider<T,String> keyMapper)
Creates a new generator.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ComponentRenderer<COMPONENT extends Component,SOURCE>
Base class for all renderers that support arbitrary
Components. |
| Modifier and Type | Method and Description |
|---|---|
Component |
TextRenderer.createComponent(ITEM item) |
Component |
IconRenderer.createComponent(ITEM item) |
Component |
NativeButtonRenderer.createComponent(SOURCE item) |
Component |
BasicRenderer.createComponent(SOURCE item) |
| Constructor and Description |
|---|
IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator)
Creates a new renderer instance using the default
ItemLabelGenerator: String::valueOf and the provided
iconGenerator. |
IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator,
ItemLabelGenerator<ITEM> itemLabelGenerator)
Creates a new renderer instance using the provided
iconGenerator
and itemLabelGenerator. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
MultiSelect<C extends Component,T>
Multi selection component which allows to select and deselect multiple items.
|
class |
MultiSelectionEvent<C extends Component,T>
Fired when the selection changes in a listing component that supports
multiple item selection.
|
interface |
MultiSelectionListener<C extends Component,T>
A listener for listening for selection changes from a multiselection
component.
|
interface |
SelectionEvent<C extends Component,T>
A selection event that unifies the way to access to selection event for multi
selection and single selection components (in case when only one selected
item is required).
|
interface |
SelectionListener<C extends Component,T>
A listener for
SelectionEvent. |
interface |
SelectionModel<C extends Component,T>
Models the selection logic of a
Listing component. |
static interface |
SelectionModel.Multi<C extends Component,T>
A selection model in which multiple items can be selected at the same
time.
|
static interface |
SelectionModel.Single<C extends Component,T>
A selection model in which at most one item can be selected at a time.
|
interface |
SingleSelect<C extends Component,T>
Single selection component whose selection is treated as a value.
|
class |
SingleSelectionEvent<C extends Component,T>
Fired when the selection changes in a listing component.
|
interface |
SingleSelectionListener<C extends Component,T>
A listener for listening to selection changes on a single selection
component.
|
| Modifier and Type | Method and Description |
|---|---|
default <T extends Component> |
Instantiator.createComponent(Class<T> componentClass)
Creates an instance of a component by its
componentClass. |
| Modifier and Type | Method and Description |
|---|---|
<T extends Component> |
Element.as(Class<T> componentType)
Creates a new component instance using this element.
|
| Modifier and Type | Method and Description |
|---|---|
Optional<Component> |
Element.getComponent()
Gets the component this element has been mapped to, if any.
|
default Optional<Component> |
ElementStateProvider.getComponent(StateNode node)
Gets the component this element is mapped to.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
ElementUtil.setComponent(Element element,
Component component)
Defines a mapping between this element and the given
Component. |
default void |
ElementStateProvider.setComponent(StateNode node,
Component component)
Defines a mapping between the element and the given component.
|
| Modifier and Type | Method and Description |
|---|---|
static List<HtmlImport> |
AnnotationReader.getHtmlImportAnnotations(Class<? extends Component> componentClass)
Finds all
HtmlImport annotations on the given Component
class, its super classes and implemented interfaces. |
static List<JavaScript> |
AnnotationReader.getJavaScriptAnnotations(Class<? extends Component> componentClass)
Finds all
JavaScript annotations on the given Component
class, its super classes and implemented interfaces. |
static List<StyleSheet> |
AnnotationReader.getStyleSheetAnnotations(Class<? extends Component> componentClass)
Finds all
StyleSheet annotations on the given Component
class, its super classes and implemented interfaces. |
| Modifier and Type | Method and Description |
|---|---|
Optional<Component> |
ComponentMapping.getComponent()
Gets the component this node has been mapped to, if any.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ComponentMapping.setComponent(Component component)
Assigns the given component to this node.
|
| 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 |
|---|---|
<T,C extends Component & HasUrlParameter<T>> |
Router.getUrl(Class<? extends C> navigationTarget,
List<T> parameters)
Get the url string for given navigation target with the parameters in the
url.
|
<T,C extends Component & HasUrlParameter<T>> |
Router.getUrl(Class<? extends C> navigationTarget,
T parameter)
Get the url string for given navigation target with the parameter in the
url.
|
<T,C extends Component & HasUrlParameter<T>> |
RouterLink.setRoute(Router router,
Class<? extends C> navigationTarget,
T parameter)
Set the navigation target for this link.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Component> |
RouteData.getNavigationTarget()
Get
Route navigation target. |
Class<? extends Component> |
NavigationState.getNavigationTarget()
Gets the navigation target of this state.
|
| Modifier and Type | Method and Description |
|---|---|
String |
Router.getUrl(Class<? extends Component> navigationTarget)
Get the registered url string for given navigation target.
|
String |
Router.getUrlBase(Class<? extends Component> navigationTarget)
Return the url base without any url parameters.
|
void |
BeforeEvent.rerouteTo(Class<? extends Component> routeTargetType)
Reroutes the navigation to show the given component instead of the
component that is currently about to be displayed.
|
void |
NavigationState.setNavigationTarget(Class<? extends Component> navigationTarget)
Sets the navigation target of this state.
|
void |
RouterLink.setRoute(Router router,
Class<? extends Component> navigationTarget)
Set the navigation target for this link.
|
NavigationStateBuilder |
NavigationStateBuilder.withTarget(Class<? extends Component> navigationTarget)
Assigns the given navigation target to the navigation state being built.
|
NavigationStateBuilder |
NavigationStateBuilder.withTarget(Class<? extends Component> navigationTarget,
List<String> urlParameters)
Assigns the given navigation target with the given url parameter to the
navigation state being built.
|
| Constructor and Description |
|---|
RouteData(Class<? extends RouterLayout> parentLayout,
String url,
List<Class<?>> parameters,
Class<? extends Component> navigationTarget)
RouteData constructor.
|
RouterLink(Router router,
String text,
Class<? extends Component> navigationTarget)
Creates a new router link for the given navigation target using the given
text.
|
RouterLink(String text,
Class<? extends Component> navigationTarget)
Creates a new router link for the given navigation target using the given
text.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
NavigationStateRenderer.notifyNavigationTarget(Component componentInstance,
NavigationEvent navigationEvent,
BeforeEnterEvent beforeEnterEvent,
LocationChangeEvent locationChangeEvent) |
protected void |
ErrorStateRenderer.notifyNavigationTarget(Component componentInstance,
NavigationEvent navigationEvent,
BeforeEnterEvent beforeEnterEvent,
LocationChangeEvent locationChangeEvent) |
protected abstract void |
AbstractNavigationStateRenderer.notifyNavigationTarget(Component componentInstance,
NavigationEvent navigationEvent,
BeforeEnterEvent beforeEnterEvent,
LocationChangeEvent locationChangeEvent)
Notified the navigation target about the status of the navigation.
|
static void |
RouterUtil.updatePageTitle(NavigationEvent navigationEvent,
Component routeTarget)
Updates the page title according to the currently visible component.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
RouterUtil.checkForDuplicates(Class<? extends Component> routeTargetType,
Collection<Class<? extends RouterLayout>> routeLayoutTypes)
Checks that the same component type is not used in multiple parts of a
route chain.
|
protected List<Class<? extends RouterLayout>> |
NavigationStateRenderer.getRouterLayoutTypes(Class<? extends Component> targetType) |
List<Class<? extends RouterLayout>> |
ErrorStateRenderer.getRouterLayoutTypes(Class<? extends Component> targetType)
Gets the router layout types to show for the given route target type,
starting from the parent layout immediately wrapping the route target
type.
|
protected abstract List<Class<? extends RouterLayout>> |
AbstractNavigationStateRenderer.getRouterLayoutTypes(Class<? extends Component> routeTargetType)
Gets the router layout types to show for the given route target type,
starting from the parent layout immediately wrapping the route target
type.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends Component> |
RouteRegistry.ErrorTargetEntry.getNavigationTarget()
Gets the navigation target type.
|
Optional<Class<? extends Component>> |
RouteRegistry.getNavigationTarget(String pathString)
Gets the optional navigation target class for a given Location.
|
Optional<Class<? extends Component>> |
RouteRegistry.getNavigationTarget(String pathString,
List<String> segments)
Gets the optional navigation target class for a given Location matching
with path segments.
|
Class<? extends Component> |
RouteTarget.getTarget(List<String> segments)
Get route target for given segments.
|
protected Set<Class<? extends Component>> |
AbstractRouteRegistryInitializer.validateRouteClasses(Stream<Class<?>> routeClasses)
Validate the potential route classes stream and return them as a set.
|
| Modifier and Type | Method and Description |
|---|---|
void |
RouteTarget.addRoute(Class<? extends Component> target)
Add a new route navigation target.
|
Optional<String> |
RouteRegistry.getTargetUrl(Class<? extends Component> navigationTarget)
Get the url string for given navigation target.
|
void |
RouteRegistry.setErrorNavigationTargets(Set<Class<? extends Component>> errorNavigationTargets)
Set error handler navigation targets.
|
void |
RouteRegistry.setNavigationTargets(Set<Class<? extends Component>> navigationTargets)
Registers a set of components as navigation targets.
|
boolean |
NavigationTargetFilter.testNavigationTarget(Class<? extends Component> navigationTarget)
Tests whether the given navigation target class should be included.
|
| Constructor and Description |
|---|
ErrorTargetEntry(Class<? extends Component> navigationTarget,
Class<? extends Exception> handledExceptionType)
Creates a new new entry with the given navigation target type and
exception type.
|
RouteTarget(Class<? extends Component> target)
Create a new Route target holder.
|
Copyright © 2018. All rights reserved.