[LMS-708] add: - Some help text to sample batch registration.

SVN: 9442

openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/client/application/ui/widget/HelpHtml.java

+/*
+ * Copyright 2008 ETH Zuerich, CISD
+ *
+ * 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 ch.systemsx.cisd.openbis.generic.client.web.client.application.ui.widget;
+
+import com.google.gwt.http.client.Request;
+import com.google.gwt.http.client.RequestBuilder;
+import com.google.gwt.http.client.RequestCallback;
+import com.google.gwt.http.client.RequestException;
+import com.google.gwt.http.client.Response;
+import com.google.gwt.user.client.ui.HTML;
+
+/**
+ * A {@link HTML} panel for displaying some help text.
+ * <p>
+ * An <i>HTML</i> page named {@code <widgetId>.html} is expected in the public <code>help</code>
+ * directory.
+ * </p>
+ * 
+ * @author Christian Ribeaud
+ */
+public final class HelpHtml extends HTML
+{
+    private final String helpUrl;
+
+    public HelpHtml(final String widgetId)
+    {
+        final RequestBuilder requestBuilder =
+                new RequestBuilder(RequestBuilder.GET, helpUrl = createUrl(widgetId));
+        try
+        {
+            requestBuilder.sendRequest(null, new HelpRequestCallback());
+        } catch (final RequestException ex)
+        {
+            displayException(ex);
+        }
+    }
+
+    private final static String createUrl(final String widgetId)
+    {
+        return "help/" + widgetId + ".html";
+    }
+
+    private final void displayException(final Throwable ex)
+    {
+        setText("An error has occurred while getting help page '" + helpUrl + "': "
+                + ex.getMessage() + ".");
+    }
+
+    private final void displayHelp(final String help)
+    {
+        setHTML(help);
+    }
+
+    //
+    // Helper classes
+    //
+
+    private final class HelpRequestCallback implements RequestCallback
+    {
+
+        //
+        // RequestCallback
+        //
+
+        public final void onError(final Request request, final Throwable ex)
+        {
+            displayException(ex);
+        }
+
+        public final void onResponseReceived(final Request request, final Response response)
+        {
+            displayHelp(response.getText());
+        }
+    }
+}

openbis/source/java/ch/systemsx/cisd/openbis/public/help/sample-batch-registration.html

+Sample registration file example:<br /><br />
+<pre>
+identifier	parent	user.color	user.index
+cisd:/cisd/cp-1200	dp-1200	red	1
+</pre>
\ No newline at end of file