public class WizardController extends java.lang.Object implements FormBackendIf
Modifier and Type | Field and Description |
---|---|
static int |
ACTION_TYPE_ADD |
static int |
ACTION_TYPE_CLONE |
static int |
ACTION_TYPE_MODIFY |
static int |
ACTION_TYPE_MOVE |
static java.lang.String |
FIELD_ID_PAGE_NUMBER |
static java.lang.String |
FIELD_ID_SESSION_ID |
static java.lang.String |
IS_NEW_SESSION |
protected java.util.List<PageDefinition> |
pages |
Constructor and Description |
---|
WizardController() |
Modifier and Type | Method and Description |
---|---|
WizardController |
addPage(java.lang.String title,
PageIf impl,
java.lang.String description)
Deprecated.
|
WizardController |
addPage(java.lang.String title,
PageIf impl,
java.lang.String description,
boolean clickable)
Deprecated.
|
WizardController |
addPage(java.lang.String title,
PageIf impl,
java.lang.String description,
boolean clickable,
java.lang.String rbid) |
WizardController |
addPage(java.lang.String title,
PageIf impl,
java.lang.String description,
java.lang.String rbid) |
WizardController |
addPage(java.lang.String title,
PageIf impl,
java.lang.String description,
java.lang.String rbid,
HelpInfo helpInfo) |
FormResult |
doFormSubmit(java.lang.String user,
ReportContext context,
java.lang.String formId,
FormFieldData[] data) |
java.util.List<PageIf> |
getFormPages() |
TabularReport |
getFormTabularReport(ReportContext context,
java.lang.String formId,
java.lang.String reportName) |
HelpInfo |
getHelpInfo() |
FormResult |
getInitialFormData(ReportContext context,
java.lang.String formId) |
java.lang.String |
getNextButtonLabel() |
java.lang.String |
getRbid() |
WizardSessionRecoveryStateEncoder |
getRecoveryStateEncoder() |
java.util.List<MappableResourceIf> |
getResources() |
java.lang.String |
getSubmitButtonLabel() |
int |
getWizardActionType() |
java.lang.String |
getWizardTitle() |
boolean |
hasMappableResources() |
boolean |
isDisableWizardNavigation() |
boolean |
isRequireAdminPrivileges() |
FormResult |
moveFormPage(ReportContext context,
java.lang.String formId,
java.lang.String sessionId,
int currentPage,
int newPage)
Page number is between 0 to N-1
|
WizardController |
setDataManager(DataManagerIf dataMgr) |
void |
setDisableWizardNavigation(boolean disableWizardNavigation) |
void |
setHelpInfo(HelpInfo helpInfo) |
void |
setNextButtonLabel(java.lang.String nextButtonLabel) |
void |
setNextButtonLabel(java.lang.String nextButtonLabel,
java.lang.String rbid) |
void |
setRbid(java.lang.String rbid) |
void |
setRecoveryStateEncoder(WizardSessionRecoveryStateEncoder recoveryStateEncoder) |
void |
setRequireAdminPrivileges(boolean requireAdminPrivileges) |
void |
setSubmitButtonLabel(java.lang.String submitButtonLabel) |
void |
setSubmitButtonLabel(java.lang.String submitButtonLabel,
java.lang.String rbid) |
void |
setWizardActionType(int wizardActionType) |
void |
setWizardTitle(java.lang.String wizardTitle) |
void |
setWizardTitle(java.lang.String wizardTitle,
java.lang.String rbid) |
FormResult |
validateForm(ReportContext context,
java.lang.String formId,
FormFieldData[] data) |
public static final int ACTION_TYPE_ADD
public static final int ACTION_TYPE_MODIFY
public static final int ACTION_TYPE_CLONE
public static final int ACTION_TYPE_MOVE
public static final java.lang.String FIELD_ID_PAGE_NUMBER
public static final java.lang.String FIELD_ID_SESSION_ID
protected java.util.List<PageDefinition> pages
public static final java.lang.String IS_NEW_SESSION
public java.util.List<MappableResourceIf> getResources()
public java.util.List<PageIf> getFormPages()
public int getWizardActionType()
public void setWizardActionType(int wizardActionType)
wizardActionType
- the wizardActionType to setpublic boolean isDisableWizardNavigation()
public void setDisableWizardNavigation(boolean disableWizardNavigation)
disableWizardNavigation
- the disableWizardNavigation to setpublic HelpInfo getHelpInfo()
public void setHelpInfo(HelpInfo helpInfo)
public boolean isRequireAdminPrivileges()
public void setRequireAdminPrivileges(boolean requireAdminPrivileges)
requireAdminPrivileges
- the requireAdminPrivileges to setpublic WizardController setDataManager(DataManagerIf dataMgr)
@Deprecated public WizardController addPage(java.lang.String title, PageIf impl, java.lang.String description)
@Deprecated public WizardController addPage(java.lang.String title, PageIf impl, java.lang.String description, boolean clickable)
public WizardController addPage(java.lang.String title, PageIf impl, java.lang.String description, java.lang.String rbid)
title
- page title shown in UI as step (English)impl
- page form implementationdescription
- page description shown in UI at the top of page (English)rbid
- resource bundle tag for translation (without ".title", ".desc") format convention - XYZFeature.wizard.wizardname.page.pagenamepublic WizardController addPage(java.lang.String title, PageIf impl, java.lang.String description, boolean clickable, java.lang.String rbid)
title
- page title shown in UI as step (English)impl
- page form implementationdescription
- page description shown in UI at the top of page (English)rbid
- resource bundle tag for translation (without ".title", ".desc") format convention - XYZFeature.wizard.wizardname.page.pagenamepublic WizardController addPage(java.lang.String title, PageIf impl, java.lang.String description, java.lang.String rbid, HelpInfo helpInfo)
title
- impl
- description
- rbid
- helpInfo
- Provide the Help info that is part of this Pagepublic java.lang.String getWizardTitle()
public void setWizardTitle(java.lang.String wizardTitle)
wizardTitle
- the wizardTitle to setpublic void setWizardTitle(java.lang.String wizardTitle, java.lang.String rbid)
wizardTitle
- wizard title shown in UI (English)rbid
- resource bundle tag for translation format convention - XYZFeature.wizard.wizardname.titlepublic WizardSessionRecoveryStateEncoder getRecoveryStateEncoder()
public void setRecoveryStateEncoder(WizardSessionRecoveryStateEncoder recoveryStateEncoder)
public FormResult validateForm(ReportContext context, java.lang.String formId, FormFieldData[] data) throws java.lang.Exception
validateForm
in interface FormBackendIf
java.lang.Exception
public FormResult doFormSubmit(java.lang.String user, ReportContext context, java.lang.String formId, FormFieldData[] data) throws java.lang.Exception
doFormSubmit
in interface FormBackendIf
java.lang.Exception
public TabularReport getFormTabularReport(ReportContext context, java.lang.String formId, java.lang.String reportName) throws java.lang.Exception
getFormTabularReport
in interface FormBackendIf
java.lang.Exception
public java.lang.String getNextButtonLabel()
public java.lang.String getSubmitButtonLabel()
public void setNextButtonLabel(java.lang.String nextButtonLabel)
nextButtonLabel
- the nextButtonLabel to set
wizard will calculate for remaining pages, if it hasn't reached to the last page, it sets the button label as the value of thispublic void setNextButtonLabel(java.lang.String nextButtonLabel, java.lang.String rbid)
nextButtonLabel
- Next button label shown in UIrbid
- resource bundle tag for translation format convention - XYZFeature.wizard.wizardname.nextpublic void setSubmitButtonLabel(java.lang.String submitButtonLabel)
submitButtonLabel
- the submitButtonLabel to setpublic void setSubmitButtonLabel(java.lang.String submitButtonLabel, java.lang.String rbid)
submitButtonLabel
- Submit button label shown in UIrbid
- resource bundle tag for translation format convention - XYZFeature.wizard.wizardname.submitpublic FormResult getInitialFormData(ReportContext context, java.lang.String formId) throws java.lang.Exception
getInitialFormData
in interface FormBackendIf
java.lang.Exception
public FormResult moveFormPage(ReportContext context, java.lang.String formId, java.lang.String sessionId, int currentPage, int newPage) throws java.lang.Exception
FormBackendIf
moveFormPage
in interface FormBackendIf
java.lang.Exception
public java.lang.String getRbid()
public void setRbid(java.lang.String rbid)
public boolean hasMappableResources()
hasMappableResources
in interface FormBackendIf