Minor documentation/comment changes
[online-glom:gwt-glom.git] / src / main / java / org / glom / web / client / activity / TableSelectionActivity.java
1 /*
2  * Copyright (C) 2011 Openismus GmbH
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 org.glom.web.client.ClientFactory;
23 import org.glom.web.client.OnlineGlomServiceAsync;
24 import org.glom.web.client.event.TableChangeEvent;
25 import org.glom.web.client.place.DetailsPlace;
26 import org.glom.web.client.place.HasSelectableTablePlace;
27 import org.glom.web.client.place.ListPlace;
28 import org.glom.web.client.ui.TableSelectionView;
29 import org.glom.web.client.ui.View;
30 import org.glom.web.shared.DocumentInfo;
31
32 import com.google.gwt.activity.shared.AbstractActivity;
33 import com.google.gwt.core.client.GWT;
34 import com.google.gwt.event.dom.client.ChangeEvent;
35 import com.google.gwt.event.dom.client.ChangeHandler;
36 import com.google.gwt.event.dom.client.HasChangeHandlers;
37 import com.google.gwt.event.shared.EventBus;
38 import com.google.gwt.event.shared.HandlerRegistration;
39 import com.google.gwt.place.shared.Place;
40 import com.google.gwt.user.client.Window;
41 import com.google.gwt.user.client.rpc.AsyncCallback;
42 import com.google.gwt.user.client.ui.AcceptsOneWidget;
43
44 /**
45  *
46  */
47 public class TableSelectionActivity extends AbstractActivity implements View.Presenter {
48         private final ClientFactory clientFactory;
49         private String documentID;
50         private String documentTitle;
51         private String tableName;
52         private HandlerRegistration changeHandlerRegistration = null;
53
54         // This activity isn't properly configured until the List or Details Place is set with the appropriate methods
55         public TableSelectionActivity(ClientFactory clientFactory) {
56                 this.clientFactory = clientFactory;
57         }
58
59         /**
60          * Invoked by the ActivityManager to start a new Activity
61          */
62         @Override
63         public void start(AcceptsOneWidget containerWidget, final EventBus eventBus) {
64
65                 final TableSelectionView tableSelectionView = clientFactory.getTableSelectionView();
66                 tableSelectionView.setPresenter(this);
67
68                 // For table changes with the tableSelector:
69                 HasChangeHandlers tableSelector = tableSelectionView.getTableSelector();
70                 changeHandlerRegistration = tableSelector.addChangeHandler(new ChangeHandler() {
71                         @Override
72                         public void onChange(ChangeEvent event) {
73                                 // Fire a table change event so that other views (e.g. the details view) know about the change and can
74                                 // update themselves.
75                                 eventBus.fireEvent(new TableChangeEvent(tableSelectionView.getSelectedTableName()));
76
77                                 // Update the browser title because there's place change and the setPlace() method will not be called.
78                                 Window.setTitle(documentTitle + ": " + tableSelectionView.getSelectedTableTitle());
79                         }
80                 });
81
82                 // get the table names, table titles and default table index for the current document
83                 AsyncCallback<DocumentInfo> callback = new AsyncCallback<DocumentInfo>() {
84                         public void onFailure(Throwable caught) {
85                                 // TODO: create a way to notify users of asynchronous callback failures
86                                 GWT.log("AsyncCallback Failed: OnlineGlomService.getDocumentInfo()");
87                         }
88
89                         public void onSuccess(DocumentInfo result) {
90                                 tableSelectionView.setTableSelection(result.getTableNames(), result.getTableTitles());
91
92                                 if (tableName == null || tableName.isEmpty()) {
93                                         tableName = result.getTableNames().get(result.getDefaultTableIndex());
94                                 }
95
96                                 tableSelectionView.setSelectedTableName(tableName);
97                                 documentTitle = result.getTitle();
98                                 tableSelectionView.setDocumentTitle(documentTitle);
99                                 Window.setTitle(documentTitle + ": " + result.getTableTitles().get(result.getDefaultTableIndex()));
100                         }
101                 };
102                 OnlineGlomServiceAsync.Util.getInstance().getDocumentInfo(documentID, callback);
103
104                 // we're done, set the widget
105                 containerWidget.setWidget(tableSelectionView.asWidget());
106         }
107
108         // This method will be called before the {@link TableSelectionActivity#start(AcceptsOneWidget, EventBus)} method and
109         // any time the Place changes after the start method has been called.
110         public void setPlace(HasSelectableTablePlace place) {
111                 documentID = place.getDocumentID();
112                 tableName = place.getTableName();
113
114                 TableSelectionView tableSelectionView = clientFactory.getTableSelectionView();
115
116                 // Update the selected table if it's not correct.
117                 if (!tableSelectionView.getSelectedTableName().equals(tableName)) {
118                         tableSelectionView.setSelectedTableName(tableName);
119                 }
120
121                 // Update the browser title if document title has already been setup.
122                 if (documentTitle != null && !documentTitle.isEmpty()) {
123                         Window.setTitle(documentTitle + ": " + tableSelectionView.getSelectedTableTitle());
124                 }
125
126                 // show the 'back to list' link if we're at a DetailsPlace, hide it otherwise
127                 if (place instanceof DetailsPlace) {
128                         tableSelectionView.setBackLinkVisible(true);
129                         tableSelectionView.setBackLink(documentID, tableName);
130                 } else if (place instanceof ListPlace) {
131                         tableSelectionView.setBackLinkVisible(false);
132                 }
133         }
134
135         private void clearView() {
136                 clientFactory.getTableSelectionView().clear();
137                 if (changeHandlerRegistration != null) {
138                         changeHandlerRegistration.removeHandler();
139                         changeHandlerRegistration = null;
140                 }
141         }
142
143         /*
144          * (non-Javadoc)
145          * 
146          * @see com.google.gwt.activity.shared.AbstractActivity#onCancel()
147          */
148         @Override
149         public void onCancel() {
150                 clearView();
151         }
152
153         /*
154          * (non-Javadoc)
155          * 
156          * @see com.google.gwt.activity.shared.AbstractActivity#onStop()
157          */
158         @Override
159         public void onStop() {
160                 clearView();
161         }
162
163         /*
164          * (non-Javadoc)
165          * 
166          * @see org.glom.web.client.ui.View.Presenter#goTo(com.google.gwt.place.shared.Place)
167          */
168         @Override
169         public void goTo(Place place) {
170                 clientFactory.getPlaceController().goTo(place);
171         }
172
173 }