diff options
Diffstat (limited to 'server/src/main/java/com/vaadin/ui/Notification.java')
| -rw-r--r-- | server/src/main/java/com/vaadin/ui/Notification.java | 76 |
1 files changed, 38 insertions, 38 deletions
diff --git a/server/src/main/java/com/vaadin/ui/Notification.java b/server/src/main/java/com/vaadin/ui/Notification.java index 6a619ed543..410493c81f 100644 --- a/server/src/main/java/com/vaadin/ui/Notification.java +++ b/server/src/main/java/com/vaadin/ui/Notification.java @@ -1,12 +1,12 @@ /* * Copyright 2000-2014 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 @@ -59,7 +59,7 @@ import com.vaadin.shared.Position; * configured to show up in a custom position, for a specified time (or until * clicked), and with a custom stylename. An icon can also be added. * </p> - * + * */ public class Notification implements Serializable { public enum Type { @@ -123,9 +123,9 @@ public class Notification implements Serializable { /** * Creates a "humanized" notification message. - * + * * The caption is rendered as plain text with HTML automatically escaped. - * + * * @param caption * The message to show */ @@ -135,9 +135,9 @@ public class Notification implements Serializable { /** * Creates a notification message of the specified type. - * + * * The caption is rendered as plain text with HTML automatically escaped. - * + * * @param caption * The message to show * @param type @@ -150,10 +150,10 @@ public class Notification implements Serializable { /** * Creates a "humanized" notification message with a bigger caption and * smaller description. - * + * * The caption and description are rendered as plain text with HTML * automatically escaped. - * + * * @param caption * The message caption * @param description @@ -166,10 +166,10 @@ public class Notification implements Serializable { /** * Creates a notification message of the specified type, with a bigger * caption and smaller description. - * + * * The caption and description are rendered as plain text with HTML * automatically escaped. - * + * * @param caption * The message caption * @param description @@ -184,9 +184,9 @@ public class Notification implements Serializable { /** * Creates a notification message of the specified type, with a bigger * caption and smaller description. - * + * * Care should be taken to to avoid XSS vulnerabilities if html is allowed. - * + * * @param caption * The message caption * @param description @@ -230,7 +230,7 @@ public class Notification implements Serializable { /** * Gets the caption part of the notification message. - * + * * @return The message caption */ public String getCaption() { @@ -239,7 +239,7 @@ public class Notification implements Serializable { /** * Sets the caption part of the notification message - * + * * @param caption * The message caption */ @@ -249,7 +249,7 @@ public class Notification implements Serializable { /** * Gets the description part of the notification message. - * + * * @return The message description. */ public String getDescription() { @@ -258,7 +258,7 @@ public class Notification implements Serializable { /** * Sets the description part of the notification message. - * + * * @param description */ public void setDescription(String description) { @@ -267,7 +267,7 @@ public class Notification implements Serializable { /** * Gets the position of the notification message. - * + * * @return The position */ public Position getPosition() { @@ -276,7 +276,7 @@ public class Notification implements Serializable { /** * Sets the position of the notification message. - * + * * @param position * The desired notification position */ @@ -286,7 +286,7 @@ public class Notification implements Serializable { /** * Gets the icon part of the notification message. - * + * * @return The message icon */ public Resource getIcon() { @@ -295,7 +295,7 @@ public class Notification implements Serializable { /** * Sets the icon part of the notification message. - * + * * @param icon * The desired message icon */ @@ -305,7 +305,7 @@ public class Notification implements Serializable { /** * Gets the delay before the notification disappears. - * + * * @return the delay in msec, -1 indicates the message has to be clicked. */ public int getDelayMsec() { @@ -314,7 +314,7 @@ public class Notification implements Serializable { /** * Sets the delay before the notification disappears. - * + * * @param delayMsec * the desired delay in msec, -1 to require the user to click the * message @@ -325,7 +325,7 @@ public class Notification implements Serializable { /** * Sets the style name for the notification message. - * + * * @param styleName * The desired style name. */ @@ -335,7 +335,7 @@ public class Notification implements Serializable { /** * Gets the style name for the notification message. - * + * * @return */ public String getStyleName() { @@ -347,7 +347,7 @@ public class Notification implements Serializable { * true, the texts are passed to the browser as html and the developer is * responsible for ensuring no harmful html is used. If set to false, the * texts are passed to the browser as plain text. - * + * * @param htmlContentAllowed * true if the texts are used as html, false if used as plain * text @@ -359,7 +359,7 @@ public class Notification implements Serializable { /** * Checks whether caption and description are interpreted as html or plain * text. - * + * * @return true if the texts are used as html, false if used as plain text * @see #setHtmlContentAllowed(boolean) */ @@ -369,7 +369,7 @@ public class Notification implements Serializable { /** * Shows this notification on a Page. - * + * * @param page * The page on which the notification should be shown */ @@ -381,12 +381,12 @@ public class Notification implements Serializable { /** * Shows a notification message on the middle of the current page. The * message automatically disappears ("humanized message"). - * + * * The caption is rendered as plain text with HTML automatically escaped. - * + * * @see #Notification(String) * @see #show(Page) - * + * * @param caption * The message */ @@ -399,12 +399,12 @@ public class Notification implements Serializable { * of the message depends on the type, which is one of the basic types * defined in {@link Notification}, for instance * Notification.TYPE_WARNING_MESSAGE. - * + * * The caption is rendered as plain text with HTML automatically escaped. - * + * * @see #Notification(String, int) * @see #show(Page) - * + * * @param caption * The message * @param type @@ -419,12 +419,12 @@ public class Notification implements Serializable { * of the message depends on the type, which is one of the basic types * defined in {@link Notification}, for instance * Notification.TYPE_WARNING_MESSAGE. - * + * * The caption is rendered as plain text with HTML automatically escaped. - * + * * @see #Notification(String, Type) * @see #show(Page) - * + * * @param caption * The message * @param description |