Package com.microstrategy.web.app.transforms

Class FolderSaveAsXHTMLTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform

com.microstrategy.web.app.transforms.AbstractFolderTransform

com.microstrategy.web.app.transforms.FolderSmallIconTransform

com.microstrategy.web.app.transforms.FolderSaveAsXHTMLTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class FolderSaveAsXHTMLTransform
extends FolderSmallIconTransform

This class extends the FolderSmallIconTransform by changing the events for opening templates, filters, reports and documents. We use this transform in the save as page, there users should only be able to browse folders and nothing else. So the getEvent(com.microstrategy.web.objects.WebObjectInfo) method returns a null event for all object types except folders. The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.

Since:

MicroStrategy Web 8.0.0

Nested Class Summary

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

AbstractFolderTransform.Context

Field Summary

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

folderJS, FP_FOLDER_JS, FP_OBJECT_CLICK_JS, objectClickJS

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

_bandingIndex, _imgHeight, _imgWidth, _sortedChildUnits, datamartImage, documentImage, execTarget, filterImage, folderImage, FP_CREATE_REPORT_DISPLAY_SECTION, FP_DATAMART_IMAGE, FP_DOCUMENT_IMAGE, FP_EXEC_TARGET, FP_FILTER_IMAGE, FP_FOLDER_IMAGE, FP_GRAPH_IMAGE, FP_GRID_GRAPH_IMAGE, FP_IMAGE_HEIGTH, FP_IMAGE_WIDTH, FP_LEVEL_FLAG, FP_MAX_OBJECT_TYPE_COUNT, FP_REPORT_IMAGE, FP_RW_DOCUMENT_IMAGE, FP_SORT_ASCENDING, FP_SORT_FIELD, FP_TABLE_ID, FP_TEMPLATE_IMAGE, graphImage, gridGraphImage, imageHeight, imageWidth, LEVEL_ALL, LEVEL_CONFIRM_DELETE, LEVEL_DELETE, LEVEL_DESCRIPTION, LEVEL_DISPLAY_HEADERS, LEVEL_EDIT, LEVEL_EMPTY_FOLDER_MESSAGE, LEVEL_EXPORT_EXCEL, LEVEL_EXPORT_PDF, LEVEL_FOLDER_INFORMATION, LEVEL_INCREMENTAL_FETCH, LEVEL_LOCATION, LEVEL_MODIFIED, LEVEL_NAME, LEVEL_OWNER, LEVEL_SEND_NOW, LEVEL_SUBSCRIPTION, levelFlag, maxObjectTypeCount, reportImage, rwDocumentImage, sortAscending, sortField, tableId, templateImage

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

FP_INCREMENTAL_FETCH_NAV_TYPE, FP_INCREMENTAL_FETCH_PAGE_BLOCK, imgBlank, incrementalFetchNavigationType, incrementalFetchPageBlock

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
FolderSaveAsXHTMLTransform()	Class constructor, initializes formal parameters

Method Summary

Modifier and Type	Method	Description
protected AnchorTag	generateAnchor(WebEvent event)	Overwrites the parent method by assigning an onclick event information to the anchor for events related with this transform.
WebEvent	getEvent(WebObjectInfo object)	Extends the parent method by returning events only for objects of the type EnumDSSXMLObjectTypes.DssXmlTypeFolder.
void	renderEmptyList(MarkupOutput out, WebFolder folder)	Deprecated. please use and customize the AbstractFolderTransform.renderEmptyList(MarkupOutput out) method instead since this one won't be called by future releases
void	renderNameInfo(MarkupOutput out, WebObjectInfo object)	Overwrites the parent method by adding javascript code in case of DHTML for appending the report name, report description and prompt selection to the image link information.

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

getContainerAttributes, getDescription, getObjectAttributes, getTooltipInfo, postAnchorGenerated, renderLayeredIconInfo, renderList, renderObject, renderObjectName, setObjectClickJS

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

addScriptDependency, canCreateSubscription, canDelete, canEdit, canExecute, canExport, canExportToPDF, canSendNow, checkLevel, getBlockPosition, getBlockSize, getChildCount, getContext, getContextMenu, getContextMenuAttributes, getDeleteEvent, getDeleteEvent, getEditEvent, getExportEvent, getExportEvent, getFeatures, getFlashExportEvent, getFolderBean, getFolderChildCount, getGoToArgument, getGoToEvent, getHtmlExportEvent, getImageName, getImageSrc, getListComparator, getMstrExportEvent, getOringalChildCount, getPDFExportEvent, getSendNowEvent, getSortedChildUnits, getSortedList, getSubscriptionsEvent, getSupportedBeanType, getViewMediaReportEvent, getViewMediaRWEvent, initializeCss, initializeImages, initializeSelectedItemsList, initializeTransform, isEmptyList, isFeatureAvailable, isFolderEmpty, isObjectRunableinPauseMode, isObjectSelected, isObjectVisible, isViewableReport, newContext, renderEmptyList, renderImage, renderJavaScript, renderList, renderObjectCount, setBoneProperties, transformForRequestSuccessful

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

addCSSForObjectType, getCssName, getDereferenceShortcuts, getImageTooltip, getIncrementalFetchComponent, getListItemAttributes, getNameWrapperTag, getObjectAbbreviation, getObjectDescription, getObjectModificationTime, getObjectName, getOwnerName, getPathTransform, getVisualizationMode, getVisualizationMode, isUserEnabled, isVisualizationObject, isVisualizationObject, renderAbbreviationInfo, renderAbbreviationInfo, renderDescriptionInfo, renderDescriptionInfo, renderIconInfo, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, renderLayeredIconInfo, renderLocationInfo, renderModifiedInfo, renderOwnerInfo

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

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, 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, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, 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, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

FolderSaveAsXHTMLTransform

public FolderSaveAsXHTMLTransform()

Class constructor, initializes formal parameters

Method Detail

renderEmptyList

@Deprecated
public void renderEmptyList(MarkupOutput out,
                            WebFolder folder)

Deprecated.

please use and customize the AbstractFolderTransform.renderEmptyList(MarkupOutput out) method instead since this one won't be called by future releases

Renders the folder when it has no children. Overwrites the parent method by adding the DIV tag around the empty contents message (if applicable).

Overrides:

renderEmptyList in class AbstractFolderTransform

Parameters:

out - MarkupOutput instance where the transform's output will be saved.

folder - the WebFolder instance from the FolderBean being transformed.

generateAnchor

protected AnchorTag generateAnchor(WebEvent event)

Overwrites the parent method by assigning an onclick event information to the anchor for events related with this transform.

Overrides:

generateAnchor in class AbstractAppTransform

Parameters:

event - WebEvent instance from where the anchor information will be initialized

Returns:

AnchorTag initialized with the event details.

See Also:

AbstractAppTransform.generateAnchor(com.microstrategy.web.beans.WebEvent)

renderNameInfo

public void renderNameInfo(MarkupOutput out,
                           WebObjectInfo object)

Overwrites the parent method by adding javascript code in case of DHTML for appending the report name, report description and prompt selection to the image link information.

Overrides:

renderNameInfo in class FolderSmallIconTransform

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

getEvent

public WebEvent getEvent(WebObjectInfo object)

Extends the parent method by returning events only for objects of the type EnumDSSXMLObjectTypes.DssXmlTypeFolder. For other objects types, it will return null.

Overrides:

getEvent in class AbstractFolderTransform

Parameters:

object - a WebObjectInfo for which the event must be retrieved.

Returns:

The default WebEvent associated with opening folders for the objects of type EnumDSSXMLObjectTypes.DssXmlTypeFolder. For any other object types, returns null.