com.vaadin.terminal.


Interface VariableOwner

All Superinterfaces:

Serializable

All Known Subinterfaces:

Component, Component.Focusable, ComponentContainer, DragSource, DropTarget, Field, Layout

All Known Implementing Classes:

AbsoluteLayout, AbstractComponent, AbstractComponentContainer, AbstractField, AbstractLayout, AbstractMedia, AbstractOrderedLayout, AbstractSelect, AbstractSplitPanel, AbstractTextField, Accordion, Audio, Button, CheckBox, ComboBox, CssLayout, CustomComponent, CustomLayout, DateField, DragAndDropService, DragAndDropWrapper, Embedded, ExpandLayout, Form, FormLayout, GridLayout, HorizontalLayout, HorizontalSplitPanel, InlineDateField, Label, Link, ListSelect, LoginForm, MenuBar, NativeButton, NativeSelect, OptionGroup, OrderedLayout, Panel, PasswordField, PopupDateField, PopupView, ProgressIndicator, RichTextArea, Select, Slider, SplitPanel, Table, TabSheet, TextArea, TextField, Tree, TreeTable, TwinColSelect, Upload, UriFragmentUtility, VerticalLayout, VerticalSplitPanel, Video, Window

public interface VariableOwner
extends Serializable

Listener interface for UI variable changes. The user communicates with the application using the so-called variables. When the user makes a change using the UI the terminal trasmits the changed variables to the application, and the components owning those variables may then process those changes.

Since:

3.0

Version:

6.8.18

Author:

Vaadin Ltd.

Nested Class Summary
static interface VariableOwner.ErrorEvent
          VariableOwner error event.
 
Method Summary
 void changeVariables(Object source, Map<String,Object> variables)
          Called when one or more variables handled by the implementing class are changed.
 boolean isEnabled()
           Tests if the variable owner is enabled or not.
 boolean isImmediate()
           Tests if the variable owner is in immediate mode or not.
 

Method Detail

changeVariables

void changeVariables(Object source,
                     Map<String,Object> variables)

Called when one or more variables handled by the implementing class are changed.

Parameters:
source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.
variables - the Mapping from variable names to new variable values.

isEnabled

boolean isEnabled()

Tests if the variable owner is enabled or not. The terminal should not send any variable changes to disabled variable owners.

Returns:
true if the variable owner is enabled, false if not

isImmediate

boolean isImmediate()

Tests if the variable owner is in immediate mode or not. Being in immediate mode means that all variable changes are required to be sent back from the terminal immediately when they occur.

Note: VariableOwner does not include a set- method for the immediateness property. This is because not all VariableOwners wish to offer the functionality. Such VariableOwners are never in the immediate mode, thus they always return false in isImmediate().

Returns:
true if the component is in immediate mode, false if not.