gitorious.org Git - online-glom:gwt-glom.git/blob - src/main/java/org/glom/web/client/activity/DetailsActivity.java

1 /*

3 *

4 * This file is part of GWT-Glom.

5 *

6 * GWT-Glom is free software: you can redistribute it and/or modify it

7 * under the terms of the GNU Lesser General Public License as published by the

8 * Free Software Foundation, either version 3 of the License, or (at your

9 * option) any later version.

10 *

11 * GWT-Glom is distributed in the hope that it will be useful, but WITHOUT

12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License

14 * for more details.

15 *

16 * You should have received a copy of the GNU Lesser General Public License

17 * along with GWT-Glom. If not, see <http://www.gnu.org/licenses/>.

18 */

19

20 package org.glom.web.client.activity;

21

22 import java.util.List;

23

24 import org.glom.web.client.ClientFactory;

25 import org.glom.web.client.OnlineGlomServiceAsync;

26 import org.glom.web.client.StringUtils;

27 import org.glom.web.client.Utils;

28 import org.glom.web.client.event.LocaleChangeEvent;

29 import org.glom.web.client.event.LocaleChangeEventHandler;

30 import org.glom.web.client.event.QuickFindChangeEvent;

31 import org.glom.web.client.event.QuickFindChangeEventHandler;

32 import org.glom.web.client.event.TableChangeEvent;

33 import org.glom.web.client.event.TableChangeEventHandler;

34 import org.glom.web.client.place.DetailsPlace;

35 import org.glom.web.client.place.DocumentSelectionPlace;

36 import org.glom.web.client.place.ListPlace;

37 import org.glom.web.client.ui.DetailsView;

38 import org.glom.web.client.ui.cell.NavigationButtonCell;

39 import org.glom.web.client.ui.details.DetailsCell;

40 import org.glom.web.client.ui.details.Portal;

41 import org.glom.web.client.ui.details.RelatedListTable;

42 import org.glom.web.shared.DataItem;

43 import org.glom.web.shared.DetailsLayoutAndData;

44 import org.glom.web.shared.NavigationRecord;

45 import org.glom.web.shared.TypedDataItem;

46 import org.glom.web.shared.libglom.layout.LayoutGroup;

47 import org.glom.web.shared.libglom.layout.LayoutItemField;

48 import org.glom.web.shared.libglom.layout.LayoutItemPortal;

49

50 import com.google.gwt.cell.client.ValueUpdater;

51 import com.google.gwt.core.client.GWT;

52 import com.google.gwt.dom.client.Element;

53 import com.google.gwt.dom.client.NativeEvent;

54 import com.google.gwt.event.dom.client.ClickEvent;

55 import com.google.gwt.event.dom.client.ClickHandler;

56 import com.google.gwt.event.shared.EventBus;

57 import com.google.gwt.user.client.rpc.AsyncCallback;

58 import com.google.gwt.user.client.ui.AcceptsOneWidget;

59

60 /**

61 *

62 */

