com.sun.webui.jsf.model.WizardStepListItem Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2018 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.webui.jsf.model;
import com.sun.webui.jsf.component.WizardStep;
/**
* Defines the interface of an object used to represent a WizardStep
* for use in a WizardStepList, and for rendering a step list in the
* Steps pane of a rendered Wizard component.
*/
public interface WizardStepListItem {
/**
* Returns true if this step is a substep.
*/
public boolean isSubstep();
/**
* Returns true if this step is a branch step.
*/
public boolean isBranch();
/**
* Returns the text that should be displayed describing this branch step.
*/
public String getPlaceholderText();
/**
* Returns the number of this step in the list of steps.
*/
public String getStepNumberString();
/**
* Returns true if this step is the current step.
*/
public boolean isCurrentStep();
/**
* If currentStep is true this WizardStepListItem represents
* the current step in the step list. If false, it is not the current
* step.
*
* @param currentStep true if this WizardStepListItem is the current step.
*/
public void setCurrentStep(boolean currentStep);
/**
* Returns true if this step can be navigated to out of sequence.
*/
public boolean canGotoStep();
/**
* If canGotoStep is true, this step can be navigated to
* out of sequence.
*
* @param canGotoStep If true this step can be reached out of sequence.
*/
public void setCanGotoStep(boolean canGotoStep);
/**
* Return the WizardStep instance that this WizardStepListItem represents.
*/
public WizardStep getStep();
/**
* Set the WizardStep instance this WizardStepListItem represents.
*
* @param step The WizardStep instance this WizardStepListItem represents.
*/
public void setStep(WizardStep step);
}