Also includes minor other javadoc and formatting fixes.tags/8.2.0.alpha3
@@ -249,7 +249,8 @@ public final class CvalChecker { | |||
msg = info.getMessage().replace("\\n", "\n"); | |||
} else if (info != null && info.isLicenseExpired()) { | |||
String type = "evaluation".equals(info.getType()) | |||
? "Evaluation license" : "License"; | |||
? "Evaluation license" | |||
: "License"; | |||
msg = getErrorMessage("expired", title, majorVers, type); | |||
} else if (key == null) { | |||
msg = getErrorMessage("none", title, majorVers); | |||
@@ -261,7 +262,7 @@ public final class CvalChecker { | |||
} | |||
/** | |||
* Exception thrown when the license server is unreachable | |||
* Exception thrown when the license server is unreachable. | |||
*/ | |||
public static class UnreachableCvalServerException extends Exception { | |||
private static final long serialVersionUID = 1L; |
@@ -204,7 +204,7 @@ public class ApplicationConfiguration implements EntryPoint { | |||
} | |||
/** | |||
* Wraps a native javascript object containing fields for an error message | |||
* Wraps a native javascript object containing fields for an error message. | |||
* | |||
* @since 7.0 | |||
*/ | |||
@@ -311,7 +311,7 @@ public class ApplicationConfiguration implements EntryPoint { | |||
} | |||
/** | |||
* Gets the URL to the context root of the web application | |||
* Gets the URL to the context root of the web application. | |||
* | |||
* @return the URL to the server-side context root as a string | |||
* | |||
@@ -833,7 +833,7 @@ public class ApplicationConfiguration implements EntryPoint { | |||
/** | |||
* Registers that callback that the bootstrap javascript uses to start | |||
* applications once the widgetset is loaded and all required information is | |||
* available | |||
* available. | |||
* | |||
* @param widgetsetName | |||
* the name of this widgetset | |||
@@ -882,7 +882,7 @@ public class ApplicationConfiguration implements EntryPoint { | |||
}-*/; | |||
/** | |||
* Checks whether debug logging should be quiet | |||
* Checks whether debug logging should be quiet. | |||
* | |||
* @return <code>true</code> if debug logging should be quiet | |||
*/ |
@@ -288,7 +288,7 @@ public class ApplicationConnection implements HasHandlers { | |||
/** | |||
* Triggered when the {@link ApplicationConnection} marks a previously | |||
* running application as stopped by invoking | |||
* {@link ApplicationConnection#setApplicationRunning(false)} | |||
* {@link ApplicationConnection#setApplicationRunning(false)}. | |||
* | |||
* @param event | |||
* the event triggered by the {@link ApplicationConnection} | |||
@@ -756,7 +756,7 @@ public class ApplicationConnection implements HasHandlers { | |||
} | |||
/** | |||
* Returns the loading indicator used by this ApplicationConnection | |||
* Returns the loading indicator used by this ApplicationConnection. | |||
* | |||
* @return The loading indicator for this ApplicationConnection | |||
*/ | |||
@@ -1058,7 +1058,7 @@ public class ApplicationConnection implements HasHandlers { | |||
} | |||
/** | |||
* Returns false | |||
* Returns false. | |||
* | |||
* @param paintable | |||
* @return false, always | |||
@@ -1235,7 +1235,7 @@ public class ApplicationConnection implements HasHandlers { | |||
} | |||
/** | |||
* Gets the main view | |||
* Gets the main view. | |||
* | |||
* @return the main view | |||
*/ | |||
@@ -1306,7 +1306,7 @@ public class ApplicationConnection implements HasHandlers { | |||
} | |||
/** | |||
* Get VTooltip instance related to application connection | |||
* Get VTooltip instance related to application connection. | |||
* | |||
* @return VTooltip instance | |||
*/ | |||
@@ -1517,7 +1517,7 @@ public class ApplicationConnection implements HasHandlers { | |||
} | |||
/** | |||
* Gets the server RPC queue for this application | |||
* Gets the server RPC queue for this application. | |||
* | |||
* @since 7.6 | |||
* @return the server RPC queue | |||
@@ -1527,7 +1527,7 @@ public class ApplicationConnection implements HasHandlers { | |||
} | |||
/** | |||
* Gets the communication error handler for this application | |||
* Gets the communication error handler for this application. | |||
* | |||
* @since 7.6 | |||
* @return the server RPC queue | |||
@@ -1537,7 +1537,7 @@ public class ApplicationConnection implements HasHandlers { | |||
} | |||
/** | |||
* Gets the (server to client) message handler for this application | |||
* Gets the (server to client) message handler for this application. | |||
* | |||
* @since 7.6 | |||
* @return the message handler | |||
@@ -1547,7 +1547,7 @@ public class ApplicationConnection implements HasHandlers { | |||
} | |||
/** | |||
* Gets the server rpc manager for this application | |||
* Gets the server rpc manager for this application. | |||
* | |||
* @since 7.6 | |||
* @return the server rpc manager | |||
@@ -1557,7 +1557,7 @@ public class ApplicationConnection implements HasHandlers { | |||
} | |||
/** | |||
* Gets the (client to server) message sender for this application | |||
* Gets the (client to server) message sender for this application. | |||
* | |||
* @since 7.6 | |||
* @return the message sender |
@@ -404,7 +404,7 @@ public class BrowserInfo { | |||
} | |||
/** | |||
* Checks if the browser is run on iOS | |||
* Checks if the browser is run on iOS. | |||
* | |||
* @return true if the browser is run on iOS, false otherwise | |||
*/ | |||
@@ -423,7 +423,7 @@ public class BrowserInfo { | |||
} | |||
/** | |||
* Checks if the browser is run on Android | |||
* Checks if the browser is run on Android. | |||
* | |||
* @return true if the browser is run on Android, false otherwise | |||
*/ | |||
@@ -461,7 +461,7 @@ public class BrowserInfo { | |||
/** | |||
* Tests if this is an Android devices with a broken scrollTop | |||
* implementation | |||
* implementation. | |||
* | |||
* @return true if scrollTop cannot be trusted on this device, false | |||
* otherwise |
@@ -39,7 +39,7 @@ public interface ComponentConnector extends ServerConnector { | |||
public AbstractComponentState getState(); | |||
/** | |||
* Returns the widget for this {@link ComponentConnector} | |||
* Returns the widget for this {@link ComponentConnector}. | |||
*/ | |||
public Widget getWidget(); | |||
@@ -37,7 +37,7 @@ public class ConnectorMap { | |||
.create(); | |||
/** | |||
* Returns a {@link ServerConnector} by its id | |||
* Returns a {@link ServerConnector} by its id. | |||
* | |||
* @param connectorId | |||
* The connector id | |||
@@ -104,7 +104,7 @@ public class ConnectorMap { | |||
} | |||
/** | |||
* Removes all registered connectors | |||
* Removes all registered connectors. | |||
*/ | |||
public void clear() { | |||
idToComponentDetail.clear(); | |||
@@ -197,7 +197,7 @@ public class ConnectorMap { | |||
} | |||
/** | |||
* Gets all registered {@link ComponentConnector} instances | |||
* Gets all registered {@link ComponentConnector} instances. | |||
* | |||
* @return An array of all registered {@link ComponentConnector} instances | |||
* |
@@ -32,7 +32,7 @@ import com.vaadin.shared.MouseEventDetails.MouseButton; | |||
public class MouseEventDetailsBuilder { | |||
/** | |||
* Construct a {@link MouseEventDetails} object from the given event | |||
* Construct a {@link MouseEventDetails} object from the given event. | |||
* | |||
* @param evt | |||
* The event to use as a source for the details | |||
@@ -43,7 +43,7 @@ public class MouseEventDetailsBuilder { | |||
} | |||
/** | |||
* Construct a {@link MouseEventDetails} object from the given event | |||
* Construct a {@link MouseEventDetails} object from the given event. | |||
* | |||
* @param evt | |||
* The event to use as a source for the details |
@@ -106,7 +106,7 @@ public class Profiler { | |||
} | |||
/** | |||
* Gets the name of the node | |||
* Gets the name of the node. | |||
* | |||
* @return the name of the node | |||
*/ | |||
@@ -137,7 +137,7 @@ public class Profiler { | |||
/** | |||
* Gets the total time spent in this node, including time spent in sub | |||
* nodes | |||
* nodes. | |||
* | |||
* @return the total time spent, in milliseconds | |||
*/ | |||
@@ -147,7 +147,7 @@ public class Profiler { | |||
/** | |||
* Gets the minimum time spent for one invocation of this node, | |||
* including time spent in sub nodes | |||
* including time spent in sub nodes. | |||
* | |||
* @return the time spent for the fastest invocation, in milliseconds | |||
*/ | |||
@@ -157,7 +157,7 @@ public class Profiler { | |||
/** | |||
* Gets the maximum time spent for one invocation of this node, | |||
* including time spent in sub nodes | |||
* including time spent in sub nodes. | |||
* | |||
* @return the time spent for the slowest invocation, in milliseconds | |||
*/ | |||
@@ -166,7 +166,7 @@ public class Profiler { | |||
} | |||
/** | |||
* Gets the number of times this node has been entered | |||
* Gets the number of times this node has been entered. | |||
* | |||
* @return the number of times the node has been entered | |||
*/ | |||
@@ -176,7 +176,7 @@ public class Profiler { | |||
/** | |||
* Gets the total time spent in this node, excluding time spent in sub | |||
* nodes | |||
* nodes. | |||
* | |||
* @return the total time spent, in milliseconds | |||
*/ | |||
@@ -189,7 +189,7 @@ public class Profiler { | |||
} | |||
/** | |||
* Gets the child nodes of this node | |||
* Gets the child nodes of this node. | |||
* | |||
* @return a collection of child nodes | |||
*/ |
@@ -163,7 +163,7 @@ public class ResourceLoader { | |||
} | |||
/** | |||
* Returns the default ResourceLoader | |||
* Returns the default ResourceLoader. | |||
* | |||
* @return the default ResourceLoader | |||
*/ | |||
@@ -405,12 +405,12 @@ public class ResourceLoader { | |||
if (rules === undefined) { | |||
rules = sheet.rules; | |||
} | |||
if (rules === null) { | |||
// Style sheet loaded, but can't access length because of XSS -> assume there's something there | |||
return 1; | |||
} | |||
// Return length so we can distinguish 0 (probably 404 error) from normal case. | |||
return rules.length; | |||
} catch (err) { |
@@ -27,12 +27,12 @@ public class StyleConstants { | |||
public static final String HORIZONTAL_SPACING = "hspacing"; | |||
/** | |||
* Added to all UI components | |||
* Added to all UI components. | |||
*/ | |||
public static final String UI_WIDGET = "v-widget"; | |||
/** | |||
* Added to all layouts to denote they are layouts | |||
* Added to all layouts to denote they are layouts. | |||
*/ | |||
public static final String UI_LAYOUT = "v-layout"; | |||
@@ -340,7 +340,7 @@ public class Util { | |||
} | |||
/** | |||
* Defers the execution of {@link #runWebkitOverflowAutoFix(Element)} | |||
* Defers the execution of {@link #runWebkitOverflowAutoFix(Element)}. | |||
* | |||
* @deprecated As of 7.4.0, use | |||
* {@link WidgetUtil#runWebkitOverflowAutoFixDeferred(Element)} | |||
@@ -656,7 +656,7 @@ public class Util { | |||
} | |||
/** | |||
* Force webkit to redraw an element | |||
* Force webkit to redraw an element. | |||
* | |||
* @deprecated As of 7.4.0, use | |||
* {@link WidgetUtil#forceWebkitRedraw(Element)} instead. | |||
@@ -954,7 +954,7 @@ public class Util { | |||
} | |||
/** | |||
* Gets currently focused element and checks if it's editable | |||
* Gets currently focused element and checks if it's editable. | |||
* | |||
* @deprecated As of 7.4.0, use | |||
* {@link WidgetUtil#isFocusedElementEditable()} instead. | |||
@@ -1002,7 +1002,7 @@ public class Util { | |||
/** | |||
* Checks if the given event is either a touch event or caused by the left | |||
* mouse button | |||
* mouse button. | |||
* | |||
* @deprecated As of 7.4.0, use | |||
* {@link WidgetUtil#isTouchEventOrLeftMouseButton(Event)} |
@@ -265,8 +265,8 @@ public class VCaption extends HTML implements HasErrorIndicatorElement { | |||
setErrorIndicatorElementVisible(true); | |||
// Hide error indicator from assistive devices | |||
Roles.getTextboxRole() | |||
.setAriaHiddenState(errorIndicatorElement, true); | |||
Roles.getTextboxRole().setAriaHiddenState(errorIndicatorElement, | |||
true); | |||
ErrorUtil.setErrorLevelStyle(errorIndicatorElement, | |||
StyleConstants.STYLE_NAME_ERROR_INDICATOR, | |||
@@ -662,7 +662,7 @@ public class VCaption extends HTML implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Sets the tooltip that should be shown for the caption | |||
* Sets the tooltip that should be shown for the caption. | |||
* | |||
* @param tooltipInfo | |||
* The tooltip that should be shown or null if no tooltip should | |||
@@ -673,7 +673,7 @@ public class VCaption extends HTML implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Returns the tooltip that should be shown for the caption | |||
* Returns the tooltip that should be shown for the caption. | |||
* | |||
* @return The tooltip to show or null if no tooltip should be shown | |||
*/ |
@@ -71,7 +71,7 @@ public class VLoadingIndicator { | |||
/** | |||
* Returns the delay (in ms) which must pass before the loading indicator | |||
* moves into the "first" state and is shown to the user | |||
* moves into the "first" state and is shown to the user. | |||
* | |||
* @return The delay (in ms) until moving into the "first" state. Counted | |||
* from when {@link #trigger()} is called. | |||
@@ -82,7 +82,7 @@ public class VLoadingIndicator { | |||
/** | |||
* Sets the delay (in ms) which must pass before the loading indicator moves | |||
* into the "first" state and is shown to the user | |||
* into the "first" state and is shown to the user. | |||
* | |||
* @param firstDelay | |||
* The delay (in ms) until moving into the "first" state. Counted | |||
@@ -190,7 +190,7 @@ public class VLoadingIndicator { | |||
/** | |||
* Returns the {@link ApplicationConnection} which uses this loading | |||
* indicator | |||
* indicator. | |||
* | |||
* @return The ApplicationConnection for this loading indicator | |||
*/ | |||
@@ -236,7 +236,7 @@ public class VLoadingIndicator { | |||
} | |||
/** | |||
* Returns the root element of the loading indicator | |||
* Returns the root element of the loading indicator. | |||
* | |||
* @return The loading indicator DOM element | |||
*/ |
@@ -47,6 +47,8 @@ import com.google.gwt.user.client.ui.Widget; | |||
import com.vaadin.client.ui.VOverlay; | |||
/** | |||
* A tooltip used by components. | |||
* | |||
* TODO open for extension | |||
*/ | |||
public class VTooltip extends VOverlay { | |||
@@ -366,8 +368,10 @@ public class VTooltip extends VOverlay { | |||
if (roomBelow > heightNeeded) { | |||
y = roomAbove; | |||
} else { | |||
y = roomAbove - offsetHeight - (currentElement != null | |||
? currentElement.getOffsetHeight() : 0); | |||
y = roomAbove - offsetHeight | |||
- (currentElement != null | |||
? currentElement.getOffsetHeight() | |||
: 0); | |||
} | |||
if (y + offsetHeight - Window.getScrollTop() > Window | |||
@@ -503,7 +507,7 @@ public class VTooltip extends VOverlay { | |||
} | |||
/** | |||
* Replace current open tooltip with new content | |||
* Replace current open tooltip with new content. | |||
*/ | |||
public void replaceCurrentTooltip() { | |||
if (closing) { |
@@ -48,7 +48,7 @@ import com.vaadin.shared.ui.ErrorLevel; | |||
import com.vaadin.shared.util.SharedUtil; | |||
/** | |||
* Utility methods which are related to client side code only | |||
* Utility methods which are related to client side code only. | |||
*/ | |||
public class WidgetUtil { | |||
@@ -66,7 +66,7 @@ public class WidgetUtil { | |||
/** | |||
* Redirects the browser to the given url or refreshes the page if url is | |||
* null | |||
* null. | |||
* | |||
* @since 7.6 | |||
* @param url | |||
@@ -418,7 +418,7 @@ public class WidgetUtil { | |||
} | |||
/** | |||
* Defers the execution of {@link #runWebkitOverflowAutoFix(Element)} | |||
* Defers the execution of {@link #runWebkitOverflowAutoFix(Element)}. | |||
* | |||
* @since 7.2.6 | |||
* @param elem | |||
@@ -791,7 +791,7 @@ public class WidgetUtil { | |||
com.google.gwt.dom.client.Element el, String p) | |||
/*-{ | |||
try { | |||
if (el.currentStyle) { | |||
// IE | |||
return el.currentStyle[p]; | |||
@@ -806,7 +806,7 @@ public class WidgetUtil { | |||
} catch (e) { | |||
return ""; | |||
} | |||
}-*/; | |||
/** | |||
@@ -820,7 +820,7 @@ public class WidgetUtil { | |||
try { | |||
el.focus(); | |||
} catch (e) { | |||
} | |||
}-*/; | |||
@@ -829,10 +829,11 @@ public class WidgetUtil { | |||
* DOM upwards from given element. | |||
* <p> | |||
* <strong>Note:</strong> If {@code element} is inside some widget {@code W} | |||
* , <em>and</em> {@code W} in turn is wrapped in a {@link com.google.gwt.user.client.ui.Composite Composite} | |||
* {@code C}, this method will not find {@code W} but returns {@code C}. | |||
* This may also be the case with other Composite-like classes that hijack | |||
* the event handling of their child widget(s). | |||
* , <em>and</em> {@code W} in turn is wrapped in a | |||
* {@link com.google.gwt.user.client.ui.Composite Composite} {@code C}, this | |||
* method will not find {@code W} but returns {@code C}. This may also be | |||
* the case with other Composite-like classes that hijack the event handling | |||
* of their child widget(s). | |||
* | |||
* @param element | |||
* the element where to start seeking of Widget | |||
@@ -848,11 +849,12 @@ public class WidgetUtil { | |||
* traversing DOM upwards from given element. | |||
* <p> | |||
* <strong>Note:</strong> If {@code element} is inside some widget {@code W} | |||
* , <em>and</em> {@code W} in turn is wrapped in a {@link com.google.gwt.user.client.ui.Composite Composite} | |||
* {@code C}, this method will not find {@code W}. It returns either | |||
* {@code C} or null, depending on whether the class parameter matches. This | |||
* may also be the case with other Composite-like classes that hijack the | |||
* event handling of their child widget(s). | |||
* , <em>and</em> {@code W} in turn is wrapped in a | |||
* {@link com.google.gwt.user.client.ui.Composite Composite} {@code C}, this | |||
* method will not find {@code W}. It returns either {@code C} or null, | |||
* depending on whether the class parameter matches. This may also be the | |||
* case with other Composite-like classes that hijack the event handling of | |||
* their child widget(s). | |||
* <p> | |||
* Only accepts the exact class {@code class1} if not null. | |||
* | |||
@@ -872,11 +874,12 @@ public class WidgetUtil { | |||
* traversing DOM upwards from given element. | |||
* <p> | |||
* <strong>Note:</strong> If {@code element} is inside some widget {@code W} | |||
* , <em>and</em> {@code W} in turn is wrapped in a {@link com.google.gwt.user.client.ui.Composite Composite} | |||
* {@code C}, this method will not find {@code W}. It returns either | |||
* {@code C} or null, depending on whether the class parameter matches. This | |||
* may also be the case with other Composite-like classes that hijack the | |||
* event handling of their child widget(s). | |||
* , <em>and</em> {@code W} in turn is wrapped in a | |||
* {@link com.google.gwt.user.client.ui.Composite Composite} {@code C}, this | |||
* method will not find {@code W}. It returns either {@code C} or null, | |||
* depending on whether the class parameter matches. This may also be the | |||
* case with other Composite-like classes that hijack the event handling of | |||
* their child widget(s). | |||
* | |||
* @param element | |||
* the element where to start seeking of Widget | |||
@@ -927,7 +930,7 @@ public class WidgetUtil { | |||
} | |||
/** | |||
* Force webkit to redraw an element | |||
* Force webkit to redraw an element. | |||
* | |||
* @param element | |||
* The element that should be redrawn | |||
@@ -1173,12 +1176,12 @@ public class WidgetUtil { | |||
if ($wnd.document.activeElement) { | |||
return $wnd.document.activeElement; | |||
} | |||
return null; | |||
}-*/; | |||
/** | |||
* Gets currently focused element and checks if it's editable | |||
* Gets currently focused element and checks if it's editable. | |||
* | |||
* @since 7.4 | |||
* | |||
@@ -1244,11 +1247,11 @@ public class WidgetUtil { | |||
/*-{ | |||
var top = elem.offsetTop; | |||
var height = elem.offsetHeight; | |||
if (elem.parentNode != elem.offsetParent) { | |||
top -= elem.parentNode.offsetTop; | |||
} | |||
var cur = elem.parentNode; | |||
while (cur && (cur.nodeType == 1)) { | |||
if (top < cur.scrollTop) { | |||
@@ -1257,12 +1260,12 @@ public class WidgetUtil { | |||
if (top + height > cur.scrollTop + cur.clientHeight) { | |||
cur.scrollTop = (top + height) - cur.clientHeight; | |||
} | |||
var offsetTop = cur.offsetTop; | |||
if (cur.parentNode != cur.offsetParent) { | |||
offsetTop -= cur.parentNode.offsetTop; | |||
} | |||
top += offsetTop - cur.scrollTop; | |||
cur = cur.parentNode; | |||
} | |||
@@ -1270,7 +1273,7 @@ public class WidgetUtil { | |||
/** | |||
* Checks if the given event is either a touch event or caused by the left | |||
* mouse button | |||
* mouse button. | |||
* | |||
* @param event | |||
* @return true if the event is a touch event or caused by the left mouse | |||
@@ -1711,7 +1714,7 @@ public class WidgetUtil { | |||
} | |||
var heightWithoutBorder = cloneElement.offsetHeight; | |||
parentElement.removeChild(cloneElement); | |||
return heightWithBorder - heightWithoutBorder; | |||
} | |||
}-*/; | |||
@@ -1881,17 +1884,17 @@ public class WidgetUtil { | |||
* {@code prefix-errorLevel} format. | |||
* | |||
* @param element | |||
* element to apply the style name to | |||
* element to apply the style name to | |||
* @param prefix | |||
* part of the style name before the error level string | |||
* part of the style name before the error level string | |||
* @param errorLevel | |||
* error level for which the style will be applied | |||
* error level for which the style will be applied | |||
*/ | |||
public static void setErrorLevelStyle(Element element, String prefix, | |||
ErrorLevel errorLevel) { | |||
for (ErrorLevel errorLevelValue : ErrorLevel.values()) { | |||
String className = | |||
prefix + "-" + errorLevelValue.toString().toLowerCase(); | |||
String className = prefix + "-" | |||
+ errorLevelValue.toString().toLowerCase(); | |||
if (errorLevel == errorLevelValue) { | |||
element.addClassName(className); | |||
} else { |
@@ -50,7 +50,7 @@ public class AtmospherePushConnection implements PushConnection { | |||
protected enum State { | |||
/** | |||
* Opening request has been sent, but still waiting for confirmation | |||
* Opening request has been sent, but still waiting for confirmation. | |||
*/ | |||
CONNECT_PENDING, | |||
@@ -381,7 +381,7 @@ public class AtmospherePushConnection implements PushConnection { | |||
/** | |||
* Called if the transport mechanism cannot be used and the fallback will be | |||
* tried | |||
* tried. | |||
*/ | |||
protected void onTransportFailure() { | |||
getLogger().warning("Push connection using primary method (" | |||
@@ -525,7 +525,7 @@ public class AtmospherePushConnection implements PushConnection { | |||
JavaScriptObject config) | |||
/*-{ | |||
var self = this; | |||
config.url = uri; | |||
config.onOpen = $entry(function(response) { | |||
self.@com.vaadin.client.communication.AtmospherePushConnection::onOpen(*)(response); | |||
@@ -551,7 +551,7 @@ public class AtmospherePushConnection implements PushConnection { | |||
config.onClientTimeout = $entry(function(request) { | |||
self.@com.vaadin.client.communication.AtmospherePushConnection::onClientTimeout(*)(request); | |||
}); | |||
return $wnd.vaadinPush.atmosphere.subscribe(config); | |||
}-*/; | |||
@@ -45,7 +45,7 @@ public interface ConnectionStateHandler { | |||
void setConnection(ApplicationConnection connection); | |||
/** | |||
* Called when an exception occurs during a {@link Heartbeat} request | |||
* Called when an exception occurs during a {@link Heartbeat} request. | |||
* | |||
* @param request | |||
* The heartbeat request | |||
@@ -55,7 +55,8 @@ public interface ConnectionStateHandler { | |||
void heartbeatException(Request request, Throwable exception); | |||
/** | |||
* Called when a heartbeat request returns a status code other than OK (200) | |||
* Called when a heartbeat request returns a status code other than OK | |||
* (200). | |||
* | |||
* @param request | |||
* The heartbeat request | |||
@@ -65,7 +66,7 @@ public interface ConnectionStateHandler { | |||
void heartbeatInvalidStatusCode(Request request, Response response); | |||
/** | |||
* Called when a {@link Heartbeat} request succeeds | |||
* Called when a {@link Heartbeat} request succeeds. | |||
*/ | |||
void heartbeatOk(); | |||
@@ -116,7 +117,7 @@ public interface ConnectionStateHandler { | |||
/** | |||
* Called when the push connection has lost the connection to the server and | |||
* will proceed to try to re-establish the connection | |||
* will proceed to try to re-establish the connection. | |||
* | |||
* @param pushConnection | |||
* The push connection which will be reconnected | |||
@@ -132,7 +133,7 @@ public interface ConnectionStateHandler { | |||
void pushOk(PushConnection pushConnection); | |||
/** | |||
* Called when the required push script could not be loaded | |||
* Called when the required push script could not be loaded. | |||
* | |||
* @param resourceUrl | |||
* The URL which was used for loading the script | |||
@@ -151,11 +152,11 @@ public interface ConnectionStateHandler { | |||
/** | |||
* Called when invalid content (not JSON) was returned from the server as | |||
* the result of an XmlHttpRequest request | |||
* the result of an XmlHttpRequest request. | |||
* | |||
* @param xhrConnectionError | |||
* The error containing what was being sent to the server and what | |||
* was returned | |||
* The error containing what was being sent to the server and | |||
* what was returned | |||
*/ | |||
void xhrInvalidContent(XhrConnectionError xhrConnectionError); | |||
@@ -164,19 +165,19 @@ public interface ConnectionStateHandler { | |||
* the result of an XmlHttpRequest. | |||
* | |||
* @param xhrConnectionError | |||
* The error containing what was being sent to the server and what | |||
* was returned | |||
* The error containing what was being sent to the server and | |||
* what was returned | |||
*/ | |||
void xhrInvalidStatusCode(XhrConnectionError xhrConnectionError); | |||
/** | |||
* Called whenever a XmlHttpRequest to the server completes successfully | |||
* Called whenever a XmlHttpRequest to the server completes successfully. | |||
*/ | |||
void xhrOk(); | |||
/** | |||
* Called when a message is to be sent to the server through the push | |||
* channel but the push channel is not connected | |||
* channel but the push channel is not connected. | |||
* | |||
* @param payload | |||
* The payload to send to the server | |||
@@ -185,7 +186,7 @@ public interface ConnectionStateHandler { | |||
/** | |||
* Called when invalid content (not JSON) was pushed from the server through | |||
* the push connection | |||
* the push connection. | |||
* | |||
* @param pushConnection | |||
* The push connection used |
@@ -24,7 +24,7 @@ import elemental.json.Json; | |||
import elemental.json.JsonValue; | |||
/** | |||
* Client side serializer/deserializer for java.util.Date | |||
* Client side serializer/deserializer for java.util.Date. | |||
* | |||
* @since 7.2 | |||
* @author Vaadin Ltd |
@@ -77,7 +77,7 @@ public class DefaultConnectionStateHandler implements ConnectionStateHandler { | |||
} | |||
/** | |||
* Checks if this type is of higher priority than the given type | |||
* Checks if this type is of higher priority than the given type. | |||
* | |||
* @param type | |||
* the type to compare to | |||
@@ -129,7 +129,7 @@ public class DefaultConnectionStateHandler implements ConnectionStateHandler { | |||
} | |||
/** | |||
* Returns the connection this handler is connected to | |||
* Returns the connection this handler is connected to. | |||
* | |||
* @return the connection for this handler | |||
*/ | |||
@@ -184,7 +184,7 @@ public class DefaultConnectionStateHandler implements ConnectionStateHandler { | |||
/** | |||
* Called whenever an error occurs in communication which should be handled | |||
* by showing the reconnect dialog and retrying communication until | |||
* successful again | |||
* successful again. | |||
* | |||
* @param type | |||
* The type of failure detected | |||
@@ -273,7 +273,7 @@ public class DefaultConnectionStateHandler implements ConnectionStateHandler { | |||
/** | |||
* Re-sends the payload to the server (if not null) or re-sends a heartbeat | |||
* request immediately | |||
* request immediately. | |||
* | |||
* @param payload | |||
* the payload that did not reach the server, null if the problem | |||
@@ -299,7 +299,7 @@ public class DefaultConnectionStateHandler implements ConnectionStateHandler { | |||
/** | |||
* Called whenever a reconnect attempt fails to allow updating of dialog | |||
* contents | |||
* contents. | |||
*/ | |||
protected void updateDialog() { | |||
reconnectDialog.setText(getDialogText(reconnectAttempt)); | |||
@@ -307,7 +307,7 @@ public class DefaultConnectionStateHandler implements ConnectionStateHandler { | |||
/** | |||
* Called when we should give up trying to reconnect and let the user decide | |||
* how to continue | |||
* how to continue. | |||
* | |||
*/ | |||
protected void giveUp() { | |||
@@ -338,7 +338,7 @@ public class DefaultConnectionStateHandler implements ConnectionStateHandler { | |||
} | |||
/** | |||
* Checks if the reconnect dialog is visible to the user | |||
* Checks if the reconnect dialog is visible to the user. | |||
* | |||
* @return true if the user can see the dialog, false otherwise | |||
*/ | |||
@@ -370,7 +370,7 @@ public class DefaultConnectionStateHandler implements ConnectionStateHandler { | |||
/** | |||
* Gets the text to show in the reconnect dialog after giving up (reconnect | |||
* limit reached) | |||
* limit reached). | |||
* | |||
* @param reconnectAttempt | |||
* The number of the current reconnection attempt | |||
@@ -382,7 +382,7 @@ public class DefaultConnectionStateHandler implements ConnectionStateHandler { | |||
} | |||
/** | |||
* Gets the text to show in the reconnect dialog | |||
* Gets the text to show in the reconnect dialog. | |||
* | |||
* @param reconnectAttempt | |||
* The number of the current reconnection attempt |
@@ -32,7 +32,7 @@ import com.vaadin.client.WidgetUtil; | |||
import com.vaadin.client.ui.VOverlay; | |||
/** | |||
* The default implementation of the reconnect dialog | |||
* The default implementation of the reconnect dialog. | |||
* | |||
* @since 7.6 | |||
* @author Vaadin Ltd |
@@ -30,7 +30,7 @@ import com.vaadin.shared.ui.ui.UIConstants; | |||
import com.vaadin.shared.util.SharedUtil; | |||
/** | |||
* Handles sending of heartbeats to the server and reacting to the response | |||
* Handles sending of heartbeats to the server and reacting to the response. | |||
* | |||
* @since 7.2 | |||
* @author Vaadin Ltd | |||
@@ -53,7 +53,7 @@ public class Heartbeat { | |||
} | |||
/** | |||
* Initializes the heartbeat for the given application connection | |||
* Initializes the heartbeat for the given application connection. | |||
* | |||
* @param applicationConnection | |||
* the connection | |||
@@ -83,7 +83,7 @@ public class Heartbeat { | |||
} | |||
/** | |||
* Sends a heartbeat to the server | |||
* Sends a heartbeat to the server. | |||
*/ | |||
public void send() { | |||
timer.cancel(); |
@@ -144,7 +144,7 @@ public class MessageHandler { | |||
private int sessionExpirationInterval; | |||
/** | |||
* Holds the time spent rendering the last request | |||
* Holds the time spent rendering the last request. | |||
*/ | |||
protected int lastProcessingTime; | |||
@@ -936,13 +936,13 @@ public class MessageHandler { | |||
Profiler.leave(key); | |||
} | |||
} else if (legacyConnector == null) { | |||
getLogger().severe( | |||
"Received update for " + uidl.getTag() | |||
+ ", but there is no such paintable (" | |||
+ connectorId + ") rendered."); | |||
getLogger().severe("Received update for " | |||
+ uidl.getTag() | |||
+ ", but there is no such paintable (" | |||
+ connectorId + ") rendered."); | |||
} else { | |||
getLogger() | |||
.severe("Server sent Vaadin 6 style updates for " | |||
getLogger().severe( | |||
"Server sent Vaadin 6 style updates for " | |||
+ Util.getConnectorString( | |||
legacyConnector) | |||
+ " but this is not a Vaadin 6 Paintable"); | |||
@@ -1723,7 +1723,7 @@ public class MessageHandler { | |||
} | |||
/** | |||
* Checks if the first UIDL has been handled | |||
* Checks if the first UIDL has been handled. | |||
* | |||
* @return true if the initial UIDL has already been processed, false | |||
* otherwise | |||
@@ -1777,7 +1777,7 @@ public class MessageHandler { | |||
} | |||
/** | |||
* Unwraps and parses the given JSON, originating from the server | |||
* Unwraps and parses the given JSON, originating from the server. | |||
* | |||
* @param jsonText | |||
* the json from the server | |||
@@ -1811,7 +1811,7 @@ public class MessageHandler { | |||
}-*/; | |||
/** | |||
* Parse the given wrapped JSON, received from the server, to a ValueMap | |||
* Parse the given wrapped JSON, received from the server, to a ValueMap. | |||
* | |||
* @param wrappedJsonText | |||
* the json, wrapped as done by the server |
@@ -363,7 +363,7 @@ public class MessageSender { | |||
} | |||
/** | |||
* Used internally to update what the server expects | |||
* Used internally to update what the server expects. | |||
* | |||
* @param nextExpectedId | |||
* the new client id to set |
@@ -18,7 +18,7 @@ package com.vaadin.client.communication; | |||
import com.vaadin.client.ApplicationConnection; | |||
/** | |||
* Interface which must be implemented by the reconnect dialog | |||
* Interface which must be implemented by the reconnect dialog. | |||
* | |||
* @since 7.6 | |||
* @author Vaadin Ltd | |||
@@ -26,7 +26,7 @@ import com.vaadin.client.ApplicationConnection; | |||
public interface ReconnectDialog { | |||
/** | |||
* Sets the main text shown in the dialog | |||
* Sets the main text shown in the dialog. | |||
* | |||
* @param text | |||
* the text to show | |||
@@ -44,14 +44,14 @@ public interface ReconnectDialog { | |||
void setReconnecting(boolean reconnecting); | |||
/** | |||
* Checks if the reconnect dialog is visible to the user | |||
* Checks if the reconnect dialog is visible to the user. | |||
* | |||
* @return true if the user can see the dialog, false otherwise | |||
*/ | |||
boolean isVisible(); | |||
/** | |||
* Shows the dialog to the user | |||
* Shows the dialog to the user. | |||
* | |||
* @param connection | |||
* the application connection this is related to | |||
@@ -59,7 +59,7 @@ public interface ReconnectDialog { | |||
void show(ApplicationConnection connection); | |||
/** | |||
* Hides the dialog from the user | |||
* Hides the dialog from the user. | |||
*/ | |||
void hide(); | |||
@@ -87,7 +87,7 @@ public interface ReconnectDialog { | |||
/** | |||
* Called once after initialization to allow the reconnect dialog to preload | |||
* required resources, which might not be available when the server | |||
* connection is gone | |||
* connection is gone. | |||
*/ | |||
void preload(ApplicationConnection connection); | |||
} |
@@ -82,7 +82,7 @@ public class ServerRpcQueue { | |||
} | |||
/** | |||
* Removes any pending invocation of the given method from the queue | |||
* Removes any pending invocation of the given method from the queue. | |||
* | |||
* @param invocation | |||
* The invocation to remove | |||
@@ -129,7 +129,7 @@ public class ServerRpcQueue { | |||
} | |||
/** | |||
* Returns a collection of all queued method invocations | |||
* Returns a collection of all queued method invocations. | |||
* <p> | |||
* The returned collection must not be modified in any way | |||
* | |||
@@ -140,7 +140,7 @@ public class ServerRpcQueue { | |||
} | |||
/** | |||
* Clears the queue | |||
* Clears the queue. | |||
*/ | |||
public void clear() { | |||
pendingInvocations.clear(); | |||
@@ -150,7 +150,7 @@ public class ServerRpcQueue { | |||
} | |||
/** | |||
* Returns the current size of the queue | |||
* Returns the current size of the queue. | |||
* | |||
* @return the number of invocations in the queue | |||
*/ | |||
@@ -159,7 +159,7 @@ public class ServerRpcQueue { | |||
} | |||
/** | |||
* Returns the server RPC queue for the given application | |||
* Returns the server RPC queue for the given application. | |||
* | |||
* @param connection | |||
* the application connection which owns the queue | |||
@@ -170,7 +170,7 @@ public class ServerRpcQueue { | |||
} | |||
/** | |||
* Checks if the queue is empty | |||
* Checks if the queue is empty. | |||
* | |||
* @return true if the queue is empty, false otherwise | |||
*/ | |||
@@ -204,7 +204,7 @@ public class ServerRpcQueue { | |||
}; | |||
/** | |||
* Checks if a flush operation is pending | |||
* Checks if a flush operation is pending. | |||
* | |||
* @return true if a flush is pending, false otherwise | |||
*/ | |||
@@ -214,7 +214,7 @@ public class ServerRpcQueue { | |||
/** | |||
* Checks if a loading indicator should be shown when the RPCs have been | |||
* sent to the server and we are waiting for a response | |||
* sent to the server and we are waiting for a response. | |||
* | |||
* @return true if a loading indicator should be shown, false otherwise | |||
*/ | |||
@@ -236,7 +236,7 @@ public class ServerRpcQueue { | |||
} | |||
/** | |||
* Returns the current invocations as JSON | |||
* Returns the current invocations as JSON. | |||
* | |||
* @return the current invocations in a JSON format ready to be sent to the | |||
* server | |||
@@ -307,7 +307,7 @@ public class ServerRpcQueue { | |||
} | |||
/** | |||
* Checks if the given method invocation originates from Javascript | |||
* Checks if the given method invocation originates from Javascript. | |||
* | |||
* @param invocation | |||
* the invocation to check | |||
@@ -320,7 +320,7 @@ public class ServerRpcQueue { | |||
/** | |||
* Checks if the given method invocation represents a Vaadin 6 variable | |||
* change | |||
* change. | |||
* | |||
* @param invocation | |||
* the invocation to check |
@@ -44,7 +44,7 @@ import elemental.json.JsonObject; | |||
/** | |||
* Provides a connection to the /UIDL url on the server and knows how to send | |||
* messages to that end point | |||
* messages to that end point. | |||
* | |||
* @since 7.6 | |||
* @author Vaadin Ltd | |||
@@ -118,7 +118,7 @@ public class XhrConnection { | |||
} | |||
/** | |||
* Sets the payload which was sent to the server | |||
* Sets the payload which was sent to the server. | |||
* | |||
* @param payload | |||
* the payload which was sent to the server | |||
@@ -226,7 +226,7 @@ public class XhrConnection { | |||
} | |||
/** | |||
* Retrieves the URI to use when sending RPCs to the server | |||
* Retrieves the URI to use when sending RPCs to the server. | |||
* | |||
* @return The URI to use for server messages. | |||
*/ |
@@ -22,7 +22,7 @@ import elemental.json.JsonObject; | |||
/** | |||
* XhrConnectionError provides detail about an error which occured during an XHR | |||
* request to the server | |||
* request to the server. | |||
* | |||
* @since 7.6 | |||
* @author Vaadin Ltd | |||
@@ -35,7 +35,7 @@ public class XhrConnectionError { | |||
private JsonObject payload; | |||
/** | |||
* Constructs an event from the given request, payload and exception | |||
* Constructs an event from the given request, payload and exception. | |||
* | |||
* @param request | |||
* the request which failed | |||
@@ -52,7 +52,7 @@ public class XhrConnectionError { | |||
} | |||
/** | |||
* Constructs an event from the given request, response and payload | |||
* Constructs an event from the given request, response and payload. | |||
* | |||
* @param request | |||
* the request which failed | |||
@@ -69,7 +69,7 @@ public class XhrConnectionError { | |||
} | |||
/** | |||
* Returns the exception which caused the problem, if available | |||
* Returns the exception which caused the problem, if available. | |||
* | |||
* @return the exception which caused the problem, or null if not available | |||
*/ | |||
@@ -78,7 +78,7 @@ public class XhrConnectionError { | |||
} | |||
/** | |||
* Returns the request for which the problem occurred | |||
* Returns the request for which the problem occurred. | |||
* | |||
* @return the request where the problem occurred | |||
*/ | |||
@@ -87,7 +87,7 @@ public class XhrConnectionError { | |||
} | |||
/** | |||
* Returns the received response, if available | |||
* Returns the received response, if available. | |||
* | |||
* @return the received response, or null if not available | |||
*/ | |||
@@ -96,11 +96,11 @@ public class XhrConnectionError { | |||
} | |||
/** | |||
* Returns the payload which was sent to the server | |||
* Returns the payload which was sent to the server. | |||
* | |||
* @return the payload which was sent, never null | |||
*/ | |||
public JsonObject getPayload() { | |||
return payload; | |||
} | |||
} | |||
} |
@@ -21,7 +21,7 @@ import com.vaadin.shared.ui.Connect; | |||
import com.vaadin.shared.ui.grid.renderers.HtmlRendererState; | |||
/** | |||
* A connector for {@link UnsafeHtmlRenderer} | |||
* A connector for {@link UnsafeHtmlRenderer}. | |||
* | |||
* @since 8.0 | |||
* @author Vaadin Ltd |
@@ -98,7 +98,7 @@ public class DebugButton extends Button { | |||
} | |||
/** | |||
* Indicates wheter the Button is currently in its active state or not | |||
* Indicates wheter the Button is currently in its active state or not. | |||
* | |||
* @return true if the Button is active, false otherwise | |||
*/ |
@@ -33,7 +33,7 @@ import com.vaadin.shared.Version; | |||
import com.vaadin.shared.util.SharedUtil; | |||
/** | |||
* Information section of the debug window | |||
* Information section of the debug window. | |||
* | |||
* @since 7.1 | |||
* @author Vaadin Ltd |
@@ -168,7 +168,7 @@ public class SelectorPath { | |||
} | |||
/** | |||
* Returns the name of the component described by given query fragment | |||
* Returns the name of the component described by given query fragment. | |||
* | |||
* @param fragment | |||
* Query fragment |
@@ -748,7 +748,7 @@ public final class VDebugWindow extends VOverlay { | |||
} | |||
/** | |||
* Called when a response is received | |||
* Called when a response is received. | |||
* | |||
* @param ac | |||
* @param uidl |
@@ -42,7 +42,7 @@ public class PointerEventSupportImpl { | |||
} | |||
/** | |||
* Initializes event support | |||
* Initializes event support. | |||
*/ | |||
protected void init() { | |||
@@ -18,7 +18,7 @@ package com.vaadin.client.event; | |||
import com.vaadin.client.event.PointerEvent.EventType; | |||
/** | |||
* Pointer event support class for IE 10 ("ms" prefixed pointer events) | |||
* Pointer event support class for IE 10 ("ms" prefixed pointer events). | |||
* | |||
* @since 7.2 | |||
* @author Vaadin Ltd |
@@ -20,7 +20,7 @@ import com.google.gwt.user.client.impl.DOMImplStandard; | |||
import com.vaadin.client.event.PointerEvent.EventType; | |||
/** | |||
* Pointer event support class for IE 11+ (unprefixed pointer events) | |||
* Pointer event support class for IE 11+ (unprefixed pointer events). | |||
* | |||
* @since 7.2 | |||
* @author Vaadin Ltd |
@@ -31,7 +31,7 @@ import com.vaadin.shared.ui.Connect; | |||
import com.vaadin.shared.util.SharedUtil; | |||
/** | |||
* Client-side code for {@link BrowserWindowOpener} | |||
* Client-side code for {@link BrowserWindowOpener}. | |||
* | |||
* @author Vaadin Ltd | |||
* @since 7.0.0 |
@@ -43,17 +43,17 @@ public class ResponsiveConnector extends AbstractExtensionConnector | |||
implements ElementResizeListener { | |||
/** | |||
* The target component which we will monitor for width changes | |||
* The target component which we will monitor for width changes. | |||
*/ | |||
protected AbstractComponentConnector target; | |||
/** | |||
* All the width breakpoints found for this particular instance | |||
* All the width breakpoints found for this particular instance. | |||
*/ | |||
protected JavaScriptObject widthBreakpoints; | |||
/** | |||
* All the height breakpoints found for this particular instance | |||
* All the height breakpoints found for this particular instance. | |||
*/ | |||
protected JavaScriptObject heightBreakpoints; | |||
@@ -97,7 +97,7 @@ public class ResponsiveConnector extends AbstractExtensionConnector | |||
/** | |||
* Construct the list of selectors that should be matched against in the | |||
* range selectors | |||
* range selectors. | |||
* | |||
* @return The selectors in a comma delimited string. | |||
*/ |
@@ -25,7 +25,7 @@ import com.vaadin.client.communication.StateChangeEvent; | |||
/** | |||
* Encapsulates the data that the widgetset compiler generates for supporting a | |||
* connector method annotated with {@link OnStateChange} | |||
* connector method annotated with {@link OnStateChange}. | |||
* | |||
* @since 7.2 | |||
* @author Vaadin Ltd |
@@ -23,7 +23,7 @@ import com.google.gwt.i18n.shared.DateTimeFormat.PredefinedFormat; | |||
import com.vaadin.client.widget.grid.RendererCellReference; | |||
/** | |||
* A renderer for rendering dates into cells | |||
* A renderer for rendering dates into cells. | |||
* | |||
* @since 7.4 | |||
* @author Vaadin Ltd |
@@ -73,13 +73,13 @@ public class HierarchyRenderer extends ClickableRenderer<Object, Widget> { | |||
private static native RowReference<Object> getRowReference( | |||
RendererCellReference cell) /*-{ | |||
return cell.@com.vaadin.client.widget.grid.CellReference::getRowReference()(); | |||
}-*/; | |||
return cell.@com.vaadin.client.widget.grid.CellReference::getRowReference()(); | |||
}-*/; | |||
private static native FlyweightCell getFlyweightCell( | |||
RendererCellReference cell) /*-{ | |||
return cell.@com.vaadin.client.widget.grid.RendererCellReference::cell; | |||
}-*/; | |||
return cell.@com.vaadin.client.widget.grid.RendererCellReference::cell; | |||
}-*/; | |||
} | |||
private String nodeStyleName; | |||
@@ -222,8 +222,8 @@ public class HierarchyRenderer extends ClickableRenderer<Object, Widget> { | |||
private boolean isCollapsed(JsonObject rowDescription) { | |||
boolean collapsed; | |||
collapsed = rowDescription | |||
.getBoolean(HierarchicalDataCommunicatorConstants.ROW_COLLAPSED); | |||
collapsed = rowDescription.getBoolean( | |||
HierarchicalDataCommunicatorConstants.ROW_COLLAPSED); | |||
return collapsed; | |||
} | |||
@@ -248,7 +248,7 @@ public class HierarchyRenderer extends ClickableRenderer<Object, Widget> { | |||
} | |||
/** | |||
* Decides whether the element was rendered by {@link HierarchyRenderer} | |||
* Decides whether the element was rendered by {@link HierarchyRenderer}. | |||
*/ | |||
public static boolean isElementInHierarchyWidget(Element element) { | |||
Widget w = WidgetUtil.findWidget(element); |
@@ -142,7 +142,7 @@ public abstract class AbstractClickEventHandler implements MouseDownHandler, | |||
} | |||
/** | |||
* Checks if there is a server side event listener registered for clicks | |||
* Checks if there is a server side event listener registered for clicks. | |||
* | |||
* @return true if there is a server side event listener registered, false | |||
* otherwise |
@@ -100,7 +100,7 @@ public abstract class AbstractComponentConnector extends AbstractConnector | |||
private static final int TOUCH_CONTEXT_MENU_TIMEOUT = 500; | |||
/** | |||
* Default constructor | |||
* Default constructor. | |||
*/ | |||
public AbstractComponentConnector() { | |||
} | |||
@@ -490,7 +490,7 @@ public abstract class AbstractComponentConnector extends AbstractConnector | |||
Profiler.leave("AbstractComponentConnector.onStateChanged"); | |||
} | |||
@OnStateChange({"errorMessage", "errorLevel"}) | |||
@OnStateChange({ "errorMessage", "errorLevel" }) | |||
private void setErrorLevel() { | |||
// Add or remove the widget's error level style name | |||
ErrorUtil.setErrorLevelStyle(getWidget().getElement(), |
@@ -31,7 +31,7 @@ public abstract class AbstractHasComponentsConnector | |||
List<ComponentConnector> childComponents; | |||
/** | |||
* Default constructor | |||
* Default constructor. | |||
*/ | |||
public AbstractHasComponentsConnector() { | |||
addConnectorHierarchyChangeHandler(this); |
@@ -34,7 +34,7 @@ public abstract class Action implements Command { | |||
} | |||
/** | |||
* Executed when action fired | |||
* Executed when action fired. | |||
*/ | |||
@Override | |||
public abstract void execute(); |
@@ -26,7 +26,8 @@ import com.google.gwt.user.client.ui.Widget; | |||
import com.google.gwt.user.client.ui.impl.FocusImpl; | |||
/** | |||
* A panel that contains an always visible 0x0 size element that holds the focus | |||
* A panel that contains an always visible 0x0 size element that holds the | |||
* focus. | |||
*/ | |||
public class FocusElementPanel extends SimpleFocusablePanel { | |||
@@ -29,7 +29,7 @@ import com.google.gwt.user.client.ui.Widget; | |||
public class FocusUtil { | |||
/** | |||
* Sets the access key property | |||
* Sets the access key property. | |||
* | |||
* @param focusable | |||
* The widget for which we want to set the access key. |
@@ -96,7 +96,7 @@ public class FocusableFlexTable extends FlexTable implements HasFocusHandlers, | |||
} | |||
/** | |||
* Sets the keyboard focus to the panel | |||
* Sets the keyboard focus to the panel. | |||
* | |||
* @param focus | |||
* Should the panel have keyboard focus. If true the keyboard |
@@ -36,7 +36,7 @@ public class FocusableFlowPanel extends FlowPanel implements HasFocusHandlers, | |||
HasBlurHandlers, HasKeyDownHandlers, HasKeyPressHandlers, Focusable { | |||
/** | |||
* Constructor | |||
* Constructor. | |||
*/ | |||
public FocusableFlowPanel() { | |||
// make focusable, as we don't need access key magic we don't need to | |||
@@ -108,7 +108,7 @@ public class FocusableFlowPanel extends FlowPanel implements HasFocusHandlers, | |||
} | |||
/** | |||
* Focus the panel | |||
* Focus the panel. | |||
*/ | |||
@Override | |||
public void focus() { |
@@ -23,14 +23,14 @@ import com.google.gwt.user.client.ui.Widget; | |||
public class JavaScriptWidget extends Widget { | |||
/** | |||
* Creates a JavaScriptWidget based on a <div> element | |||
* Creates a JavaScriptWidget based on a <div> element. | |||
*/ | |||
public JavaScriptWidget() { | |||
this("div"); | |||
} | |||
/** | |||
* Creates a JavaScriptWidget based on an element with the given tag | |||
* Creates a JavaScriptWidget based on an element with the given tag. | |||
* | |||
* @param tagName | |||
* the tag to use for the element |
@@ -53,7 +53,7 @@ public class ShortcutActionHandler { | |||
/** | |||
* Returns the ShortCutActionHandler currently used or null if there is | |||
* currently no shortcutactionhandler | |||
* currently no shortcutactionhandler. | |||
*/ | |||
ShortcutActionHandler getShortcutActionHandler(); | |||
} |
@@ -17,7 +17,7 @@ | |||
package com.vaadin.client.ui; | |||
/** | |||
* This class is used for "row actions" in VTree and ITable | |||
* This class is used for "row actions" in VTree and VScrollTable. | |||
*/ | |||
public class TreeAction extends Action { | |||
@@ -28,10 +28,10 @@ import com.vaadin.client.VCaption; | |||
public class VAbsoluteLayout extends ComplexPanel { | |||
/** Tag name for widget creation */ | |||
/** Tag name for widget creation. */ | |||
public static final String TAGNAME = "absolutelayout"; | |||
/** Class name, prefix in styling */ | |||
/** Class name, prefix in styling. */ | |||
public static final String CLASSNAME = "v-absolutelayout"; | |||
private DivElement marginElement; | |||
@@ -39,7 +39,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
protected final Element canvas = DOM.createDiv(); | |||
/** | |||
* Default constructor | |||
* Default constructor. | |||
*/ | |||
public VAbsoluteLayout() { | |||
setElement(Document.get().createDivElement()); | |||
@@ -83,7 +83,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Does this layout contain a widget | |||
* Does this layout contain a widget. | |||
* | |||
* @param widget | |||
* The widget to check | |||
@@ -152,7 +152,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Sets a caption for a contained widget | |||
* Sets a caption for a contained widget. | |||
* | |||
* @param child | |||
* The child widget to set the caption for | |||
@@ -192,7 +192,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Get the caption for a widget | |||
* Get the caption for a widget. | |||
* | |||
* @param child | |||
* The child widget to get the caption of | |||
@@ -206,7 +206,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Get the pixel width of an slot in the layout | |||
* Get the pixel width of an slot in the layout. | |||
* | |||
* @param child | |||
* The widget in the layout. | |||
@@ -221,7 +221,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Get the pixel height of an slot in the layout | |||
* Get the pixel height of an slot in the layout. | |||
* | |||
* @param child | |||
* The widget in the layout | |||
@@ -237,7 +237,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Get the wrapper for a widget | |||
* Get the wrapper for a widget. | |||
* | |||
* @param child | |||
* The child to get the wrapper for | |||
@@ -281,7 +281,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Updates all style names contained in the layout | |||
* Updates all style names contained in the layout. | |||
* | |||
* @param primaryStyleName | |||
* The style name to use as primary | |||
@@ -364,7 +364,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Internal wrapper for wrapping widgets in the Absolute layout | |||
* Internal wrapper for wrapping widgets in the Absolute layout. | |||
*/ | |||
protected class AbsoluteWrapper extends SimplePanel { | |||
private String css; | |||
@@ -378,7 +378,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
private String[] extraStyleNames; | |||
/** | |||
* Constructor | |||
* Constructor. | |||
* | |||
* @param child | |||
* The child to wrap | |||
@@ -388,14 +388,14 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Get the caption of the wrapper | |||
* Get the caption of the wrapper. | |||
*/ | |||
public VCaption getCaption() { | |||
return caption; | |||
} | |||
/** | |||
* Set the caption for the wrapper | |||
* Set the caption for the wrapper. | |||
* | |||
* @param caption | |||
* The caption for the wrapper | |||
@@ -410,7 +410,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Removes the wrapper caption and itself from the layout | |||
* Removes the wrapper caption and itself from the layout. | |||
*/ | |||
public void destroy() { | |||
if (caption != null) { | |||
@@ -420,7 +420,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Set the position for the wrapper in the layout | |||
* Set the position for the wrapper in the layout. | |||
* | |||
* @param position | |||
* The position string | |||
@@ -484,7 +484,7 @@ public class VAbsoluteLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Updates the style names using the primary style name as prefix | |||
* Updates the style names using the primary style name as prefix. | |||
*/ | |||
protected void updateStyleNames() { | |||
setStyleName( |
@@ -87,7 +87,7 @@ public abstract class VAbstractCalendarPanel<R extends Enum<R>> | |||
} | |||
/** | |||
* Blur listener that listens to blur event from the panel | |||
* Blur listener that listens to blur event from the panel. | |||
*/ | |||
public interface FocusOutListener { | |||
/** | |||
@@ -1294,7 +1294,7 @@ public abstract class VAbstractCalendarPanel<R extends Enum<R>> | |||
} | |||
/** | |||
* Handle the keyboard navigation when the resolution is set to MONTH | |||
* Handle the keyboard navigation when the resolution is set to MONTH. | |||
* | |||
* @param keycode | |||
* The keycode to handle | |||
@@ -1350,7 +1350,7 @@ public abstract class VAbstractCalendarPanel<R extends Enum<R>> | |||
} | |||
/** | |||
* Handle keyboard navigation what the resolution is set to DAY | |||
* Handle keyboard navigation what the resolution is set to DAY. | |||
* | |||
* @param keycode | |||
* The keycode to handle | |||
@@ -1456,7 +1456,7 @@ public abstract class VAbstractCalendarPanel<R extends Enum<R>> | |||
} | |||
/** | |||
* Handles the keyboard navigation | |||
* Handles the keyboard navigation. | |||
* | |||
* @param keycode | |||
* The key code that was pressed | |||
@@ -1796,7 +1796,8 @@ public abstract class VAbstractCalendarPanel<R extends Enum<R>> | |||
} | |||
/** | |||
* Returns the submit listener that listens to selection made from the panel | |||
* Returns the submit listener that listens to selection made from the | |||
* panel. | |||
* | |||
* @return The listener or NULL if no listener has been set | |||
*/ |
@@ -299,7 +299,7 @@ public abstract class VAbstractPopupCalendar<PANEL extends VAbstractCalendarPane | |||
/** | |||
* Set correct tab index for disabled text field in IE as the value set in | |||
* setTextFieldEnabled(...) gets overridden in | |||
* TextualDateConnection.updateFromUIDL(...) | |||
* TextualDateConnection.updateFromUIDL(...). | |||
* | |||
* @since 7.3.1 | |||
*/ | |||
@@ -382,7 +382,7 @@ public abstract class VAbstractPopupCalendar<PANEL extends VAbstractCalendarPane | |||
} | |||
/** | |||
* Opens the calendar panel popup | |||
* Opens the calendar panel popup. | |||
*/ | |||
public void openCalendarPanel() { | |||
@@ -476,7 +476,7 @@ public abstract class VAbstractPopupCalendar<PANEL extends VAbstractCalendarPane | |||
/** | |||
* Sets the content of a special field for assistive devices, so that they | |||
* can recognize the change and inform the user (reading out in case of | |||
* screen reader) | |||
* screen reader). | |||
* | |||
* @param selectedDate | |||
* Date that is currently selected | |||
@@ -545,7 +545,7 @@ public abstract class VAbstractPopupCalendar<PANEL extends VAbstractCalendarPane | |||
} | |||
/** | |||
* Closes the open popup panel | |||
* Closes the open popup panel. | |||
*/ | |||
public void closeCalendarPanel() { | |||
if (open) { |
@@ -256,10 +256,11 @@ public abstract class VAbstractSplitPanel extends ComplexPanel { | |||
private float convertToPixels(String pos) { | |||
float posAsFloat; | |||
if (pos.indexOf("%") > 0) { | |||
posAsFloat = Math | |||
.round(Float.parseFloat(pos.substring(0, pos.length() - 1)) | |||
/ 100 * (orientation == Orientation.HORIZONTAL | |||
? getOffsetWidth() : getOffsetHeight())); | |||
posAsFloat = Math.round( | |||
Float.parseFloat(pos.substring(0, pos.length() - 1)) / 100 | |||
* (orientation == Orientation.HORIZONTAL | |||
? getOffsetWidth() | |||
: getOffsetHeight())); | |||
} else { | |||
posAsFloat = Float.parseFloat(pos.substring(0, pos.length() - 2)); | |||
} | |||
@@ -278,7 +279,8 @@ public abstract class VAbstractSplitPanel extends ComplexPanel { | |||
float pixelPosition = Float | |||
.parseFloat(pos.substring(0, pos.length() - 2)); | |||
int offsetLength = orientation == Orientation.HORIZONTAL | |||
? getOffsetWidth() : getOffsetHeight(); | |||
? getOffsetWidth() | |||
: getOffsetHeight(); | |||
// Take splitter size into account at the edge | |||
if (pixelPosition + getSplitterSize() >= offsetLength) { | |||
@@ -602,21 +604,21 @@ public abstract class VAbstractSplitPanel extends ComplexPanel { | |||
} | |||
/** | |||
* Called when starting drag resize | |||
* Called when starting drag resize. | |||
* | |||
* @since 7.5.1 | |||
*/ | |||
protected abstract void startResize(); | |||
/** | |||
* Called when stopping drag resize | |||
* Called when stopping drag resize. | |||
* | |||
* @since 7.5.1 | |||
*/ | |||
protected abstract void stopResize(); | |||
/** | |||
* Gets the first container | |||
* Gets the first container. | |||
* | |||
* @since 7.5.1 | |||
* @return the firstContainer | |||
@@ -626,7 +628,7 @@ public abstract class VAbstractSplitPanel extends ComplexPanel { | |||
} | |||
/** | |||
* Gets the second container | |||
* Gets the second container. | |||
* | |||
* @since 7.5.1 | |||
* @return the secondContainer |
@@ -209,7 +209,7 @@ public class VAccordion extends VTabsheetBase { | |||
} | |||
/** | |||
* Returns caption width including padding | |||
* Returns caption width including padding. | |||
* | |||
* @return | |||
*/ |
@@ -1021,7 +1021,7 @@ public class VComboBox extends Composite implements Field, KeyDownHandler, | |||
} | |||
/** | |||
* The menu where the suggestions are rendered | |||
* The menu where the suggestions are rendered. | |||
*/ | |||
public class SuggestionMenu extends MenuBar | |||
implements SubPartAware, LoadHandler { | |||
@@ -1361,7 +1361,7 @@ public class VComboBox extends Composite implements Field, KeyDownHandler, | |||
} | |||
/** | |||
* Overridden to avoid selecting text when text input is disabled | |||
* Overridden to avoid selecting text when text input is disabled. | |||
*/ | |||
@Override | |||
public void setSelectionRange(int pos, int length) { |
@@ -104,7 +104,7 @@ public class VContextMenu extends VOverlay implements SubPartAware { | |||
} | |||
/** | |||
* Sets the element from which to build menu | |||
* Sets the element from which to build menu. | |||
* | |||
* @param ao | |||
*/ |
@@ -22,15 +22,15 @@ import com.vaadin.client.Profiler; | |||
import com.vaadin.client.StyleConstants; | |||
/** | |||
* VCCSlayout is a layout which supports configuring it's children with CSS | |||
* selectors | |||
* VCssLayout is a layout which supports configuring it's children with CSS | |||
* selectors. | |||
*/ | |||
public class VCssLayout extends FlowPanel { | |||
public static final String CLASSNAME = "v-csslayout"; | |||
/** | |||
* Default constructor | |||
* Default constructor. | |||
*/ | |||
public VCssLayout() { | |||
super(); |
@@ -337,7 +337,7 @@ public class VCustomLayout extends ComplexPanel { | |||
} | |||
} | |||
/** Get the location of an widget */ | |||
/** Get the location of an widget. */ | |||
public String getLocation(Widget w) { | |||
for (final String location : locationToWidget.keySet()) { | |||
if (locationToWidget.get(location) == w) { | |||
@@ -347,7 +347,7 @@ public class VCustomLayout extends ComplexPanel { | |||
return null; | |||
} | |||
/** Removes given widget from the layout */ | |||
/** Removes given widget from the layout. */ | |||
@Override | |||
public boolean remove(Widget w) { | |||
final String location = getLocation(w); | |||
@@ -364,13 +364,13 @@ public class VCustomLayout extends ComplexPanel { | |||
return false; | |||
} | |||
/** Adding widget without specifying location is not supported */ | |||
/** Adding widget without specifying location is not supported. */ | |||
@Override | |||
public void add(Widget w) { | |||
throw new UnsupportedOperationException(); | |||
} | |||
/** Clear all widgets from the layout */ | |||
/** Clear all widgets from the layout. */ | |||
@Override | |||
public void clear() { | |||
super.clear(); |
@@ -61,7 +61,7 @@ public class VDateTimeCalendarPanel | |||
private ListBox ampm; | |||
/** | |||
* Constructor | |||
* Constructor. | |||
*/ | |||
public VTime() { | |||
super(); | |||
@@ -209,7 +209,7 @@ public class VDateTimeCalendarPanel | |||
} | |||
/** | |||
* Updates the valus to correspond to the values in value | |||
* Updates the value to correspond to the values in value. | |||
*/ | |||
public void updateTimes() { | |||
if (getDate() == null) { | |||
@@ -316,7 +316,7 @@ public class VDateTimeCalendarPanel | |||
} | |||
/** | |||
* Dispatches an event when the panel when time is changed | |||
* Dispatches an event when the panel when time is changed. | |||
*/ | |||
public interface TimeChangeListener { | |||
@@ -60,8 +60,7 @@ import com.vaadin.shared.ui.dd.HorizontalDropLocation; | |||
import com.vaadin.shared.ui.dd.VerticalDropLocation; | |||
/** | |||
* | |||
* Must have features pending: | |||
* A wrapper for Drag and Drop. Must have features pending: | |||
* | |||
* drop details: locations + sizes in document hierarchy up to wrapper | |||
* | |||
@@ -448,8 +447,8 @@ public class VDragAndDropWrapper extends VCustomComponent | |||
} | |||
protected String[] acceptedTypes = { "Text", "Url", | |||
"text/html", "text/plain", "text/rtf" }; | |||
protected String[] acceptedTypes = { "Text", "Url", "text/html", | |||
"text/plain", "text/rtf" }; | |||
private boolean isAcceptedType(String type) { | |||
for (String t : acceptedTypes) { | |||
@@ -467,11 +466,11 @@ public class VDragAndDropWrapper extends VCustomComponent | |||
public final native void postFile(VHtml5File file) | |||
/*-{ | |||
this.setRequestHeader('Content-Type', 'multipart/form-data'); | |||
// Seems like IE10 will loose the file if we don't keep a reference to it... | |||
this.fileBeingUploaded = file; | |||
this.send(file); | |||
}-*/; | |||
@@ -627,19 +626,19 @@ public class VDragAndDropWrapper extends VCustomComponent | |||
protected native void hookHtml5Events(com.google.gwt.user.client.Element el) | |||
/*-{ | |||
var me = this; | |||
el.addEventListener("dragenter", $entry(function(ev) { | |||
return me.@com.vaadin.client.ui.VDragAndDropWrapper::html5DragEnter(Lcom/vaadin/client/ui/dd/VHtml5DragEvent;)(ev); | |||
}), false); | |||
el.addEventListener("dragleave", $entry(function(ev) { | |||
return me.@com.vaadin.client.ui.VDragAndDropWrapper::html5DragLeave(Lcom/vaadin/client/ui/dd/VHtml5DragEvent;)(ev); | |||
}), false); | |||
el.addEventListener("dragover", $entry(function(ev) { | |||
return me.@com.vaadin.client.ui.VDragAndDropWrapper::html5DragOver(Lcom/vaadin/client/ui/dd/VHtml5DragEvent;)(ev); | |||
}), false); | |||
el.addEventListener("drop", $entry(function(ev) { | |||
return me.@com.vaadin.client.ui.VDragAndDropWrapper::html5DragDrop(Lcom/vaadin/client/ui/dd/VHtml5DragEvent;)(ev); | |||
}), false); |
@@ -44,7 +44,7 @@ import com.vaadin.shared.ui.ErrorLevel; | |||
import com.vaadin.shared.ui.MarginInfo; | |||
/** | |||
* Two col Layout that places caption on left col and field on right col | |||
* Two col Layout that places caption on left col and field on right col. | |||
*/ | |||
public class VFormLayout extends SimplePanel { | |||
@@ -378,8 +378,8 @@ public class VFormLayout extends SimplePanel { | |||
// Hide the error indicator from screen reader, as this | |||
// information is set directly at the input field | |||
Roles.getFormRole() | |||
.setAriaHiddenState(errorIndicatorElement, true); | |||
Roles.getFormRole().setAriaHiddenState(errorIndicatorElement, | |||
true); | |||
ErrorUtil.setErrorLevelStyle(errorIndicatorElement, | |||
StyleConstants.STYLE_NAME_ERROR_INDICATOR, errorLevel); |
@@ -113,7 +113,7 @@ public class VGridLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Returns the column widths measured in pixels | |||
* Returns the column widths measured in pixels. | |||
* | |||
* @return | |||
*/ | |||
@@ -122,7 +122,7 @@ public class VGridLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Returns the row heights measured in pixels | |||
* Returns the row heights measured in pixels. | |||
* | |||
* @return | |||
*/ | |||
@@ -131,7 +131,7 @@ public class VGridLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Returns the spacing between the cells horizontally in pixels | |||
* Returns the spacing between the cells horizontally in pixels. | |||
* | |||
* @return | |||
*/ | |||
@@ -140,7 +140,7 @@ public class VGridLayout extends ComplexPanel { | |||
} | |||
/** | |||
* Returns the spacing between the cells vertically in pixels | |||
* Returns the spacing between the cells vertically in pixels. | |||
* | |||
* @return | |||
*/ |
@@ -19,14 +19,14 @@ import com.vaadin.client.StyleConstants; | |||
import com.vaadin.client.ui.orderedlayout.VAbstractOrderedLayout; | |||
/** | |||
* Represents a layout where the children is ordered vertically | |||
* Represents a layout where the children is ordered vertically. | |||
*/ | |||
public class VHorizontalLayout extends VAbstractOrderedLayout { | |||
public static final String CLASSNAME = "v-horizontallayout"; | |||
/** | |||
* Default constructor | |||
* Default constructor. | |||
*/ | |||
public VHorizontalLayout() { | |||
super(false); |
@@ -94,7 +94,6 @@ public class VMenuBar extends SimpleFocusablePanel | |||
*/ | |||
public static final Command emptyCommand = null; | |||
/** Widget fields **/ | |||
protected boolean subMenu; | |||
protected List<CustomMenuItem> items; | |||
protected Element containerElement; | |||
@@ -251,7 +250,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
/** | |||
* This is called by the items in the menu and it communicates the | |||
* information to the server | |||
* information to the server. | |||
* | |||
* @param clickedItemId | |||
* id of the item that was clicked | |||
@@ -270,14 +269,14 @@ public class VMenuBar extends SimpleFocusablePanel | |||
/** Widget methods **/ | |||
/** | |||
* Returns a list of items in this menu | |||
* Returns a list of items in this menu. | |||
*/ | |||
public List<CustomMenuItem> getItems() { | |||
return items; | |||
} | |||
/** | |||
* Remove all the items in this menu | |||
* Remove all the items in this menu. | |||
*/ | |||
public void clearItems() { | |||
Element e = getContainerElement(); | |||
@@ -288,7 +287,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Returns the containing element of the menu | |||
* Returns the containing element of the menu. | |||
* | |||
* @return | |||
*/ | |||
@@ -298,7 +297,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Add a new item to this menu | |||
* Add a new item to this menu. | |||
* | |||
* @param html | |||
* items text | |||
@@ -315,7 +314,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Add a new item to this menu | |||
* Add a new item to this menu. | |||
* | |||
* @param item | |||
*/ | |||
@@ -340,7 +339,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Remove the given item from this menu | |||
* Remove the given item from this menu. | |||
* | |||
* @param item | |||
*/ | |||
@@ -437,7 +436,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* When an item is clicked | |||
* When an item is clicked. | |||
* | |||
* @param item | |||
*/ | |||
@@ -468,7 +467,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* When the user hovers the mouse over the item | |||
* When the user hovers the mouse over the item. | |||
* | |||
* @param item | |||
*/ | |||
@@ -495,7 +494,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* When the mouse is moved away from an item | |||
* When the mouse is moved away from an item. | |||
* | |||
* @param item | |||
*/ | |||
@@ -693,7 +692,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Hides the submenu of an item | |||
* Hides the submenu of an item. | |||
* | |||
* @param item | |||
*/ | |||
@@ -717,7 +716,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Listener method, fired when this menu is closed | |||
* Listener method, fired when this menu is closed. | |||
*/ | |||
@Override | |||
public void onClose(CloseEvent<PopupPanel> event) { | |||
@@ -731,7 +730,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Recursively hide all child menus | |||
* Recursively hide all child menus. | |||
*/ | |||
public void hideChildren() { | |||
hideChildren(true, true); | |||
@@ -739,7 +738,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
/** | |||
* | |||
* Recursively hide all child menus | |||
* Recursively hide all child menus. | |||
* | |||
* @param animateIn | |||
* enable/disable animate-in animation when hide popup | |||
@@ -755,7 +754,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Recursively hide all parent menus | |||
* Recursively hide all parent menus. | |||
*/ | |||
public void hideParents(boolean autoClosed) { | |||
if (visibleChildMenu != null) { | |||
@@ -771,7 +770,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
/** | |||
* Returns the parent menu of this menu, or null if this is the top-level | |||
* menu | |||
* menu. | |||
* | |||
* @return | |||
*/ | |||
@@ -780,7 +779,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Set the parent menu of this menu | |||
* Set the parent menu of this menu. | |||
* | |||
* @param parent | |||
*/ | |||
@@ -790,7 +789,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
/** | |||
* Returns the currently selected item of this menu, or null if nothing is | |||
* selected | |||
* selected. | |||
* | |||
* @return | |||
*/ | |||
@@ -799,7 +798,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Set the currently selected item of this menu | |||
* Set the currently selected item of this menu. | |||
* | |||
* @param item | |||
*/ | |||
@@ -818,7 +817,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
/** | |||
* | |||
* A class to hold information on menu items | |||
* A class to hold information on menu items. | |||
* | |||
*/ | |||
public static class CustomMenuItem extends Widget implements HasHTML { | |||
@@ -1332,7 +1331,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Handles the keyboard events handled by the MenuBar | |||
* Handles the keyboard events handled by the MenuBar. | |||
* | |||
* @param keycode | |||
* The key code received | |||
@@ -1692,7 +1691,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Get menu item with given DOM element | |||
* Get menu item with given DOM element. | |||
* | |||
* @param element | |||
* Element used in search | |||
@@ -1721,7 +1720,7 @@ public class VMenuBar extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Get menu item with given DOM element | |||
* Get menu item with given DOM element. | |||
* | |||
* @param element | |||
* Element used in search |
@@ -99,7 +99,7 @@ public class VPanel extends SimplePanel implements ShortcutActionHandlerOwner, | |||
} | |||
/** | |||
* Sets the keyboard focus on the Panel | |||
* Sets the keyboard focus on the Panel. | |||
* | |||
* @param focus | |||
* Should the panel have focus or not. | |||
@@ -200,7 +200,7 @@ public class VPanel extends SimplePanel implements ShortcutActionHandlerOwner, | |||
sinkEvents(Event.MOUSEEVENTS); | |||
captionNode.insertBefore(errorIndicatorElement, captionText); | |||
} | |||
} else if (errorIndicatorElement != null){ | |||
} else if (errorIndicatorElement != null) { | |||
captionNode.removeChild(errorIndicatorElement); | |||
errorIndicatorElement = null; | |||
} |
@@ -80,7 +80,7 @@ public class VPopupView extends HTML | |||
private boolean enabled = true; | |||
/** | |||
* loading constructor | |||
* Loading constructor. | |||
*/ | |||
public VPopupView() { | |||
super(); |
@@ -460,7 +460,7 @@ public class VSlider extends SimpleFocusablePanel | |||
} | |||
/** | |||
* Handles the keyboard events handled by the Slider | |||
* Handles the keyboard events handled by the Slider. | |||
* | |||
* @param keycode | |||
* The key code received |
@@ -100,7 +100,7 @@ public class VTabsheet extends VTabsheetBase | |||
} | |||
/** | |||
* Representation of a single "tab" shown in the TabBar | |||
* Representation of a single "tab" shown in the TabBar. | |||
* | |||
*/ | |||
public static class Tab extends SimplePanel implements HasFocusHandlers, | |||
@@ -198,7 +198,7 @@ public class VTabsheet extends VTabsheetBase | |||
} | |||
/** | |||
* Toggles the style names for the Tab | |||
* Toggles the style names for the Tab. | |||
* | |||
* @param selected | |||
* true if the Tab is selected |
@@ -63,7 +63,7 @@ public abstract class VTabsheetBase extends ComplexPanel implements HasEnabled { | |||
public abstract Iterator<Widget> getWidgetIterator(); | |||
/** | |||
* Clears current tabs and contents | |||
* Clears current tabs and contents. | |||
*/ | |||
protected abstract void clearPaintables(); | |||
@@ -19,14 +19,14 @@ import com.vaadin.client.StyleConstants; | |||
import com.vaadin.client.ui.orderedlayout.VAbstractOrderedLayout; | |||
/** | |||
* Represents a layout where the children is ordered vertically | |||
* Represents a layout where the children is ordered vertically. | |||
*/ | |||
public class VVerticalLayout extends VAbstractOrderedLayout { | |||
public static final String CLASSNAME = "v-verticallayout"; | |||
/** | |||
* Default constructor | |||
* Default constructor. | |||
*/ | |||
public VVerticalLayout() { | |||
super(true); |
@@ -37,7 +37,7 @@ import com.vaadin.ui.AbsoluteLayout; | |||
/** | |||
* Connects the server side {@link AbsoluteLayout} with the client side | |||
* counterpart {@link VAbsoluteLayout} | |||
* counterpart {@link VAbsoluteLayout}. | |||
*/ | |||
@Connect(AbsoluteLayout.class) | |||
public class AbsoluteLayoutConnector extends AbstractComponentContainerConnector |
@@ -37,7 +37,7 @@ import com.vaadin.ui.CssLayout; | |||
/** | |||
* Connects the server side widget {@link CssLayout} with the client side | |||
* counterpart {@link VCssLayout} | |||
* counterpart {@link VCssLayout}. | |||
*/ | |||
@Connect(CssLayout.class) | |||
public class CssLayoutConnector extends AbstractLayoutConnector { |
@@ -40,7 +40,7 @@ public class CustomFieldConnector extends AbstractFieldConnector | |||
List<ComponentConnector> childComponents; | |||
/** | |||
* Default constructor | |||
* Default constructor. | |||
*/ | |||
public CustomFieldConnector() { | |||
addConnectorHierarchyChangeHandler(this); |
@@ -171,7 +171,9 @@ public class VDragEvent { | |||
} | |||
/** | |||
* TODO consider using similar smaller (than map) api as in Transferable | |||
* Returns the details of the drag and drop operation. | |||
* | |||
* TODO consider using similar smaller (than map) API as in Transferable | |||
* | |||
* TODO clean up when drop handler changes | |||
* |
@@ -77,7 +77,7 @@ public interface VDropHandler { | |||
public void dragOver(VDragEvent currentDrag); | |||
/** | |||
* Returns the ComponentConnector with which this DropHandler is associated | |||
* Returns the ComponentConnector with which this DropHandler is associated. | |||
*/ | |||
public ComponentConnector getConnector(); | |||
@@ -50,7 +50,7 @@ import com.vaadin.shared.ui.orderedlayout.AbstractOrderedLayoutServerRpc; | |||
import com.vaadin.shared.ui.orderedlayout.AbstractOrderedLayoutState; | |||
/** | |||
* Base class for vertical and horizontal ordered layouts | |||
* Base class for vertical and horizontal ordered layouts. | |||
*/ | |||
public abstract class AbstractOrderedLayoutConnector | |||
extends AbstractLayoutConnector { |
@@ -17,7 +17,7 @@ | |||
package com.vaadin.client.ui.orderedlayout; | |||
/** | |||
* Defines where the caption should be placed | |||
* Defines where the caption should be placed. | |||
*/ | |||
public enum CaptionPosition { | |||
TOP, RIGHT, BOTTOM, LEFT |
@@ -23,7 +23,7 @@ import com.vaadin.ui.HorizontalLayout; | |||
/** | |||
* Connects the client widget {@link VHorizontalLayout} with the Vaadin server | |||
* side counterpart {@link HorizontalLayout} | |||
* side counterpart {@link HorizontalLayout}. | |||
*/ | |||
@Connect(value = HorizontalLayout.class, loadStyle = LoadStyle.EAGER) | |||
public class HorizontalLayoutConnector extends AbstractOrderedLayoutConnector { |
@@ -222,7 +222,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Returns the alignment for the slot | |||
* Returns the alignment for the slot. | |||
* | |||
*/ | |||
public AlignmentInfo getAlignment() { | |||
@@ -230,7 +230,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Sets the style names for the slot containing the widget | |||
* Sets the style names for the slot containing the widget. | |||
* | |||
* @param stylenames | |||
* The style names for the slot | |||
@@ -248,7 +248,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Sets how the widget is aligned inside the slot | |||
* Sets how the widget is aligned inside the slot. | |||
* | |||
* @param alignment | |||
* The alignment inside the slot | |||
@@ -336,7 +336,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Get the element which is added to make the spacing | |||
* Get the element which is added to make the spacing. | |||
* | |||
* @return | |||
*/ | |||
@@ -345,14 +345,14 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Does the slot have spacing | |||
* Does the slot have spacing. | |||
*/ | |||
public boolean hasSpacing() { | |||
return getSpacingElement() != null; | |||
} | |||
/** | |||
* Get the vertical amount in pixels of the spacing | |||
* Get the vertical amount in pixels of the spacing. | |||
*/ | |||
protected int getVerticalSpacing() { | |||
if (spacer == null) { | |||
@@ -364,7 +364,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Get the horizontal amount of pixels of the spacing | |||
* Get the horizontal amount of pixels of the spacing. | |||
* | |||
* @return | |||
*/ | |||
@@ -378,7 +378,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Set the position of the caption relative to the slot | |||
* Set the position of the caption relative to the slot. | |||
* | |||
* @param captionPosition | |||
* The position of the caption | |||
@@ -403,14 +403,14 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Get the position of the caption relative to the slot | |||
* Get the position of the caption relative to the slot. | |||
*/ | |||
public CaptionPosition getCaptionPosition() { | |||
return captionPosition; | |||
} | |||
/** | |||
* Set the caption of the slot | |||
* Set the caption of the slot. | |||
* | |||
* @param captionText | |||
* The text of the caption | |||
@@ -448,7 +448,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Set the caption of the slot as text | |||
* Set the caption of the slot as text. | |||
* | |||
* @param captionText | |||
* The text of the caption | |||
@@ -473,7 +473,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Set the caption of the slot | |||
* Set the caption of the slot. | |||
* | |||
* @param captionText | |||
* The text of the caption | |||
@@ -501,7 +501,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Set the caption of the slot | |||
* Set the caption of the slot. | |||
* | |||
* @param captionText | |||
* The text of the caption | |||
@@ -684,14 +684,14 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
} | |||
/** | |||
* Does the slot have a caption | |||
* Does the slot have a caption. | |||
*/ | |||
public boolean hasCaption() { | |||
return caption != null; | |||
} | |||
/** | |||
* Get the slots caption element | |||
* Get the slots caption element. | |||
*/ | |||
public com.google.gwt.user.client.Element getCaptionElement() { | |||
return DOM.asOld(caption); | |||
@@ -700,7 +700,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
private boolean relativeWidth = false; | |||
/** | |||
* Set if the slot has a relative width | |||
* Set if the slot has a relative width. | |||
* | |||
* @param relativeWidth | |||
* True if slot uses relative width, false if the slot has a | |||
@@ -718,7 +718,7 @@ public class Slot extends SimplePanel implements HasErrorIndicatorElement { | |||
private boolean relativeHeight = false; | |||
/** | |||
* Set if the slot has a relative height | |||
* Set if the slot has a relative height. | |||
* | |||
* @param relativeHeight | |||
* True if the slot uses a relative height, false if the slot has |
@@ -36,7 +36,7 @@ import com.vaadin.client.Util; | |||
import com.vaadin.shared.ui.MarginInfo; | |||
/** | |||
* Base class for ordered layouts | |||
* Base class for ordered layouts. | |||
*/ | |||
public class VAbstractOrderedLayout extends FlowPanel { | |||
@@ -206,7 +206,7 @@ public class VAbstractOrderedLayout extends FlowPanel { | |||
} | |||
/** | |||
* Remove a slot from the layout | |||
* Remove a slot from the layout. | |||
* | |||
* @param widget | |||
* @return | |||
@@ -304,7 +304,7 @@ public class VAbstractOrderedLayout extends FlowPanel { | |||
} | |||
/** | |||
* Set the layout manager for the layout | |||
* Set the layout manager for the layout. | |||
* | |||
* @param manager | |||
* The layout manager to use | |||
@@ -314,7 +314,7 @@ public class VAbstractOrderedLayout extends FlowPanel { | |||
} | |||
/** | |||
* Get the layout manager used by this layout | |||
* Get the layout manager used by this layout. | |||
* | |||
*/ | |||
public LayoutManager getLayoutManager() { | |||
@@ -451,7 +451,7 @@ public class VAbstractOrderedLayout extends FlowPanel { | |||
} | |||
/** | |||
* Set the margin of the layout | |||
* Set the margin of the layout. | |||
* | |||
* @param marginInfo | |||
* The margin information | |||
@@ -466,7 +466,7 @@ public class VAbstractOrderedLayout extends FlowPanel { | |||
} | |||
/** | |||
* Turn on or off spacing in the layout | |||
* Turn on or off spacing in the layout. | |||
* | |||
* @param spacing | |||
* True if spacing should be used, false if not |
@@ -23,7 +23,7 @@ import com.vaadin.ui.VerticalLayout; | |||
/** | |||
* Connects the client widget {@link VVerticalLayout} with the Vaadin server | |||
* side counterpart {@link VerticalLayout} | |||
* side counterpart {@link VerticalLayout}. | |||
*/ | |||
@Connect(value = VerticalLayout.class, loadStyle = LoadStyle.EAGER) | |||
public class VerticalLayoutConnector extends AbstractOrderedLayoutConnector { |
@@ -651,7 +651,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector | |||
} | |||
/** | |||
* Checks if the given sub window is a child of this UI Connector | |||
* Checks if the given sub window is a child of this UI Connector. | |||
* | |||
* @deprecated Should be replaced by a more generic mechanism for getting | |||
* non-ComponentConnector children | |||
@@ -873,7 +873,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector | |||
} | |||
/** | |||
* Invokes the layout analyzer on the server | |||
* Invokes the layout analyzer on the server. | |||
* | |||
* @since 7.1 | |||
*/ | |||
@@ -942,7 +942,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector | |||
} | |||
/** | |||
* Loads the new theme and removes references to the old theme | |||
* Loads the new theme and removes references to the old theme. | |||
* | |||
* @since 7.4.3 | |||
* @param oldTheme | |||
@@ -1152,7 +1152,7 @@ public class UIConnector extends AbstractSingleComponentContainerConnector | |||
} | |||
/** | |||
* Returns the name of the theme currently in used by the UI | |||
* Returns the name of the theme currently in used by the UI. | |||
* | |||
* @since 7.3 | |||
* @return the theme name used by this UI |
@@ -19,7 +19,7 @@ import com.google.gwt.dom.client.Element; | |||
import com.vaadin.client.ui.VUpload; | |||
/** | |||
* IE does not have onload, detect onload via readystatechange | |||
* IE does not have onload, detect onload via readystatechange. | |||
* | |||
*/ | |||
public class UploadIFrameOnloadStrategyIE extends UploadIFrameOnloadStrategy { |
@@ -18,7 +18,7 @@ package com.vaadin.client.ui.window; | |||
import com.google.gwt.event.shared.GwtEvent; | |||
/** | |||
* Event for window position updates | |||
* Event for window position updates. | |||
* | |||
* @since 7.1.9 | |||
* @author Vaadin Ltd | |||
@@ -31,7 +31,7 @@ public class WindowMoveEvent extends GwtEvent<WindowMoveHandler> { | |||
private final int newY; | |||
/** | |||
* Creates a new event with the given parameters | |||
* Creates a new event with the given parameters. | |||
* | |||
* @param x | |||
* The new x-position for the VWindow | |||
@@ -44,7 +44,7 @@ public class WindowMoveEvent extends GwtEvent<WindowMoveHandler> { | |||
} | |||
/** | |||
* Gets the new x position of the window | |||
* Gets the new x position of the window. | |||
* | |||
* @return the new X position of the VWindow | |||
*/ | |||
@@ -53,7 +53,7 @@ public class WindowMoveEvent extends GwtEvent<WindowMoveHandler> { | |||
} | |||
/** | |||
* Gets the new y position of the window | |||
* Gets the new y position of the window. | |||
* | |||
* @return the new Y position of the VWindow | |||
*/ | |||
@@ -62,7 +62,7 @@ public class WindowMoveEvent extends GwtEvent<WindowMoveHandler> { | |||
} | |||
/** | |||
* Gets the type of the event | |||
* Gets the type of the event. | |||
* | |||
* @return the type of the event | |||
*/ |
@@ -18,7 +18,7 @@ package com.vaadin.client.ui.window; | |||
import com.google.gwt.event.shared.EventHandler; | |||
/** | |||
* Handler for {@link WindowMoveEvent}s | |||
* Handler for {@link WindowMoveEvent}s. | |||
* | |||
* @since 7.1.9 | |||
* @author Vaadin Ltd |
@@ -24,8 +24,9 @@ import com.vaadin.client.widget.escalator.FlyweightRow.CellIterator; | |||
import com.vaadin.client.widgets.Escalator; | |||
/** | |||
* A {@link FlyweightCell} represents a cell in the {@link com.vaadin.client.widgets.Grid Grid} or | |||
* {@link Escalator} at a certain point in time. | |||
* A {@link FlyweightCell} represents a cell in the | |||
* {@link com.vaadin.client.widgets.Grid Grid} or {@link Escalator} at a certain | |||
* point in time. | |||
* | |||
* <p> | |||
* Since the {@link FlyweightCell} follows the <code>Flyweight</code>-pattern | |||
@@ -51,7 +52,7 @@ public class FlyweightCell { | |||
} | |||
/** | |||
* Returns the row index of the cell | |||
* Returns the row index of the cell. | |||
*/ | |||
public int getRow() { | |||
assertSetup(); | |||
@@ -59,7 +60,7 @@ public class FlyweightCell { | |||
} | |||
/** | |||
* Returns the column index of the cell | |||
* Returns the column index of the cell. | |||
*/ | |||
public int getColumn() { | |||
assertSetup(); |
@@ -129,8 +129,7 @@ public interface RowContainer { | |||
* row elements. | |||
* @since 8.1 | |||
*/ | |||
public void setNewRowCallback( | |||
Consumer<List<TableRowElement>> consumer); | |||
public void setNewRowCallback(Consumer<List<TableRowElement>> consumer); | |||
} | |||
/** | |||
@@ -289,7 +288,7 @@ public interface RowContainer { | |||
throws IndexOutOfBoundsException, IllegalStateException; | |||
/** | |||
* Returns the root element of RowContainer | |||
* Returns the root element of RowContainer. | |||
* | |||
* @return RowContainer root element | |||
*/ |
@@ -35,7 +35,7 @@ public class RowVisibilityChangeEvent | |||
private final Range visibleRows; | |||
/** | |||
* Creates a new row visibility change event | |||
* Creates a new row visibility change event. | |||
* | |||
* @param firstVisibleRow | |||
* the index of the first visible row |
@@ -169,7 +169,7 @@ public abstract class ScrollbarBundle implements DeferredWorker { | |||
} | |||
/** | |||
* Checks whether the scroll handle is currently visible or not | |||
* Checks whether the scroll handle is currently visible or not. | |||
* | |||
* @return <code>true</code> if the scroll handle is currently visible. | |||
* <code>false</code> if not. | |||
@@ -373,7 +373,7 @@ public abstract class ScrollbarBundle implements DeferredWorker { | |||
protected abstract String internalGetScrollSize(); | |||
/** | |||
* Sets the primary style name | |||
* Sets the primary style name. | |||
* | |||
* @param primaryStyleName | |||
* The primary style name to use | |||
@@ -496,7 +496,7 @@ public abstract class ScrollbarBundle implements DeferredWorker { | |||
protected abstract void internalForceScrollbar(boolean enable); | |||
/** | |||
* Gets the length of the scrollbar | |||
* Gets the length of the scrollbar. | |||
* | |||
* @return the length of the scrollbar in pixels | |||
*/ |
@@ -18,7 +18,7 @@ package com.vaadin.client.widget.grid; | |||
import com.vaadin.client.widgets.Grid; | |||
/** | |||
* Callback interface for generating custom style names for cells | |||
* Callback interface for generating custom style names for cells. | |||
* | |||
* @author Vaadin Ltd | |||
* @param <T> | |||
@@ -37,4 +37,4 @@ public interface CellStyleGenerator<T> { | |||
* any style | |||
*/ | |||
public abstract String getStyle(CellReference<T> cellReference); | |||
} | |||
} |
@@ -25,7 +25,7 @@ import com.google.gwt.user.client.ui.Widget; | |||
*/ | |||
public interface DetailsGenerator { | |||
/** A details generator that provides no details */ | |||
/** A details generator that provides no details. */ | |||
public static final DetailsGenerator NULL = new DetailsGenerator() { | |||
@Override | |||
public Widget getDetails(int rowIndex) { |
@@ -18,7 +18,7 @@ package com.vaadin.client.widget.grid; | |||
import java.io.Serializable; | |||
/** | |||
* Callback interface for generating custom style names for data rows | |||
* Callback interface for generating custom style names for data rows. | |||
* | |||
* @author Vaadin Ltd | |||
* @param <T> | |||
@@ -38,4 +38,4 @@ public interface RowStyleGenerator<T> extends Serializable { | |||
* style | |||
*/ | |||
public abstract String getStyle(RowReference<T> rowReference); | |||
} | |||
} |
@@ -25,7 +25,7 @@ import com.google.gwt.event.shared.GwtEvent; | |||
*/ | |||
public class GridEnabledEvent extends GwtEvent<GridEnabledHandler> { | |||
/** | |||
* The type of this event | |||
* The type of this event. | |||
*/ | |||
public static final Type<GridEnabledHandler> TYPE = new Type<>(); | |||
private final boolean enabled; |
@@ -27,7 +27,7 @@ import com.google.gwt.event.shared.GwtEvent; | |||
public class GridSelectionAllowedEvent | |||
extends GwtEvent<GridSelectionAllowedHandler> { | |||
/** | |||
* The type of this event | |||
* The type of this event. | |||
*/ | |||
public static final Type<GridSelectionAllowedHandler> TYPE = new Type<>(); | |||
private final boolean isSelectionAllowed; |
@@ -18,14 +18,14 @@ package com.vaadin.client.widget.grid.events; | |||
import com.google.gwt.event.shared.GwtEvent; | |||
/** | |||
* An event that signifies that a scrollbar bundle has been scrolled | |||
* An event that signifies that a scrollbar bundle has been scrolled. | |||
* | |||
* @author Vaadin Ltd | |||
* @since 7.4 | |||
*/ | |||
public class ScrollEvent extends GwtEvent<ScrollHandler> { | |||
/** The type of this event */ | |||
/** The type of this event. */ | |||
public static final Type<ScrollHandler> TYPE = new Type<>(); | |||
@Override |
@@ -18,7 +18,7 @@ package com.vaadin.client.widget.grid.events; | |||
import com.google.gwt.event.shared.EventHandler; | |||
/** | |||
* A handler that gets called whenever a scrollbar bundle is scrolled | |||
* A handler that gets called whenever a scrollbar bundle is scrolled. | |||
* | |||
* @author Vaadin Ltd | |||
* @since 7.4 |
@@ -60,7 +60,7 @@ public class SortEvent<T> extends GwtEvent<SortHandler<?>> { | |||
/** | |||
* Static access to the GWT event type identifier associated with this Event | |||
* class | |||
* class. | |||
* | |||
* @return a type object, uniquely describing this event type. | |||
*/ | |||
@@ -69,7 +69,7 @@ public class SortEvent<T> extends GwtEvent<SortHandler<?>> { | |||
} | |||
/** | |||
* Get access to the Grid that fired this event | |||
* Get access to the Grid that fired this event. | |||
* | |||
* @return the grid instance | |||
*/ | |||
@@ -79,7 +79,7 @@ public class SortEvent<T> extends GwtEvent<SortHandler<?>> { | |||
} | |||
/** | |||
* Get access to the Grid that fired this event | |||
* Get access to the Grid that fired this event. | |||
* | |||
* @return the grid instance | |||
*/ | |||
@@ -88,7 +88,7 @@ public class SortEvent<T> extends GwtEvent<SortHandler<?>> { | |||
} | |||
/** | |||
* Get the sort ordering that is to be applied to the Grid | |||
* Get the sort ordering that is to be applied to the Grid. | |||
* | |||
* @return a list of sort order objects | |||
*/ |