Wizard.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2012 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.zkoss.wizard;
 
import java.util.Iterator;
import java.util.LinkedList;
import org.turro.i18n.I_;
import org.turro.zkoss.util.ComponentIterator;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zk.ui.util.GenericForwardComposer;
import org.zkoss.zul.Button;
import org.zkoss.zul.Caption;
import org.zkoss.zul.Tab;
import org.zkoss.zul.Tabbox;
 
public class Wizard extends GenericForwardComposer {
 
  private Button wbprior, wbnext, wbfinish, wbcancel;
  private LinkedList<WizardPanel> list = new LinkedList<WizardPanel>();
  private Tabbox wizardbox;
 
  public void onOK() {
    WizardPanel wp = (WizardPanel) wizardbox.getSelectedPanel();
    if(wp.isAllowNext()) {
      onClick$wbnext();
    } else if(wp.isAllowFinish()) {
      onClick$wbfinish();
    }
  }
  
  public void onCancel() {
    WizardPanel wp = (WizardPanel) wizardbox.getSelectedPanel();
    if(wp.isAllowCancel()) {
      onClick$wbcancel();
    }
  }
  
  public void onClick$wbprior() {
    priorPanel();
  }
  
  public void onClick$wbnext() {
    nextPanel();
  }
  
  public void onClick$wbfinish() {
    WizardPanel wp = (WizardPanel) wizardbox.getSelectedPanel();
    if(wp.doLeave(true)) {
      if(wp.doFinish()) {
        Events.postEvent(new Event(Events.ON_CLOSE, self));
        //self.detach();
      }
    }
  }
  
  public void onClick$wbcancel() {
    WizardPanel wp = (WizardPanel) wizardbox.getSelectedPanel();
    if(wp.doCancel()) {
        Events.postEvent(new Event(Events.ON_CLOSE, self));
      //self.detach();
    }
  }
  
  protected void priorPanel() {
    int current = wizardbox.getSelectedIndex();
    if(current < 1) return;
    WizardPanel wpcurrent = list.get(current);
    if(wpcurrent.doLeave(false)) {
      current--;
      for(int i = current; i >= 0; i--) {
        WizardPanel wp = list.get(i);
        if(!wp.isShouldSkip()) {
          if(wp.doEnter()) {
            wizardbox.setSelectedIndex(i);
            updateWizard();
          }
          break;
        }
      }
    }
  }
  
  public void nextPanel() {
    int current = wizardbox.getSelectedIndex();
    if(current > list.size() - 2) return;
    WizardPanel wpcurrent = list.get(current);
    if(wpcurrent.doLeave(true)) {
      current++;
      for(int i = current; i < list.size(); i++) {
        WizardPanel wp = list.get(i);
        if(!wp.isShouldSkip() && !wp.checkSkipFirst()) {
          if(wp.doEnter()) {
            wizardbox.setSelectedIndex(i);
            updateWizard();
          }
          break;
        }
      }
    }
  }
  
  public void setPriorStatus(boolean enabled) {
    wbprior.setDisabled(!enabled);
  }
  
  public void setNextStatus(boolean enabled) {
    wbnext.setDisabled(!enabled);
  }
  
  public void setFinishStatus(boolean enabled) {
    wbfinish.setDisabled(!enabled);
  }
  
  public void setCancelStatus(boolean enabled) {
    wbcancel.setDisabled(!enabled);
  }
  
  @Override
  public void doFinally() throws Exception {
    super.doFinally();
    Caption caption = new Caption(null, "/_zul/images/wizard.png");
    self.appendChild(caption);
    wizardbox.setSclass("wizard");
    wizardbox.setHflex("true");
    wizardbox.setVflex("true");
    wizardbox.getTabs().setSclass("wtabs");
    for(Iterator it = wizardbox.getTabs().getChildren().iterator(); it.hasNext();) {
      Tab tab = (Tab) it.next();
      tab.setDisabled(true);
      tab.setSclass("wizardtab");
    }
    new ComponentIterator<WizardPanel>(self) {
      @Override
      protected void doComponent(WizardPanel component) {
        list.add(component);
      }
    };
    list.getFirst().setAllowPrior(false);
    list.getLast().setAllowNext(false);
    updateWizard();
    wbprior.setLabel(I_.get("<< Previous"));
    wbnext.setLabel(I_.get("Next >>"));
    wbfinish.setLabel(I_.get("Finish"));
    wbcancel.setLabel(I_.get("Cancel"));
    for(WizardPanel wp : list) {
      if(!wp.shouldSkip && !wp.checkSkipFirst()) {
        if(wp.doEnter()) {
          wizardbox.setSelectedPanel(wp);
          updateWizard();
          break;
        }
      }
    }
  }
 
  protected void updateWizard() {
    WizardPanel wp = (WizardPanel) wizardbox.getSelectedPanel();
    for(Iterator it = wizardbox.getTabs().getChildren().iterator(); it.hasNext();) {
      Tab tab = (Tab) it.next();
      if(tab.getIndex() < wp.getIndex()) {
        tab.setSclass("wpdone");
      } else if(tab.getIndex() == wp.getIndex()) {
        tab.setSclass("wpcurrent");
      } else {
        tab.setSclass("wppending");
      }
    }
    if(wp.isFinalSplash()) {
      wbfinish.setLabel(I_.get("Close"));
    }
    updateButtons();
  }
  
  protected void updateButtons() {
    WizardPanel wp = (WizardPanel) wizardbox.getSelectedPanel();
    setPriorStatus(wp.isAllowPrior());
    setNextStatus(wp.isAllowNext());
    setFinishStatus(wp.isAllowFinish());
    setCancelStatus(wp.isAllowCancel());
  }
 
}