Class Wizard
- java.lang.Object
-
- de.hybris.platform.cockpit.wizards.Wizard
-
- Direct Known Subclasses:
GenericItemWizard
public class Wizard extends java.lang.ObjectThis class was moved to ext/cockpit from productcockpit
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classWizard.WizardEvent
-
Field Summary
Fields Modifier and Type Field Description protected WizardPagecurrentPagestatic java.lang.StringDO_BACK_ON_FIRST_PAGEprotected org.zkoss.zul.WindowframeComponentprotected java.util.Stack<java.lang.String>historyprotected java.util.List<Message>messages
-
Constructor Summary
Constructors Constructor Description Wizard()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddMessage(Message msg)protected voidcheckShowBackOnFirstPage()protected voidcleanupHistory()voidclose()protected org.zkoss.zul.WindowcreateFrameComponent(java.lang.String uri)protected org.zkoss.zk.ui.ComponentcreatePageComponent(org.zkoss.zk.ui.Component parent, WizardPage page, WizardPageController controller)voiddoBack()voiddoCancel()voiddoDone()voiddoNext()java.util.Map<java.lang.String,java.lang.Object>getAllPageAttributes()java.lang.StringgetComponentURI()java.lang.StringgetContextClass()WizardPageControllergetCurrentController()WizardPagegetCurrentPage()WizardPageControllergetDefaultController()org.zkoss.zul.WindowgetFrameComponent()java.lang.StringgetHeight()java.util.List<Message>getMessages()WizardPagegetPage(java.lang.String id)protected org.zkoss.zk.ui.ComponentgetPageContainer()java.lang.StringgetPageRoot()java.util.List<WizardPage>getPages()WizardPagegetPreviousPage()java.lang.StringgetTitle()java.lang.StringgetWidth()WizardContextgetWizardContext()booleanisForceHideDone()booleanisForceShowNext()booleanisShowBack()booleanisShowCancel()booleanisShowDone()booleanisShowNext()voidrefreshButtons()voidresize()voidsetComponentURI(java.lang.String componentURI)voidsetContextClass(java.lang.String contextClass)protected voidsetCurrentPage(WizardPage currentPage)voidsetDefaultController(WizardPageController defaultController)voidsetForceHideDone(boolean forceHideDone)voidsetForceShowNext(boolean forceShowNext)voidsetHeight(java.lang.String height)voidsetPageRoot(java.lang.String pageRoot)voidsetPages(java.util.List<WizardPage> pages)protected voidsetPreviousPage(WizardPage previousPage)voidsetShowBack(boolean showBack)voidsetShowCancel(boolean showCancel)voidsetShowDone(boolean showDone)voidsetShowNext(boolean showNext)voidsetTitle(java.lang.String i3key)Sets the i3 key for titlevoidsetWidth(java.lang.String width)voidsetWizardContext(WizardContext context)protected voidsetWizardTitle(java.lang.String title)voidshow()Showing current wizardstatic voidshow(java.lang.String beanID)static voidshow(java.lang.String beanID, WizardContext context)protected voidupdateView()
-
-
-
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 org.zkoss.zul.Window frameComponent
-
-
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 beanIDcontext- the wizard context
-
getPage
public WizardPage getPage(java.lang.String id)
-
show
public void show()
Showing current wizard
-
checkShowBackOnFirstPage
protected void checkShowBackOnFirstPage()
-
createFrameComponent
protected org.zkoss.zul.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 org.zkoss.zul.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 org.zkoss.zk.ui.Component getPageContainer()
-
setWizardTitle
protected void setWizardTitle(java.lang.String title)
-
updateView
protected void updateView()
-
createPageComponent
protected org.zkoss.zk.ui.Component createPageComponent(org.zkoss.zk.ui.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)
-
-