WizardPanel.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 org.zkoss.zul.Tabpanel;
 
public class WizardPanel extends Tabpanel {
 
  private Object objectValue;
  
  protected boolean 
          allowFinish = false, 
          allowNext = true, 
          allowPrior = true, 
          allowCancel = true, 
          shouldSkip = false,
          skipFirst = false,
          finalSplash = false;
 
  public Object getObjectValue() {
    return objectValue;
  }
 
  public void setObjectValue(Object objectValue) {
    this.objectValue = objectValue;
  }
  
  public boolean doEnter() {
    return getComposer() == null ? false : getComposer().doEnter();
  }
  
  public boolean doLeave(boolean forwards) {
    return getComposer() == null ? false : getComposer().doLeave(forwards);
  }
  
  public boolean doFinish() {
    return getComposer() == null ? false : getComposer().doFinish();
  }
  
  public boolean doCancel() {
    return getComposer() == null ? false : getComposer().doCancel();
  }
  
  public boolean isAllowCancel() {
    return allowCancel && !finalSplash;
  }
 
  public void setAllowCancel(boolean allowCancel) {
    this.allowCancel = allowCancel;
  }
 
  public boolean isAllowFinish() {
    return allowFinish;
  }
 
  public void setAllowFinish(boolean allowFinish) {
    this.allowFinish = allowFinish;
  }
 
  public boolean isAllowNext() {
    return allowNext && !finalSplash;
  }
 
  public void setAllowNext(boolean allowNext) {
    this.allowNext = allowNext;
  }
 
  public boolean isAllowPrior() {
    return allowPrior && !finalSplash;
  }
 
  public void setAllowPrior(boolean allowPrior) {
    this.allowPrior = allowPrior;
  }
 
  public boolean isFinalSplash() {
    return finalSplash;
  }
 
  public void setFinalSplash(boolean finalSplash) {
    this.finalSplash = finalSplash;
    if(finalSplash) allowFinish = true;
  }
 
  public boolean isShouldSkip() {
    return shouldSkip;
  }
 
  public void setShouldSkip(boolean shouldSkip) {
    this.shouldSkip = shouldSkip;
  }
 
  public boolean isSkipFirst() {
    return skipFirst;
  }
 
  public void setSkipFirst(boolean skipFirst) {
    this.skipFirst = skipFirst;
  }
  
  public boolean checkSkipFirst() {
    if(skipFirst) {
      skipFirst = false;
      return true;
    }
    return false;
  }
  
  private WizardPanelComposer getComposer() {
    Object composer = getAttribute("$composer");
    if(composer instanceof WizardPanelComposer) {
      return (WizardPanelComposer) composer;
    }
    return null;
  }
}