de.hybris.platform.cockpit.wizards

Class Wizard

java.lang.Object

de.hybris.platform.cockpit.wizards.Wizard

Direct Known Subclasses:

GenericItemWizard

public class Wizard
extends java.lang.Object

This class was moved to ext/cockpit from productcockpit

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Wizard.WizardEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected WizardPage	currentPage
static java.lang.String	DO_BACK_ON_FIRST_PAGE
protected Window	frameComponent
protected java.util.Stack<java.lang.String>	history
protected java.util.List<Message>	messages

Constructor Summary

Constructors

Constructor and Description
Wizard()

Method Summary

Modifier and Type	Method and Description
void	addMessage(Message msg)
protected void	checkShowBackOnFirstPage()
protected void	cleanupHistory()
void	close()
protected Window	createFrameComponent(java.lang.String uri)
protected Component	createPageComponent(Component parent, WizardPage page, WizardPageController controller)
void	doBack()
void	doCancel()
void	doDone()
void	doNext()
java.util.Map<java.lang.String,java.lang.Object>	getAllPageAttributes()
java.lang.String	getComponentURI()
java.lang.String	getContextClass()
WizardPageController	getCurrentController()
WizardPage	getCurrentPage()
WizardPageController	getDefaultController()
Window	getFrameComponent()
java.lang.String	getHeight()
java.util.List<Message>	getMessages()
WizardPage	getPage(java.lang.String id)
protected Component	getPageContainer()
java.lang.String	getPageRoot()
java.util.List<WizardPage>	getPages()
WizardPage	getPreviousPage()
java.lang.String	getTitle()
java.lang.String	getWidth()
WizardContext	getWizardContext()
boolean	isForceHideDone()
boolean	isForceShowNext()
boolean	isShowBack()
boolean	isShowCancel()
boolean	isShowDone()
boolean	isShowNext()
void	refreshButtons()
void	resize()
void	setComponentURI(java.lang.String componentURI)
void	setContextClass(java.lang.String contextClass)
protected void	setCurrentPage(WizardPage currentPage)
void	setDefaultController(WizardPageController defaultController)
void	setForceHideDone(boolean forceHideDone)
void	setForceShowNext(boolean forceShowNext)
void	setHeight(java.lang.String height)
void	setPageRoot(java.lang.String pageRoot)
void	setPages(java.util.List<WizardPage> pages)
protected void	setPreviousPage(WizardPage previousPage)
void	setShowBack(boolean showBack)
void	setShowCancel(boolean showCancel)
void	setShowDone(boolean showDone)
void	setShowNext(boolean showNext)
void	setTitle(java.lang.String i3key) Sets the i3 key for title
void	setWidth(java.lang.String width)
void	setWizardContext(WizardContext context)
protected void	setWizardTitle(java.lang.String title)
void	show() Showing current wizard
static void	show(java.lang.String beanID)
static void	show(java.lang.String beanID, WizardContext context)
protected void	updateView()

Methods inherited from class java.lang.Object

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

Field Detail

DO_BACK_ON_FIRST_PAGE

public static final java.lang.String DO_BACK_ON_FIRST_PAGE

See Also:

Constant Field Values

messages

protected final java.util.List<Message> messages

history

protected final java.util.Stack<java.lang.String> history

currentPage

protected WizardPage currentPage

frameComponent

protected Window frameComponent

Constructor Detail

Wizard

public Wizard()

Method Detail

show

public static void show(java.lang.String beanID)

Parameters:

beanID - - current beanID

show

public static void show(java.lang.String beanID,
                        WizardContext context)

Parameters:

beanID - - current beanID

context - the wizard context

getPage

public WizardPage getPage(java.lang.String id)

show

public void show()

Showing current wizard

checkShowBackOnFirstPage

protected void checkShowBackOnFirstPage()

createFrameComponent

protected Window createFrameComponent(java.lang.String uri)

close

public void close()

getCurrentPage

public WizardPage getCurrentPage()

setCurrentPage

protected void setCurrentPage(WizardPage currentPage)

getCurrentController

public WizardPageController getCurrentController()

getComponentURI

public java.lang.String getComponentURI()

setComponentURI

public void setComponentURI(java.lang.String componentURI)

isShowNext

public boolean isShowNext()

setShowNext

public void setShowNext(boolean showNext)

isShowBack

public boolean isShowBack()

setShowBack

public void setShowBack(boolean showBack)

isShowDone

public boolean isShowDone()

setShowDone

public void setShowDone(boolean showDone)

getPages

public java.util.List<WizardPage> getPages()

setPages

public void setPages(java.util.List<WizardPage> pages)

getDefaultController

public WizardPageController getDefaultController()

setDefaultController

public void setDefaultController(WizardPageController defaultController)

getFrameComponent

public Window getFrameComponent()

getWidth

public java.lang.String getWidth()

setWidth

public void setWidth(java.lang.String width)

getHeight

public java.lang.String getHeight()

setHeight

public void setHeight(java.lang.String height)

isShowCancel

public boolean isShowCancel()

setShowCancel

public void setShowCancel(boolean showCancel)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String i3key)

Sets the i3 key for title

Parameters:

i3key - the i3 key for the title

getPageContainer

protected Component getPageContainer()

setWizardTitle

protected void setWizardTitle(java.lang.String title)

updateView

protected void updateView()

createPageComponent

protected Component createPageComponent(Component parent,
                                        WizardPage page,
                                        WizardPageController controller)

refreshButtons

public void refreshButtons()

doNext

public void doNext()

cleanupHistory

protected void cleanupHistory()

doBack

public void doBack()

doCancel

public void doCancel()

doDone

public void doDone()

getAllPageAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAllPageAttributes()

addMessage

public void addMessage(Message msg)

getMessages

public java.util.List<Message> getMessages()

getPreviousPage

public WizardPage getPreviousPage()

setPreviousPage

protected void setPreviousPage(WizardPage previousPage)

resize

public void resize()

getWizardContext

public WizardContext getWizardContext()

setWizardContext

public void setWizardContext(WizardContext context)

getContextClass

public java.lang.String getContextClass()

setContextClass

public void setContextClass(java.lang.String contextClass)

isForceHideDone

public boolean isForceHideDone()

setForceHideDone

public void setForceHideDone(boolean forceHideDone)

getPageRoot

public java.lang.String getPageRoot()

setPageRoot

public void setPageRoot(java.lang.String pageRoot)

isForceShowNext

public boolean isForceShowNext()

setForceShowNext

public void setForceShowNext(boolean forceShowNext)