/*
* File : Wizard.java
* Created : 30 sept. 2003 00:06:56
* By : Olivier
*
* Azureus - a Java Bittorrent client
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details ( see the LICENSE file ).
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.gudy.azureus2.ui.swt.wizard;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.graphics.*;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.*;
import org.gudy.azureus2.core3.internat.MessageText;
import org.gudy.azureus2.core3.util.AERunnable;
import org.gudy.azureus2.ui.swt.Messages;
import org.gudy.azureus2.ui.swt.Utils;
import org.gudy.azureus2.ui.swt.components.shell.ShellFactory;
/**
* @author Olivier
*
*/
public class Wizard {
private final static int DEFAULT_WIDTH = 500;
List<WizardListener> listeners = new ArrayList<WizardListener>(1);
Display display;
Shell wizardWindow;
Label title;
Label currentInfo;
Label errorMessage;
IWizardPanel currentPanel;
Composite panel;
Font titleFont;
protected Button previous, next, finish, cancel;
Listener closeCatcher;
int wizardHeight;
private boolean completed;
public
Wizard(
String keyTitle )
{
this( keyTitle, false );
}
public
Wizard(
String keyTitle,
boolean modal )
{
this( modal );
setTitleKey( keyTitle );
}
public
Wizard(
String keyTitle,
boolean modal,
int width )
{
this( modal, width );
setTitleKey( keyTitle );
}
public
Wizard(
boolean modal )
{
this( modal, DEFAULT_WIDTH );
}
public
Wizard(
boolean modal,
int width )
{
int style = SWT.DIALOG_TRIM | SWT.RESIZE;
if (modal) {
style |= SWT.APPLICATION_MODAL;
}
wizardWindow = ShellFactory.createMainShell(style);
this.display = wizardWindow.getDisplay();
GridLayout layout = new GridLayout();
layout.numColumns = 1;
layout.horizontalSpacing = 0;
layout.verticalSpacing = 0;
layout.marginHeight = 0;
layout.marginWidth = 0;
wizardWindow.setLayout(layout);
Utils.setShellIcon(wizardWindow);
Composite cTitle = new Composite(wizardWindow, SWT.NULL);
Color white = display.getSystemColor(SWT.COLOR_WHITE);
cTitle.setBackground(white);
GridData gridData = new GridData(GridData.FILL_HORIZONTAL);
cTitle.setLayoutData(gridData);
GridLayout titleLayout = new GridLayout();
titleLayout.numColumns = 1;
cTitle.setLayout(titleLayout);
title = new Label(cTitle, SWT.NULL);
title.setBackground(white);
gridData = new GridData(GridData.FILL_HORIZONTAL);
title.setLayoutData(gridData);
Font font = title.getFont();
FontData[] data = font.getFontData();
for(int i = 0 ; i < data.length ; i++) {
data[i].setStyle(SWT.BOLD);
}
titleFont=new Font(display,data);
title.setFont(titleFont);
currentInfo = new Label(cTitle, SWT.NULL);
gridData = new GridData(GridData.FILL_HORIZONTAL);
currentInfo.setLayoutData(gridData);
currentInfo.setBackground(white);
errorMessage = new Label(cTitle, SWT.NULL);
gridData = new GridData(GridData.FILL_HORIZONTAL);
errorMessage.setLayoutData(gridData);
errorMessage.setBackground(white);
Color red = display.getSystemColor(SWT.COLOR_RED);
errorMessage.setForeground(red);
gridData = new GridData(GridData.FILL_HORIZONTAL);
new Label(wizardWindow, SWT.SEPARATOR | SWT.HORIZONTAL).setLayoutData(gridData);
panel = new Composite(wizardWindow, SWT.NULL);
gridData = new GridData(GridData.FILL_BOTH);
panel.setLayoutData(gridData);
gridData = new GridData(GridData.FILL_HORIZONTAL);
new Label(wizardWindow, SWT.SEPARATOR | SWT.HORIZONTAL).setLayoutData(gridData);
Composite cButtons = new Composite(wizardWindow, SWT.NULL);
gridData = new GridData(GridData.FILL_HORIZONTAL);
cButtons.setLayoutData(gridData);
GridLayout layoutButtons = new GridLayout();
layoutButtons.numColumns = 5;
cButtons.setLayout(layoutButtons);
gridData = new GridData(GridData.FILL_HORIZONTAL);
new Label(cButtons, SWT.NULL).setLayoutData(gridData);
cancel = new Button(cButtons, SWT.PUSH);
gridData = new GridData();
gridData.widthHint = 90;
gridData.horizontalAlignment = GridData.CENTER;
cancel.setLayoutData(gridData);
Messages.setLanguageText(cancel, "Button.cancel");
previous = new Button(cButtons, SWT.PUSH);
gridData = new GridData();
gridData.widthHint = 90;
gridData.horizontalAlignment = GridData.END;
previous.setLayoutData(gridData);
Messages.setLanguageText(previous, "wizard.previous");
next = new Button(cButtons, SWT.PUSH);
gridData = new GridData();
gridData.widthHint = 90;
gridData.horizontalAlignment = GridData.BEGINNING;
next.setLayoutData(gridData);
Messages.setLanguageText(next, "wizard.next");
finish = new Button(cButtons, SWT.PUSH);
gridData = new GridData();
gridData.widthHint = 90;
gridData.horizontalAlignment = GridData.CENTER;
finish.setLayoutData(gridData);
Messages.setLanguageText(finish, "wizard.finish");
previous.addListener(SWT.Selection, new Listener() {
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
public void handleEvent(Event arg0) {
clearPanel();
currentPanel = currentPanel.getPreviousPanel();
refresh();
}
});
next.addListener(SWT.Selection, new Listener() {
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
public void handleEvent(Event arg0) {
IWizardPanel nextPanel = currentPanel.getNextPanel();
clearPanel();
currentPanel = nextPanel;
refresh();
}
});
closeCatcher = new Listener() {
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
public void handleEvent(Event event) {
event.doit = false;
}
};
finish.addListener(SWT.Selection, new Listener() {
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
public void handleEvent(Event arg0){
finishSelected();
}
});
cancel.addListener(SWT.Selection, new Listener() {
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
public void handleEvent(Event arg0) {
cancelSelected();
}
});
wizardWindow.addDisposeListener(new DisposeListener() {
public void widgetDisposed(DisposeEvent de) {
onClose();
}
});
wizardWindow.addListener(SWT.Traverse, new Listener() {
public void handleEvent(Event e) {
if ( e.character == SWT.ESC){
if ( cancel.isEnabled()){
wizardWindow.dispose();
}
}
}
});
wizardHeight = wizardWindow.computeSize(width,SWT.DEFAULT).y - 50;
wizardWindow.setSize(width,400);
}
private void
cancelSelected()
{
completed = true;
if ( currentPanel != null ){
currentPanel.cancelled();
}
wizardWindow.dispose();
}
private void
finishSelected()
{
if ( currentPanel.isFinishSelectionOK()){
completed = true;
wizardWindow.addListener(SWT.Close, closeCatcher);
clearPanel();
currentPanel = currentPanel.getFinishPanel();
refresh();
currentPanel.finish();
}
}
private void clearPanel() {
if ( panel.isDisposed()){
return;
}
Control[] controls = panel.getChildren();
for (int i = 0; i < controls.length; i++) {
if (controls[i] != null && !controls[i].isDisposed())
controls[i].dispose();
}
setTitle("");
setCurrentInfo("");
}
private void refresh(){
if (currentPanel == null){
setDefaultButton();
return;
}
previous.setEnabled(currentPanel.isPreviousEnabled());
next.setEnabled(currentPanel.isNextEnabled());
finish.setEnabled(currentPanel.isFinishEnabled());
setDefaultButton();
currentPanel.show();
panel.layout();
panel.redraw();
insureSize();
}
private void
setDefaultButton()
{
if (!wizardWindow.isDisposed()){
display.asyncExec(new AERunnable() {
public void runSupport() {
if (!wizardWindow.isDisposed()){
Button default_button = null;
if ( next.isEnabled()){
default_button = next;
}else if ( finish.isEnabled()){
default_button = finish;
}else if ( previous.isEnabled()){
default_button = previous;
}else if ( cancel.isEnabled()){
default_button = cancel;
}
if ( default_button != null ){
wizardWindow.setDefaultButton( default_button );
}
}
}
});
}
}
public Composite getPanel() {
return panel;
}
public void setTitle(String title) {
this.title.setText(title);
}
public void setTitleAsResourceID(String id) {
Messages.setLanguageText(title, id);
}
public void setCurrentInfo(String currentInfo) {
this.currentInfo.setText("\t" + currentInfo);
}
public void setErrorMessage(String errorMessage) {
this.errorMessage.setText(errorMessage);
}
public void setTitleKey(String key) {
Messages.setLanguageText(wizardWindow, key);
}
public void setNextEnabled(boolean enabled) {
this.next.setEnabled(enabled);
setDefaultButton();
}
public void setPreviousEnabled(boolean enabled) {
this.previous.setEnabled(enabled);
setDefaultButton();
}
public void setFinishEnabled(boolean enabled) {
this.finish.setEnabled(enabled);
setDefaultButton();
}
public void setFirstPanel(IWizardPanel panel) {
this.currentPanel = panel;
refresh();
insureSize();
Utils.centreWindow( wizardWindow );
wizardWindow.open();
}
public Shell getWizardWindow() {
return wizardWindow;
}
public String getErrorMessage() {
return errorMessage.getText();
}
public Display getDisplay() {
return display;
}
public void switchToClose() {
if (!wizardWindow.isDisposed()) {
display.asyncExec(new AERunnable() {
public void runSupport() {
if (closeCatcher != null && wizardWindow != null && !wizardWindow.isDisposed()) {
wizardWindow.removeListener(SWT.Close, closeCatcher);
cancel.setText(MessageText.getString("wizard.close"));
cancel.setEnabled(true);
setDefaultButton();
}
}
});
}
}
public void
close()
{
completed = true;
if ( !wizardWindow.isDisposed()){
wizardWindow.dispose();
}
}
public void onClose() {
if (titleFont != null && !titleFont.isDisposed()) {
titleFont.dispose();
titleFont=null;
}
for (int i=0;i<listeners.size();i++){
listeners.get(i).closed();
}
if ( !completed ){
completed = true;
currentPanel.cancelled();
}
}
/**
* @return Returns the currentPanel.
*/
public IWizardPanel getCurrentPanel() {
return currentPanel;
}
private void insureSize() {
//panel.pack();
Point p = panel.computeSize(wizardWindow.getSize().x,SWT.DEFAULT);
int height = p.y + wizardHeight;
if(height > wizardWindow.getSize().y)
wizardWindow.setSize(p.x,height);
}
public void
addListener(
WizardListener l )
{
if (wizardWindow.isDisposed() && closeCatcher != null) {
l.closed();
}
listeners.add(l);
}
public void
removeListener(
WizardListener l )
{
listeners.remove(l);
}
}