[Sblim-commit] wbemsmt-tools-wizard-framework/org/sblim/wbemsmt/tools/wizard/container IWizardContainer.java,NONE,1.1 WizardContainerBase.java,NONE,1.1

[Wolfgang T. <ta...@us...>]

Update of /cvsroot/sblim/wbemsmt-tools-wizard-framework/org/sblim/wbemsmt/tools/wizard/container
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12647/org/sblim/wbemsmt/tools/wizard/container

Added Files:
	IWizardContainer.java WizardContainerBase.java 
Log Message:
First initial version of the wizard framework that is used
by wbem smt eui implementations.

--- NEW FILE: IWizardContainer.java ---
 /** 
  * IWizardContainer.java
  *
  * (C) Copyright IBM Corp. 2005
  *
  * THIS FILE IS PROVIDED UNDER THE TERMS OF THE COMMON PUBLIC LICENSE
  * ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS FILE
  * CONSTITUTES RECIPIENTS ACCEPTANCE OF THE AGREEMENT.
  *
  * You can obtain a current copy of the Common Public License from
  * http://www.opensource.org/licenses/cpl1.0.php
  *
  * @author:	Bert Lange <La...@de...>
  *
  * Contributors:
  *
  *
  * Description: Methods which should be used in all JSF/Swing wizard container implementations.
  * 			
  * 
  */
package org.sblim.wbemsmt.tools.wizard.container;

import java.util.HashMap;
import java.util.Stack;
import java.util.Vector;

public interface IWizardContainer {
	/*
	 * CleanUp data object values if user input is no more valid (called in case of 'Back' or 'Cancel' action)
	 */
	public void cleanUP(String pageName);	
	/*
	 * Get the name of the current wizard page
	 */
	public String getCurrentPageName();
	/*
	 * Return the page next in wizard flow
	 */
	public String getNextWizardPageName();
	/*
	 * Returns the all page objects configured in wizard container class
	 */
	public HashMap getPages();
	/*
	 * Get the stack object holding the pages the wizard previously run through
	 */
	public Stack getUsedPages();
	/*
	 * Do initialization stuff for wizard container
	 */
	public void initWizardContainer();

	public boolean isBackButtonFlag();
	public boolean isCancelButtonFlag();
	public boolean isFinishButtonFlag();
	public boolean isNextButtonFlag();
	
	/*
	 * Check if the given page name ist the first page in wizard flow
	 */
	public boolean isFirst(String pageName);
	/*
	 * Check if the given page name is the last page in wizard flow
	 */
	public boolean isLast(String pageName);
	/*
	 * Use method to check (in data object) if user input for the named property is valid.
	 * The 'result' vector can be filled with specific error messages, error IDs or own exception objects
	 * for further processing
	 */
	public boolean isValid(String propertyName, Object value, Vector result);
	/*
	 * Do actions if wizard flow complete and preWizardFinish method (successfully) executed
	 */
	public void postWizardFinish();
	/*
	 * Do actions if wizard flow complete (usual create related CIM objects on server side)
	 */
	public void preWizardFinish() throws Exception;
	/*
	 * Set the name of the current wizard page
	 */
	public void setCurrentPageName(String pageName);
	/*
	 * Set run type to container ('JSF' or 'SWING')
	 */
	public void setWizardRunType(String wizardRunType);
	/*
	 * Set flags for navigation buttons according to actual wizard state
	 */
	public void updateButtonStates(boolean isLast, boolean isFirst);
}

--- NEW FILE: WizardContainerBase.java ---
 /** 
  * WizardContainerBase.java
  *
  * (C) Copyright IBM Corp. 2005
  *
  * THIS FILE IS PROVIDED UNDER THE TERMS OF THE COMMON PUBLIC LICENSE
  * ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS FILE
  * CONSTITUTES RECIPIENTS ACCEPTANCE OF THE AGREEMENT.
  *
  * You can obtain a current copy of the Common Public License from
  * http://www.opensource.org/licenses/cpl1.0.php
  *
  * @author:	Bert Lange <La...@de...>
  *
  * Contributors:
  *
  *
  * Description: Abstract class implementation for common parts for derived 'WizardContainer' 
  * 				classes (for all JSF/Swing configuration tasks).
  * 			
  * 
  */
package org.sblim.wbemsmt.tools.wizard.container;

import java.util.HashMap;
import java.util.Stack;

public abstract class WizardContainerBase {

