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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
// Copyright (C) 2012 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.google.gerrit.client.changes;
import com.google.gerrit.client.Gerrit;
import com.google.gerrit.client.rpc.GerritCallback;
import com.google.gerrit.common.data.ToggleStarRequest;
import com.google.gerrit.reviewdb.client.Change;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.dom.client.ClickHandler;
import com.google.gwt.event.dom.client.KeyPressEvent;
import com.google.gwt.event.shared.EventBus;
import com.google.gwt.event.shared.SimpleEventBus;
import com.google.gwt.resources.client.ImageResource;
import com.google.gwt.user.client.ui.Image;
import com.google.gwtexpui.globalkey.client.KeyCommand;
import com.google.gwtjsonrpc.common.VoidResult;
import com.google.web.bindery.event.shared.Event;
import com.google.web.bindery.event.shared.HandlerRegistration;
/** Supports the star icon displayed on changes and tracking the status. */
public class StarredChanges {
private static final EventBus eventBus = new SimpleEventBus();
private static final Event.Type<ChangeStarHandler> TYPE =
new Event.Type<ChangeStarHandler>();
/** Handler that can receive notifications of a change's starred status. */
public static interface ChangeStarHandler {
public void onChangeStar(ChangeStarEvent event);
}
/** Event fired when a star changes status. The new status is reported. */
public static class ChangeStarEvent extends Event<ChangeStarHandler> {
private boolean starred;
public ChangeStarEvent(Change.Id source, boolean starred) {
setSource(source);
this.starred = starred;
}
public boolean isStarred() {
return starred;
}
@Override
public Type<ChangeStarHandler> getAssociatedType() {
return TYPE;
}
@Override
protected void dispatch(ChangeStarHandler handler) {
handler.onChangeStar(this);
}
}
/**
* Create a star icon for the given change, and current status. Returns null
* if the user is not signed in and cannot support starred changes.
*/
public static Icon createIcon(Change.Id source, boolean starred) {
return Gerrit.isSignedIn() ? new Icon(source, starred) : null;
}
/** Make a key command that toggles the star for a change. */
public static KeyCommand newKeyCommand(final Icon icon) {
return new KeyCommand(0, 's', Util.C.changeTableStar()) {
@Override
public void onKeyPress(KeyPressEvent event) {
icon.toggleStar();
}
};
}
/** Add a handler to listen for starred status to change. */
public static HandlerRegistration addHandler(
Change.Id source,
ChangeStarHandler handler) {
return eventBus.addHandlerToSource(TYPE, source, handler);
}
/**
* Broadcast the current starred value of a change to UI widgets. This does
* not RPC to the server and does not alter the starred status of a change.
*/
public static void fireChangeStarEvent(Change.Id id, boolean starred) {
eventBus.fireEventFromSource(
new ChangeStarEvent(id, starred),
id);
}
/**
* Set the starred status of a change. This method broadcasts to all
* interested UI widgets and sends an RPC to the server to record the
* updated status.
*/
public static void toggleStar(
final Change.Id changeId,
final boolean newValue) {
if (next == null) {
next = new ToggleStarRequest();
}
next.toggle(changeId, newValue);
fireChangeStarEvent(changeId, newValue);
if (!busy) {
start();
}
}
private static ToggleStarRequest next;
private static boolean busy;
private static void start() {
final ToggleStarRequest req = next;
next = null;
busy = true;
Util.LIST_SVC.toggleStars(req, new GerritCallback<VoidResult>() {
@Override
public void onSuccess(VoidResult result) {
if (next != null) {
start();
} else {
busy = false;
}
}
@Override
public void onFailure(Throwable caught) {
rollback(req);
if (next != null) {
rollback(next);
next = null;
}
busy = false;
super.onFailure(caught);
}
});
}
private static void rollback(ToggleStarRequest req) {
if (req.getAddSet() != null) {
for (Change.Id id : req.getAddSet()) {
fireChangeStarEvent(id, false);
}
}
if (req.getRemoveSet() != null) {
for (Change.Id id : req.getRemoveSet()) {
fireChangeStarEvent(id, true);
}
}
}
public static class Icon extends Image
implements ChangeStarHandler, ClickHandler {
private final Change.Id changeId;
private boolean starred;
private HandlerRegistration handler;
Icon(Change.Id changeId, boolean starred) {
super(resource(starred));
this.changeId = changeId;
this.starred = starred;
addClickHandler(this);
}
/**
* Toggles the state of the star, as if the user clicked on the image. This
* will broadcast the new star status to all interested UI widgets, and RPC
* to the server to store the changed value.
*/
public void toggleStar() {
StarredChanges.toggleStar(changeId, !starred);
}
@Override
protected void onLoad() {
handler = StarredChanges.addHandler(changeId, this);
}
@Override
protected void onUnload() {
handler.removeHandler();
handler = null;
}
@Override
public void onChangeStar(ChangeStarEvent event) {
setResource(resource(event.isStarred()));
starred = event.isStarred();
}
@Override
public void onClick(ClickEvent event) {
toggleStar();
}
private static ImageResource resource(boolean starred) {
return starred ? Gerrit.RESOURCES.starFilled() : Gerrit.RESOURCES.starOpen();
}
}
private StarredChanges() {
}
}
|
