org.apache.wicket.extensions.wizard.IWizardStep Maven / Gradle / Ivy
Show all versions of org.ops4j.pax.wicket.service Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.extensions.wizard;
import org.apache.wicket.Component;
import org.apache.wicket.IClusterable;
/**
* Models one step in a wizard, and is the equivalent of one panel in a wizard from an end-user's
* perspective.
*
* Typically, you would extend {@link WizardStep panel based wizard steps} and provide a custom
* panel for the step instead of directly implementing this interface.
*
*
*
* Swing Wizard Framework served as a valuable
* source of inspiration.
*
*
* @author Eelco Hillenius
*/
public interface IWizardStep extends IClusterable
{
/**
* This method is called whenever the user presses next while this step is active.
*
* This method will only be called if {@link IWizardModel#isNextAvailable} and
* {@link #isComplete} return true.
*/
void applyState();
/**
* Gets the header component for this step. This component is displayed in a special section of
* the wizard.
*
* @param id
* The id that the component should be created with
* @param parent
* The parent component (for post 1.2)
* @param wizard
* The wizard component the header will be placed on
* @return The header component
*/
Component getHeader(String id, Component parent, IWizard wizard);
/**
* Returns the current view this step is displaying. This component will be displayed in the
* main section of the wizard with this step is active. This may changed at any time by as long
* as an appropriate property change event is fired.
*
* @param id
* The id that the component should be created with
* @param parent
* The parent component (for post 1.2)
* @param wizard
* The wizard component the header will be placed on
* @return The current view of the step.
*/
Component getView(String id, Component parent, IWizard wizard);
/**
* Initializes this step with the model it will belong to.
*
* @param wizardModel
* the owning wizard model
*/
void init(IWizardModel wizardModel);
/**
* Checks if this step is compete. This method should return true if the wizard can proceed to
* the next step.
*
* @return true if the wizard can proceed from this step, false otherwise.
*/
boolean isComplete();
}