| 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 | Method and Description |
|---|---|
Component |
HasValue.ValueChangeEvent.getComponent()
Returns the component.
|
| Modifier and Type | Method and Description |
|---|---|
Optional<Component> |
ValueContext.getComponent()
Returns an
Optional for the Component related to value
conversion. |
| Constructor and Description |
|---|
ValueChangeEvent(Component component,
HasValue<V> hasValue,
V oldValue,
boolean userOriginated)
Creates a new
ValueChange event containing the given value,
originating from the given source component. |
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 | Field and Description |
|---|---|
protected Component |
ActionManager.viewer |
| Modifier and Type | Method and Description |
|---|---|
<T extends Component & Action.Container & VariableOwner> |
ActionManager.setViewer(T viewer) |
| Modifier and Type | Method and Description |
|---|---|
Component |
LayoutEvents.LayoutClickEvent.getChildComponent()
Returns the direct child component of the layout which contains the
clicked component.
|
Component |
LayoutEvents.LayoutClickEvent.getClickedComponent()
Returns the component that was clicked, which is somewhere inside the
parent layout on which the listener was registered.
|
Component |
TransferableImpl.getSourceComponent() |
Component |
Transferable.getSourceComponent()
Deprecated.
|
| Constructor and Description |
|---|
BlurEvent(Component source) |
ClickEvent(Component source,
MouseEventDetails mouseEventDetails) |
CollapseEvent(Component source,
T collapsedItem,
boolean userOriginated)
Construct a collapse event.
|
ContextClickEvent(Component source,
MouseEventDetails mouseEventDetails) |
DoubleClickEvent(Component source) |
ExpandEvent(Component source,
T expandedItem,
boolean userOriginated)
Construct an expand event.
|
FocusAndBlurServerRpcDecorator(Component component,
SerializableConsumer<Component.Event> eventHandler)
Create a new decorator instance.
|
FocusAndBlurServerRpcImpl(Component component) |
FocusEvent(Component source) |
LayoutClickEvent(Component source,
MouseEventDetails mouseEventDetails,
Component clickedComponent,
Component childComponent) |
SortEvent(Component source,
List<T> sortOrder,
boolean userOriginated)
Creates a new sort order change event with a sort order list.
|
TransferableImpl(Component sourceComponent,
Map<String,Object> rawVariables) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
DragSource
Deprecated.
Replaced in 8.1 by
DragSourceExtension |
interface |
DropTarget
Deprecated.
Replaced in 8.1 by
DropTargetExtension. |
| Constructor and Description |
|---|
SourceIs(Component... component) |
| Constructor and Description |
|---|
MultiSelectionEvent(Component component,
MultiSelect<T> source,
Set<T> oldSelection,
boolean userOriginated)
Creates a new selection change event in a multiselect component.
|
SingleSelectionEvent(Component component,
SingleSelect<T> source,
T oldSelection,
boolean userOriginated)
Creates a new selection change event in a component.
|
| Modifier and Type | Class and Description |
|---|---|
static class |
Navigator.EmptyView
Empty view component.
|
| Modifier and Type | Method and Description |
|---|---|
default Component |
View.getViewComponent()
Gets the component to show when navigating to the view.
|
| Modifier and Type | Method and Description |
|---|---|
static Component |
DefaultErrorHandler.findComponent(Connector connector)
Finds the nearest component by traversing upwards in the hierarchy.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PaintTarget.addAttribute(String name,
Component value)
Adds a Component type attribute.
|
void |
JsonPaintTarget.addAttribute(String name,
Component value) |
void |
PaintTarget.addVariable(VariableOwner owner,
String name,
Component value)
Adds a Component type variable.
|
void |
JsonPaintTarget.addVariable(VariableOwner owner,
String name,
Component value) |
static boolean |
ComponentSizeValidator.checkHeights(Component component) |
static boolean |
ComponentSizeValidator.checkWidths(Component component) |
void |
PaintTarget.endPaintable(Component paintable)
Prints paintable element end tag.
|
void |
JsonPaintTarget.endPaintable(Component paintable) |
static Locale |
ServletPortletHelper.findLocale(Component component,
VaadinSession session,
VaadinRequest request)
Deprecated.
Helper to find the most most suitable Locale.
|
static boolean |
LegacyCommunicationManager.isComponentVisibleToClient(Component child)
Deprecated.
As of 7.1. See #11411.
|
static void |
Responsive.makeResponsive(Component... components)
Enable responsive width and height range styling for the target component
or UI instance.
|
static void |
LegacyPaint.paint(Component component,
PaintTarget target)
Paints the Paintable into a UIDL stream.
|
static boolean |
ComponentSizeValidator.parentCanDefineHeight(Component component) |
static boolean |
ComponentSizeValidator.parentCanDefineWidth(Component component) |
PaintTarget.PaintStatus |
PaintTarget.startPaintable(Component paintable,
String tag)
Prints element start tag of a paintable section.
|
PaintTarget.PaintStatus |
JsonPaintTarget.startPaintable(Component connector,
String tagName) |
static List<ComponentSizeValidator.InvalidLayout> |
ComponentSizeValidator.validateComponentRelativeSizes(Component component,
List<ComponentSizeValidator.InvalidLayout> errors,
ComponentSizeValidator.InvalidLayout parent)
Recursively checks given component and its subtree for invalid layout
setups.
|
| Constructor and Description |
|---|
InvalidLayout(Component component,
boolean height,
boolean width) |
| Modifier and Type | Interface and Description |
|---|---|
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.
|
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.
|
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 |
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 |
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.
|
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 | Field and Description |
|---|---|
protected LinkedList<Component> |
CssLayout.components
Custom layout slots containing the components.
|
protected LinkedList<Component> |
AbstractOrderedLayout.components
Custom layout slots containing the components.
|
protected KeyMapper<Component> |
TabSheet.keyMapper
Mapper between server-side component instances (tab contents) and keys
given to the client that identify tabs.
|
| Modifier and Type | Method and Description |
|---|---|
<V extends Component> |
Grid.addComponentColumn(ValueProvider<T,V> componentProvider)
Adds a column that shows components.
|
<F,C extends HasValue<F> & Component> |
Grid.Column.setEditorComponent(C editorComponent)
Sets a component to use for editing values of this columns in the
editor row.
|
<C extends HasValue<V> & Component> |
Grid.Column.setEditorComponent(C editorComponent,
Setter<T,V> setter)
Sets a component and setter to use for editing values of this column
in the editor row.
|
| Modifier and Type | Method and Description |
|---|---|
protected Component |
LoginForm.createContent(TextField userNameField,
PasswordField passwordField,
Button loginButton)
Create the content for the login form with the supplied user name field,
password field and the login button.
|
Component[] |
Window.getAssistiveDescription()
Gets the components that are used as assistive description.
|
Component |
HasComponents.ComponentAttachEvent.getAttachedComponent()
Gets the attached component.
|
Component |
TabSheet.Tab.getComponent()
Get the component related to the Tab.
|
Component |
TabSheet.TabSheetTabImpl.getComponent() |
Component |
GridLayout.Area.getComponent()
Gets the component connected to the area.
|
Component |
Component.Event.getComponent()
Gets the component where the event occurred.
|
Component |
CssLayout.getComponent(int index)
Returns the component at the given position.
|
Component |
AbstractOrderedLayout.getComponent(int index)
Returns the component at the given position.
|
Component |
GridLayout.getComponent(int x,
int y)
Gets the Component at given index.
|
Component |
CustomLayout.getComponent(String location)
Gets the child-component by its location.
|
protected Component |
CustomComponent.getCompositionRoot()
Returns the composition root.
|
protected Component |
Composite.getCompositionRoot()
Returns the composition root.
|
Component |
SingleComponentContainer.getContent()
Gets the content of this container.
|
protected Component |
CustomField.getContent()
Returns the content (UI) of the custom component.
|
Component |
AbstractSingleComponentContainer.getContent() |
Component |
HasComponents.ComponentDetachEvent.getDetachedComponent()
Gets the detached component.
|
Component |
DragAndDropWrapper.WrapperTransferable.getDraggedComponent()
Deprecated.
The component in wrapper that is being dragged or null if the
transferable is not a component (most likely an html5 drag).
|
Component |
DragAndDropWrapper.getDragImageComponent()
Deprecated.
Gets the component that will be used as the drag image.
|
Component |
AbstractSplitPanel.getFirstComponent()
Gets the first component of this split panel.
|
Component |
PopupView.Content.getPopupComponent()
This should return the full Component representing the data.
|
Component |
AbstractSplitPanel.getSecondComponent()
Gets the second component of this split panel.
|
Component |
TabSheet.getSelectedTab()
Gets the selected tab content component.
|
protected abstract Component |
CustomField.initContent()
Create the content component or layout for the field.
|
| Modifier and Type | Method and Description |
|---|---|
Iterator<Component> |
ComponentContainer.getComponentIterator()
Deprecated.
As of 7.0, use
HasComponents.iterator() instead. |
Iterator<Component> |
AbstractComponentContainer.getComponentIterator()
Deprecated.
As of 7.0, use
HasComponents.iterator() instead. |
Iterator<Component> |
UI.iterator() |
Iterator<Component> |
TabSheet.iterator()
Gets the component container iterator for going through all the
components (tab contents).
|
Iterator<Component> |
PopupView.iterator()
This class only contains other components when the popup is showing.
|
Iterator<Component> |
HasComponents.iterator()
Gets an iterator to the collection of contained components.
|
Iterator<Component> |
GridLayout.iterator()
Gets an Iterator for the components contained in the layout.
|
Iterator<Component> |
Grid.iterator()
Gets an iterator to the collection of contained components.
|
Iterator<Component> |
CustomLayout.iterator()
Gets the component container iterator for going trough all the components
in the container.
|
Iterator<Component> |
CustomField.iterator() |
Iterator<Component> |
CustomComponent.iterator() |
Iterator<Component> |
CssLayout.iterator()
Gets the component container iterator for going trough all the components
in the container.
|
Iterator<Component> |
Composite.iterator() |
Iterator<Component> |
AbstractSplitPanel.iterator()
Gets an iterator to the collection of contained components.
|
Iterator<Component> |
AbstractSingleComponentContainer.iterator() |
Iterator<Component> |
AbstractOrderedLayout.iterator()
Gets the component container iterator for going trough all the components
in the container.
|
Iterator<Component> |
AbsoluteLayout.iterator()
Gets an iterator for going through all components enclosed in the
absolute layout.
|
| Modifier and Type | Method and Description |
|---|---|
void |
TabSheet.addComponent(Component c)
Adds a new tab into TabSheet.
|
void |
LegacyWindow.addComponent(Component component)
Deprecated.
Adds a component to this UI.
|
void |
GridLayout.addComponent(Component component)
Adds the component into this container to the cursor position.
|
void |
CustomLayout.addComponent(Component c)
Adds the component into this container.
|
void |
CssLayout.addComponent(Component c)
Add a component into this container.
|
void |
ComponentContainer.addComponent(Component c)
Adds the component into this container.
|
void |
AbstractSplitPanel.addComponent(Component c)
Add a component into this container.
|
void |
AbstractOrderedLayout.addComponent(Component c)
Add a component into this container.
|
void |
AbstractComponentContainer.addComponent(Component c)
This only implements the events and component parent calls.
|
void |
AbsoluteLayout.addComponent(Component c) |
void |
CssLayout.addComponent(Component c,
int index)
Adds a component into indexed position in this container.
|
void |
AbstractOrderedLayout.addComponent(Component c,
int index)
Adds a component into indexed position in this container.
|
void |
GridLayout.addComponent(Component component,
int column,
int row)
Adds the component to the grid in cells column1,row1 (NortWest corner of
the area.) End coordinates (SouthEast corner of the area) are the same as
column1,row1.
|
void |
GridLayout.addComponent(Component component,
int column1,
int row1,
int column2,
int row2)
Adds a component to the grid in the specified area.
|
void |
CustomLayout.addComponent(Component c,
String location)
Adds the component into this container to given location.
|
void |
AbsoluteLayout.addComponent(Component c,
String cssPosition)
Adds a component to the layout.
|
void |
CssLayout.addComponentAsFirst(Component c)
Adds a component into this container.
|
void |
AbstractOrderedLayout.addComponentAsFirst(Component c)
Adds a component into this container.
|
void |
ComponentContainer.addComponents(Component... components)
Adds the components in the given order to this component container.
|
void |
AbstractComponentContainer.addComponents(Component... components) |
void |
VerticalLayout.addComponentsAndExpand(Component... components)
Adds the given components to this layout and sets them as expanded.
|
void |
HorizontalLayout.addComponentsAndExpand(Component... components)
Adds the given components to this layout and sets them as expanded.
|
protected void |
Grid.AbstractGridExtension.addComponentToGrid(Component c)
Adds given component to the connector hierarchy of Grid.
|
TabSheet.Tab |
TabSheet.addTab(Component c)
Adds a new tab into TabSheet.
|
TabSheet.Tab |
TabSheet.addTab(Component component,
int position)
Adds a new tab into TabSheet.
|
TabSheet.Tab |
TabSheet.addTab(Component c,
String caption)
Adds a new tab into TabSheet.
|
TabSheet.Tab |
TabSheet.addTab(Component c,
String caption,
Resource icon)
Adds a new tab into TabSheet.
|
TabSheet.Tab |
TabSheet.addTab(Component tabComponent,
String caption,
Resource icon,
int position)
Adds a new tab into TabSheet.
|
static boolean |
ComponentRootSetter.canSetRoot(Component customComponent)
Checks if the given custom component or composite may accept a root
component.
|
protected static PopupView.Content |
PopupView.createContent(String minimizedValue,
Component popupContent)
Creates a Content from given text representation and popup content.
|
protected void |
AbstractSingleComponentContainer.fireComponentAttachEvent(Component component)
Fires the component attached event.
|
protected void |
AbstractComponentContainer.fireComponentAttachEvent(Component component)
Fires the component attached event.
|
protected void |
AbstractSingleComponentContainer.fireComponentDetachEvent(Component component)
Fires the component detached event.
|
protected void |
AbstractComponentContainer.fireComponentDetachEvent(Component component)
Fires the component detached event.
|
Alignment |
Layout.AlignmentHandler.getComponentAlignment(Component childComponent)
Returns the current Alignment of given component.
|
Alignment |
GridLayout.getComponentAlignment(Component childComponent) |
Alignment |
AbstractOrderedLayout.getComponentAlignment(Component childComponent) |
GridLayout.Area |
GridLayout.getComponentArea(Component component)
Returns information about the area where given component is laid in the
GridLayout.
|
int |
CssLayout.getComponentIndex(Component component)
Returns the index of the given component.
|
int |
AbstractOrderedLayout.getComponentIndex(Component component)
Returns the index of the given component.
|
protected String |
CssLayout.getCss(Component c)
Returns styles to be applied to given component.
|
float |
FormLayout.getExpandRatio(Component component)
Deprecated.
This method currently has no effect as expand ratios are not
implemented in FormLayout
|
float |
AbstractOrderedLayout.getExpandRatio(Component component)
Returns the expand ratio of given component.
|
AbsoluteLayout.ComponentPosition |
AbsoluteLayout.getPosition(Component component)
Gets the position of a component in the layout.
|
TabSheet.Tab |
TabSheet.getTab(Component c)
Returns the
TabSheet.Tab (metadata) for a component. |
protected boolean |
AbstractComponent.isOrHasAncestor(Component content)
Determine whether a
content component is equal to, or the
ancestor of this component. |
boolean |
TabSheet.isRendered(Component childComponent) |
boolean |
SelectiveRenderer.isRendered(Component childComponent)
Checks if the child component should be rendered (sent to the client
side).
|
void |
TabSheet.CloseHandler.onTabClose(TabSheet tabsheet,
Component tabContent)
Called when a user has pressed the close icon of a tab in the client
side widget.
|
void |
TabSheet.removeComponent(Component component)
Removes a component and its corresponding tab.
|
void |
LegacyWindow.removeComponent(Component component)
Deprecated.
This implementation removes the component from the content container (
LegacyWindow.getContent()) instead of from the actual UI. |
void |
GridLayout.removeComponent(Component component)
Removes the specified component from the layout.
|
void |
CustomLayout.removeComponent(Component c)
Removes the component from this container.
|
void |
CssLayout.removeComponent(Component c)
Removes the component from this container.
|
void |
ComponentContainer.removeComponent(Component c)
Removes the component from this container.
|
void |
AbstractSplitPanel.removeComponent(Component c)
Removes the component from this container.
|
void |
AbstractOrderedLayout.removeComponent(Component c)
Removes the component from this container.
|
void |
AbstractComponentContainer.removeComponent(Component c)
This only implements the events and component parent calls.
|
void |
AbsoluteLayout.removeComponent(Component c) |
protected void |
Grid.AbstractGridExtension.removeComponentFromGrid(Component c)
Removes given component from the connector hierarchy of Grid.
|
static void |
AbstractSingleComponentContainer.removeFromParent(Component content)
Utility method for removing a component from its parent (if possible).
|
void |
TabSheet.replaceComponent(Component oldComponent,
Component newComponent)
Replaces a component (tab content) with another.
|
void |
LegacyWindow.replaceComponent(Component oldComponent,
Component newComponent)
Deprecated.
This implementation replaces a component in the content container (
LegacyWindow.getContent()) instead of in the actual UI. |
void |
GridLayout.replaceComponent(Component oldComponent,
Component newComponent) |
void |
CustomLayout.replaceComponent(Component oldComponent,
Component newComponent) |
void |
CssLayout.replaceComponent(Component oldComponent,
Component newComponent) |
void |
ComponentContainer.replaceComponent(Component oldComponent,
Component newComponent)
Replaces the component in the container with another one without changing
position.
|
void |
AbstractSplitPanel.replaceComponent(Component oldComponent,
Component newComponent) |
void |
AbstractOrderedLayout.replaceComponent(Component oldComponent,
Component newComponent) |
void |
AbsoluteLayout.replaceComponent(Component oldComponent,
Component newComponent)
Replaces one component with another one.
|
void |
UI.scrollIntoView(Component component)
Scrolls any component between the component and UI to a suitable position
so the component is visible to the user.
|
void |
Window.setAssistiveDescription(Component... components)
Allows to specify which components contain the description for the
window.
|
void |
Layout.AlignmentHandler.setComponentAlignment(Component childComponent,
Alignment alignment)
Set alignment for one contained component in this layout.
|
void |
GridLayout.setComponentAlignment(Component childComponent,
Alignment alignment) |
void |
AbstractOrderedLayout.setComponentAlignment(Component childComponent,
Alignment alignment) |
protected void |
CustomComponent.setCompositionRoot(Component compositionRoot)
Sets the composition root for the component.
|
protected void |
Composite.setCompositionRoot(Component compositionRoot)
Sets the component contained in the composite.
|
void |
UI.setContent(Component content) |
void |
SingleComponentContainer.setContent(Component content)
Sets the content of this container.
|
void |
LegacyWindow.setContent(Component content)
Deprecated.
Set the content of the window.
|
void |
AbstractSingleComponentContainer.setContent(Component content)
Sets the content of this container.
|
void |
DragAndDropWrapper.setDragImageComponent(Component dragImageComponent)
Deprecated.
Sets the component that will be used as the drag image.
|
void |
FormLayout.setExpandRatio(Component component,
float ratio)
Deprecated.
This method currently has no effect as expand ratios are not
implemented in FormLayout
|
void |
AbstractOrderedLayout.setExpandRatio(Component component,
float ratio)
This method is used to control how excess space in layout is distributed
among components.
|
void |
AbstractSplitPanel.setFirstComponent(Component c)
Sets the first component of this split panel.
|
void |
AbsoluteLayout.setPosition(Component component,
AbsoluteLayout.ComponentPosition position)
Sets the position of a component in the layout.
|
static void |
ComponentRootSetter.setRoot(Component customComponent,
Component component)
Sets the composition root for the given custom component or composite.
|
void |
AbstractSplitPanel.setSecondComponent(Component c)
Sets the second component of this split panel.
|
void |
TabSheet.setSelectedTab(Component component)
Sets the selected tab.
|
void |
TabSheet.setSelectedTab(Component component,
boolean userOriginated)
Sets the selected tab.
|
| Constructor and Description |
|---|
Accordion(Component... components)
Constructs a new accordion containing the given components.
|
Area(Component component,
int column1,
int row1,
int column2,
int row2)
Construct a new area on a grid.
|
Area(GridLayoutState.ChildComponentData childData,
Component component) |
ClickEvent(Component source)
New instance of text change event.
|
ClickEvent(Component source,
MouseEventDetails details)
Constructor with mouse details.
|
CloseEvent(Component source) |
ComponentAttachEvent(HasComponents container,
Component attachedComponent)
Creates a new attach event.
|
ComponentDetachEvent(HasComponents container,
Component detachedComponent)
Creates a new detach event.
|
CssLayout(Component... children)
Constructs a CssLayout with the given components in the given order.
|
CustomComponent(Component compositionRoot)
Constructs a new custom component.
|
DragAndDropWrapper(Component root)
Deprecated.
Wraps given component in a
DragAndDropWrapper. |
ErrorEvent(ErrorMessage message,
Component component)
Constructs a new event with a specified source component.
|
Event(Component source)
Constructs a new event with the specified source component.
|
FormLayout(Component... children)
Constructs a FormLayout and adds the given components to it.
|
GridLayout(int columns,
int rows,
Component... children)
Constructs a GridLayout of given size (number of columns and rows) and
adds the given components in order to the grid.
|
HorizontalLayout(Component... children)
Constructs a HorizontalLayout with the given components.
|
HorizontalSplitPanel(Component firstComponent,
Component secondComponent)
Creates a horizontal split panel containing the given components.
|
Panel(Component content)
Creates a new empty panel which contains the given content.
|
Panel(String caption,
Component content)
Creates a new empty panel with the given caption and content.
|
PopupView(String small,
Component large)
A simple way to create a PopupPanel.
|
ResizeEvent(Component source) |
SelectedTabChangeEvent(Component source,
boolean userOriginated)
Creates a new instance of the event.
|
SplitPositionChangeEvent(Component source,
boolean userOriginated,
float oldPosition,
Sizeable.Unit oldUnit,
float position,
Sizeable.Unit unit)
Creates a split position change event.
|
SplitterClickEvent(Component source,
MouseEventDetails mouseEventDetails) |
TabSheet(Component... components)
Constructs a new TabSheet containing the given components.
|
UI(Component content)
Creates a new UI with the given component (often a layout) as its
content.
|
VerticalLayout(Component... children)
Constructs a VerticalLayout with the given components.
|
VerticalSplitPanel(Component firstComponent,
Component secondComponent)
Creates a horizontal split panel containing the given components.
|
Window(String caption,
Component content)
Creates a new, empty window with the given content and title.
|
WindowModeChangeEvent(Component source,
WindowMode windowMode) |
WindowOrderChangeEvent(Component source,
int order) |
WindowOrderUpdateEvent(Component source,
Collection<Window> windows) |
WrapperTransferable(Component sourceComponent,
Map<String,Object> rawVariables)
Deprecated.
|
| 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 | Method and Description |
|---|---|
protected Component |
ColorPickerSelect.initContent() |
protected Component |
ColorPickerHistory.initContent() |
| Modifier and Type | Method and Description |
|---|---|
protected String |
ColorPickerPreview.getCss(Component c) |
| Modifier and Type | Method and Description |
|---|---|
Component |
HeaderCell.getComponent()
Returns the component displayed in this cell.
|
Component |
FooterCell.getComponent()
Returns the component displayed in this cell.
|
| Modifier and Type | Method and Description |
|---|---|
Collection<? extends Component> |
StaticSection.StaticRow.getComponents() |
Collection<? extends Component> |
HeaderRow.getComponents()
Gets a collection of all components inside this row.
|
Collection<? extends Component> |
FooterRow.getComponents()
Gets a collection of all components inside this row.
|
| Modifier and Type | Method and Description |
|---|---|
void |
HeaderCell.setComponent(Component component)
Sets the component displayed in this cell.
|
void |
FooterCell.setComponent(Component component)
Sets the component displayed in this cell.
|
| Modifier and Type | Method and Description |
|---|---|
String |
EditorErrorGenerator.apply(Map<Component,Grid.Column<T,?>> fieldToColumn,
BinderValidationStatus<T> status)
Generates an error message from given validation status object.
|
| Modifier and Type | Method and Description |
|---|---|
Component |
Design.ComponentFactory.createComponent(String fullyQualifiedClassName,
DesignContext context)
Creates a component based on the fully qualified name derived from
the tag name in the design.
|
Component |
Design.DefaultComponentFactory.createComponent(String fullyQualifiedClassName,
DesignContext context) |
Component |
DesignContext.ComponentCreatedEvent.getComponent()
Returns the created component.
|
Component |
DesignContext.getComponentByCaption(String caption)
Returns a component having the specified caption.
|
Component |
DesignContext.getComponentById(String globalId)
Returns a component having the specified global id.
|
Component |
DesignContext.getComponentByLocalId(String localId)
Returns a component having the specified local id.
|
Component |
DesignContext.getRootComponent()
Returns the root component of a created component hierarchy.
|
static Component |
Design.read(InputStream design)
Loads a design from the given input stream.
|
Component |
DesignContext.readDesign(org.jsoup.nodes.Element componentDesign)
Reads the given design node and creates the corresponding component tree.
|
Component |
Design.ComponentMapper.tagToComponent(String tag,
Design.ComponentFactory componentFactory,
DesignContext context)
Resolves and creates a component using the provided component factory
based on a tag name.
|
Component |
Design.DefaultComponentMapper.tagToComponent(String tagName,
Design.ComponentFactory componentFactory,
DesignContext context) |
| Modifier and Type | Method and Description |
|---|---|
protected Class<? extends Component> |
Design.DefaultComponentFactory.resolveComponentClass(String qualifiedClassName,
DesignContext context)
Resolves a component class based on the fully qualified name of the
class.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
FieldBinder.bindField(Component instance)
Tries to bind the given
Component instance to a member field of
the bind target. |
boolean |
FieldBinder.bindField(Component instance,
String localId)
Tries to bind the given
Component instance to a member field of
the bind target. |
String |
Design.ComponentMapper.componentToTag(Component component,
DesignContext context)
Resolves a tag name from a component.
|
String |
Design.DefaultComponentMapper.componentToTag(Component component,
DesignContext context) |
org.jsoup.nodes.Element |
DesignContext.createElement(Component childComponent)
Creates an html tree node corresponding to the given element.
|
String |
DesignContext.getComponentLocalId(Component component)
Returns the local id for a component.
|
Map<String,String> |
DesignContext.getCustomAttributes(Component component)
Gets the attributes that the component did not handle.
|
<T> T |
DesignContext.getDefaultInstance(Component component)
Returns the default instance for the given class.
|
static DesignContext |
Design.read(Component rootComponent)
Loads a design for the given root component.
|
static DesignContext |
Design.read(InputStream stream,
Component rootComponent)
Loads a design from the given stream using the given root component.
|
static DesignContext |
Design.read(String filename,
Component rootComponent)
Loads a design from the given file name using the given root component.
|
void |
DesignContext.readDesign(org.jsoup.nodes.Element componentDesign,
Component component)
Reads the given design node and populates the given component with the
corresponding component tree.
|
boolean |
DesignContext.setComponentLocalId(Component component,
String localId)
Creates a mapping between the given local id and the component.
|
void |
DesignContext.setCustomAttribute(Component component,
String attribute,
String value)
Sets a custom attribute not handled by the component.
|
void |
DesignContext.setRootComponent(Component rootComponent)
Sets the root component of a created component hierarchy.
|
boolean |
DesignContext.shouldWriteChildren(Component c,
Component defaultC)
Helper method for component write implementors to determine whether their
children should be written out or not.
|
boolean |
ShouldWriteDataDelegate.shouldWriteData(Component component)
Determines whether the container data of a component should be written
out.
|
boolean |
DesignContext.shouldWriteData(Component component)
Determines whether the container data of a component should be written
out by delegating to a
ShouldWriteDataDelegate. |
static void |
Design.write(Component component,
OutputStream outputStream)
Writes the given component tree in design format to the given output
stream.
|
| Modifier and Type | Method and Description |
|---|---|
JsonValue |
ComponentRenderer.encode(Component value) |
Copyright © 2021 Vaadin Ltd. All rights reserved.