* source code.
*
* @param serverConnector
+ * @deprecated as of 7.1. Replaced by
+ * {@link UIConnector#showServerDebugInfo(ServerConnector)}
*/
+ @Deprecated
void highlightConnector(ServerConnector serverConnector) {
- String params = getRepaintAllParameters() + "&"
- + ApplicationConstants.PARAM_HIGHLIGHT_CONNECTOR + "="
- + serverConnector.getConnectorId();
- makeUidlRequest("", params);
+ getUIConnector().showServerDebugInfo(serverConnector);
}
/**
import com.vaadin.client.ConnectorMap;
import com.vaadin.client.Focusable;
import com.vaadin.client.Paintable;
+import com.vaadin.client.ServerConnector;
import com.vaadin.client.UIDL;
import com.vaadin.client.VConsole;
import com.vaadin.client.communication.StateChangeEvent;
import com.vaadin.shared.ui.ComponentStateUtil;
import com.vaadin.shared.ui.Connect;
import com.vaadin.shared.ui.Connect.LoadStyle;
+import com.vaadin.shared.ui.ui.DebugWindowServerRpc;
import com.vaadin.shared.ui.ui.PageClientRpc;
import com.vaadin.shared.ui.ui.PageState;
import com.vaadin.shared.ui.ui.ScrollClientRpc;
.getName(), "poll"));
}
}
+
+ /**
+ * Sends a request to the server to print details to console that will help
+ * the developer to locate the corresponding server-side connector in the
+ * source code.
+ *
+ * @since 7.1
+ * @param serverConnector
+ * the connector to locate
+ */
+ public void showServerDebugInfo(ServerConnector serverConnector) {
+ getRpcProxy(DebugWindowServerRpc.class).showServerDebugInfo(
+ serverConnector);
+ }
}
import java.io.Writer;
import java.util.List;
-import com.vaadin.server.ClientConnector;
import com.vaadin.server.ComponentSizeValidator;
import com.vaadin.server.ComponentSizeValidator.InvalidLayout;
import com.vaadin.server.SystemMessages;
* @param async
* True if this message is sent by the server asynchronously,
* false if it is a response to a client message.
- * @param hilightedConnector
- * The connector that should be highlighted on the client or null
- * if none.
* @param messages
* a {@link SystemMessages} containing client-side error
* messages.
*
*/
public void write(UI ui, Writer writer, boolean repaintAll,
- boolean analyzeLayouts, boolean async,
- ClientConnector hilightedConnector, SystemMessages messages)
+ boolean analyzeLayouts, boolean async, SystemMessages messages)
throws IOException {
List<InvalidLayout> invalidComponentRelativeSizes = null;
}
writer.write("]");
}
- if (hilightedConnector != null) {
- writer.write(", \"hl\":\"");
- writer.write(hilightedConnector.getConnectorId());
- writer.write("\"");
- }
}
if (async) {
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
-import java.util.LinkedList;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.json.JSONException;
-import com.vaadin.server.ClientConnector;
import com.vaadin.server.Constants;
import com.vaadin.server.LegacyCommunicationManager.InvalidUIDLSecurityKeyException;
import com.vaadin.server.ServletPortletHelper;
import com.vaadin.shared.ApplicationConstants;
import com.vaadin.shared.JsonConstants;
import com.vaadin.shared.Version;
-import com.vaadin.ui.Component;
import com.vaadin.ui.UI;
/**
checkWidgetsetVersion(request);
String requestThemeName = request.getParameter("theme");
- ClientConnector highlightedConnector;
// repaint requested or session has timed out and new one is created
boolean repaintAll;
- // TODO PUSH repaintAll, analyzeLayouts, highlightConnector should be
+ // TODO PUSH repaintAll, analyzeLayouts should be
// part of the message payload to make the functionality transport
// agnostic
// analyzing can be done only with repaintAll
analyzeLayouts = (request
.getParameter(ApplicationConstants.PARAM_ANALYZE_LAYOUTS) != null);
-
- String pid = request
- .getParameter(ApplicationConstants.PARAM_HIGHLIGHT_CONNECTOR);
- if (pid != null) {
- highlightedConnector = uI.getConnectorTracker().getConnector(
- pid);
- highlightConnector(highlightedConnector);
- }
}
StringWriter stringWriter = new StringWriter();
outWriter.write("for(;;);[{");
}
- // TODO Does this belong here?
- protected void highlightConnector(ClientConnector highlightedConnector) {
- StringBuilder sb = new StringBuilder();
- sb.append("*** Debug details of a connector: *** \n");
- sb.append("Type: ");
- sb.append(highlightedConnector.getClass().getName());
- sb.append("\nId:");
- sb.append(highlightedConnector.getConnectorId());
- if (highlightedConnector instanceof Component) {
- Component component = (Component) highlightedConnector;
- if (component.getCaption() != null) {
- sb.append("\nCaption:");
- sb.append(component.getCaption());
- }
- }
- printHighlightedConnectorHierarchy(sb, highlightedConnector);
- getLogger().info(sb.toString());
- }
-
- // TODO Does this belong here?
- protected void printHighlightedConnectorHierarchy(StringBuilder sb,
- ClientConnector connector) {
- LinkedList<ClientConnector> h = new LinkedList<ClientConnector>();
- h.add(connector);
- ClientConnector parent = connector.getParent();
- while (parent != null) {
- h.addFirst(parent);
- parent = parent.getParent();
- }
-
- sb.append("\nConnector hierarchy:\n");
- VaadinSession session2 = connector.getUI().getSession();
- sb.append(session2.getClass().getName());
- sb.append("(");
- sb.append(session2.getClass().getSimpleName());
- sb.append(".java");
- sb.append(":1)");
- int l = 1;
- for (ClientConnector connector2 : h) {
- sb.append("\n");
- for (int i = 0; i < l; i++) {
- sb.append(" ");
- }
- l++;
- Class<? extends ClientConnector> connectorClass = connector2
- .getClass();
- Class<?> topClass = connectorClass;
- while (topClass.getEnclosingClass() != null) {
- topClass = topClass.getEnclosingClass();
- }
- sb.append(connectorClass.getName());
- sb.append("(");
- sb.append(topClass.getSimpleName());
- sb.append(".java:1)");
- }
- }
-
private static final Logger getLogger() {
return Logger.getLogger(UidlRequestHandler.class.getName());
}
.getSystemMessages(ui.getLocale(), null);
// TODO hilightedConnector
new MetadataWriter().write(ui, writer, repaintAll, analyzeLayouts,
- async, null, messages);
+ async, messages);
writer.write(", ");
writer.write("\"resources\" : ");
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.concurrent.Future;
+import java.util.logging.Logger;
import com.vaadin.event.Action;
import com.vaadin.event.Action.Handler;
import com.vaadin.event.MouseEvents.ClickEvent;
import com.vaadin.event.MouseEvents.ClickListener;
import com.vaadin.navigator.Navigator;
+import com.vaadin.server.ClientConnector;
import com.vaadin.server.LocaleService;
import com.vaadin.server.Page;
import com.vaadin.server.PaintException;
import com.vaadin.server.VaadinServlet;
import com.vaadin.server.VaadinSession;
import com.vaadin.server.communication.PushConnection;
+import com.vaadin.shared.Connector;
import com.vaadin.shared.EventId;
import com.vaadin.shared.MouseEventDetails;
import com.vaadin.shared.communication.PushMode;
+import com.vaadin.shared.ui.ui.DebugWindowServerRpc;
import com.vaadin.shared.ui.ui.ScrollClientRpc;
import com.vaadin.shared.ui.ui.UIClientRpc;
import com.vaadin.shared.ui.ui.UIConstants;
import com.vaadin.shared.ui.ui.UIServerRpc;
import com.vaadin.shared.ui.ui.UIState;
import com.vaadin.ui.Component.Focusable;
+import com.vaadin.util.ConnectorHelper;
import com.vaadin.util.CurrentInstance;
/**
*/
}
};
+ private DebugWindowServerRpc debugRpc = new DebugWindowServerRpc() {
+ @Override
+ public void showServerDebugInfo(Connector connector) {
+ String info = ConnectorHelper
+ .getDebugInformation((ClientConnector) connector);
+ getLogger().info(info);
+ }
+ };
/**
* Timestamp keeping track of the last heartbeat of this UI. Updated to the
*/
public UI(Component content) {
registerRpc(rpc);
+ registerRpc(debugRpc);
setSizeFull();
setContent(content);
}
return localeService;
}
+ private static Logger getLogger() {
+ return Logger.getLogger(UI.class.getName());
+ }
}
--- /dev/null
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package com.vaadin.util;
+
+import java.util.LinkedList;
+
+import com.vaadin.server.ClientConnector;
+import com.vaadin.ui.Component;
+
+/**
+ * Provides various helper methods for connectors. Meant for internal use.
+ *
+ * @since 7.1
+ * @author Vaadin Ltd
+ */
+public class ConnectorHelper {
+
+ /**
+ * Creates a string containing debug info for the connector
+ *
+ * @since 7.1
+ * @param connector
+ * The connector to print debug info about
+ * @return A string with debug information
+ */
+ public static String getDebugInformation(ClientConnector connector) {
+ StringBuilder sb = new StringBuilder();
+ sb.append("*** Debug details of a connector: *** \n");
+ sb.append("Type: ");
+ sb.append(connector.getClass().getName());
+ sb.append("\nId:");
+ sb.append(connector.getConnectorId());
+ if (connector instanceof Component) {
+ Component component = (Component) connector;
+ if (component.getCaption() != null) {
+ sb.append("\nCaption:");
+ sb.append(component.getCaption());
+ }
+ }
+ writeHierarchyInformation(connector, sb);
+ return sb.toString();
+ }
+
+ /**
+ * Creates a string containing hierarchy information for the connector
+ *
+ * @since 7.1
+ * @param connector
+ * The connector to get hierarchy information for
+ * @param builder
+ * The StringBuilder where the information should be written
+ */
+ public static void writeHierarchyInformation(ClientConnector connector,
+ StringBuilder builder) {
+ LinkedList<ClientConnector> h = new LinkedList<ClientConnector>();
+ h.add(connector);
+ ClientConnector parent = connector.getParent();
+ while (parent != null) {
+ h.addFirst(parent);
+ parent = parent.getParent();
+ }
+
+ builder.append("\nConnector hierarchy:\n");
+
+ int l = 0;
+ for (ClientConnector connector2 : h) {
+ if (l != 0) {
+ builder.append("\n");
+ for (int i = 0; i < l; i++) {
+ builder.append(" ");
+ }
+ }
+ l++;
+ Class<? extends ClientConnector> connectorClass = connector2
+ .getClass();
+ Class<?> topClass = connectorClass;
+ while (topClass.getEnclosingClass() != null) {
+ topClass = topClass.getEnclosingClass();
+ }
+ builder.append(connectorClass.getName());
+ builder.append("(");
+ builder.append(topClass.getSimpleName());
+ builder.append(".java:1)");
+ }
+ }
+
+}
public static final String UIDL_SECURITY_TOKEN_ID = "Vaadin-Security-Key";
public static final String PARAM_ANALYZE_LAYOUTS = "analyzeLayouts";
- public static final String PARAM_HIGHLIGHT_CONNECTOR = "highlightConnector";
@Deprecated
public static final String UPDATE_VARIABLE_INTERFACE = "v";
--- /dev/null
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+/**
+ *
+ */
+package com.vaadin.shared.ui.ui;
+
+import com.vaadin.shared.Connector;
+import com.vaadin.shared.communication.ServerRpc;
+
+/**
+ * Server RPC methods for the Debug Window.
+ *
+ * @since 7.1
+ * @author Vaadin Ltd
+ */
+public interface DebugWindowServerRpc extends ServerRpc {
+ /**
+ * Sends a request to the server to print details to console that will help
+ * the developer to locate the corresponding server-side connector in the
+ * source code.
+ *
+ * @since 7.1
+ * @param connector
+ * the connector to locate
+ **/
+ public void showServerDebugInfo(Connector connector);
+
+}
projects / vaadin-framework.git / commitdiff