com.vaadin.server.VariableOwner Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.server;
import java.io.Serializable;
import java.util.Map;
import com.vaadin.ui.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.
*
*
* @author Vaadin Ltd.
* @since 3.0
* @deprecated As of 7.0. Only provided to ease porting of Vaadin 6 components.
* Do not implement this directly, implement
* {@link LegacyComponent}.
*/
@Deprecated
public interface VariableOwner extends Serializable {
/**
* Called when one or more variables handled by the implementing class are
* changed.
*
* @param source
* the Source of the variable change. This is the origin of the
* event. For example in Web Adapter this is the request.
* @param variables
* the Mapping from variable names to new variable values.
*/
public void changeVariables(Object source, Map variables);
/**
*
* Tests if the variable owner is enabled or not. The terminal should not
* send any variable changes to disabled variable owners.
*
*
* @return true if the variable owner is enabled,
* false if not
*/
public boolean isEnabled();
}