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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
/*
* 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.ui;
import java.io.Serializable;
import com.vaadin.shared.ui.VMarginInfo;
import com.vaadin.shared.ui.AlignmentInfo.Bits;
/**
* Extension to the {@link ComponentContainer} interface which adds the
* layouting control to the elements in the container. This is required by the
* various layout components to enable them to place other components in
* specific locations in the UI.
*
* @author Vaadin Ltd.
* @since 3.0
*/
public interface Layout extends ComponentContainer, Serializable {
/**
* Enable layout margins. Affects all four sides of the layout. This will
* tell the client-side implementation to leave extra space around the
* layout. The client-side implementation decides the actual amount, and it
* can vary between themes.
*
* @param enabled
*/
public void setMargin(boolean enabled);
/**
* Enable specific layout margins. This will tell the client-side
* implementation to leave extra space around the layout in specified edges,
* clockwise from top (top, right, bottom, left). The client-side
* implementation decides the actual amount, and it can vary between themes.
*
* @param top
* @param right
* @param bottom
* @param left
*/
public void setMargin(boolean top, boolean right, boolean bottom,
boolean left);
/**
* AlignmentHandler is most commonly an advanced {@link Layout} that can
* align its components.
*/
public interface AlignmentHandler extends Serializable {
/**
* Contained component should be aligned horizontally to the left.
*
* @deprecated Use of {@link Alignment} class and its constants
*/
@Deprecated
public static final int ALIGNMENT_LEFT = Bits.ALIGNMENT_LEFT;
/**
* Contained component should be aligned horizontally to the right.
*
* @deprecated Use of {@link Alignment} class and its constants
*/
@Deprecated
public static final int ALIGNMENT_RIGHT = Bits.ALIGNMENT_RIGHT;
/**
* Contained component should be aligned vertically to the top.
*
* @deprecated Use of {@link Alignment} class and its constants
*/
@Deprecated
public static final int ALIGNMENT_TOP = Bits.ALIGNMENT_TOP;
/**
* Contained component should be aligned vertically to the bottom.
*
* @deprecated Use of {@link Alignment} class and its constants
*/
@Deprecated
public static final int ALIGNMENT_BOTTOM = Bits.ALIGNMENT_BOTTOM;
/**
* Contained component should be horizontally aligned to center.
*
* @deprecated Use of {@link Alignment} class and its constants
*/
@Deprecated
public static final int ALIGNMENT_HORIZONTAL_CENTER = Bits.ALIGNMENT_HORIZONTAL_CENTER;
/**
* Contained component should be vertically aligned to center.
*
* @deprecated Use of {@link Alignment} class and its constants
*/
@Deprecated
public static final int ALIGNMENT_VERTICAL_CENTER = Bits.ALIGNMENT_VERTICAL_CENTER;
/**
* Set alignment for one contained component in this layout. Alignment
* is calculated as a bit mask of the two passed values.
*
* @deprecated Use {@link #setComponentAlignment(Component, Alignment)}
* instead
*
* @param childComponent
* the component to align within it's layout cell.
* @param horizontalAlignment
* the horizontal alignment for the child component (left,
* center, right). Use ALIGNMENT constants.
* @param verticalAlignment
* the vertical alignment for the child component (top,
* center, bottom). Use ALIGNMENT constants.
*/
@Deprecated
public void setComponentAlignment(Component childComponent,
int horizontalAlignment, int verticalAlignment);
/**
* Set alignment for one contained component in this layout. Use
* predefined alignments from Alignment class.
*
* Example: <code>
* layout.setComponentAlignment(myComponent, Alignment.TOP_RIGHT);
* </code>
*
* @param childComponent
* the component to align within it's layout cell.
* @param alignment
* the Alignment value to be set
*/
public void setComponentAlignment(Component childComponent,
Alignment alignment);
/**
* Returns the current Alignment of given component.
*
* @param childComponent
* @return the {@link Alignment}
*/
public Alignment getComponentAlignment(Component childComponent);
}
/**
* This type of layout supports automatic addition of space between its
* components.
*
*/
public interface SpacingHandler extends Serializable {
/**
* Enable spacing between child components within this layout.
*
* <p>
* <strong>NOTE:</strong> This will only affect the space between
* components, not the space around all the components in the layout
* (i.e. do not confuse this with the cellspacing attribute of a HTML
* Table). Use {@link #setMargin(boolean)} to add space around the
* layout.
* </p>
*
* <p>
* See the reference manual for more information about CSS rules for
* defining the amount of spacing to use.
* </p>
*
* @param enabled
* true if spacing should be turned on, false if it should be
* turned off
*/
public void setSpacing(boolean enabled);
/**
*
* @return true if spacing between child components within this layout
* is enabled, false otherwise
*/
public boolean isSpacing();
}
/**
* This type of layout supports automatic addition of margins (space around
* its components).
*/
public interface MarginHandler extends Serializable {
/**
* Enable margins for this layout.
*
* <p>
* <strong>NOTE:</strong> This will only affect the space around the
* components in the layout, not space between the components in the
* layout. Use {@link #setSpacing(boolean)} to add space between the
* components in the layout.
* </p>
*
* <p>
* See the reference manual for more information about CSS rules for
* defining the size of the margin.
* </p>
*
* @param marginInfo
* MarginInfo object containing the new margins.
*/
public void setMargin(MarginInfo marginInfo);
/**
*
* @return MarginInfo containing the currently enabled margins.
*/
public MarginInfo getMargin();
}
@SuppressWarnings("serial")
public static class MarginInfo extends VMarginInfo implements Serializable {
public MarginInfo(boolean enabled) {
super(enabled, enabled, enabled, enabled);
}
public MarginInfo(boolean top, boolean right, boolean bottom,
boolean left) {
super(top, right, bottom, left);
}
}
}
|
