We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.
Package com.vaadin.flow.component
-
Interface Summary Interface Description AttachNotifier Mixin interface for components that support adding attach listeners.
BlurNotifier<T extends Component> Mixin interface to handle blur events on components.
ClickNotifier<T extends Component> Mixin interface for components that support adding click listeners to the their root elements.
ComponentEventListener<T extends ComponentEvent<?>> Generic listener for component events.
CompositionNotifier Mixin interface for components that support adding composition listeners to the their root elements.
DetachNotifier Mixin interface for components that support adding detach listeners.
Focusable<T extends Component> Represents a component that can gain and lose focus.
FocusNotifier<T extends Component> Mixin interface to handle focus events on components.
HasAriaLabel A generic interface for components and other user interface objects that may have an aria-label property to set the accessible name of the component.
HasComponents A component to which the user can add and remove child components.
HasElement Marker interface for any class which is based on an
Element.HasEnabled A generic interface for components and other user interface objects that may be enabled or disabled.
HasHelper Mixin interface for field components that have helper text as property and slots for inserting components.
HasLabel A component that supports label definition.
HasOrderedComponents A component which the children components are ordered, so the index of each child matters for the layout.
HasSize Any component implementing this interface supports setting the size of the component using
HasSize.setWidth(String)andHasSize.setHeight(String).HasStyle Represents
Componentwhich has class attribute and inline styles.HasText A component that supports text content.
HasTheme Represents
Componentwhich has theme attribute.HasValidation A component that supports input validation.
HasValue<E extends HasValue.ValueChangeEvent<V>,V> A generic interface for field components and other user interface objects that have a user-editable value.
HasValue.ValueChangeEvent<V> An event fired when the value of a
HasValuechanges.HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>> A listener for value change events.
HasValueAndElement<E extends HasValue.ValueChangeEvent<V>,V> A component that has a value.
HeartbeatListener Listener for listening to the heartbeat of the application.
InputNotifier Mixin interface for components that support adding input listeners to the their root elements.
ItemLabelGenerator<T> ItemLabelGeneratorcan be used to customize the string shown to the user for an item.JsonSerializable Base interface for classes that are serializable to and from
JsonObject.Key An interface to represent keyboard keys.
KeyNotifier Mixin interface for components that support adding key event listeners to the their root elements.
PollNotifier The interface for adding and removing
PollEventlisteners.PropertyDescriptor<S,G> Describes a component property that has its value stored in some form in the component's element, typically an element property or attribute.
PushConfiguration Provides method for configuring the push channel.
ReconnectDialogConfiguration Provides methods for configuring the reconnect dialog.
ShortcutEventListener Listener for shortcut events.
WebComponentExporterFactory<C extends Component> Exports a
Componentas a web component. -
Class Summary Class Description AbstractCompositeField<C extends Component,S extends AbstractCompositeField<C,S,T>,T> An abstract field class that is backed by a composite component.
AbstractField<C extends AbstractField<C,T>,T> An abstract implementation of a field, or a
Componentallowing user input.AbstractField.ComponentValueChangeEvent<C extends Component,V> Value change event fired by components.
AbstractSinglePropertyField<C extends AbstractField<C,T>,T> Abstract field that is based on a single element property.
AttachEvent Event fired after a
Componentis attached to the UI.BlurNotifier.BlurEvent<C extends Component> Represents the DOM event "blur".
ClickEvent<C extends Component> Event fired when a component is clicked.
Component A Component is a higher level abstraction of an
Elementor a hierarchy ofElements.ComponentEvent<T extends Component> An event whose source is a
Component.ComponentEventBus An event bus for
Components.ComponentEventBusUtil Static helpers and caching functionality for
ComponentEventBus.ComponentUtil Utility methods for
Component.Composite<T extends Component> A composite encapsulates a
Componenttree to allow creation of new components by composing existing components.CompositionEndEvent The event when a composition is ended.
CompositionStartEvent The event when a composition is started.
CompositionUpdateEvent The event when a composition is updated.
DetachEvent Event fired before a
Componentis detached from the UI.FocusNotifier.FocusEvent<C extends Component> Represents the DOM event "focus".
HeartbeatEvent Event created for an application heartbeat from the client.
Html A component which encapsulates a given HTML fragment with a single root element.
HtmlComponent Base class for a
Componentthat represents a single built-in HTML element.HtmlContainer Base class for a
Componentthat represents a single built-in HTML element that can contain child components or text.InputEvent Event fired when the component has received any type of input (e.g.
KeyDownEvent The event when a key is pressed.
KeyEventListener<E extends KeyboardEvent> A conditional event listener for
KeyboardEvents.KeyPressEvent The event when a key is pressed.
KeyUpEvent The event when a key is released.
PollEvent An event that is fired whenever a client polls the server for asynchronous UI updates.
PropertyDescriptors Factory methods for creating
PropertyDescriptorinstances.ShortcutEvent Event when shortcut is detected.
ShortcutRegistration A registration object for both configuring and removing the registered keyboard shortcut.
Shortcuts Collections of methods for configuring more complex Shortcut interactions.
Text A component which encapsulates the given text in a text node.
UI The topmost component in any component hierarchy.
WebComponentExporter<C extends Component> Exports a
Componentas a web component.WebComponentExporter.WebComponentConfigurationFactory Produces
WebComponentConfigurationinstances from eitherWebComponentExporterclasses or instances.WebComponentExporterFactory.DefaultWebComponentExporterFactory<C extends Component> Default factory implementation which uses an exporter class to instantiate it using its default constructor.
-
Enum Summary Enum Description Direction Specifies the direction of the text and other content inside of an element.
HasText.WhiteSpace Represents
"white-space"style values.KeyLocation Possible keyboard key locations.
KeyModifier Modifier keys.
Unit Enum of supported units in Css sizes.
-
Exception Summary Exception Description UIDetachedException Exception thrown if the UI has been detached when it should not be.
-
Annotation Types Summary Annotation Type Description ClientCallable Publishes the annotated method so it can be invoked from the client side using the notation
this.$server.method().DebounceSettings Debounce settings for declaratively defined client-side event handlers.
DomEvent Maps a DOM event to a
ComponentEvent.EventData Maps data from a DOM event to a
ComponentEvent.NotSupported Methods annotated with
NotSupportedare mapped to the original webcomponent implementation, but not supported at Java level.Synchronize Annotates getters for which properties should be synchronized to the server.
Tag Defines the tag to use for the root element for a component created using the default
Componentconstructor.