unwrap() - returns client-specific component instance (Vaadin or Swing component). Can be used in client module to simplify invocation of underlying API, see Working with Vaadin Components section.

com.vaadin.ui.TextField vTextField = textField.unwrap(com.vaadin.ui.TextField.class);

unwrapComposition() - returns the outmost external container of client-specific component instance. Can be used in client module to simplify invocation of underlying API.

commit() - updates all changes made since the previous commit to the data source.

discard() - discards all changes since last commit. The object updates its value from the data source.

isModified() - returns true if the object value has been modified since it was last updated from the data source.

addExpandedStateChangeListener() - adds the listener implementing the ExpandedStateChangeListener interface to intercept the component’s expanded state change events.

@Subscribe("groupBox")
protected void onGroupBoxExpandedStateChange(Collapsable.ExpandedStateChangeEvent event) {
    notifications.create()
            .withCaption("Expanded: " + groupBox.isExpanded())
            .show();
}

add() - adds child component to the container.

remove() - removes the child component from the container.

removeAll() - removes all children components from te container.

getOwnComponent() - returns the component directly owned by this container.

getComponent() - returns the component belonging to the whole components tree below this container.

getComponentNN() - returns the component belonging to the whole components tree below this container. Throws an exception if not found.

getOwnComponents() - returns all components directly owned by this container.

getComponents() - returns all components belonging to the whole components tree below this container.

indexOf() - returns the index of a given component in an ordered container.

setContextHelpText() - sets context help text. If set, then a special icon will be added for a field, see contextHelpText.

setContextHelpTextHtmlEnabled() - defines if context help text should be rendered as HTML, see contextHelpTextHtmlEnabled.

setContextHelpIconClickHandler() - sets a context help icon click handler. Click handler has priority over context help text, i.e. no tooltip with context help text will be shown if the click handler is set.

applySettings() - restores the last user settings for this component.

saveSettings() - saves current user settings for this component.

isUserOriginated() - provides information of the event origin. Returns true if this event was triggered by user interaction, on the client side, or false if it was triggered programmatically, on the server side.

@Subscribe("customersTable")
protected void onCustomersTableSelection(Table.SelectionEvent<Customer> event) {
    if (event.isUserOriginated())
        notifications.create()
                .withCaption("You selected " + event.getSelected().size() + " customers")
                .show();
}

CollapseEvent in TreeDataGrid,

ColumnCollapsingChangeEvent in DataGrid,

ColumnReorderEvent in DataGrid,

ColumnResizeEvent in DataGrid,

ExpandedStateChangeEvent in Filter and GroupBoxLayout (see Collapsable),

ExpandEvent in TreeDataGrid,

SelectedTabChangeEvent in TabSheet,

SelectionEvent in DataGrid,

SelectionEvent in Table,

SortEvent in DataGrid,

SplitPositionChangeEvent in SplitPanel,

ValueChangeEvent of the components implementing HasValue interface (see ValueChangeListener).

addValueChangeListener() - adds the listener implementing the ValueChangeListener interface to intercept the component’s value changes.

@Inject
private TextField<String> textField;
@Inject
private Notifications notifications;

@Subscribe
protected void onInit(InitEvent event) {
    textField.addValueChangeListener(stringValueChangeEvent ->
            notifications.create()
                    .withCaption("Before: " + stringValueChangeEvent.getPrevValue() +
                            ". After: " + stringValueChangeEvent.getValue())
                    .show());
}

@Subscribe("textField")
protected void onTextFieldValueChange(HasValue.ValueChangeEvent<String> event) {
    notifications.create()
            .withCaption("Before: " + event.getPrevValue() +
                    ". After: " + event.getValue())
            .show();
}

addLayoutClickListener() - adds the listener implementing the LayoutClickListener interface to intercept the clicks on the component area.

vbox.addLayoutClickListener(layoutClickEvent ->
    notifications.create()
            .withCaption("Clicked")
            .show());

@Subscribe("vbox")
protected void onVboxLayoutClick(LayoutClickNotifier.LayoutClickEvent event) {
    notifications.create()
            .withCaption("Clicked")
            .show();
}

setMargin() - sets the margins for the component.

getMargin() - returns margin configuration as an instance of MarginInfo class.

setOuterMargin() - sets the outer margins outside the border of the component.

getOuterMargin() - returns outer margin configuration as an instance of MarginInfo class.

setSpacing() - adds space between the component and its child components.

vbox.setSpacing(true);

addShortcutAction() - adds an action which is triggered when the user presses a given key combination.

cssLayout.addShortcutAction(new ShortcutAction("SHIFT-A", shortcutTriggeredEvent ->
        notifications.create()
                .withCaption("SHIFT-A action")
                .show()));