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
|
/*
* Copyright 2000-2022 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.NotificationRole;
import com.vaadin.shared.ui.ui.UIState.NotificationTypeConfiguration;
import com.vaadin.ui.Notification.Type;
/**
* Provides methods for configuring the notification.
*
* @author Vaadin Ltd
* @since 7.2
*/
public interface NotificationConfiguration extends Serializable {
/**
* Sets the accessibility prefix for a notification type.
* <p>
* This prefix is read to assistive device users before the content of the
* notification, but not visible on the page.
*
* @param type
* type of the notification
* @param prefix
* string that is placed before the notification content
*/
public void setAssistivePrefix(Type type, String prefix);
/**
* Gets the accessibility prefix for a notification type.
* <p>
* This prefix is read to assistive device users before the content of the
* notification, but not visible on the page.
*
* @param type
* type of the notification
* @return The accessibility prefix for the provided notification type
*/
public String getAssistivePrefix(Type type);
/**
* Sets the accessibility postfix for a notification type.
* <p>
* This postfix is read to assistive device users after the content of the
* notification, but not visible on the page.
*
* @param type
* type of the notification
* @param postfix
* string that is placed after the notification content
*/
public void setAssistivePostfix(Type type, String postfix);
/**
* Gets the accessibility postfix for a notification type.
* <p>
* This postfix is read to assistive device users after the content of the
* notification, but not visible on the page.
*
* @param type
* type of the notification
* @return The accessibility postfix for the provided notification type
*/
public String getAssistivePostfix(Type type);
/**
* Sets the WAI-ARIA role for a notification type.
* <p>
* This role defines how an assistive device handles a notification.
* Available roles are alert 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 type
* type of the notification
* @param role
* role to set for the notification type
*/
public void setAssistiveRole(Type type, NotificationRole role);
/**
* Gets the WAI-ARIA role for a notification type.
* <p>
* This role defines how an assistive device handles a notification.
* Available roles are alert and status (@see
* <a href="http://www.w3.org/TR/2011/CR-wai-aria-20110118/roles">Roles
* Model</a>)
* <p>
* The default role is alert.
*
* @param type
* type of the notification
* @return role to set for the notification type
*/
public NotificationRole getAssistiveRole(Type type);
}
class NotificationConfigurationImpl implements NotificationConfiguration {
private final UI ui;
public NotificationConfigurationImpl(UI ui) {
this.ui = ui;
}
@Override
public void setAssistivePrefix(Type type, String prefix) {
getConfigurationBean(type).prefix = prefix;
}
@Override
public String getAssistivePrefix(Type type) {
NotificationTypeConfiguration styleSetup = getTypeConf(type);
if (styleSetup != null) {
return styleSetup.prefix;
}
return null;
}
@Override
public void setAssistivePostfix(Type type, String postfix) {
getConfigurationBean(type).postfix = postfix;
}
@Override
public String getAssistivePostfix(Type type) {
NotificationTypeConfiguration styleSetup = getTypeConf(type);
if (styleSetup != null) {
return styleSetup.postfix;
}
return null;
}
@Override
public void setAssistiveRole(Type type, NotificationRole role) {
getConfigurationBean(type).notificationRole = role;
}
@Override
public NotificationRole getAssistiveRole(Type type) {
NotificationTypeConfiguration styleSetup = getTypeConf(type);
if (styleSetup != null) {
return styleSetup.notificationRole;
}
return null;
}
private NotificationTypeConfiguration getConfigurationBean(Type type) {
NotificationTypeConfiguration styleSetup = getTypeConf(type);
if (styleSetup == null) {
styleSetup = new NotificationTypeConfiguration();
ui.getState().notificationConfigurations.put(type.getStyle(),
styleSetup);
}
return styleSetup;
}
private NotificationTypeConfiguration getTypeConf(Type type) {
return ui.getState().notificationConfigurations.get(type.getStyle());
}
}
|