Interface VariableOwner

  • All Superinterfaces:
    java.io.Serializable
    All Known Subinterfaces:
    LegacyComponent
    All Known Implementing Classes:
    ColorPickerPopup, CustomLayout, DragAndDropService, DragAndDropWrapper, LegacyWindow, MenuBar, Panel, UI, Upload, Window

    @Deprecated
    public interface VariableOwner
    extends java.io.Serializable
    Deprecated.
    As of 7.0. Only provided to ease porting of Vaadin 6 components. Do not implement this directly, implement LegacyComponent.

    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
    Author:
    Vaadin Ltd.
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void changeVariables​(java.lang.Object source, java.util.Map<java.lang.String,​java.lang.Object> variables)
      Deprecated.
      Called when one or more variables handled by the implementing class are changed.
      boolean isEnabled()
      Deprecated.
      Tests if the variable owner is enabled or not.
    • Method Detail

      • changeVariables

        void changeVariables​(java.lang.Object source,
                             java.util.Map<java.lang.String,​java.lang.Object> variables)
        Deprecated.
        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()
        Deprecated.

        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