Package com.microstrategy.web.app.transforms

Class WizardTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractEditorTransform

com.microstrategy.web.app.transforms.WizardTransform

All Implemented Interfaces:

AppTransform, Transform

Direct Known Subclasses:

AddDataSetWizardTransform

public class WizardTransform
extends AbstractEditorTransform

This transform will act as HTML container for a Wizard. It'll provide of space Wizard step pages will be displayed. It divides rendering process into the following sections:

• Pre-Content renderPreContent(MarkupOutput out)
• Body Message renderBodyMessage(MarkupOutput out)
• Contents renderContent(MarkupOutput out)
• Post-Content renderPostContent(MarkupOutput out)

The execution bar information is divided into the following sections:

Navigation Bar renderNavigationButtons(MarkupOutput out) Execution Bar renderExecutionButtons(MarkupOutput out)

Since:

MicroStrategy Web 8.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	_cancelButtonImage	Local property for holding the cancelButtonImage value
protected WebEvent	_cancelWizardEvent	WebEvent instance with the information for cancelling the wizard
protected java.lang.String	_finishButtonImage	Local property for holding the finishButtonImage value
protected WebEvent	_finishWizardEvent	WebEvent instance with the information for finishing the wizard
protected int	_levelFlag	Local property for holding the levelFlag value
protected java.lang.String	_nextButtonImage	Local property for holding the nextButtonImage value
protected WebEvent	_nextStepEvent	WebEvent instance with the information for going forward a step on the wizard
protected java.lang.String	_previousButtonImage	Local property for holding the previousButtonImage value
protected WebEvent	_previousStepEvent	WebEvent instance with the information for going back a step on the wizard
protected WizardBean	_wizardBean	WizardBean being transformed by this class
protected java.lang.String	_wizardWidth	Local property for holding the wizardWidth value
FormalParameter	cancelButtonImage	Formal parameter indicating the image to use for the Cancel button.
FormalParameter	displayFinish	Formal parameter indicating if the Finish button option should be shown on the wizard
FormalParameter	displayNext	Formal parameter indicating if the Next button option should be shown on the wizard
FormalParameter	displayPrevious	Formal parameter indicating if the Previous button option should be shown on the wizard
FormalParameter	finishButtonImage	Formal parameter indicating the image to use for the Finish button.
static java.lang.String	FP_LEVEL_FLAG	String value with the name of the formal parameter for levelFlag
static int	LEVEL_SHOW_ALL	Value associated with the levelFlag formal parameter for indicating the all sections should be shown
static int	LEVEL_SHOW_CONTENT	Value associated with the levelFlag formal parameter for indicating the content section should be shown
static int	LEVEL_SHOW_ERROR	Value associated with the levelFlag formal parameter for indicating the error section should be shown
static int	LEVEL_SHOW_EXECUTION_BAR	Value associated with the levelFlag formal parameter for indicating the execution bar section should be shown
static int	LEVEL_SHOW_NAVIGATION_INDEX	Value associated with the levelFlag formal parameter for indicating the navigation index section should be shown
static int	LEVEL_SHOW_POST_CONTENT	Value associated with the levelFlag formal parameter for indicating the post-content section should be shown
static int	LEVEL_SHOW_PRE_CONTENT	Value associated with the levelFlag formal parameter for indicating the pre-content section should be shown
FormalParameter	levelFlag	Formal parameter indicating which sections of the wizard should be shown
FormalParameter	nextButtonImage	Formal parameter indicating the image to use for the Next button.
FormalParameter	previousButtonImage	Formal parameter indicating the image to use for the Previous button.
FormalParameter	wizardWidth	Formal parameter indicating the width of the wizard

Fields inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform

_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_INCLUDE_DYNAMIC_SCRIPT, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors

