com.sun.webui.jsf.model.WizardStepListBase Maven / Gradle / Ivy

Go to download
/*
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License).  You may not use this file except in
 * compliance with the License.
 * 
 * You can obtain a copy of the license at
 * https://woodstock.dev.java.net/public/CDDLv1.0.html.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 * 
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at https://woodstock.dev.java.net/public/CDDLv1.0.html.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * you own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
 */
package com.sun.webui.jsf.model;

import java.util.Iterator;
import java.util.NoSuchElementException;

import com.sun.webui.jsf.component.WizardStep;

public class WizardStepListBase implements WizardStepList {

    private WizardModel wModel;
    private int currentStep;
    private String currentStepNumberString;

    public WizardStepListBase(WizardModel wModel) {
        this.wModel = wModel;
        iterate();
    }

    public String getCurrentStepNumberString() {
        return currentStepNumberString;
    }
    private static final String DOT = "."; //NOI18N
    private static final String SWBRACKET_OPEN = "["; //NOI18N
    private static final String SWBRACKET_CLOSE = "["; //NOI18N

    protected String formatStepNumber(int stepNumber) {
        return String.valueOf(stepNumber);
    }

    protected String formatSubstepNumber(int stepNumber, int substep) {
        return String.valueOf(stepNumber).concat(DOT).
                concat(String.valueOf(substep));
    }

    protected String formatBranch(String placeholderText) {
        return SWBRACKET_OPEN.concat(placeholderText).concat(SWBRACKET_CLOSE);
    }

    // Do this to set up the state of the list,
    // basically set up currentStep details.
    //
    private void iterate() {
        Iterator iterator = this.iterator();
        while (iterator.hasNext()) {
            iterator.next();
        }
    }

    public Iterator iterator() {

        return new Iterator() {

            private int stepNumber = 0;
            private int substep = 0;
            private String stepNumberString;
            private String placeholderText;
            private boolean isBranch;
            private Iterator wizardStepIterator = wModel.getWizardStepIterator();

            public boolean hasNext() {
                return wizardStepIterator.hasNext();
            }

            public Object next() throws NoSuchElementException {

                if (isBranch) {
                    // Log too
                    throw new NoSuchElementException(
                            "No more steps after branch"); //NOI18N
                }

                boolean isCurrentStep = false;

                try {
                    WizardStep step = (WizardStep) wizardStepIterator.next();
                    boolean isSubstep = wModel.isSubstep(step);
                    isBranch = wModel.isBranch(step);
                    placeholderText = null;
                    // A substep cannot be the first step.
                    //
                    if (isSubstep) {
                        ++substep;
                        stepNumberString =
                                formatSubstepNumber(stepNumber, substep);
                    } else if (isBranch) {
                        ++stepNumber;
                        substep = 0;
                        /*
                        placeholderText =
                        formatBranch(wModel.getPlaceholderText(step));
                         */
                        stepNumberString = null;
                    } else {
                        ++stepNumber;
                        substep = 0;
                        stepNumberString = formatStepNumber(stepNumber);
                    }
                    isCurrentStep = wModel.isCurrentStep(step);
                    if (isCurrentStep) {
                        currentStep = stepNumber;
                        currentStepNumberString = stepNumberString;
                    }
                    return new WizardStepListItemBase(step,
                            stepNumberString, isCurrentStep,
                            isSubstep, isBranch,
                            placeholderText,
                            wModel.canGotoStep(step));


                } catch (Exception e) {
                    NoSuchElementException nse = new NoSuchElementException();
                    nse.initCause(e);
                    throw nse;
                }
            }

            public void remove() throws UnsupportedOperationException {
                throw new UnsupportedOperationException();
            }
        };
    }
}