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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|
/*******************************************************************************
* Copyright (c) 2004, 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* yyyymmdd bug Email and other contact information
* -------- -------- -----------------------------------------------------------
* 20060223 129232 pmoogk@ca.ibm.com - Peter Moogk
* 20060313 130958 pmoogk@ca.ibm.com - Peter Moogk
*******************************************************************************/
package org.eclipse.wst.command.internal.env.ui.widgets;
import java.util.Hashtable;
import java.util.Stack;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.jface.wizard.IWizard;
import org.eclipse.jface.wizard.IWizardContainer;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.wst.command.internal.env.core.data.DataFlowManager;
import org.eclipse.wst.command.internal.env.core.fragment.CommandFragment;
import org.eclipse.wst.command.internal.env.eclipse.EclipseEnvironment;
import org.eclipse.wst.command.internal.env.ui.registry.WidgetRegistry;
import org.eclipse.wst.common.environment.ILog;
public class WizardPageManager extends SimpleCommandEngineManager
{
private WizardPageFactory pageFactory_;
private Hashtable pageTable_;
private IWizard wizard_;
protected SimpleWidgetRegistry registry_;
// These variables are used and set by our methods which is
// why they are not initialized in the constructor.
private PageWizardDataEvents currentPage_;
private PageWizardDataEvents nextPage_;
private PageWizardDataEvents nextPeekPage_;
private PageWizardDataEvents firstPage_;
private CommandFragment lastUndoFragment_;
private boolean firstFragment_;
private INamedWidgetContributorFactory widgetFactory_;
private Stack widgetStack_;
private Stack widgetStackStack_;
private Hashtable widgetTable_;
private WidgetRegistry widgetRegistry_;
private Hashtable widgetFactoryTable_;
public WizardPageManager( SimpleWidgetRegistry registry,
WizardPageFactory pageFactory,
IWizard wizard,
DataFlowManager dataManager,
EclipseEnvironment environment )
{
super( environment, dataManager );
pageFactory_ = pageFactory;
pageTable_ = new Hashtable();
registry_ = registry;
wizard_ = wizard;
widgetTable_ = new Hashtable();
widgetFactoryTable_ = new Hashtable();
widgetRegistry_ = WidgetRegistry.instance();
widgetStackStack_ = new Stack();
}
public IWizardPage getStartingPage()
{
if( firstPage_ == null )
{
firstPage_ = (PageWizardDataEvents)getNextPage();
}
return firstPage_;
}
public IStatus runForwardToNextStop()
{
firstFragment_ = true;
nextPage_ = null;
IWizardContainer container = wizard_.getContainer();
if( container == null || container.getCurrentPage() == null )
{
container = null;
}
return super.runForwardToNextStop( container );
}
public IWizardPage getCurrentPage()
{
return currentPage_;
}
public boolean hasNextPage()
{
nextPeekPage_ = null;
try
{
nextPeekPage_ = getNextPageInGroup( widgetFactory_, false );
if( nextPeekPage_ == null )
{
// If a page is found nextPage_ will be set to its value in the method below.
engine_.peekForwardToNextStop();
}
}
catch( Throwable exc )
{
exc.printStackTrace();
}
return nextPeekPage_ != null;
}
public IWizardPage getNextPage()
{
try
{
// Need to externalize the data for the current page so that
// when we move forward below the data is available.
if( currentPage_ != null ) currentPage_.getDataEvents().externalize();
if( environment_.getLog().isEnabled() )
{
environment_.getLog().log(ILog.INFO, "ws_dt_cmd_engine", 5010, this, "Cmd stack dump:", engine_ );
}
nextPage_ = getNextPageInGroup( widgetFactory_, true );
if( nextPage_ == null )
{
widgetFactory_ = null;
widgetStack_ = null;
IStatus status = runForwardToNextStop();
if( status.getSeverity() == IStatus.ERROR )
{
// An error has occured so we need undo to the previous stop point.
undoToLastPage();
}
}
if( nextPage_ != null ) nextPage_.setWizard( wizard_ );
return nextPage_;
}
catch( Throwable exc )
{
exc.printStackTrace();
}
return null;
}
public void handlePageVisible( PageWizardDataEvents page, boolean isPageVisible )
{
if( !isPageVisible && page == firstPage_ && page == currentPage_ )
{
// We are moving back one page from the first page. This can't happen with popup wizards
// since the previous button would be greyed out. But when the new wizard launches this wizard
// the previous button is not greyed out and brings the user back to the list wizards to select.
// Therefore, we must unwind the command engine and get ready for the user to invoke this wizard
// again. We are assuming here that the first page is never part of a widget group!
undoToLastPage();
currentPage_ = null;
firstPage_ = null;
}
if( currentPage_ != null && page == currentPage_.getPreviousPage() && isPageVisible )
{
// We are moving back one page.
// Note: we don't internalize the previous page and we do not externalize the current page.
// we are basically just leaving the current page without retrieving its state and
// moving to the previous page which already has its state set.
if( widgetFactory_ != null )
{
if( widgetStack_.size() > 0 )
{
widgetStack_.pop();
}
if( widgetStack_.size() == 0 )
{
widgetFactory_ = null;
widgetStack_ = null;
widgetStackStack_.pop();
}
}
if( widgetFactory_ == null )
{
undoToLastPage();
}
// Since we are moving backwards we need to remove the
// current page object from the mapping table.
dataManager_.unprocess( currentPage_.getDataEvents() );
currentPage_ = page;
}
else if( isPageVisible )
{
try
{
// We are moving forward one page.
WidgetDataEvents dataEvents = page.getDataEvents();
dataManager_.process( dataEvents ); // Push model data into the new page.
dataEvents.internalize();
page.validatePageToStatus();
}
catch( Throwable exc )
{
exc.printStackTrace();
}
finally
{
if( currentPage_ != null ) page.setPreviousPage( currentPage_ );
currentPage_ = page;
}
}
}
public boolean performFinish()
{
// We need to simulate the next button being pressed until there are no more pages.
// If an error occurs we will return false and reset the command stack back our original state.
boolean doneOk = true;
PageWizardDataEvents startPage = currentPage_;
// Externalize the current page.
currentPage_.getDataEvents().externalize();
// Loop through subsequent pages.
do
{
IStatus status = runForwardToNextStop();
if( status.getSeverity() == IStatus.ERROR )
{
// An error occured in one of the commands.
doneOk = false;
}
}
while( nextPage_ != null && doneOk);
if( !doneOk )
{
// An error occured, so we need to return the command stack to it's
// orginal state.
PageWizardDataEvents page = null;
boolean done = false;
do
{
done = engine_.undoToLastStop();
page = getPage( lastUndoFragment_ );
if( page == null && lastUndoFragment_ != null && getWidgetFactory( lastUndoFragment_.getId() ) == widgetFactory_ )
{
// The current widget factory is associated with the last fragment that was undone.
// Therefore, we are back to where we started.
done = true;
}
}
while( page != startPage && !done );
}
return doneOk;
}
public boolean performCancel()
{
while( !engine_.undoToLastStop() ){}
return true;
}
protected boolean peekFragment( CommandFragment fragment )
{
// Check to see if this fragment is in our page table.
nextPeekPage_ = getPage( fragment );
if( nextPeekPage_ == null )
{
INamedWidgetContributorFactory factory = getWidgetFactory( fragment.getId() );
if( factory != null )
{
nextPeekPage_ = getNextPageInGroup( factory, false );
}
}
return nextPeekPage_ == null;
}
protected boolean nextFragment( CommandFragment fragment )
{
// If the super class nextFragment want us to stop then we will stop right away.
if( !super.nextFragment( fragment ) ) return false;
// The first fragment is either at the start of the wizard
// or it is on a wizard page. In either case we do not want
// to stop if a page is found.
if( firstFragment_ )
{
firstFragment_ = false;
}
else
{
widgetFactory_ = getWidgetFactory( fragment.getId() );
if( widgetFactory_ != null )
{
widgetStack_ = new Stack();
nextPage_ = getNextPageInGroup( widgetFactory_, true );
if( nextPage_ == null )
{
// We found a widget contributor for this fragment, but no page was delivered for it.
// We will therefore, not put it on our stack of widget stacks.
widgetStack_ = null;
widgetFactory_ = null;
}
else
{
StackEntry entry = new StackEntry();
entry.factory_ = widgetFactory_;
entry.stack_ = widgetStack_;
widgetStackStack_.push( entry );
}
}
else
{
nextPage_ = getPage( fragment );
}
}
return nextPage_ == null;
}
protected boolean undoFragment( CommandFragment fragment )
{
lastUndoFragment_ = fragment;
return true;
}
private PageWizardDataEvents getNextPageInGroup( INamedWidgetContributorFactory factory, boolean pushNewWidget )
{
PageWizardDataEvents page = null;
if( factory != null )
{
INamedWidgetContributor newWidget = null;
if( widgetStack_ == null || widgetStack_.size() == 0 )
{
newWidget = factory.getFirstNamedWidget();
}
else
{
INamedWidgetContributor currentWidget = (INamedWidgetContributor)widgetStack_.peek();
newWidget = factory.getNextNamedWidget( currentWidget );
}
if( newWidget != null )
{
page = getPage( newWidget );
if( pushNewWidget )
{
widgetStack_.push( newWidget );
}
}
}
return page;
}
private void undoToLastPage()
{
boolean stackEmpty = false;
boolean doneUndoing = false;
while( !doneUndoing )
{
stackEmpty = engine_.undoToLastStop();
IWizardPage page = null;
if( lastUndoFragment_ != null )
{
page = getPage( lastUndoFragment_ );
if( page == null )
{
// Check to see if a group page fragment was found.
INamedWidgetContributorFactory factory = getWidgetFactory( lastUndoFragment_.getId() );
if( factory != null )
{
StackEntry entry = (StackEntry)widgetStackStack_.peek();
widgetFactory_ = entry.factory_;
widgetStack_ = entry.stack_;
if( widgetStack_ != null && !widgetStack_.empty() )
{
INamedWidgetContributor currentWidget = (INamedWidgetContributor)widgetStack_.peek();
page = getPage( currentWidget );
}
}
}
}
doneUndoing = page != null || stackEmpty;
}
}
private PageWizardDataEvents getPage( CommandFragment fragment )
{
// Check to see if this fragment is in our page table.
PageWizardDataEvents page = (PageWizardDataEvents)pageTable_.get( fragment );
String id = fragment.getId();
if( page == null && id != null )
{
// Check to see if this fragment id is in the registry.
PageInfo pageInfo = registry_.getPageInfo( id );
if( pageInfo != null )
{
page = pageFactory_.getPage( pageInfo, this );
pageTable_.put( fragment, page );
}
}
return page;
}
private PageWizardDataEvents getPage( INamedWidgetContributor widget )
{
PageWizardDataEvents page = (PageWizardDataEvents)widgetTable_.get( widget );
if( page == null )
{
PageInfo pageInfo = new PageInfo(widget.getTitle(), widget.getDescription(), widget.getWidgetContributorFactory() );
page = pageFactory_.getPage( pageInfo, this );
widgetTable_.put( widget, page );
}
return page;
}
private INamedWidgetContributorFactory getWidgetFactory( String id )
{
INamedWidgetContributorFactory factory = (INamedWidgetContributorFactory)widgetFactoryTable_.get( id );
if( factory == null )
{
// The factory is not in our table so we will try the registry.
factory = widgetRegistry_.getFactory( id );
if( factory != null )
{
widgetFactoryTable_.put( id, factory );
factory.registerDataMappings( dataManager_.getMappingRegistry() );
dataManager_.process( factory );
}
}
else
{
dataManager_.process( factory );
}
return factory;
}
private class StackEntry
{
INamedWidgetContributorFactory factory_;
Stack stack_;
}
}
|