Constructor	Description
WizardTransform()	Default no-args constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	checkLevel(int iLevelConst)	Check if the levelFlag formal parameter value contains the indicated flag value
protected WebEvent	getCancelWizardEvent()	Generate the event required for cancelling the wizard.
java.lang.String	getDescription()	Return description for this Transform.
protected WebEvent	getFinishWizardEvent()	Generate the event required for finishing the wizard.
protected WebEvent	getNextEvent()	Generate the event required for accessing the next step of the wizard.
protected WebEvent	getPreviousEvent()	Generate the event required for accessing the previous step of the wizard.
java.lang.Class	getSupportedBeanType()	Get the class of objects this transform is able to handle, which is WizardBean.
WizardBean	getWizardBean()	Returns current instance of WizardBean being transformed.
protected void	initEditor(Editor editor)	Initialize the editor with the global settings.
void	initializeImages()	Initialize the images to be used by this transform.
void	initializeTransform(Transformable data)	Initializes transform formal parameters
void	renderBodyMessage(MarkupOutput out)	Renders the title to show before the body of the wizard's current step.
void	renderContent(MarkupOutput out)	Renders Wizard content section.
void	renderEditorContents(MarkupOutput out)	Method that renders the editor contents corresponding to this Wizard.
void	renderExecutionBar(MarkupOutput out)	Generates the output for the navigation/finish/cancel buttons.
void	renderExecutionButtons(MarkupOutput out)	Renders buttons for execution in Wizard steps, mainly Finish and Cancel.
void	renderHiddenInputs(MarkupOutput out)	Renders required hidden input information for the wizard form to be complete for a user request.
void	renderNavigationButtons(MarkupOutput out)	Renders buttons for navigating through Wizard steps, mainly Next and Previous.
void	renderPostContent(MarkupOutput out)	Renders Wizard pre content section.
void	renderPreContent(MarkupOutput out)	Renders Wizard pre content section.
void	transformForRequestInError(MarkupOutput out)	Transform output when the status is EnumRequestStatus.WebBeanRequestEndsInError.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform

generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initHelp, renderEditor, renderEditorElement, renderJavascript, setFocusFieldId, transformForRequestSuccessful

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

LEVEL_SHOW_CONTENT

public static final int LEVEL_SHOW_CONTENT

Value associated with the levelFlag formal parameter for indicating the content section should be shown

See Also:

Constant Field Values

LEVEL_SHOW_ERROR

public static final int LEVEL_SHOW_ERROR

Value associated with the levelFlag formal parameter for indicating the error section should be shown

See Also:

Constant Field Values

LEVEL_SHOW_NAVIGATION_INDEX

public static final int LEVEL_SHOW_NAVIGATION_INDEX

Value associated with the levelFlag formal parameter for indicating the navigation index section should be shown

See Also:

Constant Field Values

LEVEL_SHOW_EXECUTION_BAR

public static final int LEVEL_SHOW_EXECUTION_BAR

Value associated with the levelFlag formal parameter for indicating the execution bar section should be shown

See Also:

Constant Field Values

LEVEL_SHOW_PRE_CONTENT

public static final int LEVEL_SHOW_PRE_CONTENT

Value associated with the levelFlag formal parameter for indicating the pre-content section should be shown

See Also:

Constant Field Values

LEVEL_SHOW_POST_CONTENT

public static final int LEVEL_SHOW_POST_CONTENT

Value associated with the levelFlag formal parameter for indicating the post-content section should be shown

See Also:

Constant Field Values

LEVEL_SHOW_ALL

public static final int LEVEL_SHOW_ALL

Value associated with the levelFlag formal parameter for indicating the all sections should be shown

See Also:

Constant Field Values

FP_LEVEL_FLAG

public static final java.lang.String FP_LEVEL_FLAG

String value with the name of the formal parameter for levelFlag

See Also:

Constant Field Values

_wizardBean

protected WizardBean _wizardBean

WizardBean being transformed by this class

_nextStepEvent

protected WebEvent _nextStepEvent

WebEvent instance with the information for going forward a step on the wizard

_previousStepEvent

protected WebEvent _previousStepEvent

WebEvent instance with the information for going back a step on the wizard

_cancelWizardEvent

protected WebEvent _cancelWizardEvent

WebEvent instance with the information for cancelling the wizard

_finishWizardEvent

protected WebEvent _finishWizardEvent

WebEvent instance with the information for finishing the wizard

displayPrevious

public FormalParameter displayPrevious

Formal parameter indicating if the Previous button option should be shown on the wizard

displayNext

public FormalParameter displayNext

Formal parameter indicating if the Next button option should be shown on the wizard

displayFinish

public FormalParameter displayFinish

Formal parameter indicating if the Finish button option should be shown on the wizard

nextButtonImage

public FormalParameter nextButtonImage

Formal parameter indicating the image to use for the Next button.

_nextButtonImage

protected java.lang.String _nextButtonImage

Local property for holding the nextButtonImage value

previousButtonImage

public FormalParameter previousButtonImage

Formal parameter indicating the image to use for the Previous button.

_previousButtonImage

protected java.lang.String _previousButtonImage

Local property for holding the previousButtonImage value

finishButtonImage

public FormalParameter finishButtonImage

Formal parameter indicating the image to use for the Finish button.

_finishButtonImage

protected java.lang.String _finishButtonImage

Local property for holding the finishButtonImage value

cancelButtonImage

public FormalParameter cancelButtonImage

