com.vaadin.ui.
Package com.vaadin.ui
-
Interface Summary Interface Description AbstractColorPicker.Coordinates2Color Interface for converting 2d-coordinates to a Color.
AbstractSplitPanel.SplitPositionChangeListener Interface for listening for
AbstractSplitPanel.SplitPositionChangeEvent
s fired by a SplitPanel.AbstractSplitPanel.SplitterClickListener SplitterClickListener
interface for listening forSplitterClickEvent
fired by aSplitPanel
.Button.ClickListener Interface for listening for a
Button.ClickEvent
fired by aComponent
.ComboBox.CaptionFilter Predicate to check
ComboBox
item captions against user typed strings.ComboBox.FetchItemsCallback<T> A callback method for fetching items.
ComboBox.NewItemHandler Deprecated. Since 8.4 replaced byComboBox.NewItemProvider
.ComboBox.NewItemProvider<T> Provider function that adds a new item based on user input when the new items allowed mode is active.
Component Component
is 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.Event
s.ComponentContainer A special type of parent which allows the user to add and remove components to it.
DescriptionGenerator<T> A callback interface for generating description texts for an item.
Grid.FetchItemsCallback<T> A callback method for fetching items.
HasChildMeasurementHint Component with layout measuring hint.
HasComponents Interface that must be implemented by all
Component
s that contain otherComponent
s.HasComponents.ComponentAttachDetachNotifier Interface for
HasComponents
implementations that support sending attach and detach events for components.HasComponents.ComponentAttachListener Component attach listener interface.
HasComponents.ComponentDetachListener Component detach listener interface.
HasStyleNames Implemented by components which support style names.
HasValueChangeMode Implemented by components which support value change modes.
IconGenerator<T> A callback interface for generating icons for an item.
ItemCaptionGenerator<T> ItemCaptionGenerator
can be used to customize the string shown to the user for an item.ItemCollapseAllowedProvider<T> A callback interface for resolving whether client-side collapsing should be allowed for an item in a listing component that displays hierarchical data, such as
TreeGrid
.JavaScript.JavaScriptCallbackRpc JavaScriptFunction Defines a method that is called by a client-side JavaScript function.
Layout Extension to the
ComponentContainer
interface which adds the layouting control to the elements in the container.Layout.AlignmentHandler AlignmentHandler is most commonly an advanced
Layout
that 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 Listener triggered when a login occurs in a
LoginForm
.MenuBar.Command This interface contains the layer for menu commands of the
MenuBar
class.MultiSelect<T> Multi selection component which allows to select and deselect multiple items.
Notification.CloseListener An interface used for listening to Notification close events.
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
HasComponents
implementors 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.
SingleSelect<V> Single selection component whose selection is treated as a value.
StyleGenerator<T> A callback interface for generating custom CSS class names for items.
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.ItemClickListener<T> A listener for item click events.
UI.DelayedCallback An interface for the callback in
UI.runAfterRoundTrip(DelayedCallback)
.UI.DelayedCallbackRegistration An interface used for keeping track of callback requests registered via
UI.runAfterRoundTrip(DelayedCallback)
.UI.WindowOrderUpdateListener An interface used for listening to Windows order update events.
Upload.ChangeListener Listener for
Upload.ChangeEvent
.Upload.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.
Window.WindowOrderChangeListener An interface used for listening to Window order change 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
Component
interface.AbstractComponentContainer Extension to
AbstractComponent
that defines the default implementation for the methods inComponentContainer
.AbstractDateField<T extends Temporal & TemporalAdjuster & Serializable & Comparable<? super T>,R extends Enum<R>> A date editor component with
LocalDate
as an input value.AbstractEmbedded Abstract base for embedding components.
AbstractField<T> An abstract implementation of a field, or a
Component
allowing user input.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
Layout
interface.AbstractListing<T> A base class for listing components.
AbstractListing.AbstractListingExtension<T> A helper base class for creating extensions for Listing components.
AbstractLocalDateField Abstract DateField class for
LocalDate
type.AbstractLocalDateTimeField Abstract DateField class for
LocalDateTime
type.AbstractMedia Abstract base class for the HTML5 media components.
AbstractMultiSelect<T> Base class for listing components that allow selecting multiple items.
AbstractOrderedLayout AbstractSingleComponentContainer Abstract base class for component containers that have only one child component.
AbstractSingleSelect<T> An abstract base class for listing components that only support single selection and no lazy loading of data items.
AbstractSplitPanel AbstractSplitPanel.
AbstractSplitPanel.SplitPositionChangeEvent Event that indicates a change in SplitPanel's splitter position.
AbstractSplitPanel.SplitterClickEvent AbstractTextField Abstract base class for text input components.
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
ShortcutListener
specifically made to define a keyboard shortcut that invokes a click on the given button.CheckBox CheckBox.CheckBoxInputElement The inner input element of the CheckBox.
CheckBox.CheckBoxLabelElement The inner label element of the CheckBox.
CheckBoxGroup<T> A group of Checkboxes.
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<T> A filtering dropdown single-select.
ComboBox.DeclarativeStyleGenerator<T> Item style generator class for declarative support.
Component.ErrorEvent Class of all component originated error events.
Component.Event Superclass of all component originated events.
ComponentRootSetter Internal utility class.
Composite Composite allows creating new UI components by composition of existing server-side components.
ConnectorTracker A class which takes care of book keeping of
ClientConnector
s 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
Component
interface to allow creating new UI components by composition of existing server-side components.CustomField<T> A
HasValue
whose 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 entry component, which displays the actual date selector as a popup.
DateTimeField A date time entry component, which displays the actual date selector as a popup.
Dependency Represents a stylesheet or JavaScript to include on the page.
DragAndDropWrapper Deprecated. Replaced in 8.1 withDragSourceExtension
andDropTargetExtension
.Embedded A component for embedding external objects.
FormLayout FormLayout is used to layout fields.
Grid<T> A grid component for displaying tabular data.
Grid.AbstractGridExtension<T> A helper base class for creating extensions for the Grid component.
Grid.Column<T,V> This extension manages the configuration and data communication for a Column inside of a Grid component.
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.DetailsManager<T> Class for managing visible details rows.
Grid.GridContextClickEvent<T> ContextClickEvent for the Grid Component.
Grid.ItemClick<T> An event fired when an item in the Grid has been clicked.
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
HorizontalLayout
is 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 DragAndDropWrapper
can 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.
InlineDateTimeField A date time 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.
LegacyWindow Deprecated. Link Link is used to create external or internal URL links.
ListSelect<T> 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 Event sent when the login form is submitted.
MenuBar A class representing a horizontal menu bar.
NativeButton NativeSelect<T> A simple drop-down select component.
Notification A notification message, used to display temporary messages to the user - for example "Document saved", or "Save failed".
Notification.CloseEvent Event fired when a notification is closed.
Panel Panel - a simple single component container.
PasswordField A field that is used to enter secret text information like passwords.
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 A component for displaying progress.
RadioButtonGroup<T> A group of RadioButtons.
RichTextArea A simple RichTextArea to edit HTML format text.
Slider A component for selecting a numerical value within a range.
TabSheet TabSheet component.
TabSheet.SelectedTabChangeEvent Selected tab change event.
TextArea A text field that supports multi line editing.
TextField A component for editing textual data that fits on a single line.
Tree<T> Tree component.
Tree.ItemClick<T> Tree item click event.
Tree.TreeContextClickEvent<T> ContextClickEvent for the Tree Component.
Tree.TreeMultiSelectionModel<T> Custom MultiSelectionModel for Tree.
TreeGrid<T> A grid component for displaying hierarchical tabular data.
TwinColSelect<T> Multiselect component with two lists: left side for available items and right side for selected items.
UI The topmost component in any component hierarchy.
UI.WindowOrderUpdateEvent Event which is fired when the ordering of the windows is updated.
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
VerticalLayout
is 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
ShortcutListener
specifically 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.
Window.WindowOrderChangeEvent Event which is fired when the window order position is changed.
-
Enum Summary Enum Description AbstractColorPicker.PopupStyle The style of the color picker popup.
Dependency.Type The type of dependency.
DragAndDropWrapper.DragStartMode Grid.Column.NestedNullBehavior Behavior when parsing nested properties which may contain
null
values in the property chain.Grid.SelectionMode Selection mode representing the built-in selection models in grid.
HasChildMeasurementHint.ChildMeasurementHint Specifies how you would like child components measurements to be handled.
Notification.Type -
Exception Summary Exception Description UIDetachedException Exception thrown if the UI has been detached when it should not be.