Add example of how to replace change screen with custom screen
There is a new user preference that allows users to configure the
default change screen or the cookbook change screen.
Change-Id: Ie29658256b80cff5bd5329601e7f14e1b856cffb
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/src/main/java/com/googlesource/gerrit/plugins/cookbook/client/ChangeScreenPreferencePanel.java b/src/main/java/com/googlesource/gerrit/plugins/cookbook/client/ChangeScreenPreferencePanel.java
new file mode 100644
index 0000000..b610f87
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/cookbook/client/ChangeScreenPreferencePanel.java
@@ -0,0 +1,154 @@
+// Copyright (C) 2015 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.cookbook.client;
+
+import com.google.gerrit.client.info.AccountPreferencesInfo;
+import com.google.gerrit.plugin.client.Plugin;
+import com.google.gerrit.plugin.client.extension.Panel;
+import com.google.gerrit.plugin.client.rpc.RestApi;
+import com.google.gwt.dom.client.Style.Unit;
+import com.google.gwt.event.dom.client.ChangeEvent;
+import com.google.gwt.event.dom.client.ChangeHandler;
+import com.google.gwt.user.client.Timer;
+import com.google.gwt.user.client.rpc.AsyncCallback;
+import com.google.gwt.user.client.ui.HorizontalPanel;
+import com.google.gwt.user.client.ui.Label;
+import com.google.gwt.user.client.ui.ListBox;
+import com.google.gwt.user.client.ui.VerticalPanel;
+
+import java.util.Map;
+
+public class ChangeScreenPreferencePanel extends VerticalPanel {
+ private static final String DEFAULT = "DEFAULT";
+ private static final String COOKBOOK = "COOKBOOK";
+ private static final String OTHER = "OTHER";
+ private static final String DEFAULT_URL_MATCH = "/c/(.*)";
+ private static final String COOKBOOK_URL_TOKEN =
+ "/x/" + Plugin.get().getName() + "/c/$1";
+
+ static class Factory implements Panel.EntryPoint {
+ @Override
+ public void onLoad(Panel panel) {
+ panel.setWidget(new ChangeScreenPreferencePanel());
+ }
+ }
+
+ private Label savedLabel;
+ private Timer hideTimer;
+
+ ChangeScreenPreferencePanel() {
+ new RestApi("accounts").id("self").view("preferences")
+ .get(new AsyncCallback<AccountPreferencesInfo>() {
+ @Override
+ public void onSuccess(AccountPreferencesInfo result) {
+ display(result);
+ }
+
+ @Override
+ public void onFailure(Throwable caught) {
+ // never invoked
+ }
+ });
+ }
+
+ private void display(final AccountPreferencesInfo info) {
+ Label heading = new Label(Plugin.get().getName() + " plugin");
+ heading.setStyleName("smallHeading");
+ add(heading);
+ HorizontalPanel p = new HorizontalPanel();
+ add(p);
+
+ Label label = new Label("Change Screen:");
+ p.add(label);
+ label.getElement().getStyle().setMarginRight(5, Unit.PX);
+ label.getElement().getStyle().setMarginTop(2, Unit.PX);
+ final ListBox box = new ListBox();
+ p.add(box);
+ savedLabel = new Label("Saved");
+ savedLabel.getElement().getStyle().setMarginLeft(5, Unit.PX);
+ savedLabel.getElement().getStyle().setMarginTop(2, Unit.PX);
+ savedLabel.setVisible(false);
+ p.add(savedLabel);
+
+ box.addItem(DEFAULT, DEFAULT);
+ box.addItem(COOKBOOK, COOKBOOK);
+
+ String selected = DEFAULT;
+ if (info.urlAliases().containsKey(DEFAULT_URL_MATCH)) {
+ String token = info.urlAliases().get(DEFAULT_URL_MATCH);
+ if (token.equals(COOKBOOK_URL_TOKEN)) {
+ selected = COOKBOOK;
+ } else if (!token.equals(DEFAULT_URL_MATCH)) {
+ box.addItem(OTHER, OTHER);
+ selected = OTHER;
+ }
+ }
+
+ for (int i = 0; i < box.getItemCount(); i++) {
+ if (selected.equals(box.getValue(i))) {
+ box.setSelectedIndex(i);
+ break;
+ }
+ }
+
+ box.addChangeHandler(new ChangeHandler() {
+ @Override
+ public void onChange(ChangeEvent event) {
+ savedLabel.setVisible(false);
+ if (box.getSelectedValue().equals(OTHER)) {
+ return;
+ }
+
+ Map<String, String> urlAliases = info.urlAliases();
+ if (box.getSelectedValue().equals(COOKBOOK)) {
+ urlAliases.put(DEFAULT_URL_MATCH, COOKBOOK_URL_TOKEN);
+ } else {
+ urlAliases.remove(DEFAULT_URL_MATCH);
+ }
+ info.setUrlAliases(urlAliases);
+
+ new RestApi("accounts").id("self").view("preferences")
+ .put(info, new AsyncCallback<AccountPreferencesInfo>() {
+ @Override
+ public void onSuccess(AccountPreferencesInfo result) {
+ Plugin.get().refreshUserPreferences();
+ showSavedStatus();
+ }
+
+ @Override
+ public void onFailure(Throwable caught) {
+ // never invoked
+ }
+ });
+ }
+ });
+ }
+
+ private void showSavedStatus() {
+ if (hideTimer != null) {
+ hideTimer.cancel();
+ hideTimer = null;
+ }
+ savedLabel.setVisible(true);
+ hideTimer = new Timer() {
+ @Override
+ public void run() {
+ savedLabel.setVisible(false);
+ hideTimer = null;
+ }
+ };
+ hideTimer.schedule(1000);
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/cookbook/client/CookBookChangeScreen.java b/src/main/java/com/googlesource/gerrit/plugins/cookbook/client/CookBookChangeScreen.java
new file mode 100644
index 0000000..9a9bf86
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/cookbook/client/CookBookChangeScreen.java
@@ -0,0 +1,34 @@
+// Copyright (C) 2015 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.cookbook.client;
+
+import com.google.gerrit.plugin.client.screen.Screen;
+import com.google.gwt.user.client.ui.Label;
+import com.google.gwt.user.client.ui.VerticalPanel;
+
+class CookBookChangeScreen extends VerticalPanel {
+ static class Factory implements Screen.EntryPoint {
+ @Override
+ public void onLoad(Screen screen) {
+ screen.setPageTitle("CookBook Change Screen");
+ screen.show(new CookBookChangeScreen());
+ }
+ }
+
+ CookBookChangeScreen() {
+ setStyleName("cookbook-panel");
+ add(new Label("TODO: implement this screen"));
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/cookbook/client/CookBookPlugin.java b/src/main/java/com/googlesource/gerrit/plugins/cookbook/client/CookBookPlugin.java
index 7a56ca0..c51ec3c 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/cookbook/client/CookBookPlugin.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/cookbook/client/CookBookPlugin.java
@@ -31,8 +31,12 @@
@Override
public void onPluginLoad() {
Plugin.get().screen("", new IndexScreen.Factory());
+ Plugin.get().screenRegex("c/(.*)", new CookBookChangeScreen.Factory());
Plugin.get().settingsScreen("preferences", "Food Preferences",
new FoodPreferencesScreen.Factory());
+ Plugin.get().panel(
+ GerritUiExtensionPoint.PREFERENCES_SCREEN_BOTTOM,
+ new ChangeScreenPreferencePanel.Factory());
Plugin.get().panel(GerritUiExtensionPoint.PROFILE_SCREEN_BOTTOM,
new CookBookProfileExtension.Factory());
Plugin.get().panel(