Formal parameter indicating the image to use for the Cancel button.

_cancelButtonImage

protected java.lang.String _cancelButtonImage

Local property for holding the cancelButtonImage value

wizardWidth

public FormalParameter wizardWidth

Formal parameter indicating the width of the wizard

_wizardWidth

protected java.lang.String _wizardWidth

Local property for holding the wizardWidth value

levelFlag

public FormalParameter levelFlag

Formal parameter indicating which sections of the wizard should be shown

_levelFlag

protected int _levelFlag

Local property for holding the levelFlag value

Constructor Detail

WizardTransform

public WizardTransform()

Default no-args constructor. Initialize all Formal Parameters.

Method Detail

initializeImages

public void initializeImages()

Initialize the images to be used by this transform.

Overrides:

initializeImages in class AbstractAppTransform

initEditor

protected void initEditor(Editor editor)

Initialize the editor with the global settings.

Overrides:

initEditor in class AbstractEditorTransform

Parameters:

editor - Editor instance, abstraction of the container where output is rendered.

initializeTransform

public void initializeTransform(Transformable data)

Initializes transform formal parameters

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractEditorTransform

Parameters:

data - Transformable instance to be associated with this transform.

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Get the class of objects this transform is able to handle, which is WizardBean.

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

a Class instance with the information about the beans this transform is able to manipulate.

getDescription

public java.lang.String getDescription()

Return description for this Transform.

Returns:

description text.

transformForRequestInError

public void transformForRequestInError(MarkupOutput out)

Transform output when the status is EnumRequestStatus.WebBeanRequestEndsInError.

Overrides:

transformForRequestInError in class AbstractEditorTransform

Parameters:

out - MarkupOutput where the HTML contents to be rendered will be saved.

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

renderEditorContents

public void renderEditorContents(MarkupOutput out)

Method that renders the editor contents corresponding to this Wizard.

Specified by:

renderEditorContents in class AbstractEditorTransform

Parameters:

out - MarkupOutput instance where the HTML contents to render are to be saved.

renderBodyMessage

public void renderBodyMessage(MarkupOutput out)

Renders the title to show before the body of the wizard's current step.

Parameters:

out - the MarkupOutput instance to write to

renderContent

public void renderContent(MarkupOutput out)

Renders Wizard content section.
This function will need to access WizardBean for selecting what transform to call. Here, the transform will have to redirect transform output to step-specific transform.

Parameters:

out - where to write the output of the method.

renderExecutionBar

public void renderExecutionBar(MarkupOutput out)

Generates the output for the navigation/finish/cancel buttons.

Parameters:

out - where to write the output of the method.

renderPreContent

public void renderPreContent(MarkupOutput out)

Renders Wizard pre content section.

Parameters:

out - where to write the output of the method.

renderPostContent

public void renderPostContent(MarkupOutput out)

Renders Wizard pre content section.

Parameters:

out - where to write the output of the method.

renderNavigationButtons

public void renderNavigationButtons(MarkupOutput out)

Renders buttons for navigating through Wizard steps, mainly Next and Previous.

Parameters:

out - where to write output

renderExecutionButtons

public void renderExecutionButtons(MarkupOutput out)

Renders buttons for execution in Wizard steps, mainly Finish and Cancel.

Parameters:

out - where to write output

renderHiddenInputs

public void renderHiddenInputs(MarkupOutput out)

Renders required hidden input information for the wizard form to be complete for a user request.

Parameters:

out - where to write the output of the method.

getWizardBean

public WizardBean getWizardBean()

Returns current instance of WizardBean being transformed.

Returns:

WizardBean associated with this transform

getPreviousEvent

protected WebEvent getPreviousEvent()

Generate the event required for accessing the previous step of the wizard.

Returns:

WebEvent instance initialized with the information required for going back a step on the wizard.

getNextEvent

protected WebEvent getNextEvent()

Generate the event required for accessing the next step of the wizard.

Returns:

WebEvent instance initialized with the information required for going a step forward on the wizard.

getFinishWizardEvent

protected WebEvent getFinishWizardEvent()

Generate the event required for finishing the wizard.

Returns:

WebEvent instance initialized with the information required for submitting all the wizard information.

getCancelWizardEvent

protected WebEvent getCancelWizardEvent()

Generate the event required for cancelling the wizard.

Returns:

WebEvent instance initialized with the information required for closing the wizard without submitting any of the changes.

checkLevel

protected boolean checkLevel(int iLevelConst)

Check if the levelFlag formal parameter value contains the indicated flag value

Parameters:

iLevelConst - level flag value to check for

Returns:

true means the level flag is included in the level parameter value