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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
/*
* Copyright 2000-2013 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.ui.NotificationConfigurationBean;
import com.vaadin.shared.ui.ui.NotificationConfigurationBean.Role;
import com.vaadin.shared.ui.ui.UIState.NotificationConfigurationState;
/**
* Provides methods for configuring the notification.
*
* @author Vaadin Ltd
* @since 7.1
*/
public interface NotificationConfiguration extends Serializable {
public void setStyleConfiguration(String style, String prefix,
String postfix, Role ariaRole);
/**
* Returns the complete configuration object for the given notification
* style.
*
* @param style
* String of the notification style to return
* @return The notification configuration object
*/
public NotificationConfigurationBean getStyleConfiguration(String style);
/**
* Sets the accessibility prefix for the given notification style.
*
* This prefix is read to assistive device users in front of the content of
* the notification, but not visible on the page.
*
* @param style
* String of the notification style
* @param prefix
* String that is placed before the notification content
*/
public void setAssistivePrefixForStyle(String style, String prefix);
/**
* Returns the accessibility prefix for the given notification style.
*
* This prefix is read to assistive device users in front of the content of
* the notification, but not visible on the page.
*
* @param style
* String of the notification style
* @return The prefix of the provided notification style
*/
public String getAssistivePrefixForStyle(String style);
/**
* Sets the accessibility postfix for the given notification style.
*
* This postfix is read to assistive device users after the content of the
* notification, but not visible on the page.
*
* @param style
* String of the notification style
* @param postfix
* String that is placed after the notification content
*/
public void setAssistivePostfixForStyle(String style, String postfix);
/**
* Returns the accessibility postfix for the given notification style.
*
* This postfix is read to assistive device users after the content of the
* notification, but not visible on the page.
*
* @param style
* String of the notification style
* @return The postfix of the provided notification style
*/
public String getAssistivePostfixForStyle(String style);
/**
* Sets the WAI-ARIA role for a notification style.
*
* This role defines how an assistive device handles a notification.
* Available roles are alert, alertdialog and status (@see <a
* href="http://www.w3.org/TR/2011/CR-wai-aria-20110118/roles">Roles
* Model</a>)
*
* The default role is alert.
*
* @param style
* String of the notification style
* @param role
* Role to set for the notification type
*/
public void setAssistiveRoleForStyle(String style, Role role);
/**
* Returns the WAI-ARIA role for a notification style.
*
* This role defines how an assistive device handles a notification.
* Available roles are alert, alertdialog and status (@see <a
* href="http://www.w3.org/TR/2011/CR-wai-aria-20110118/roles">Roles
* Model</a> )
*
* The default role is alert.
*
* @param style
* String of the notification style
* @return The current Role for the notification type
*/
public Role getAssistiveRoleForStyle(String style);
}
class NotificationConfigurationImpl implements NotificationConfiguration {
private UI ui;
public NotificationConfigurationImpl(UI ui) {
this.ui = ui;
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.ui.NotificationConfiguration#setStyleConfiguration(java.lang
* .String, java.lang.String, java.lang.String,
* com.vaadin.ui.NotificationConfiguration.Role)
*/
@Override
public void setStyleConfiguration(String style, String prefix,
String postfix, Role ariaRole) {
getState().setup.put(style, new NotificationConfigurationBean(prefix,
postfix, ariaRole));
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.ui.NotificationConfiguration#getStyleConfiguration(java.lang
* .String)
*/
@Override
public NotificationConfigurationBean getStyleConfiguration(String style) {
return getState(false).setup.get(style);
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.ui.NotificationConfiguration#setStylePrefix(java.lang.String,
* java.lang.String)
*/
@Override
public void setAssistivePrefixForStyle(String style, String prefix) {
getConfigurationBean(style).setAssistivePrefix(prefix);
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.ui.NotificationConfiguration#getStylePrefix(java.lang.String)
*/
@Override
public String getAssistivePrefixForStyle(String style) {
NotificationConfigurationBean styleSetup = getState().setup.get(style);
if (styleSetup != null) {
return styleSetup.getAssistivePrefix();
}
return null;
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.ui.NotificationConfiguration#setStylePostfix(com.vaadin.ui
* .Notification.Type, java.lang.String)
*/
@Override
public void setAssistivePostfixForStyle(String style, String postfix) {
getConfigurationBean(style).setAssistivePostfix(postfix);
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.ui.NotificationConfiguration#getStylePostfix(com.vaadin.ui
* .Notification.Type)
*/
@Override
public String getAssistivePostfixForStyle(String style) {
NotificationConfigurationBean styleSetup = getState().setup.get(style);
if (styleSetup != null) {
return styleSetup.getAssistivePostfix();
}
return null;
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.NotificationConfiguration#setStyleRole(com.vaadin.ui.
* Notification.Type, com.vaadin.ui.NotificationConfiguration.Role)
*/
@Override
public void setAssistiveRoleForStyle(String style, Role role) {
getConfigurationBean(style).setAssistiveRole(role);
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.NotificationConfiguration#getStyleRole(com.vaadin.ui.
* Notification.Type)
*/
@Override
public Role getAssistiveRoleForStyle(String style) {
NotificationConfigurationBean styleSetup = getState().setup.get(style);
if (styleSetup != null) {
return styleSetup.getAssistiveRole();
}
return null;
}
private NotificationConfigurationBean getConfigurationBean(String style) {
NotificationConfigurationBean styleSetup = getState().setup.get(style);
if (styleSetup == null) {
styleSetup = new NotificationConfigurationBean();
getState().setup.put(style, styleSetup);
}
return styleSetup;
}
private NotificationConfigurationState getState() {
return ui.getState().notificationConfiguration;
}
private NotificationConfigurationState getState(boolean markAsDirty) {
return ui.getState(markAsDirty).notificationConfiguration;
}
}
|
