org.efaps.ui.wicket.models.objects
Class UIWizardObject

java.lang.Object
  org.efaps.ui.wicket.models.objects.UIWizardObject

All Implemented Interfaces:

java.io.Serializable, org.apache.wicket.IClusterable

public class UIWizardObject
extends java.lang.Object
implements org.apache.wicket.IClusterable

Class is used to create wizard like behavior for a webpage. Meaning that it is possible to go forward and backward in the pages without loosing parameters, which were already given from the user.
It contains a list that stores the UIObjects hyrachical so that they can be accessed using methods like previous.

Version:

$Id: UIWizardObject.java 3447 2009-11-29 22:46:39Z tim.moxter $

Author:

The eFaps Team

See Also:

Serialized Form

Constructor Summary

UIWizardObject(UIAbstractPageObject _uiObject)
Constructor setting the current UIObject.

Method Summary

void	add(UIAbstractPageObject _uiObject) Add a UIOBject to the list of objects.
void	addParameters(AbstractUIObject _uiObject, java.util.Map<java.lang.String,java.lang.String[]> _parameters) Add parameters.
java.util.Map<java.lang.String,java.lang.String[]>	getParameters(AbstractUIObject _uiObject) Get a parameter map from the mapping.
UIAbstractPageObject	getPrevious() Method to get the previous object.
void	insertBefore(UIAbstractPageObject _uiObject) Insert a UIObject before the current one.

Methods inherited from class java.lang.Object

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

Constructor Detail

UIWizardObject

public UIWizardObject(UIAbstractPageObject _uiObject)

Constructor setting the current UIObject.

Parameters:

_uiObject - current UIOBject

Method Detail

add

public void add(UIAbstractPageObject _uiObject)

Add a UIOBject to the list of objects.

Parameters:

_uiObject - Object to add

insertBefore

public void insertBefore(UIAbstractPageObject _uiObject)

Insert a UIObject before the current one.

Parameters:

_uiObject - Object to insert

getPrevious

public UIAbstractPageObject getPrevious()

Method to get the previous object.

Returns:

previous object

addParameters

public void addParameters(AbstractUIObject _uiObject,
                          java.util.Map<java.lang.String,java.lang.String[]> _parameters)

Add parameters.

Parameters:

_uiObject - object used as key

_parameters - parameters

getParameters

public java.util.Map<java.lang.String,java.lang.String[]> getParameters(AbstractUIObject _uiObject)

Get a parameter map from the mapping.

Parameters:

_uiObject - key fot the parameter map.

Returns:

parameter map