Package com.microstrategy.web.app.transforms

Class GraphImageTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.GraphImageTransform

All Implemented Interfaces:

AppTransform, Transform

public class GraphImageTransform
extends AbstractAppTransform

This is the transform which renders the acual graph image.

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 FormalParameter	graphImageFormat	Graph Image Format to use.

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
GraphImageTransform()	default no-args constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Return the description for this Transform.
protected GraphBean	getGraphBean()	return the current report bean.
java.lang.Class	getSupportedBeanType()	Get the class of objects this transform is able to handle.
void	initializeTransform(Transformable data)	Extends initializeTransform by invoking checkDesignMode() and initializeProperties().
void	renderShell(MarkupOutput out)	Generates the shell for this Transform.
void	transformForRequestSuccessful(MarkupOutput out)	Transform the report bean when its status is "Successful".

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, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, 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.Transform

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

Field Detail

graphImageFormat

protected FormalParameter graphImageFormat

Graph Image Format to use.
Allowed Values:
PreferencesGraphTransform.GRAPH_IMAGE_TYPE_REPORT
PreferencesGraphTransform.GRAPH_IMAGE_TYPE_GIF
PreferencesGraphTransform.GRAPH_IMAGE_TYPE_JPEG

Constructor Detail

GraphImageTransform

public GraphImageTransform()

default no-args constructor.
It created the formal parameters and assign default values to them.

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Extends initializeTransform by invoking checkDesignMode() and initializeProperties().

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractAppTransform

Parameters:

data - the bean to transform.

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

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

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.

renderShell

public void renderShell(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Overrides:

renderShell in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

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

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Transform the report bean when its status is "Successful".

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - markupOut by this transform

See Also:

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

getDescription

public java.lang.String getDescription()

Return the description for this Transform.

Returns:

The description as to what this Transform does.

getGraphBean

protected GraphBean getGraphBean()

return the current report bean.

Returns:

the current report bean