| Modifier and Type | Interface and Description |
|---|---|
interface |
HasDataProvider<T>
A generic interface for listing components that use a data provider for
showing data.
|
interface |
HasFilterableDataProvider<T,F>
A generic interface for listing components that use a filterable data
provider for showing data.
|
interface |
HasHierarchicalDataProvider<T>
A generic interface for hierarchical listing components that use a data
provider for showing data.
|
interface |
HasItems<T>
A component that displays a collection of items.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DataCommunicator<T>
DataProvider base class.
|
class |
HierarchicalDataCommunicator<T>
Data communicator that handles requesting hierarchical data from
HierarchicalDataProvider and sending it to client side. |
| Modifier and Type | Method and Description |
|---|---|
ClientConnector |
ConnectorEvent.getConnector()
Returns the connector that fired the event.
|
| Constructor and Description |
|---|
ConnectorActionManager(ClientConnector connector)
Initialize an action manager for the given connector.
|
ConnectorActionManager(ClientConnector connector,
T viewer)
Initialize an action manager for the given connector using the given
viewer.
|
ConnectorEvent(ClientConnector source)
Creates a new event fired by the given source.
|
MarkedAsDirtyConnectorEvent(ClientConnector source,
UI ui) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
DragSource
Deprecated.
Replaced in 8.1 by
DragSourceExtension |
interface |
DropTarget
Deprecated.
Replaced in 8.1 by
DropTargetExtension. |
| Modifier and Type | Class and Description |
|---|---|
static class |
Navigator.EmptyView
Empty view component.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
Extension
An extension is an entity that is attached to a Component or another
Extension and independently communicates between client and server.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractClientConnector
An abstract base class for ClientConnector implementations.
|
class |
AbstractExtension
An extension is an entity that is attached to a Component or another
Extension and independently communicates between client and server.
|
class |
AbstractJavaScriptExtension
Base class for Extensions with all client-side logic implemented using
JavaScript.
|
class |
BrowserWindowOpener
Component extension that opens a browser popup window when the extended
component is clicked.
|
class |
DragAndDropService
Deprecated.
Since 8.1, no direct replacement, see
DragSourceExtension
and DropTargetExtension. |
class |
FileDownloader
Extension that starts a download when the extended component is clicked.
|
class |
Responsive
An extension providing responsive layout capabilities to any Vaadin
component.
|
| Modifier and Type | Method and Description |
|---|---|
ClientConnector |
ConnectorIdGenerationEvent.getConnector()
Gets the connector that should get an id.
|
ClientConnector |
ClientMethodInvocation.getConnector() |
ClientConnector |
LegacyCommunicationManager.getConnector(UI uI,
String connectorId)
Deprecated.
As of 7.1. In 7.2 and later, use
uI.getConnectorTracker().getConnector(connectorId) instead.
See ticket #11411. |
ClientConnector |
DragAndDropService.getParent()
Deprecated.
|
ClientConnector |
ClientConnector.getParent() |
ClientConnector |
AbstractExtension.getParent() |
| Modifier and Type | Method and Description |
|---|---|
static Iterable<? extends ClientConnector> |
AbstractClientConnector.getAllChildrenIterable(ClientConnector connector)
Get an Iterable for iterating over all child connectors, including both
extensions and child components.
|
protected Class<? extends ClientConnector> |
AbstractExtension.getSupportedParentType()
Gets a type that the parent must be an instance of.
|
Collection<Class<? extends ClientConnector>> |
JsonPaintTarget.getUsedClientConnectors() |
| Modifier and Type | Method and Description |
|---|---|
static void |
ServerRpcManager.applyInvocation(ClientConnector target,
ServerRpcMethodInvocation invocation)
Invoke a method in a server side RPC target class.
|
static ResourceReference |
ResourceReference.create(Resource resource,
ClientConnector connector,
String key) |
String |
VaadinSession.createConnectorId(ClientConnector connector)
Deprecated.
As of 7.0. Use
VaadinService.generateConnectorId(VaadinSession, ClientConnector)
instead. |
static JsonObject |
LegacyCommunicationManager.encodeState(ClientConnector connector,
SharedState state)
Deprecated.
As of 7.1. See #11411.
|
static ErrorHandler |
ErrorEvent.findErrorHandler(ClientConnector connector)
Method for finding the error handler for the given connector.
|
String |
VaadinService.generateConnectorId(VaadinSession session,
ClientConnector connector)
Generates a unique id to use for a newly attached connector.
|
static Iterable<? extends ClientConnector> |
AbstractClientConnector.getAllChildrenIterable(ClientConnector connector)
Get an Iterable for iterating over all child connectors, including both
extensions and child components.
|
static <T extends ServerRpc> |
ServerRpcManager.getRpcProxy(ClientConnector connector,
Class<T> rpcInterface)
Returns an RPC proxy for a given client to server RPC interface for the
given component or extension.
|
String |
LegacyCommunicationManager.getStreamVariableTargetUrl(ClientConnector owner,
String name,
StreamVariable value)
Deprecated.
As of 7.1. See #11411.
|
String |
PaintTarget.getTag(ClientConnector paintable) |
String |
JsonPaintTarget.getTag(ClientConnector clientConnector) |
String |
GlobalResourceHandler.getUri(ClientConnector connector,
ConnectorResource resource)
Gets a global URI for a resource if it's registered with this handler.
|
void |
LegacyCommunicationManager.handleConnectorRelatedException(ClientConnector connector,
Throwable throwable)
Deprecated.
As of 7.1. See #11411.
|
static boolean |
LegacyCommunicationManager.isConnectorVisibleToClient(ClientConnector connector)
Deprecated.
As of 7.1. See #11411.
|
void |
GlobalResourceHandler.register(Resource resource,
ClientConnector ownerConnector)
Registers a resource to be served with a global URL.
|
void |
Extension.setParent(ClientConnector parent)
Sets the parent connector of the connector.
|
void |
AbstractExtension.setParent(ClientConnector parent) |
void |
GlobalResourceHandler.unregisterConnector(ClientConnector connector)
Notifies this handler that resources registered for the given connector
can be released.
|
| Modifier and Type | Method and Description |
|---|---|
String |
LegacyCommunicationManager.getTagForType(Class<? extends ClientConnector> class1)
Deprecated.
As of 7.1. Will be removed in the future.
|
| Constructor and Description |
|---|
AttachEvent(ClientConnector source) |
ClientMethodInvocation(ClientConnector connector,
String interfaceName,
Method method,
Object[] parameters) |
ConnectorIdGenerationEvent(VaadinSession session,
ClientConnector connector)
Creates a new event for the given session and connector.
|
DetachEvent(ClientConnector source) |
ResourceReference(Resource resource,
ClientConnector connector,
String key) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
FileUploadHandler.doHandleSimpleMultipartFileUpload(VaadinSession session,
VaadinRequest request,
VaadinResponse response,
StreamVariable streamVariable,
String variableName,
ClientConnector owner,
String boundary)
Method used to stream content from a multipart request (either from
servlet or portlet request) to given StreamVariable.
|
protected void |
FileUploadHandler.doHandleXhrFilePost(VaadinSession session,
VaadinRequest request,
VaadinResponse response,
StreamVariable streamVariable,
String variableName,
ClientConnector owner,
long contentLength)
Used to stream plain file post (aka XHR2.post(File))
|
static String |
ServerRpcHandler.getIgnoredDisabledError(String what,
ClientConnector connector)
Generates an error message when the client is trying to to something
('what') with a connector which is disabled or invisible.
|
protected void |
ServerRpcHandler.handleInvocation(UI ui,
ClientConnector connector,
LegacyChangeVariablesInvocation legacyInvocation)
Handles the given Legacy variable change RPC method invocation for the
given connector.
|
protected void |
ServerRpcHandler.handleInvocation(UI ui,
ClientConnector connector,
ServerRpcMethodInvocation invocation)
Handles the given RPC method invocation for the given connector.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
Component
Component is the top-level interface that is and must be implemented
by all Vaadin components. |
static interface |
Component.Focusable
A sub-interface implemented by components that can obtain input focus.
|
interface |
ComponentContainer
A special type of parent which allows the user to add and remove components
to it.
|
interface |
HasChildMeasurementHint
Component with layout measuring hint.
|
interface |
HasComponents
|
interface |
HasValueChangeMode
Implemented by components which support value change modes.
|
interface |
Layout
Extension to the
ComponentContainer interface which adds the
layouting control to the elements in the container. |
interface |
LegacyComponent
Deprecated.
As of 7.0. This class is only intended to ease migration and
should not be used for new projects.
|
interface |
SelectiveRenderer
Interface implemented by
HasComponents implementors that wish to
dynamically be able to prevent given child components from reaching the
client side. |
interface |
SingleComponentContainer
Interface for component containers that have one child component and do not
support adding or removing components.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbsoluteLayout
AbsoluteLayout is a layout implementation that mimics html absolute
positioning.
|
class |
AbstractColorPicker
An abstract class that defines default implementation for a color picker
component.
|
class |
AbstractComponent
An abstract class that defines default implementation for the
Component interface. |
class |
AbstractComponentContainer
Extension to
AbstractComponent that defines the default
implementation for the methods in ComponentContainer. |
class |
AbstractDateField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>,R extends Enum<R>>
A date editor component with
LocalDate as an input value. |
class |
AbstractEmbedded
Abstract base for embedding components.
|
class |
AbstractField<T>
An abstract implementation of a field, or a
Component allowing user
input. |
class |
AbstractFocusable
An abstract base class for focusable components.
|
class |
AbstractJavaScriptComponent
Base class for Components with all client-side logic implemented using
JavaScript.
|
class |
AbstractLayout
An abstract class that defines default implementation for the
Layout
interface. |
class |
AbstractListing<T>
A base class for listing components.
|
static class |
AbstractListing.AbstractListingExtension<T>
A helper base class for creating extensions for Listing components.
|
class |
AbstractLocalDateField
Abstract DateField class for
LocalDate type. |
class |
AbstractLocalDateTimeField
Abstract DateField class for
LocalDateTime type. |
class |
AbstractMedia
Abstract base class for the HTML5 media components.
|
class |
AbstractMultiSelect<T>
Base class for listing components that allow selecting multiple items.
|
class |
AbstractOrderedLayout |
class |
AbstractSingleComponentContainer
Abstract base class for component containers that have only one child
component.
|
class |
AbstractSingleSelect<T>
An abstract base class for listing components that only support single
selection and no lazy loading of data items.
|
class |
AbstractSplitPanel
AbstractSplitPanel.
|
class |
AbstractTextField
Abstract base class for text input components.
|
class |
Accordion
An accordion is a component similar to a
TabSheet, but with a
vertical orientation and the selected component presented between tabs. |
class |
Audio
The Audio component translates into an HTML5 <audio> element and as
such is only supported in browsers that support HTML5 media markup.
|
class |
BrowserFrame
A component displaying an embedded web page.
|
class |
Button
A generic button component.
|
class |
CheckBox |
class |
CheckBoxGroup<T>
A group of Checkboxes.
|
class |
ColorPicker
A class that defines default (button-like) implementation for a color picker
component.
|
class |
ColorPickerArea
A class that defines area-like implementation for a color picker component.
|
class |
ComboBox<T>
A filtering dropdown single-select.
|
class |
Composite
Composite allows creating new UI components by composition of existing
server-side components.
|
class |
CssLayout
CssLayout is a layout component that can be used in browser environment only.
|
class |
CustomComponent
Custom component provides a simple implementation of the
Component
interface to allow creating new UI components by composition of existing
server-side components. |
class |
CustomField<T>
A
HasValue whose UI content can be constructed by the user, enabling
the creation of e.g. |
class |
CustomLayout
A container component with freely designed layout and style.
|
class |
DateField
A date entry component, which displays the actual date selector as a popup.
|
class |
DateTimeField
A date time entry component, which displays the actual date selector as a
popup.
|
class |
DragAndDropWrapper
Deprecated.
Replaced in 8.1 with
DragSourceExtension and
DropTargetExtension. |
class |
Embedded
A component for embedding external objects.
|
class |
Flash
A component for displaying Adobe® Flash® content.
|
class |
FormLayout
FormLayout is used to layout fields.
|
class |
Grid<T>
A grid component for displaying tabular data.
|
static class |
Grid.AbstractGridExtension<T>
A helper base class for creating extensions for the Grid component.
|
static class |
Grid.Column<T,V>
This extension manages the configuration and data communication for a
Column inside of a Grid component.
|
static class |
Grid.DetailsManager<T>
Class for managing visible details rows.
|
class |
GridLayout
A layout where the components are laid out on a grid using cell coordinates.
|
class |
HorizontalLayout
Horizontal layout
HorizontalLayout is a component container, which shows the
subcomponents in the order of their addition (horizontally). |
class |
HorizontalSplitPanel
A horizontal split panel contains two components and lays them horizontally.
|
class |
Image
Component for embedding images.
|
class |
InlineDateField
A date entry component, which displays the actual date selector inline.
|
class |
InlineDateTimeField
A date time entry component, which displays the actual date selector inline.
|
class |
JavaScript
Provides access to JavaScript functionality in the web browser.
|
class |
Label
Label component for showing non-editable short texts.
|
class |
LegacyWindow
Deprecated.
|
class |
Link
Link is used to create external or internal URL links.
|
class |
ListSelect<T>
This is a simple list select without, for instance, support for new items,
lazyloading, and other advanced features.
|
class |
LoginForm
Login form with auto-completion and auto-fill for all major browsers.
|
class |
MenuBar
A class representing a horizontal menu bar.
|
class |
NativeButton |
class |
NativeSelect<T>
A simple drop-down select component.
|
class |
Notification
A notification message, used to display temporary messages to the user - for
example "Document saved", or "Save failed".
|
class |
Panel
Panel - a simple single component container.
|
class |
PasswordField
A field that is used to enter secret text information like passwords.
|
class |
PopupView
A component for displaying a two different views to data.
|
class |
ProgressBar
A component for displaying progress.
|
class |
RadioButtonGroup<T>
A group of RadioButtons.
|
class |
RichTextArea
A simple RichTextArea to edit HTML format text.
|
class |
Slider
A component for selecting a numerical value within a range.
|
class |
TabSheet
TabSheet component.
|
class |
TextArea
A text field that supports multi line editing.
|
class |
TextField
A component for editing textual data that fits on a single line.
|
class |
Tree<T>
Tree component.
|
static class |
Tree.TreeMultiSelectionModel<T>
Custom MultiSelectionModel for Tree.
|
class |
Tree.TreeRenderer
String renderer that handles icon resources and stores their identifiers
into data objects.
|
class |
TreeGrid<T>
A grid component for displaying hierarchical tabular data.
|
class |
TwinColSelect<T>
Multiselect component with two lists: left side for available items and right
side for selected items.
|
class |
UI
The topmost component in any component hierarchy.
|
class |
Upload
Component for uploading files from client to server.
|
class |
VerticalLayout
Vertical layout
VerticalLayout is a component container, which shows the
subcomponents in the order of their addition (vertically). |
class |
VerticalSplitPanel
A vertical split panel contains two components and lays them vertically.
|
class |
Video
The Video component translates into an HTML5 <video> element and as
such is only supported in browsers that support HTML5 media markup.
|
class |
Window
A component that represents a floating popup window that can be added to a
UI. |
| Modifier and Type | Method and Description |
|---|---|
ClientConnector |
ConnectorTracker.getConnector(String connectorId)
Gets a connector by its id.
|
| Modifier and Type | Method and Description |
|---|---|
Collection<ClientConnector> |
ConnectorTracker.getDirtyConnectors()
Returns a collection of all connectors which have been marked as dirty.
|
ArrayList<ClientConnector> |
ConnectorTracker.getDirtyVisibleConnectors()
Returns a collection of those
dirty
connectors that are actually visible to the client. |
| Modifier and Type | Method and Description |
|---|---|
JsonObject |
ConnectorTracker.getDiffState(ClientConnector connector) |
boolean |
ConnectorTracker.isClientSideInitialized(ClientConnector connector)
Checks whether the given connector has already been initialized in the
browser.
|
boolean |
ConnectorTracker.isDirty(ClientConnector connector) |
void |
ConnectorTracker.markClean(ClientConnector connector)
Mark the connector as clean.
|
void |
ConnectorTracker.markClientSideInitialized(ClientConnector connector)
Marks the given connector as initialized, meaning that the client-side
state has been initialized for the connector.
|
void |
ConnectorTracker.markDirty(ClientConnector connector)
Mark the connector as dirty and notifies any marked as dirty listeners.
|
void |
ConnectorTracker.notifyMarkedAsDirtyListeners(ClientConnector connector)
Notify all registered MarkedAsDirtyListeners the given client connector
has been marked as dirty.
|
void |
ConnectorTracker.registerConnector(ClientConnector connector)
Register the given connector.
|
void |
ConnectorTracker.setDiffState(ClientConnector connector,
JsonObject diffState) |
void |
ConnectorTracker.unregisterConnector(ClientConnector connector)
Unregister the given connector.
|
| Modifier and Type | Method and Description |
|---|---|
static List<Dependency> |
Dependency.findDependencies(List<Class<? extends ClientConnector>> connectorTypes,
LegacyCommunicationManager manager,
DependencyFilter.FilterContext context)
Finds all the URLs defined for the given classes, registers the URLs to
the communication manager, passes the registered dependencies through any
defined filters and returns the filtered collection of dependencies to
load.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ColorPickerGradient
A component that represents a color gradient within a color picker.
|
class |
ColorPickerGrid
A component that represents a color selection grid within a color picker.
|
class |
ColorPickerHistory
A component that represents color selection history within a color picker.
|
class |
ColorPickerPopup
A component that represents color selection popup within a color picker.
|
class |
ColorPickerPreview
A component that represents color selection preview within a color picker.
|
class |
ColorPickerSelect
A component that represents color selection swatches within a color picker.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
GridSelectionModel<T>
The server-side interface that controls Grid's selection state.
|
interface |
MultiSelectionModel<T>
Multiselection model interface for Grid.
|
interface |
SingleSelectionModel<T>
Single selection model interface for Grid.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractSelectionModel<T>
Abstract selection model for grid.
|
class |
EditorImpl<T>
Implementation of
Editor interface. |
class |
GridDragSource<T>
Makes a Grid's rows draggable for HTML5 drag and drop functionality.
|
class |
GridDropTarget<T>
Makes the rows of a Grid HTML5 drop targets.
|
class |
MultiSelectionModelImpl<T>
Multiselection model for grid.
|
class |
NoSelectionModel<T>
Selection model that doesn't allow selecting anything from the grid.
|
class |
SingleSelectionModelImpl<T>
Single selection model for grid.
|
class |
TreeGridDragSource<T>
Makes a TreeGrid's rows draggable for HTML5 drag and drop functionality.
|
class |
TreeGridDropTarget<T>
Makes the rows of a TreeGrid HTML5 drop targets.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DragSourceExtension<T extends AbstractComponent>
Extension to make a component drag source for HTML5 drag and drop
functionality.
|
class |
DropTargetExtension<T extends AbstractComponent>
Extension to make a component a drop target for HTML5 drag and drop
functionality.
|
class |
FileDropTarget<T extends AbstractComponent>
Extension to add drop target functionality to a widget for accepting and
uploading files.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
Renderer<T>
A ClientConnector for controlling client-side
Grid renderers. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractJavaScriptRenderer<T,V>
Base class for Renderers with all client-side logic implemented using
JavaScript.
|
class |
AbstractRenderer<T,V>
An abstract base class for server-side
Grid renderers. |
class |
ButtonRenderer<T>
A Renderer that displays a button with a textual caption.
|
class |
ClickableRenderer<T,V>
An abstract superclass for
Renderers that render clickable items. |
class |
ComponentRenderer
A renderer for presenting Components.
|
class |
DateRenderer
A renderer for presenting date values.
|
class |
HtmlRenderer
A renderer for presenting HTML content.
|
class |
ImageRenderer<T>
A renderer for presenting images.
|
class |
LocalDateRenderer
A renderer for presenting date values.
|
class |
LocalDateTimeRenderer
A renderer for presenting
LocalDateTime objects. |
class |
NumberRenderer
A renderer for presenting number values.
|
class |
ProgressBarRenderer
A renderer that represents double values between 0 and 1 as a graphical
progress bar.
|
class |
TextRenderer
A renderer for presenting a plain text representation of any value.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Renderer.setParent(ClientConnector parent)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static String |
ConnectorHelper.getDebugInformation(ClientConnector connector)
Creates a string containing debug info for the connector.
|
static void |
ConnectorHelper.writeHierarchyInformation(ClientConnector connector,
StringBuilder builder)
Creates a string containing hierarchy information for the connector.
|
Copyright © 2019 Vaadin Ltd. All rights reserved.