aboutsummaryrefslogtreecommitdiffstats
path: root/server/src/main/java/com/vaadin/ui/UI.java
diff options
context:
space:
mode:
authorArtur Signell <artur@vaadin.com>2016-08-18 09:31:40 +0300
committerArtur Signell <artur@vaadin.com>2016-08-18 09:31:40 +0300
commiteeffa805a212ebb25c4af18db1e927b23a3ad66a (patch)
tree3bfdb4ef4b8e9b6e9e45c77c90b4f31eba1af94e /server/src/main/java/com/vaadin/ui/UI.java
parent6d54d78944f6c3278eed3bb5e7ee19687ee5714e (diff)
downloadvaadin-framework-eeffa805a212ebb25c4af18db1e927b23a3ad66a.tar.gz
vaadin-framework-eeffa805a212ebb25c4af18db1e927b23a3ad66a.zip
Remove trailing whitespace from code and javadoc
Change-Id: I4c852b7f9928e190572876690d5bef1234494a5d
Diffstat (limited to 'server/src/main/java/com/vaadin/ui/UI.java')
-rw-r--r--server/src/main/java/com/vaadin/ui/UI.java212
1 files changed, 106 insertions, 106 deletions
diff --git a/server/src/main/java/com/vaadin/ui/UI.java b/server/src/main/java/com/vaadin/ui/UI.java
index 299cecd92a..fcae3c7b2e 100644
--- a/server/src/main/java/com/vaadin/ui/UI.java
+++ b/server/src/main/java/com/vaadin/ui/UI.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
@@ -98,10 +98,10 @@ import com.vaadin.util.CurrentInstance;
* passing a {@link Component} with the main layout or other content of the view
* to {@link #setContent(Component)} or to the constructor of the UI.
* </p>
- *
+ *
* @see #init(VaadinRequest)
* @see UIProvider
- *
+ *
* @since 7.0
*/
public abstract class UI extends AbstractSingleComponentContainer
@@ -128,7 +128,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* The id of this UI, used to find the server side instance of the UI form
* which a request originates. A negative value indicates that the UI id has
* not yet been assigned by the Application.
- *
+ *
* @see VaadinSession#getNextUIid()
*/
private int uiId = -1;
@@ -280,10 +280,10 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Creates a new UI with the given component (often a layout) as its
* content.
- *
+ *
* @param content
* the component to use as this UIs content.
- *
+ *
* @see #setContent(Component)
*/
public UI(Component content) {
@@ -312,9 +312,9 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Overridden to return a value instead of referring to the parent.
- *
+ *
* @return this UI
- *
+ *
* @see com.vaadin.ui.AbstractComponent#getUI()
*/
@Override
@@ -324,12 +324,12 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Gets the application object to which the component is attached.
- *
+ *
* <p>
* The method will return {@code null} if the component is not currently
* attached to an application.
* </p>
- *
+ *
* <p>
* Getting a null value is often a problem in constructors of regular
* components and in the initializers of custom composite components. A
@@ -338,7 +338,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* Another way is to move the problematic initialization to
* {@link #attach()}, as described in the documentation of the method.
* </p>
- *
+ *
* @return the parent application of the component or <code>null</code>.
* @see #attach()
*/
@@ -376,7 +376,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Fire a click event to all click listeners.
- *
+ *
* @param object
* The raw "value" of the variable change from the client side.
*/
@@ -408,7 +408,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/*
* (non-Javadoc)
- *
+ *
* @see com.vaadin.ui.HasComponents#iterator()
*/
@Override
@@ -428,7 +428,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/*
* (non-Javadoc)
- *
+ *
* @see com.vaadin.ui.ComponentContainer#getComponentCount()
*/
@Override
@@ -442,13 +442,13 @@ public abstract class UI extends AbstractSingleComponentContainer
* This method is for internal use by the framework. To explicitly close a
* UI, see {@link #close()}.
* </p>
- *
+ *
* @param session
* the session to set
- *
+ *
* @throws IllegalStateException
* if the session has already been set
- *
+ *
* @see #getSession()
*/
public void setSession(VaadinSession session) {
@@ -501,7 +501,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* This method is not intended to be overridden. If it is overridden, care
* should be taken since this method might be called in situations where
* {@link UI#getCurrent()} does not return this UI.
- *
+ *
* @return the id of this UI
*/
public int getUIId() {
@@ -511,7 +511,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Adds a window as a subwindow inside this UI. To open a new browser window
* or tab, you should instead use a {@link UIProvider}.
- *
+ *
* @param window
* @throws IllegalArgumentException
* if the window is already added to an application
@@ -535,7 +535,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Helper method to attach a window.
- *
+ *
* @param w
* the window to add
*/
@@ -548,13 +548,13 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Remove the given subwindow from this UI.
- *
+ *
* Since Vaadin 6.5, {@link Window.CloseListener}s are called also when
* explicitly removing a window by calling this method.
- *
+ *
* Since Vaadin 6.5, returns a boolean indicating if the window was removed
* or not.
- *
+ *
* @param window
* Window to be removed.
* @return true if the subwindow was removed, false otherwise
@@ -574,7 +574,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Gets all the windows added to this UI.
- *
+ *
* @return an unmodifiable collection of windows
*/
public Collection<Window> getWindows() {
@@ -609,10 +609,10 @@ public abstract class UI extends AbstractSingleComponentContainer
* Component.Focusable) due we want the last focused component to be focused
* in client too. Not the one that is rendered last (the case we'd get if
* implemented in Focusable only).
- *
+ *
* To focus component from Vaadin application, use Focusable.focus(). See
* {@link Focusable}.
- *
+ *
* @param focusable
* to be focused on next paint
*/
@@ -625,7 +625,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* Scrolls any component between the component and UI to a suitable position
* so the component is visible to the user. The given component must belong
* to this UI.
- *
+ *
* @param component
* the component to be scrolled into view
* @throws IllegalArgumentException
@@ -645,7 +645,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* Internal initialization method, should not be overridden. This method is
* not declared as final because that would break compatibility with e.g.
* CDI.
- *
+ *
* @param request
* the initialization request
* @param uiId
@@ -653,7 +653,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* @param embedId
* the embed id of this UI, or <code>null</code> if no id is
* known
- *
+ *
* @see #getUIId()
* @see #getEmbedId()
*/
@@ -699,7 +699,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* The {@link VaadinRequest} can be used to get information about the
* request that caused this UI to be created.
* </p>
- *
+ *
* @param request
* the Vaadin request that caused this UI to be created
*/
@@ -707,7 +707,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Internal reinitialization method, should not be overridden.
- *
+ *
* @since 7.2
* @param request
* the request that caused this UI to be reloaded
@@ -751,7 +751,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* <p>
* The {@link VaadinRequest} can be used to get information about the
* request that caused this UI to be reloaded.
- *
+ *
* @since 7.2
* @param request
* the request that caused this UI to be reloaded
@@ -770,10 +770,10 @@ public abstract class UI extends AbstractSingleComponentContainer
* <p>
* The UI is stored using a weak reference to avoid leaking memory in case
* it is not explicitly cleared.
- *
+ *
* @param ui
* the UI to register as the current UI
- *
+ *
* @see #getCurrent()
* @see ThreadLocal
*/
@@ -788,9 +788,9 @@ public abstract class UI extends AbstractSingleComponentContainer
* <p>
* The UI is stored using a weak reference to avoid leaking memory in case
* it is not explicitly cleared.
- *
+ *
* @return the current UI instance if available, otherwise <code>null</code>
- *
+ *
* @see #setCurrent(UI)
*/
public static UI getCurrent() {
@@ -799,7 +799,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Set top offset to which the UI should scroll to.
- *
+ *
* @param scrollTop
*/
public void setScrollTop(int scrollTop) {
@@ -819,7 +819,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Set left offset to which the UI should scroll to.
- *
+ *
* @param scrollLeft
*/
public void setScrollLeft(int scrollLeft) {
@@ -883,7 +883,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* When there are active window resize listeners, lazy resize mode should be
* used to avoid a large number of events during resize.
* </p>
- *
+ *
* @param resizeLazy
* true to use a delay before recalculating sizes, false to
* calculate immediately.
@@ -895,7 +895,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Checks whether lazy resize is enabled.
- *
+ *
* @return <code>true</code> if lazy resize is enabled, <code>false</code>
* if lazy resize is not enabled
*/
@@ -908,9 +908,9 @@ public abstract class UI extends AbstractSingleComponentContainer
* clicks inside the UI. Also when the click targets a component inside the
* UI, provided the targeted component does not prevent the click event from
* propagating.
- *
+ *
* Use {@link #removeListener(ClickListener)} to remove the listener.
- *
+ *
* @param listener
* The listener to add
*/
@@ -931,7 +931,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Remove a click listener from the UI. The listener should earlier have
* been added using {@link #addListener(ClickListener)}.
- *
+ *
* @param listener
* The listener to remove
*/
@@ -966,7 +966,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Returns the navigator attached to this UI or null if there is no
* navigator.
- *
+ *
* @return
*/
public Navigator getNavigator() {
@@ -975,7 +975,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* For internal use only.
- *
+ *
* @param navigator
*/
public void setNavigator(Navigator navigator) {
@@ -985,7 +985,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Setting the caption of a UI is not supported. To set the title of the
* HTML page, use Page.setTitle
- *
+ *
* @deprecated As of 7.0, use {@link Page#setTitle(String)}
*/
@Override
@@ -998,16 +998,16 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Shows a notification message on the middle of the UI. The message
* automatically disappears ("humanized message").
- *
+ *
* Care should be taken to to avoid XSS vulnerabilities as the caption is
* rendered as html.
- *
+ *
* @see #showNotification(Notification)
* @see Notification
- *
+ *
* @param caption
* The message
- *
+ *
* @deprecated As of 7.0, use Notification.show instead but be aware that
* Notification.show does not allow HTML.
*/
@@ -1022,18 +1022,18 @@ public abstract class UI extends AbstractSingleComponentContainer
* Shows a notification message the UI. The position and behavior of the
* message depends on the type, which is one of the basic types defined in
* {@link Notification}, for instance Notification.TYPE_WARNING_MESSAGE.
- *
+ *
* Care should be taken to to avoid XSS vulnerabilities as the caption is
* rendered as html.
- *
+ *
* @see #showNotification(Notification)
* @see Notification
- *
+ *
* @param caption
* The message
* @param type
* The message type
- *
+ *
* @deprecated As of 7.0, use Notification.show instead but be aware that
* Notification.show does not allow HTML.
*/
@@ -1048,18 +1048,18 @@ public abstract class UI extends AbstractSingleComponentContainer
* Shows a notification consisting of a bigger caption and a smaller
* description on the middle of the UI. The message automatically disappears
* ("humanized message").
- *
+ *
* Care should be taken to to avoid XSS vulnerabilities as the caption and
* description are rendered as html.
- *
+ *
* @see #showNotification(Notification)
* @see Notification
- *
+ *
* @param caption
* The caption of the message
* @param description
* The message description
- *
+ *
* @deprecated As of 7.0, use new Notification(...).show(Page) instead but
* be aware that HTML by default not allowed.
*/
@@ -1075,20 +1075,20 @@ public abstract class UI extends AbstractSingleComponentContainer
* description. The position and behavior of the message depends on the
* type, which is one of the basic types defined in {@link Notification} ,
* for instance Notification.TYPE_WARNING_MESSAGE.
- *
+ *
* Care should be taken to to avoid XSS vulnerabilities as the caption and
* description are rendered as html.
- *
+ *
* @see #showNotification(Notification)
* @see Notification
- *
+ *
* @param caption
* The caption of the message
* @param description
* The message description
* @param type
* The message type
- *
+ *
* @deprecated As of 7.0, use new Notification(...).show(Page) instead but
* be aware that HTML by default not allowed.
*/
@@ -1106,13 +1106,13 @@ public abstract class UI extends AbstractSingleComponentContainer
* description. The position and behavior of the message depends on the
* type, which is one of the basic types defined in {@link Notification} ,
* for instance Notification.TYPE_WARNING_MESSAGE.
- *
+ *
* Care should be taken to avoid XSS vulnerabilities if html content is
* allowed.
- *
+ *
* @see #showNotification(Notification)
* @see Notification
- *
+ *
* @param caption
* The message caption
* @param description
@@ -1122,7 +1122,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* @param htmlContentAllowed
* Whether html in the caption and description should be
* displayed as html or as plain text
- *
+ *
* @deprecated As of 7.0, use new Notification(...).show(Page).
*/
@Deprecated
@@ -1134,16 +1134,16 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Shows a notification message.
- *
+ *
* @see Notification
* @see #showNotification(String)
* @see #showNotification(String, int)
* @see #showNotification(String, String)
* @see #showNotification(String, String, int)
- *
+ *
* @param notification
* The notification message to show
- *
+ *
* @deprecated As of 7.0, use Notification.show instead
*/
@Deprecated
@@ -1157,9 +1157,9 @@ public abstract class UI extends AbstractSingleComponentContainer
* This method is not intended to be overridden. If it is overridden, care
* should be taken since this method might be called in situations where
* {@link UI#getCurrent()} does not return this UI.
- *
+ *
* @see VaadinService#closeInactiveUIs(VaadinSession)
- *
+ *
* @return The time the last heartbeat request occurred, in milliseconds
* since the epoch.
*/
@@ -1175,7 +1175,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* This method is not intended to be overridden. If it is overridden, care
* should be taken since this method might be called in situations where
* {@link UI#getCurrent()} does not return this UI.
- *
+ *
* @param lastHeartbeat
* The time the last heartbeat request occurred, in milliseconds
* since the epoch.
@@ -1186,7 +1186,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Gets the theme currently in use by this UI
- *
+ *
* @return the theme name
*/
public String getTheme() {
@@ -1203,7 +1203,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* other environment where there are multiple UIs on the same page. The old
* CSS file will be removed even if there are other UIs on the page which
* are still using it.
- *
+ *
* @since 7.3
* @param theme
* The new theme name
@@ -1258,9 +1258,9 @@ public abstract class UI extends AbstractSingleComponentContainer
* This method is not intended to be overridden. If it is overridden, care
* should be taken since this method might be called in situations where
* {@link UI#getCurrent()} does not return this UI.
- *
+ *
* @see #close()
- *
+ *
* @return whether this UI is closing.
*/
public boolean isClosing() {
@@ -1271,7 +1271,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* Called after the UI is added to the session. A UI instance is attached
* exactly once, before its {@link #init(VaadinRequest) init} method is
* called.
- *
+ *
* @see Component#attach
*/
@Override
@@ -1300,7 +1300,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/*
* (non-Javadoc)
- *
+ *
* @see
* com.vaadin.ui.AbstractSingleComponentContainer#setContent(com.vaadin.
* ui.Component)
@@ -1346,9 +1346,9 @@ public abstract class UI extends AbstractSingleComponentContainer
* later point in time.</li>
* </ul>
* </p>
- *
+ *
* @since 7.1
- *
+ *
* @param runnable
* the runnable which accesses the UI
* @throws UIDetachedException
@@ -1356,7 +1356,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* therefore not be done)
* @throws IllegalStateException
* if the current thread holds the lock for another session
- *
+ *
* @see #access(Runnable)
* @see VaadinSession#accessSynchronously(Runnable)
*/
@@ -1420,14 +1420,14 @@ public abstract class UI extends AbstractSingleComponentContainer
* The returned future can be used to check for task completion and to
* cancel the task.
* </p>
- *
+ *
* @see #getCurrent()
* @see #accessSynchronously(Runnable)
* @see VaadinSession#access(Runnable)
* @see VaadinSession#lock()
- *
+ *
* @since 7.1
- *
+ *
* @param runnable
* the runnable which accesses the UI
* @throws UIDetachedException
@@ -1478,7 +1478,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Retrieves the object used for configuring tooltips.
- *
+ *
* @return The instance used for tooltip configuration
*/
public TooltipConfiguration getTooltipConfiguration() {
@@ -1487,7 +1487,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Retrieves the object used for configuring notifications.
- *
+ *
* @return The instance used for notification configuration
*/
public NotificationConfiguration getNotificationConfiguration() {
@@ -1496,7 +1496,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Retrieves the object used for configuring the loading indicator.
- *
+ *
* @return The instance used for configuring the loading indicator
*/
public LoadingIndicatorConfiguration getLoadingIndicatorConfiguration() {
@@ -1515,14 +1515,14 @@ public abstract class UI extends AbstractSingleComponentContainer
* return this UI since writing the response may invoke logic in any
* attached component or extension. The recommended way of fulfilling these
* conditions is to use {@link #access(Runnable)}.
- *
+ *
* @throws IllegalStateException
* if push is disabled.
* @throws UIDetachedException
* if this UI is not attached to a session.
- *
+ *
* @see #getPushConfiguration()
- *
+ *
* @since 7.1
*/
public void push() {
@@ -1560,7 +1560,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* This method is not intended to be overridden. If it is overridden, care
* should be taken since this method might be called in situations where
* {@link UI#getCurrent()} does not return this UI.
- *
+ *
* @return the push connection used by this UI, or {@code null} if push is
* not available.
*/
@@ -1576,7 +1576,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* <p>
* The {@code pushConnection} argument must be non-null if and only if
* {@code getPushConfiguration().getPushMode().isEnabled()}.
- *
+ *
* @param pushConnection
* the push connection to use for this UI
*/
@@ -1609,7 +1609,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* application developer. An add-on should not set the poll interval
* directly, rather instruct the user to set it.
* </p>
- *
+ *
* @param intervalInMillis
* The interval (in ms) with which the UI should poll the server
* or -1 to disable polling
@@ -1620,7 +1620,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Returns the interval with which the UI polls the server.
- *
+ *
* @return The interval (in ms) with which the UI polls the server or -1 if
* polling is disabled
*/
@@ -1641,7 +1641,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Retrieves the object used for configuring the push channel.
- *
+ *
* @since 7.1
* @return The instance used for push configuration
*/
@@ -1651,7 +1651,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Retrieves the object used for configuring the reconnect dialog.
- *
+ *
* @since 7.6
* @return The instance used for reconnect dialog configuration
*/
@@ -1662,7 +1662,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Get the label that is added to the container element, where tooltip,
* notification and dialogs are added to.
- *
+ *
* @return the label of the container
*/
public String getOverlayContainerLabel() {
@@ -1676,7 +1676,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* This is helpful for users of assistive devices, as this element is
* reachable for them.
* </p>
- *
+ *
* @param overlayContainerLabel
* label to use for the container
*/
@@ -1687,7 +1687,7 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Returns the locale service which handles transmission of Locale data to
* the client.
- *
+ *
* @since 7.1
* @return The LocaleService for this UI
*/
@@ -1704,7 +1704,7 @@ public abstract class UI extends AbstractSingleComponentContainer
* it is embedded. The embed identifier is based on the
* <code>window.name</code> DOM attribute of the browser window where the UI
* is displayed and the id of the div element where the UI is embedded.
- *
+ *
* @since 7.2
* @return the embed id for this UI, or <code>null</code> if no id known
*/
@@ -1714,9 +1714,9 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Gets the last processed server message id.
- *
+ *
* Used internally for communication tracking.
- *
+ *
* @return lastProcessedServerMessageId the id of the last processed server
* message
* @since 7.6
@@ -1727,9 +1727,9 @@ public abstract class UI extends AbstractSingleComponentContainer
/**
* Sets the last processed server message id.
- *
+ *
* Used internally for communication tracking.
- *
+ *
* @param lastProcessedServerMessageId
* the id of the last processed server message
* @since 7.6