Wizard (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.cockpit.wizards.Wizard

Direct Known Subclasses:

AbstractNewItemsWizard, BTGAssignToGroupActionCreationWizard, BTGSegmentRestrictionActionWizard, CmsWizard, DefaultNavigationGeneratorWizard, DefaultNavigationNodeWizard, GenericItemWizard
```
public class Wizard
extends 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

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 String`	`DO_BACK_ON_FIRST_PAGE`
`protected Window`	`frameComponent`
`protected Stack<String>`	`history`
`protected List<Message>`	`messages`

Constructor Summary

Constructors
Constructor and Description

Wizard()

Constructors
Constructor and Description
`Wizard()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessage(Message msg)`
`protected void`	`checkShowBackOnFirstPage()`
`protected void`	`cleanupHistory()`
`void`	`close()`
`protected Window`	`createFrameComponent(String uri)`
`protected Component`	`createPageComponent(Component parent, WizardPage page, WizardPageController controller)`
`void`	`doBack()`
`void`	`doCancel()`
`void`	`doDone()`
`void`	`doNext()`
`Map<String,Object>`	`getAllPageAttributes()`
`String`	`getComponentURI()`
`String`	`getContextClass()`
`WizardPageController`	`getCurrentController()`
`WizardPage`	`getCurrentPage()`
`WizardPageController`	`getDefaultController()`
`Window`	`getFrameComponent()`
`String`	`getHeight()`
`List<Message>`	`getMessages()`
`WizardPage`	`getPage(String id)`
`protected Component`	`getPageContainer()`
`String`	`getPageRoot()`
`List<WizardPage>`	`getPages()`
`WizardPage`	`getPreviousPage()`
`String`	`getTitle()`
`String`	`getWidth()`
`WizardContext`	`getWizardContext()`
`boolean`	`isForceHideDone()`
`boolean`	`isForceShowNext()`
`boolean`	`isShowBack()`
`boolean`	`isShowCancel()`
`boolean`	`isShowDone()`
`boolean`	`isShowNext()`
`void`	`refreshButtons()`
`void`	`resize()`
`void`	`setComponentURI(String componentURI)`
`void`	`setContextClass(String contextClass)`
`protected void`	`setCurrentPage(WizardPage currentPage)`
`void`	`setDefaultController(WizardPageController defaultController)`
`void`	`setForceHideDone(boolean forceHideDone)`
`void`	`setForceShowNext(boolean forceShowNext)`
`void`	`setHeight(String height)`
`void`	`setPageRoot(String pageRoot)`
`void`	`setPages(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(String i3key)` Sets the i3 key for title
`void`	`setWidth(String width)`
`void`	`setWizardContext(WizardContext context)`
`protected void`	`setWizardTitle(String title)`
`void`	`show()` Showing current wizard
`static void`	`show(String beanID)`
`static void`	`show(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 String DO_BACK_ON_FIRST_PAGE

See Also:: Constant Field Values

messages
```
protected final List<Message> messages
```

history
```
protected final Stack<String> history
```

currentPage
```
protected WizardPage currentPage
```

frameComponent
```
protected Window frameComponent
```

Constructor Detail
- Wizard
```
public Wizard()
```

Method Detail

show

public static void show(String beanID)

Parameters:: beanID - - current beanID

show

public static void show(String beanID,
                        WizardContext context)

Parameters:: beanID - - current beanID; context - the wizard context

getPage
```
public WizardPage getPage(String id)
```

show
```
public void show()
```
Showing current wizard

checkShowBackOnFirstPage

protected void checkShowBackOnFirstPage()

createFrameComponent

protected Window createFrameComponent(String uri)

close
```
public void close()
```

getCurrentPage
```
public WizardPage getCurrentPage()
```

setCurrentPage

protected void setCurrentPage(WizardPage currentPage)

getCurrentController

public WizardPageController getCurrentController()

getComponentURI
```
public String getComponentURI()
```

setComponentURI

public void setComponentURI(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 List<WizardPage> getPages()
```

setPages

public void setPages(List<WizardPage> pages)

getDefaultController

public WizardPageController getDefaultController()

setDefaultController

public void setDefaultController(WizardPageController defaultController)

getFrameComponent
```
public Window getFrameComponent()
```

getWidth
```
public String getWidth()
```

setWidth
```
public void setWidth(String width)
```

getHeight
```
public String getHeight()
```

setHeight
```
public void setHeight(String height)
```

isShowCancel
```
public boolean isShowCancel()
```

setShowCancel

public void setShowCancel(boolean showCancel)

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String i3key)
```
Sets the i3 key for title

Parameters:

i3key - the i3 key for the title

getPageContainer

protected Component getPageContainer()

setWizardTitle

protected void setWizardTitle(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 Map<String,Object> getAllPageAttributes()

addMessage
```
public void addMessage(Message msg)
```

getMessages
```
public 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 String getContextClass()
```

setContextClass

public void setContextClass(String contextClass)

isForceHideDone
```
public boolean isForceHideDone()
```

setForceHideDone

public void setForceHideDone(boolean forceHideDone)

getPageRoot
```
public String getPageRoot()
```

setPageRoot

public void setPageRoot(String pageRoot)

isForceShowNext
```
public boolean isForceShowNext()
```

setForceShowNext

public void setForceShowNext(boolean forceShowNext)

Class Wizard

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DO_BACK_ON_FIRST_PAGE

messages

history

currentPage

frameComponent

Constructor Detail

Wizard

Method Detail

show

show

getPage

show

checkShowBackOnFirstPage

createFrameComponent

close

getCurrentPage

setCurrentPage

getCurrentController

getComponentURI

setComponentURI

isShowNext

setShowNext

isShowBack

setShowBack

isShowDone

setShowDone

getPages

setPages

getDefaultController

setDefaultController

getFrameComponent

getWidth

setWidth

getHeight

setHeight

isShowCancel

setShowCancel

getTitle

setTitle

getPageContainer

setWizardTitle

updateView

createPageComponent

refreshButtons

doNext

cleanupHistory

doBack

doCancel

doDone

getAllPageAttributes

addMessage

getMessages

getPreviousPage

setPreviousPage

resize

getWizardContext

setWizardContext

getContextClass

setContextClass

isForceHideDone

setForceHideDone

getPageRoot

setPageRoot

isForceShowNext

setForceShowNext