com.vaadin.server.VariableOwner Maven / Gradle / Ivy
/*
* Copyright 2000-2014 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the 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();
/**
*
* 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 {@link #isImmediate()}.
*
*
* @return true if the component is in immediate mode,
* false if not.
*/
public boolean isImmediate();
}