63 public class DetailsActivity extends HasTableActivity {

64 /*

65 * Cell renderer for the related list open buttons. Normally this wouldn't be in an Activity class but since it's

66 * making a call to the server it makes sense for it to be here.

67 */

68 private class RelatedListNavigationButtonCell extends NavigationButtonCell {

69

70 private final String relationshipName;

71

72 public RelatedListNavigationButtonCell(final String relationshipName) {

73 this.relationshipName = relationshipName;

74 }

75

76 /*

77 * (non-Javadoc)

78 *

79 * @see com.google.gwt.cell.client.ButtonCell#onEnterKeyDown(com.google.gwt.cell.client.Cell.Context,

80 * com.google.gwt.dom.client.Element, java.lang.String, com.google.gwt.dom.client.NativeEvent,

81 * com.google.gwt.cell.client.ValueUpdater)

82 */

83 @Override

84 protected void onEnterKeyDown(final Context context, final Element parent, final String value,

85 final NativeEvent event, final ValueUpdater<String> valueUpdater) {

86 final AsyncCallback<NavigationRecord> callback = new AsyncCallback<NavigationRecord>() {

87 @Override

88 public void onFailure(final Throwable caught) {

89 // TODO: create a way to notify users of asynchronous callback failures

90 GWT.log("AsyncCallback Failed: OnlineGlomService.getSuitableRecordToViewDetails(): "

91 + caught.getMessage());

92 }

93

94 @Override

95 public void onSuccess(final NavigationRecord result) {

96 if (result != null) {

97 processNavigation(result.getTableName(), result.getPrimaryKeyValue());

98 } else {

99 GWT.log("onEnterKeyDown(): getSuitableRecordToViewDetails() result is null.");

100 }

101 }

102

103 };

104

105 OnlineGlomServiceAsync.Util.getInstance().getSuitableRecordToViewDetails(documentID, tableName,

106 relationshipName, (TypedDataItem) context.getKey(), callback);

107 }

108 }

109

110 private TypedDataItem primaryKeyValue;

111 private final DetailsView detailsView;

112 List<DetailsCell> detailsCells;

113 List<Portal> portals;

114

115 public DetailsActivity(final DetailsPlace place, final ClientFactory clientFactory) {

116 super(place, clientFactory);

117 this.primaryKeyValue = place.getPrimaryKeyValue();

118 detailsView = clientFactory.getDetailsView();

119 }

120

121 /*

122 * (non-Javadoc)

123 *

124 * @see com.google.gwt.activity.shared.Activity#start(com.google.gwt.user.client.ui.AcceptsOneWidget,

125 * com.google.gwt.event.shared.EventBus)

126 */

127 @Override

128 public void start(final AcceptsOneWidget panel, final EventBus eventBus) {

129 if (StringUtils.isEmpty(documentID))

130 goTo(new DocumentSelectionPlace());

131

132 // register this class as the presenter

133 detailsView.setPresenter(this);

134

135 // TODO here's where we should check for database authentication - see ListActivity.start() for how to do this

136

137 // set the change handler for the table selection widget

138 // TODO: Why don't we just use goTo() in the TableSelectionActivity that fired this event?

139 eventBus.addHandler(TableChangeEvent.TYPE, new TableChangeEventHandler() {

140 @Override

141 public void onTableChange(final TableChangeEvent event) {

142 // note the empty primary key item

143 goTo(new DetailsPlace(documentID, event.getNewTableName(), new TypedDataItem()));

144 }

145 });

146

147 // get the layout and data for the DetailsView

148 final AsyncCallback<DetailsLayoutAndData> callback = new AsyncCallback<DetailsLayoutAndData>() {

149 @Override

150 public void onFailure(final Throwable caught) {

151 // TODO: create a way to notify users of asynchronous callback failures

152 GWT.log("AsyncCallback Failed: OnlineGlomService.getDetailsLayoutAndData(): " + caught.getMessage());

153 }

154

155 @Override

156 public void onSuccess(final DetailsLayoutAndData result) {

157 if (result == null) {

158 // The result is null only when the documentID was not found. There's nothing to display without the

159 // documentID.

160 goTo(new DocumentSelectionPlace());

161 } else {

162 // create the layout and set the data

163 createLayout(result.getLayout());

164 setData(result.getData());

165 }

166 }

167

168 };

169

170 final String localeID = Utils.getCurrentLocaleID();

171 OnlineGlomServiceAsync.Util.getInstance().getDetailsLayoutAndData(documentID, tableName, primaryKeyValue,

172 localeID, callback);

173

174 // set the change handler for the quickfind text widget

175 eventBus.addHandler(QuickFindChangeEvent.TYPE, new QuickFindChangeEventHandler() {

176 @Override

177 public void onQuickFindChange(final QuickFindChangeEvent event) {

178 // We switch to the List view, to show search results.

179 // TODO: Show the details view if there is only one result.

180 goTo(new ListPlace(documentID, tableName, event.getNewQuickFindText()));

181 }

182 });

183

184 // Set the change handler for the table selection widget

185 eventBus.addHandler(LocaleChangeEvent.TYPE, new LocaleChangeEventHandler() {

186 @Override

187 public void onLocaleChange(final LocaleChangeEvent event) {

188 // note the empty primary key item

189 goTo(new DetailsPlace(documentID, tableName, primaryKeyValue));

190 }

191 });

192

193 // indicate that the view is ready to be displayed

194 panel.setWidget(detailsView.asWidget());

195 }

196

197 /*

198 * Create the layout.

199 */

200 private void createLayout(final List<LayoutGroup> list) {

201 // add the groups

202 for (final LayoutGroup layoutGroup : list) {

203 detailsView.addGroup(layoutGroup);

204 }

205

206 // save references to the DetailsCells and the Portals

207 detailsCells = detailsView.getCells();

208 portals = detailsView.getPortals();

209

210 // Setup click handlers for the navigation buttons

211 for (final DetailsCell detailsCell : detailsCells) {

212 final LayoutItemField layoutItemField = detailsCell.getLayoutItemField();

213 if (layoutItemField == null) {

214 continue;

215 }

216 if (layoutItemField.getAddNavigation()) {

217 detailsCell.setOpenButtonClickHandler(new ClickHandler() {

218 @Override

219 public void onClick(final ClickEvent event) {

220 final TypedDataItem primaryKeyItem = Utils.getTypedDataItem(layoutItemField.getGlomType(),

221 detailsCell.getData());

222 processNavigation(layoutItemField.getNavigationTableName(), primaryKeyItem);

223

224 }

225 });

226 }

227 }

228

229 }

230

231 /*

232 * Set the data.

233 */

234 private void setData(final DataItem[] data) {

235

236 if (data == null)

237 return;

238

239 // TODO create proper client side logging

240 if (data.length != detailsCells.size())

241 GWT.log("Warning: The number of data items doesn't match the number of data detailsCells.");

242

243 for (int i = 0; i < Math.min(detailsCells.size(), data.length); i++) {

244 final DetailsCell detailsCell = detailsCells.get(i);

245 if (data[i] != null) {

246

247 // set the DatailsItem

248 detailsCell.setData(data[i]);

249 final LayoutItemField layoutItemField = detailsCell.getLayoutItemField();

250 final String fieldName = layoutItemField.getName();

251

252 // see if there are any related lists that need to be setup

253 for (final Portal portal : portals) {

254 final LayoutItemPortal layoutItemPortal = portal.getLayoutItem();

255 final String portalFromField = layoutItemPortal.getFromField();

256 if (fieldName.equals(portalFromField)) {

257 if (data[i] == null)

258 continue;

259

260 final TypedDataItem foreignKeyValue = Utils.getTypedDataItem(layoutItemField.getGlomType(),

261 data[i]);

262

263 final RelatedListTable relatedListTable = new RelatedListTable(documentID, tableName,

264 layoutItemPortal, foreignKeyValue, new RelatedListNavigationButtonCell(

265 layoutItemPortal.getRelationshipNameUsed()));

266

267 if (layoutItemPortal.getNavigationType() == LayoutItemPortal.NavigationType.NAVIGATION_NONE) {

268 relatedListTable.hideNavigationButtons();

269 }

270 portal.setContents(relatedListTable);

271

272 setRowCountForRelatedListTable(relatedListTable, layoutItemPortal.getRelationshipNameUsed(),

273 foreignKeyValue);

274 }

275 }

276 }

277 }

278 }

279

280 private void refreshData() {

281

282 // get the data for the DetailsView

283 final AsyncCallback<DataItem[]> callback = new AsyncCallback<DataItem[]>() {

284 @Override

285 public void onFailure(final Throwable caught) {

286 // TODO: create a way to notify users of asynchronous callback failures

287 GWT.log("AsyncCallback Failed: OnlineGlomService.getDetailsData(): " + caught.getMessage());

288 }

289

290 @Override

291 public void onSuccess(final DataItem[] result) {

292 setData(result);

293 }

294 };

295

296 OnlineGlomServiceAsync.Util.getInstance().getDetailsData(documentID, tableName, primaryKeyValue, callback);

297

298 }

299

300 // sets the row count for the related list table

301 private void setRowCountForRelatedListTable(final RelatedListTable relatedListTable, final String relationshipName,

302 final TypedDataItem foreignKeyValue) {

303 final AsyncCallback<Integer> callback = new AsyncCallback<Integer>() {

304 @Override

305 public void onFailure(final Throwable caught) {

306 // TODO: create a way to notify users of asynchronous callback failures

307 GWT.log("AsyncCallback Failed: OnlineGlomService.getRelatedListRowCount(): " + caught.getMessage());

308 }

309

310 @Override

311 public void onSuccess(final Integer result) {

312 if (result.intValue() <= relatedListTable.getMinNumVisibleRows()) {

313 // Set the table row count to the minimum row count if the data row count is less than or equal to

314 // the minimum row count. This ensures that data with fewer rows than the minimum will not create

315 // indexes in the underlying CellTable that will override the rendering of the empty rows.

316 relatedListTable.setRowCount(relatedListTable.getMinNumVisibleRows());

317 } else {

318 // Set the table row count to the data row count if it's larger than the minimum number of rows

319 // visible.

320 relatedListTable.setRowCount(result.intValue());

321 }

322 }

323 };

324

325 OnlineGlomServiceAsync.Util.getInstance().getRelatedListRowCount(documentID, tableName, relationshipName,

326 foreignKeyValue, callback);

327 }

328

329 /*

330 * Process a navigation by either doing: nothing if the navigation isn't valid, refreshing the data for the current

331 * table with a new primary key, or going to a new table with a new primary key.

332 */

333 private void processNavigation(final String navigationTableName, final TypedDataItem navigationPrimaryKeyValue) {

334

335 // Ensure the new table name is valid.

336 String newTableName;

337 if (!StringUtils.isEmpty(navigationTableName)) {

338 newTableName = navigationTableName;

339 } else {

340 newTableName = tableName;

341 }

342

343 // Only process the navigation if there's a valid primary key value.

344 if (navigationPrimaryKeyValue != null && !navigationPrimaryKeyValue.isEmpty()) {

345 if (!newTableName.equals(tableName)) {

346 // Go to a new DetailsPlace because the table name has changed.

347 goTo(new DetailsPlace(documentID, newTableName, navigationPrimaryKeyValue));

348 } else {

349 // Refresh the details view with the new primary because the table name has not changed.

350 primaryKeyValue = navigationPrimaryKeyValue;

351 refreshData();

352 }

353 } else {

354 // TODO notify the user that navigation isn't possible.

355 // This is what Glom displays:

356 // Frame_Glom::show_ok_dialog(_("No Corresponding Record Exists"),

357 // _("No record with this value exists. Therefore navigation to the related record is not possible."),

358 // *window, Gtk::MESSAGE_WARNING);

359 // TODO: Make it more clear to the user exactly what record, what field, and what value, we are talking

360 // about.

361 }

362 }

363

364 /*

365 * (non-Javadoc)

366 *

367 * @see com.google.gwt.activity.shared.Activity#onCancel()

368 */

369 @Override

370 public void onCancel() {

371 detailsView.clear();

372 }

373

374 /*

375 * (non-Javadoc)

376 *

377 * @see com.google.gwt.activity.shared.Activity#onStop()

378 */

379 @Override

380 public void onStop() {

381 detailsView.clear();

382 }

383

384 }