Package com.microstrategy.web.app.transforms

Class AbstractAppWidgetTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractAppWidgetTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

AbstractPromptWidgetTransform, AnnotationsTransform, AttributeElementsWidgetTransform, DataExplorerFolderWidgetTransform, DataExplorerWidgetTransform, GuiElementsBlockTransform

public abstract class AbstractAppWidgetTransform
extends AbstractAppTransform
implements LayoutTransform

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

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

AbstractAppTransform.Context

Field Summary

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
AbstractAppWidgetTransform()

Method Summary

Modifier and Type	Method	Description
protected java.util.List<FlattenedTreeNode>	buildFlattenedExpression(WebExpression exp)	get the answer expression tree and flatten it into a list
java.util.List<WebAttributeForm>	getAttForms(WebAttribute att, int displayedForm)
Block	getChildWidget(WebBean bean, java.lang.String styleName)
Block	getChildWidget(java.lang.String styleName)
java.lang.String	getCssName(WebObjectInfo object)	Utility method that helps giving the CSS class to use based on the the object type of the WebObjectInfo instance.
int	getIserverNodeFunction(WebOperatorNode node)	Returns the funtion of this node defined by IServer.
java.lang.String	getObjectInfoCssName(WebObjectInfo object)
java.lang.String	getPreferenceValueReplaceNull(java.lang.String prefName, java.lang.String nullReplace)
java.lang.Object	getSelf(java.lang.Object obj)	Returns the input argument as return value.
boolean	includeAncestorInfo()
boolean	includeFolderInfo()
boolean	includeOwnerInfo()
boolean	includeTimeInfo()
protected void	insertChildren(MutableTreeNode treeNode)
boolean	inTreeStructure()
boolean	isNull(java.lang.Object obj)	Returns whether the input argument is null.
boolean	isShowObjectTags()
void	renderShell(MarkupOutput out)	Overrides the default "shell" created when the transform is invoked.
void	renderTest(java.lang.String msg)
void	transformForRequestSuccessful(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful.

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, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeTransform, 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, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, 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.LayoutTransform

getLayoutDefinition, setLayoutDefinition

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

canTransform, getDescription, getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

AbstractAppWidgetTransform

public AbstractAppWidgetTransform()

Method Detail

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

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

renderShell

public void renderShell(MarkupOutput out)

Overrides the default "shell" created when the transform is invoked. Ideally, it would be better if we could initialize this transform with a field that indicates whether the HTML shell is created or not. In this way, subclasses can merely override this property (perhaps in their constructor) and affect how the renderShell method is invoked. Alternatively, the renderShell can be structured as a Template method to allow subclasses to easily override those methods that they do not want called.

Overrides:

renderShell in class AbstractAppTransform

Parameters:

out - The MarkupOutput representing the generated content.

getChildWidget

public Block getChildWidget(WebBean bean,
                            java.lang.String styleName)

getChildWidget

public Block getChildWidget(java.lang.String styleName)

getSelf

public java.lang.Object getSelf(java.lang.Object obj)

Returns the input argument as return value. This method is used in layout when one base value needs to assign to another base value. For example, we have base "obj", then when the type of "obj" is a certain value, we would like base "obj2" equals to "obj". Then in layout we can have . After this, obj2 points to the same object as "obj" points to.

Parameters:

obj - object to return

Returns:

Returns the input argument.

isNull

public boolean isNull(java.lang.Object obj)

Returns whether the input argument is null.

Parameters:

obj - The object to check again null

Returns:

true if the input is null, otherwise false is returned.

getCssName

public java.lang.String getCssName(WebObjectInfo object)

Utility method that helps giving the CSS class to use based on the the object type of the WebObjectInfo instance.

Parameters:

object - The WebObjectInfo for which it's image name is required.

Returns:

a String with the name of the CSS class that should be associated with the WebObjectInfo information to display. If the type specified does not match the predefined list of styles, then it returns an empty string.

includeOwnerInfo

public boolean includeOwnerInfo()

includeTimeInfo

public boolean includeTimeInfo()

isShowObjectTags

public boolean isShowObjectTags()

includeAncestorInfo

public boolean includeAncestorInfo()

includeFolderInfo

public boolean includeFolderInfo()

inTreeStructure

public boolean inTreeStructure()

getPreferenceValueReplaceNull

public java.lang.String getPreferenceValueReplaceNull(java.lang.String prefName,
                                                      java.lang.String nullReplace)

renderTest

public void renderTest(java.lang.String msg)

buildFlattenedExpression

protected java.util.List<FlattenedTreeNode> buildFlattenedExpression(WebExpression exp)

get the answer expression tree and flatten it into a list

insertChildren

protected void insertChildren(MutableTreeNode treeNode)

getObjectInfoCssName

public java.lang.String getObjectInfoCssName(WebObjectInfo object)

getIserverNodeFunction

public int getIserverNodeFunction(WebOperatorNode node)

Returns the funtion of this node defined by IServer. The function gets from WebOperatorNode will return EnumWebMRPFunction when its function type is EnumWebFunctionType.WebFunctionTypePercentQual or EnumWebFunctionType.WebFunctionTypeRankQual. This method will recover the original function from IServer, which only can be value from enumeration EnumDSSXMLFunction.

Parameters:

node -

getAttForms

public java.util.List<WebAttributeForm> getAttForms(WebAttribute att,
                                                    int displayedForm)