org.apache.click.examples.page.wizard

Class Step

java.lang.Object

org.apache.click.control.AbstractControl

org.apache.click.control.AbstractContainer

org.apache.click.control.Panel

org.apache.click.examples.control.SimplePanel

org.apache.click.examples.page.wizard.Step

All Implemented Interfaces:

Serializable, Control, Container

Direct Known Subclasses:

Step1, Step2, Step3

public abstract class Step
extends SimplePanel

Provides common functionality for each step in the wizard.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.click.control.Panel

active, disabled, id, label, model, panels, template

Fields inherited from class org.apache.click.control.AbstractContainer

controlMap, controls

Fields inherited from class org.apache.click.control.AbstractControl

actionListener, attributes, behaviors, headElements, listener, listenerMethod, messages, name, parent, styles

Fields inherited from interface org.apache.click.Control

CONTROL_MESSAGES

Constructor Summary

Constructors

Constructor and Description
Step(String name, String label, String description, WizardPage page) Constructs a Step for the specified name and page.

Method Summary

Methods

Modifier and Type	Method and Description
Button	getCancelButton() Return the button representing the cancel action.
String	getDescription() Return the Step description.
Button	getFinishButton() Return the button representing the next action.
Form	getForm() Return the Step form instance.
Button	getNextButton() Return the button representing the next action.
Button	getPreviousButton() Return the button representing the previous action.
WizardPage	getWizardPage() Return the Step WizardPage instance.
void	init() Setup and initializes the Step.
boolean	onCancel() The onCancel action.
boolean	onFinish() The onFinish action.
boolean	onNext() The onNext action.
boolean	onPrevious() The onPrevious action.
void	setDescription(String description) Set the Step visual description.
void	setWizardPage(WizardPage wizardPage) Set the WizardPage instance.

Methods inherited from class org.apache.click.examples.control.SimplePanel

hasTemplate, render, renderContainer

Methods inherited from class org.apache.click.control.Panel

addControl, addModel, createTemplateModel, getId, getLabel, getModel, getPanels, getTemplate, insert, isActive, isDisabled, onInit, onProcess, onRender, remove, removeControl, replace, setActive, setDisabled, setId, setLabel, setTemplate

Methods inherited from class org.apache.click.control.AbstractContainer

add, contains, getControl, getControlMap, getControls, getControlSizeEst, hasControls, onDestroy, renderChildren, renderContent, renderTagEnd, toString

Methods inherited from class org.apache.click.control.AbstractControl

addBehavior, addStyleClass, appendAttributes, dispatchActionEvent, getActionListener, getAttribute, getAttributes, getBehaviors, getContext, getHeadElements, getHtmlImports, getMessage, getMessage, getMessages, getName, getPage, getParent, getStyle, getStyles, getTag, hasAttribute, hasAttributes, hasBehaviors, hasStyles, isAjaxTarget, onDeploy, removeBehavior, removeStyleClass, renderTagBegin, setActionListener, setAttribute, setListener, setName, setParent, setStyle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.click.Control

getBehaviors, getContext, getHeadElements, getMessages, getName, getParent, hasBehaviors, isAjaxTarget, onDeploy, setListener, setName, setParent

Constructor Detail

Step

public Step(String name,
    String label,
    String description,
    WizardPage page)

Constructs a Step for the specified name and page.

Parameters:

name - the step name

label - the step label

description - the step description

page - the wizard page

Method Detail

getForm

public Form getForm()

Return the Step form instance.

Returns:

the Step form instance

getWizardPage

public WizardPage getWizardPage()

Return the Step WizardPage instance.

Returns:

the WizardPage instance

setWizardPage

public void setWizardPage(WizardPage wizardPage)

Set the WizardPage instance.

Parameters:

wizardPage - the WizardPage instance for this Step

getDescription

public String getDescription()

Return the Step description.

Returns:

the Step description

setDescription

public void setDescription(String description)

Set the Step visual description.

Parameters:

description - the visual description

getNextButton

public Button getNextButton()

Return the button representing the next action.

Returns:

the button representing the next action

getPreviousButton

public Button getPreviousButton()

Return the button representing the previous action.

Returns:

the button representing the previous action

getFinishButton

public Button getFinishButton()

Return the button representing the next action.

Returns:

the button representing the next action

getCancelButton

public Button getCancelButton()

Return the button representing the cancel action.

Returns:

the button representing the cancel action

onNext

public boolean onNext()

The onNext action. Subclasses can override this method to implement custom logic.

Returns:

true if Page processing should continue, false otherwise

onPrevious

public boolean onPrevious()

The onPrevious action. Subclasses can override this method to implement custom logic.

Returns:

true if Page processing should continue, false otherwise

onFinish

public boolean onFinish()

The onFinish action. Subclasses can override this method to implement custom logic.

Returns:

true if Page processing should continue, false otherwise

onCancel

public boolean onCancel()

The onCancel action. Subclasses can override this method to implement custom logic.

Returns:

true if Page processing should continue, false otherwise

init

public final void init()

Setup and initializes the Step. This method must be called before the Step can be used.