	private Stack usedPages = new Stack();
	private String currentPageName = "";
	private String summaryText = "";
	public String wizardRunType = null; 	
	protected HashMap hmPages = null;
	protected String[] summary = null;
	protected boolean noPages = false;
	public boolean backButtonFlag = true;
	public boolean nextButtonFlag = true;
	public boolean finishButtonFlag = true;
	public boolean cancelButtonFlag = true;

	
	public void updateButtonStates(boolean isLast, boolean isFirst) {
		//System.out.println("isLast: "+isLast);
		//System.out.println("isFirst: "+isFirst);
                
		if (noPages) {
			//System.out.println("state1");
			this.backButtonFlag = false;
			this.nextButtonFlag = false;
			this.finishButtonFlag = false;
			return;
		}
			if (isFirst) {
				//System.out.println("state22");
				this.backButtonFlag = false;
				if (isLast) {
					//System.out.println("state33");
					this.nextButtonFlag = false;
					this.finishButtonFlag = true;
				}
				else {
					this.finishButtonFlag = false;
					this.nextButtonFlag = true;
				}
			}
			else if (isLast) {
				//System.out.println("state55");
				this.backButtonFlag = true;
				this.nextButtonFlag = false; 
				this.finishButtonFlag = true;       		
			}
			else {
				//System.out.println("state66");
				this.backButtonFlag = true;
				this.nextButtonFlag = true; 
				this.finishButtonFlag = false;       		
			}
	}

	
	/**
	 * @return Returns the backButtonFlag.
	 */
	public boolean isBackButtonFlag() {
		return backButtonFlag;
	}
	/**
	 * @param backButtonFlag The backButtonFlag to set.
	 */
	public void setBackButtonFlag(boolean backButtonFlag) {
		this.backButtonFlag = backButtonFlag;
	}
	/**
	 * @return Returns the cancelButtonFlag.
	 */
	public boolean isCancelButtonFlag() {
		return cancelButtonFlag;
	}
	/**
	 * @param cancelButtonFlag The cancelButtonFlag to set.
	 */
	public void setCancelButtonFlag(boolean cancelButtonFlag) {
		this.cancelButtonFlag = cancelButtonFlag;
	}
	/**
	 * @return Returns the finishButtonFlag.
	 */
	public boolean isFinishButtonFlag() {
		return finishButtonFlag;
	}
	/**
	 * @param finishButtonFlag The finishButtonFlag to set.
	 */
	public void setFinishButtonFlag(boolean finishButtonFlag) {
		this.finishButtonFlag = finishButtonFlag;
	}
	/**
	 * @return Returns the nextButtonFlag.
	 */
	public boolean isNextButtonFlag() {
		return nextButtonFlag;
	}
	/**
	 * @param nextButtonFlag The nextButtonFlag to set.
	 */
	public void setNextButtonFlag(boolean nextButtonFlag) {
		this.nextButtonFlag = nextButtonFlag;
	}
	/**
	 * @return Returns the noPages.
	 */
	public boolean isNoPages() {
		return noPages;
	}
	/**
	 * @param noPages The noPages to set.
	 */
	public void setNoPages(boolean noPages) {
		this.noPages = noPages;
	}
	/**
	 * @return Returns the usedPages.
	 */
	public Stack getUsedPages() {
		return usedPages;
	}
	/**
	 * @param usedPages The usedPages to set.
	 */
	public void setUsedPages(Stack usedPages) {
		this.usedPages = usedPages;
	}
	/**
	 * @return Returns the summary.
	 */
	public String[] getSummary() {
		return summary;
	}
	/**
	 * @param summary The summary to set.
	 */
	public void setSummary(String[] summary) {
		this.summary = summary;
	}
	/**
	 * @return Returns the hmPages.
	 */
	public HashMap getPages() {
		return hmPages;
	}
	/**
	 * @param hmPages The hmPages to set.
	 */
	public void setPages(HashMap hmPages) {
		this.hmPages = hmPages;
	}
	/**
	 * @return Returns the wizardRunType.
	 */
	public String getWizardRunType() {
		return wizardRunType;
	}
	/**
	 * @param wizardRunType The runType to set.
	 */
	public void setWizardRunType(String wizardRunType) {
		this.wizardRunType = wizardRunType;
	}
	/**
	 * @return Returns the summaryText.
	 */
	public String getSummaryText() {
		return summaryText;
	}
	/**
	 * @param summaryText The summaryText to set.
	 */
	public void setSummaryText(String summaryText) {
		this.summaryText = summaryText;
	}
	/**
	 * @return Returns the currentPageName.
	 */
	public String getCurrentPageName() {
		return currentPageName;
	}
	/**
	 * @param currentPageName The currentPageName to set.
	 */
	public void setCurrentPageName(String currentPageName) {
		this.currentPageName = currentPageName;
	}

}