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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*
* Copyright 2000-2016 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.ui;
import java.io.Serializable;
import java.lang.reflect.Method;
import java.util.Iterator;
import com.vaadin.shared.Registration;
import com.vaadin.util.ReflectTools;
/**
* Interface that must be implemented by all {@link Component}s that contain
* other {@link Component}s.
*
* @author Vaadin Ltd
* @since 7.0.0
*
*/
public interface HasComponents extends Component, Iterable<Component> {
/**
* Gets an iterator to the collection of contained components. Using this
* iterator it is possible to step through all components contained in this
* container.
* <p>
* The iterator is typically unmodifiable, and calls to
* {@link Iterator#remove()} throw an exception.
*
* @return the component iterator.
*/
@Override
public Iterator<Component> iterator();
/**
* Interface for {@link HasComponents} implementations that support sending
* attach and detach events for components.
*
* @since 7.0
*/
public interface ComponentAttachDetachNotifier extends Serializable {
/**
* Listens the component attach events.
*
* @see Registration
*
* @param listener
* the listener to add, not null
* @return a registration object for removing the listener
* @since 8.0
*/
public Registration addComponentAttachListener(
ComponentAttachListener listener);
/**
* Stops the listening component attach events.
*
* @param listener
* the listener to removed.
*
* @deprecated As of 8.0, replaced by {@link Registration#remove()} in
* the registration object returned from
* {@link #addComponentAttachListener(ComponentAttachListener)}
* .
* @since 8.0
*/
@Deprecated
public void removeComponentAttachListener(
ComponentAttachListener listener);
/**
* Listens the component detach events.
*/
public Registration addComponentDetachListener(
ComponentDetachListener listener);
/**
* Stops the listening component detach events.
*/
@Deprecated
public void removeComponentDetachListener(
ComponentDetachListener listener);
}
/**
* Component attach listener interface.
*/
@FunctionalInterface
public interface ComponentAttachListener extends Serializable {
public static final Method attachMethod = ReflectTools.findMethod(
ComponentAttachListener.class, "componentAttachedToContainer",
ComponentAttachEvent.class);
/**
* A new component is attached to container.
*
* @param event
* the component attach event.
*/
public void componentAttachedToContainer(ComponentAttachEvent event);
}
/**
* Component detach listener interface.
*/
@FunctionalInterface
public interface ComponentDetachListener extends Serializable {
public static final Method detachMethod = ReflectTools.findMethod(
ComponentDetachListener.class, "componentDetachedFromContainer",
ComponentDetachEvent.class);
/**
* A component has been detached from container.
*
* @param event
* the component detach event.
*/
public void componentDetachedFromContainer(ComponentDetachEvent event);
}
/**
* Component attach event sent when a component is attached to container.
*/
@SuppressWarnings("serial")
public static class ComponentAttachEvent extends Component.Event {
private final Component component;
/**
* Creates a new attach event.
*
* @param container
* the container the component has been detached to.
* @param attachedComponent
* the component that has been attached.
*/
public ComponentAttachEvent(HasComponents container,
Component attachedComponent) {
super(container);
component = attachedComponent;
}
/**
* Gets the component container.
*
*/
public HasComponents getContainer() {
return (HasComponents) getSource();
}
/**
* Gets the attached component.
*
*/
public Component getAttachedComponent() {
return component;
}
}
/**
* Component detach event sent when a component is detached from container.
*/
@SuppressWarnings("serial")
public static class ComponentDetachEvent extends Component.Event {
private final Component component;
/**
* Creates a new detach event.
*
* @param container
* the container the component has been detached from.
* @param detachedComponent
* the component that has been detached.
*/
public ComponentDetachEvent(HasComponents container,
Component detachedComponent) {
super(container);
component = detachedComponent;
}
/**
* Gets the component container.
*
*/
public HasComponents getContainer() {
return (HasComponents) getSource();
}
/**
* Gets the detached component.
*
* @return the detached component.
*/
public Component getDetachedComponent() {
return component;
}
}
}
|
