summaryrefslogtreecommitdiffstats
path: root/gerrit-gwtui/src/main/java/com/google/gerrit/client/ui/AbstractKeyNavigation.java
blob: 21b3da933bcd2d3726f1a31474c73675971974c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
// Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
//
// 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.google.gerrit.client.ui;

import com.google.gerrit.client.Gerrit;
import com.google.gwt.event.dom.client.KeyCodes;
import com.google.gwt.event.dom.client.KeyPressEvent;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.user.client.ui.Widget;
import com.google.gwtexpui.globalkey.client.GlobalKey;
import com.google.gwtexpui.globalkey.client.KeyCommand;
import com.google.gwtexpui.globalkey.client.KeyCommandSet;

import java.util.HashMap;
import java.util.Map;

public abstract class AbstractKeyNavigation {
  public enum Action { NEXT, PREV, OPEN };

  protected final KeyCommandSet keysNavigation;
  protected final KeyCommandSet keysAction;
  private HandlerRegistration regNavigation;
  private HandlerRegistration regAction;
  private final KeyCommandSet keysOpenByEnter;
  private HandlerRegistration regOpenByEnter;
  protected final Widget parent;
  private Map<Action, String> help;
  protected static boolean initialized = false;

  protected void onNext() {};
  protected void onPrev() {};
  protected void onOpen() {};

  public AbstractKeyNavigation(final Widget parent) {
    this.parent = parent;
    help = new HashMap<AbstractKeyNavigation.Action, String>();
    keysNavigation = new KeyCommandSet(Gerrit.C.sectionNavigation());
    keysAction = new KeyCommandSet(Gerrit.C.sectionActions());
    keysOpenByEnter = new KeyCommandSet(Gerrit.C.sectionNavigation());
  }

  public void setKeyHelp(final Action action, final String text) {
    help.put(action, text);
  }

  public void initializeKeys() {
      keysNavigation.add(new NextKeyCommand(0, 'j', help.get(Action.NEXT)));
      keysNavigation.add(new PrevKeyCommand(0, 'k', help.get(Action.PREV)));
      keysAction.add(new OpenKeyCommand(0, 'o', help.get(Action.OPEN)));
      keysOpenByEnter.add(new OpenKeyCommand(0, KeyCodes.KEY_ENTER, help.get(Action.OPEN)));
  }

  public void addNavigationKey(final KeyCommand keyCommand) {
    keysNavigation.add(keyCommand);
  }

  public void setRegisterKeys(final boolean on) {
    if (on) {
      if (regNavigation == null) {
        regNavigation = GlobalKey.add(parent, keysNavigation);
      }
      if (regAction == null) {
        regAction = GlobalKey.add(parent, keysAction);
      }
      if (regOpenByEnter == null) {
        regOpenByEnter = GlobalKey.add(parent, keysOpenByEnter);
      }
    } else {
      if (regNavigation != null) {
        regNavigation.removeHandler();
        regNavigation = null;
      }

      if (regAction != null) {
        regAction.removeHandler();
        regAction = null;
      }

      if (regOpenByEnter != null) {
        regOpenByEnter.removeHandler();
        regOpenByEnter = null;
      }
    }
  }

  public void setRegisterEnter(final boolean on) {
    if (on) {
      if (regOpenByEnter != null) {
        regOpenByEnter.removeHandler();
        regOpenByEnter = null;
      }
    } else {
      if (keysOpenByEnter != null && regOpenByEnter == null) {
        regOpenByEnter = GlobalKey.add(parent, keysOpenByEnter);
      }
    }
  }

  private class PrevKeyCommand extends KeyCommand {
    public PrevKeyCommand(int mask, char key, String help) {
      super(mask, key, help);
    }

    @Override
    public void onKeyPress(final KeyPressEvent event) {
      onPrev();
    }
  }

  private class NextKeyCommand extends KeyCommand {
    public NextKeyCommand(int mask, char key, String help) {
      super(mask, key, help);
    }

    @Override
    public void onKeyPress(final KeyPressEvent event) {
      onNext();
    }
  }

  private class OpenKeyCommand extends KeyCommand {
    public OpenKeyCommand(int mask, int key, String help) {
      super(mask, key, help);
    }

    @Override
    public void onKeyPress(final KeyPressEvent event) {
      onOpen();
    }
  }

  protected class NoOpKeyCommand extends NeedsSignInKeyCommand {
    public NoOpKeyCommand(int mask, int key, String help) {
      super(mask, key, help);
    }

    @Override
    public void onKeyPress(final KeyPressEvent event) {
    }
  }
}