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.ui.
Package com.vaadin.ui
-
Interface Summary Interface Description AbstractColorPicker.Coordinates2Color Interface for converting 2d-coordinates to a Color
AbstractSelect.Filtering Interface for option filtering, used to filter options based on user entered value.
AbstractSelect.ItemDescriptionGenerator Implement this interface and pass it to Tree.setItemDescriptionGenerator or Table.setItemDescriptionGenerator to generate mouse over descriptions ("tooltips") for the rows and cells in Table or for the items in Tree.
AbstractSelect.NewItemHandler AbstractSplitPanel.SplitPositionChangeListener Interface for listening for
AbstractSplitPanel.SplitPositionChangeEvents fired by a SplitPanel.AbstractSplitPanel.SplitterClickListener SplitterClickListenerinterface for listening forSplitterClickEventfired by aSplitPanel.Button.ClickListener Interface for listening for a
Button.ClickEventfired by aComponent.ComboBox.ItemStyleGenerator ItemStyleGenerator can be used to add custom styles to combo box items shown in the popup.
Component Componentis the top-level interface that is and must be implemented by all Vaadin components.Component.Focusable A sub-interface implemented by components that can obtain input focus.
Component.Listener Listener interface for receiving
Component.Events.ComponentContainer A special type of parent which allows the user to add and remove components to it.
Field<T> Field interface is implemented by all classes (field components) that have a value that the user can change through the user interface.
FormFieldFactory Deprecated As of 7.0, use
FieldGroupinstead ofFormfor more flexibility.Grid.CellDescriptionGenerator A callback interface for generating optional descriptions (tooltips) for Grid cells.
Grid.CellStyleGenerator A callback interface for generating custom style names for Grid cells.
Grid.ColumnReorderListener An event listener for column reorder events in the Grid.
Grid.ColumnResizeListener An event listener for column resize events in the Grid.
Grid.ColumnVisibilityChangeListener An event listener for column visibility change events in the Grid.
Grid.DetailsGenerator A callback interface for generating details for a particular row in Grid.
Grid.EditorErrorHandler Error handler for the editor
Grid.EditorListener Interface for an editor event listener
Grid.RowDescriptionGenerator A callback interface for generating optional descriptions (tooltips) for Grid rows.
Grid.RowStyleGenerator A callback interface for generating custom style names for Grid rows.
Grid.SelectionModel The server-side interface that controls Grid's selection state.
Grid.SelectionModel.HasUserSelectionAllowed Interface implemented by selection models which support disabling client side selection while still allowing programmatic selection on the server.
Grid.SelectionModel.Multi A SelectionModel that supports multiple selections to be made.
Grid.SelectionModel.None A SelectionModel that does not allow for rows to be selected.
Grid.SelectionModel.Single A SelectionModel that supports for only single rows to be selected at a time.
HasChildMeasurementHint Component with layout measuring hint.
HasComponents Interface that must be implemented by all
Components that contain otherComponents.HasComponents.ComponentAttachDetachNotifier Interface for
HasComponentsimplementations that support sending attach and detach events for components.HasComponents.ComponentAttachListener Component attach listener interface.
HasComponents.ComponentDetachListener Component detach listener interface.
JavaScript.JavaScriptCallbackRpc JavaScriptFunction Defines a method that is called by a client-side JavaScript function.
Layout Extension to the
ComponentContainerinterface which adds the layouting control to the elements in the container.Layout.AlignmentHandler AlignmentHandler is most commonly an advanced
Layoutthat can align its components.Layout.MarginHandler This type of layout supports automatic addition of margins (space around its components).
Layout.SpacingHandler This type of layout supports automatic addition of space between its components.
LegacyComponent Deprecated As of 7.0.
LoadingIndicatorConfiguration Provides method for configuring the loading indicator.
LoginForm.LoginListener Login listener is a class capable to listen LoginEvents sent from LoginBox
MenuBar.Command This interface contains the layer for menu commands of the
MenuBarclass.NotificationConfiguration Provides methods for configuring the notification.
PopupView.Content Used to deliver customized content-packages to the PopupView.
PopupView.PopupVisibilityListener Defines a listener that can receive a PopupVisibilityEvent when the visibility of the popup changes.
PushConfiguration Provides method for configuring the push channel.
ReconnectDialogConfiguration Provides method for configuring the reconnect dialog.
SelectiveRenderer Interface implemented by
HasComponentsimplementors that wish to dynamically be able to prevent given child components from reaching the client side.SingleComponentContainer Interface for component containers that have one child component and do not support adding or removing components.
Table.CellStyleGenerator Allow to define specific style on cells (and rows) contents.
Table.ColumnCollapseListener Interface for listening to column collapse events.
Table.ColumnGenerator Used to create "generated columns"; columns that exist only in the Table, not in the underlying Container.
Table.ColumnReorderListener Interface for listening to column reorder events.
Table.ColumnResizeListener Interface for listening to column resize events.
Table.FooterClickListener Interface for the listener for column footer mouse click events.
Table.HeaderClickListener Interface for the listener for column header mouse click events.
Table.RowGenerator Row generators can be used to replace certain items in a table with a generated string.
TableFieldFactory Factory interface for creating new Field-instances based on Container (datasource), item id, property id and uiContext (the component responsible for displaying fields).
TabSheet.CloseHandler CloseHandler is used to process tab closing events.
TabSheet.SelectedTabChangeListener Selected tab change event listener.
TabSheet.Tab Tab meta-data for a component in a
TabSheet.TooltipConfiguration Provides method for configuring the tooltip.
Tree.CollapseListener Collapse event listener.
Tree.ExpandListener Expand event listener.
Tree.ItemStyleGenerator ItemStyleGenerator can be used to add custom styles to tree items.
Upload.ChangeListener Listener for
Upload.ChangeEventUpload.FailedListener Receives events when the uploads are finished, but unsuccessful.
Upload.FinishedListener Receives the events when the uploads are ready.
Upload.ProgressListener ProgressListener receives events to track progress of upload.
Upload.Receiver Interface that must be implemented by the upload receivers to provide the Upload component an output stream to write the uploaded data.
Upload.StartedListener Receives the events when the upload starts.
Upload.SucceededListener Receives events when the uploads are successfully finished.
Window.CloseListener An interface used for listening to Window close events.
Window.ResizeListener Listener for window resize events.
Window.WindowModeChangeListener An interface used for listening to Window maximize / restore events.
-
Class Summary Class Description AbsoluteLayout AbsoluteLayout is a layout implementation that mimics html absolute positioning.
AbstractColorPicker An abstract class that defines default implementation for a color picker component.
AbstractComponent An abstract class that defines default implementation for the
Componentinterface.AbstractComponentContainer Extension to
AbstractComponentthat defines the default implementation for the methods inComponentContainer.AbstractEmbedded Abstract base for embedding components.
AbstractField<T> Abstract field component for implementing buffered property editors.
AbstractField.FocusShortcut A ready-made
ShortcutListenerthat focuses the givenFocusable(usually aField) when the keyboard shortcut is invoked.AbstractField.ReadOnlyStatusChangeEvent An
Eventobject specifying the Property whose read-only status has changed.AbstractFocusable An abstract base class for focusable components.
AbstractJavaScriptComponent Base class for Components with all client-side logic implemented using JavaScript.
AbstractLayout An abstract class that defines default implementation for the
Layoutinterface.AbstractMedia Abstract base class for the HTML5 media components.
AbstractOrderedLayout AbstractSelect A class representing a selection of items the user has selected in a UI.
AbstractSelect.AcceptItem This criterion accepts a only a
Transferablethat contains given Item (practically its identifier) from a specific AbstractSelect.AbstractSelect.TargetItemIs Criterion which accepts a drop only if the drop target is (one of) the given Item identifier(s).
AbstractSelect.VerticalLocationIs An accept criterion to accept drops only on a specific vertical location of an item.
AbstractSingleComponentContainer Abstract base class for component containers that have only one child component.
AbstractSplitPanel AbstractSplitPanel.
AbstractSplitPanel.SplitPositionChangeEvent Event that indicates a change in SplitPanel's splitter position.
AbstractSplitPanel.SplitterClickEvent AbstractTextField AbstractTextField.TextChangeEventImpl Accordion An accordion is a component similar to a
TabSheet, but with a vertical orientation and the selected component presented between tabs.Alignment Class containing information about alignment of a component.
Audio The Audio component translates into an HTML5 <audio> element and as such is only supported in browsers that support HTML5 media markup.
BrowserFrame A component displaying an embedded web page.
Button A generic button component.
Button.ClickEvent Click event.
Button.ClickShortcut A
ShortcutListenerspecifically made to define a keyboard shortcut that invokes a click on the given button.Calendar Vaadin Calendar is for visualizing events in a calendar.
CheckBox ColorPicker A class that defines default (button-like) implementation for a color picker component.
ColorPickerArea A class that defines area-like implementation for a color picker component.
ComboBox A filtering dropdown single-select.
Component.ErrorEvent Class of all component originated error events.
Component.Event Superclass of all component originated events.
ConnectorTracker A class which takes care of book keeping of
ClientConnectors for a UI.CssLayout CssLayout is a layout component that can be used in browser environment only.
CustomComponent Custom component provides a simple implementation of the
Componentinterface to allow creating new UI components by composition of existing server-side components.CustomField<T> A
Fieldwhose UI content can be constructed by the user, enabling the creation of e.g.CustomLayout A container component with freely designed layout and style.
DateField A date editor component that can be bound to any
Propertythat is compatible withjava.util.Date.DefaultFieldFactory This class contains a basic implementation for both
FormFieldFactoryandTableFieldFactory.DragAndDropWrapper Embedded A component for embedding external objects.
Field.ValueChangeEvent An
Eventobject specifying the Field whose value has been changed.Flash A component for displaying Adobe® Flash® content.
Form Deprecated As of 7.0, use
FieldGroupinstead ofFormfor more flexibility.FormLayout FormLayout is used by
Formto layout fields.Grid A grid component for displaying tabular data.
Grid.AbstractGridExtension An abstract base class for server-side Grid extensions.
Grid.AbstractRenderer<T> An abstract base class for server-side
Grid renderers.Grid.AbstractSelectionModel A base class for SelectionModels that contains some of the logic that is reusable.
Grid.CellReference A data class which contains information which identifies a cell in a
Grid.Grid.Column A column in the grid.
Grid.ColumnReorderEvent An event that is fired when the columns are reordered.
Grid.ColumnResizeEvent An event that is fired when a column is resized, either programmatically or by the user.
Grid.ColumnVisibilityChangeEvent An event that is fired when a column's visibility changes.
Grid.CommitErrorEvent An event which is fired when saving the editor fails
Grid.DetailComponentManager A class that manages details components by calling
Grid.DetailsGeneratoras needed.Grid.EditorCloseEvent This event gets fired when an editor is dismissed or closed by other means.
Grid.EditorEvent Base class for editor related events
Grid.EditorFieldFactory Field factory used by default in the editor.
Grid.EditorMoveEvent This event gets fired when an editor is opened while another row is being edited (i.e.
Grid.EditorOpenEvent This event gets fired when an editor is opened
Grid.Footer Represents the footer section of a Grid.
Grid.FooterCell Represents a footer cell in Grid.
Grid.FooterRow Represents a footer row in Grid.
Grid.GridContextClickEvent ContextClickEvent for the Grid Component.
Grid.Header Represents the header section of a Grid.
Grid.HeaderCell Represents a header cell in Grid.
Grid.HeaderRow Represents a header row in Grid.
Grid.MultiSelectionModel A default implementation of a
Grid.SelectionModel.MultiGrid.NoSelectionModel A default implementation for a
Grid.SelectionModel.NoneGrid.RowReference A data class which contains information which identifies a row in a
Grid.Grid.SingleSelectionModel A default implementation of a
Grid.SelectionModel.SingleGrid.StaticSection<ROWTYPE extends Grid.StaticSection.StaticRow<?>> Abstract base class for Grid header and footer sections.
Grid.StaticSection.StaticRow<CELLTYPE extends com.vaadin.ui.Grid.StaticSection.StaticCell> Abstract base class for Grid header and footer rows.
GridLayout A layout where the components are laid out on a grid using cell coordinates.
HasComponents.ComponentAttachEvent Component attach event sent when a component is attached to container.
HasComponents.ComponentDetachEvent Component detach event sent when a component is detached from container.
HorizontalLayout Horizontal layout
HorizontalLayoutis a component container, which shows the subcomponents in the order of their addition (horizontally).HorizontalSplitPanel A horizontal split panel contains two components and lays them horizontally.
Html5File DragAndDropWrappercan receive also files from client computer if appropriate HTML 5 features are supported on client side.Image Component for embedding images.
InlineDateField A date entry component, which displays the actual date selector inline.
JavaScript Provides access to JavaScript functionality in the web browser.
Label Label component for showing non-editable short texts.
Label.ValueChangeEvent Value change event
LegacyWindow Deprecated Link Link is used to create external or internal URL links.
ListSelect This is a simple list select without, for instance, support for new items, lazyloading, and other advanced features.
LoginForm Login form with auto-completion and auto-fill for all major browsers.
LoginForm.LoginEvent This event is sent when login form is submitted.
MenuBar A class representing a horizontal menu bar.
NativeButton NativeSelect This is a simple drop-down select without, for instance, support for multiselect, new items, lazyloading, and other advanced features.
Notification A notification message, used to display temporary messages to the user - for example "Document saved", or "Save failed".
OptionGroup Configures select to be used as an option group.
Panel Panel - a simple single component container.
PasswordField A field that is used to enter secret text information like passwords.
PopupDateField A date entry component, which displays the actual date selector as a popup.
PopupView A component for displaying a two different views to data.
PopupView.PopupVisibilityEvent This event is received by the PopupVisibilityListeners when the visibility of the popup changes.
ProgressBar Shows the current progress of a long running task.
ProgressIndicator Deprecated as of 7.1, use
ProgressBarcombined withUI#setPushMode(PushMode)orUI.setPollInterval(int)instead.RichTextArea A simple RichTextArea to edit HTML format text.
Select Deprecated As of 7.0.
Slider A component for selecting a numerical value within a range.
Table Tableis used for representing data or components in a pageable and selectable table.Table.ColumnCollapseEvent This event is fired when the collapse state of a column changes.
Table.ColumnReorderEvent This event is fired when a columns are reordered by the end user user.
Table.ColumnResizeEvent This event is fired when a column is resized.
Table.FooterClickEvent Click event fired when clicking on the Table footers.
Table.GeneratedRow Table.HeaderClickEvent Click event fired when clicking on the Table headers.
Table.TableContextClickEvent ContextClickEvent for the Table Component.
Table.TableDropCriterion Lazy loading accept criterion for Table.
TabSheet TabSheet component.
TabSheet.SelectedTabChangeEvent Selected tab change event.
TextArea A text field that supports multi line editing.
TextField A text editor component that can be bound to any bindable Property.
Tree Tree component.
Tree.CollapseEvent Collapse event
Tree.ExpandEvent Event to fired when a node is expanded.
Tree.TargetItemAllowsChildren A criterion that accepts
Transferableonly directly on a tree node that can have children.Tree.TreeContextClickEvent ContextClickEvent for the Tree Component.
Tree.TreeDropCriterion Lazy loading accept criterion for Tree.
TreeTable TreeTable extends the
Tablecomponent so that it can also visualize a hierarchy of its Items in a similar manner thatTreedoes.TwinColSelect Multiselect component with two lists: left side for available items and right side for selected items.
UI The topmost component in any component hierarchy.
UniqueSerializable A base class for generating an unique object that is serializable.
Upload Component for uploading files from client to server.
Upload.ChangeEvent Upload.ChangeEvent event is sent when the value (filename) of the upload changes.
Upload.FailedEvent Upload.FailedEvent event is sent when the upload is received, but the reception is interrupted for some reason.
Upload.FinishedEvent Upload.FinishedEvent is sent when the upload receives a file, regardless of whether the reception was successful or failed.
Upload.NoInputStreamEvent FailedEvent that indicates that an input stream could not be obtained.
Upload.NoOutputStreamEvent FailedEvent that indicates that an output stream could not be obtained.
Upload.StartedEvent Upload.StartedEvent event is sent when the upload is started to received.
Upload.SucceededEvent Upload.SucceededEvent event is sent when the upload is received successfully.
VerticalLayout Vertical layout
VerticalLayoutis a component container, which shows the subcomponents in the order of their addition (vertically).VerticalSplitPanel A vertical split panel contains two components and lays them vertically.
Video The Video component translates into an HTML5 <video> element and as such is only supported in browsers that support HTML5 media markup.
Window A component that represents a floating popup window that can be added to a
UI.Window.CloseEvent Window.CloseShortcut A
ShortcutListenerspecifically made to define a keyboard shortcut that closes the window.Window.ResizeEvent Resize events are fired whenever the client-side fires a resize-event (e.g.
Window.WindowModeChangeEvent Event which is fired when the mode of the Window changes.
-
Enum Summary Enum Description AbstractColorPicker.PopupStyle AbstractSelect.ItemCaptionMode AbstractTextField.TextChangeEventMode Different modes how the TextField can trigger
FieldEvents.TextChangeEvents.Calendar.TimeFormat Calendar can use either 12 hours clock or 24 hours clock.
DragAndDropWrapper.DragStartMode Grid.SelectionMode Selection modes representing built-in
SelectionModelsthat come bundled withGrid.HasChildMeasurementHint.ChildMeasurementHint Specifies how you would like child components measurements to be handled.
Notification.Type Table.Align Table.ColumnHeaderMode Table.RowHeaderMode Table.TableDragMode Modes that Table support as drag sourse.
Tree.TreeDragMode Supported drag modes for Tree.
-
Exception Summary Exception Description DateField.UnparsableDateString Table.CacheUpdateException Exception thrown when one or more exceptions occurred during updating of the Table cache.
UIDetachedException Exception thrown if the UI has been detached when it should not be.