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.ArrayList;

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.layout.LayoutGroup;

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

48 import org.glom.web.shared.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 }

92

93 @Override

94 public void onSuccess(final NavigationRecord result) {

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

96 }

97

98 };

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

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

101 }

102 }

103

104 private TypedDataItem primaryKeyValue;

105 private final DetailsView detailsView;

106 ArrayList<DetailsCell> detailsCells;

107 ArrayList<Portal> portals;

108

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

110 super(place, clientFactory);

111 this.primaryKeyValue = place.getPrimaryKeyValue();

112 detailsView = clientFactory.getDetailsView();

113 }

114

115 /*

116 * (non-Javadoc)

117 *

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

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

120 */

121 @Override

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

123 if (StringUtils.isEmpty(documentID))

124 goTo(new DocumentSelectionPlace());

125

126 // register this class as the presenter

127 detailsView.setPresenter(this);

128

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

130

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

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

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

134 @Override

135 public void onTableChange(final TableChangeEvent event) {

136 // note the empty primary key item

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

138 }

139 });

140

141 // get the layout and data for the DetailsView

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

143 @Override

144 public void onFailure(final Throwable caught) {

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

146 GWT.log("AsyncCallback Failed: OnlineGlomService.getDetailsLayoutAndData()");

147 }

148

149 @Override

150 public void onSuccess(final DetailsLayoutAndData result) {

151 if (result == null) {

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

153 // documentID.

154 goTo(new DocumentSelectionPlace());

155 } else {

156 // create the layout and set the data

157 createLayout(result.getLayout());

158 setData(result.getData());

159 }

160 }

161

162 };

163

164 final String localeID = Utils.getCurrentLocaleID();

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

166 localeID, callback);

167

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

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

170 @Override

171 public void onQuickFindChange(final QuickFindChangeEvent event) {

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

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

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

175 }

176 });

177

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

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

180 @Override

181 public void onLocaleChange(final LocaleChangeEvent event) {

182 // note the empty primary key item

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

184 }

185 });

186

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

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

189 }

190

191 /*

192 * Create the layout.

193 */

194 private void createLayout(final ArrayList<LayoutGroup> layout) {

195 // add the groups

196 for (final LayoutGroup layoutGroup : layout) {

197 detailsView.addGroup(layoutGroup);

198 }

199

200 // save references to the DetailsCells and the Portals

201 detailsCells = detailsView.getCells();

202 portals = detailsView.getPortals();

203

204 // Setup click handlers for the navigation buttons

205 for (final DetailsCell detailsCell : detailsCells) {

206 final LayoutItemField layoutItemField = detailsCell.getLayoutItemField();

207 if (layoutItemField.getAddNavigation()) {

208 detailsCell.setOpenButtonClickHandler(new ClickHandler() {

209 @Override

210 public void onClick(final ClickEvent event) {

211 final TypedDataItem primaryKeyItem = Utils.getTypedDataItem(layoutItemField.getType(),

212 detailsCell.getData());

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

214

215 }

216 });

217 }

218 }

219

220 }

221

222 /*

223 * Set the data.

224 */

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

226

227 if (data == null)

228 return;

229

230 // TODO create proper client side logging

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

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

233

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

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

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

237

238 // set the DatailsItem

239 detailsCell.setData(data[i]);

240

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

242 for (final Portal portal : portals) {

243 final LayoutItemField layoutItemField = detailsCell.getLayoutItemField();

244 final LayoutItemPortal layoutItemPortal = portal.getLayoutItem();

245

246 if (layoutItemField.getName().equals(layoutItemPortal.getFromField())) {

247 if (data[i] == null)

248 continue;

249

250 final TypedDataItem foreignKeyValue = Utils

251 .getTypedDataItem(layoutItemField.getType(), data[i]);

252

253 final RelatedListTable relatedListTable = new RelatedListTable(documentID, layoutItemPortal,

254 foreignKeyValue, new RelatedListNavigationButtonCell(layoutItemPortal.getName()));

255

256 if (!layoutItemPortal.getAddNavigation()

257 || layoutItemPortal.getNavigationType() == LayoutItemPortal.NavigationType.NAVIGATION_NONE) {

258 relatedListTable.hideNavigationButtons();

259 }

260 portal.setContents(relatedListTable);

261

262 setRowCountForRelatedListTable(relatedListTable, layoutItemPortal.getName(), foreignKeyValue);

263 }

264 }

265 }

266 }

267 }

268

269 private void refreshData() {

270

271 // get the data for the DetailsView

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

273 @Override

274 public void onFailure(final Throwable caught) {

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

276 GWT.log("AsyncCallback Failed: OnlineGlomService.getDetailsData()");

277 }

278

279 @Override

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

281 setData(result);

282 }

283 };

284

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

286

287 }

288

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

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

291 final TypedDataItem foreignKeyValue) {

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

293 @Override

294 public void onFailure(final Throwable caught) {

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

296 GWT.log("AsyncCallback Failed: OnlineGlomService.getRelatedListRowCount()");

297 }

298

299 @Override

300 public void onSuccess(final Integer result) {

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

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

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

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

305 relatedListTable.setRowCount(relatedListTable.getMinNumVisibleRows());

306 } else {

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

308 // visible.

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

310 }

311 }

312 };

313

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

315 foreignKeyValue, callback);

316 }

317

318 /*

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

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

321 */

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

323

324 // Ensure the new table name is valid.

325 String newTableName;

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

327 newTableName = navigationTableName;

328 } else {

329 newTableName = tableName;

330 }

331

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

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

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

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

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

337 } else {

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

339 primaryKeyValue = navigationPrimaryKeyValue;

340 refreshData();

341 }

342 } else {

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

344 // This is what Glom displays:

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

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

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

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

349 // about.

350 }

351 }

352

353 /*

354 * (non-Javadoc)

355 *

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

357 */

358 @Override

359 public void onCancel() {

360 detailsView.clear();

361 }

362

363 /*

364 * (non-Javadoc)

365 *

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

367 */

368 @Override

369 public void onStop() {

370 detailsView.clear();

371 }

372

373 }