blob: faa0298311bd0bd1569c3e1d8c0e6d302412a1ed (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*
* Copyright 2011 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.terminal;
import java.io.Serializable;
import java.util.Map;
/**
* <p>
* Listener interface for UI variable changes. The user communicates with the
* application using the so-called <i>variables</i>. 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.
* </p>
*
* @author Vaadin Ltd.
* @since 3.0
* @deprecated in 7.0. Only provided to ease porting of Vaadin 6 components. Do
* not implement this directly, implement {@link Vaadin6Component}.
*/
@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<String, Object> variables);
/**
* <p>
* Tests if the variable owner is enabled or not. The terminal should not
* send any variable changes to disabled variable owners.
* </p>
*
* @return <code>true</code> if the variable owner is enabled,
* <code>false</code> if not
*/
public boolean isEnabled();
/**
* <p>
* 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.
* </p>
*
* <p>
* <strong>Note:</strong> <code>VariableOwner</code> 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 <code>false</code>
* in {@link #isImmediate()}.
* </p>
*
* @return <code>true</code> if the component is in immediate mode,
* <code>false</code> if not.
*/
public boolean isImmediate();
/**
* VariableOwner error event.
*/
public interface ErrorEvent extends Terminal.ErrorEvent {
/**
* Gets the source VariableOwner.
*
* @return the variable owner.
*/
public VariableOwner getVariableOwner();
}
}
|
