Package com.microstrategy.web.app.transforms

Class FolderSearchResultsXHTMLTransform

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.FolderViewTransform

com.microstrategy.web.app.transforms.FolderSearchResultsXHTMLTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

AdminFolderSearchResultsTransform, FolderQuickSearchResultsXHTMLTransform

public class FolderSearchResultsXHTMLTransform
extends FolderViewTransform

This class extends the FolderViewTransform by rendering specific messages related to search results.
Since the results of a search are returned as a folder, this transform shows the messages when the maximum object count is reached, or when the search returns no results.
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.FolderViewTransform

FolderViewTransform.ClientEvent

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.FolderViewTransform

_itemsList, CM_FLAG_ALL, CM_FLAG_COPY, CM_FLAG_CREATE_SHORTCUT, CM_FLAG_DELETE, CM_FLAG_MOVE, CM_FLAG_PROPERTIES, CM_FLAG_RENAME, contextMenuFlags, FP_CONTEXT_MENU_FLAGS, id, renderLinks

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

Method Summary

Modifier and Type	Method	Description
java.util.Map	addSummaryAttribute()	Return the Summary Attribute to be used in the table for the transform.
protected AnchorTag	generateAnchor(WebEvent event)	Overwrites the parent method by setting special attributes if the event is not provided
protected WebEvent	getAdvancedSearchEvent(WebSearch search)	Get the WebEvent for obtaining the advanced search interface.
WebEvent	getEvent(WebObjectInfo object)	Extends the parent method by changing the event of the folder bean to make sure it uses browse folder event, as well as for processing the shortcuts.
protected boolean	isObjectVisible(WebObjectInfo object)	Utility method that checks if the object should be displayed or not, based on the information provided on the AbstractFolderTransform.maxObjectTypeCount formal parameter and the current number of objects of that type that have been rendered already
void	renderEmptyList(MarkupOutput out, WebFolder folder)	Deprecated. please use and customize AbstractFolderTransform.renderEmptyList(MarkupOutput out) instead, this method won't be called by future releases.
void	renderList(MarkupOutput out, WebDisplayUnits list)	Deprecated. please use and customize AbstractFolderTransform.renderList(MarkupOutput out) instead since this method will not be called by future releases.
void	renderSearchResultsCount(MarkupOutput out)	Get the HTML to be displayed which includes the number of elements found
void	renderSearchResultsCount(MarkupOutput out, WebSearch search)	Get the HTML to be displayed which includes the number of elements found

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

canCopy, canCreateShortcut, canDisplayProperties, canMove, canRename, checkContextMenuFlag, generateAnchor, getActionImageSrc, getCopyEvent, getCreateAnalysisFromReportEvent, getCreateDocumentFromDossierEvent, getCreateDocumentFromReportEvent, getCreateDocumentFromThemeEvent, getCreateHTML5VIFromReportEvent, getCreateReportFromCubeEvent, getCreateShortcutEvent, getDeleteTooltip, getDescription, getDisplayPropertiesEvent, getEditEvent, getEvent, getExportEvent, getFlashExportEvent, getFolderName, getFolderObjects, getHtmlExportEvent, getID, getMoveEvent, getNameWrapperTag, getNewFilterEvent, getNewPromptEvent, getObjectID, getObjectManipulationBean, getObjectModificationTimeStamp, getOpenObjectManipulationDialogEvent, getPDFExportEvent, getRenameEvent, getRepublishCubeConfigJSON, getTimestamp, hasMultipleRunModesAvailable, isActionsTabAvailable, isFolderNotNull, renderAnchorTag, renderContextMenu, renderDeleteInfo, renderDescriptionInfo, renderEditInfo, renderEmptyCellForActions, renderExport, renderFolderDescription, renderFolderName, renderIconInfo, renderLayeredIconInfo, renderLayeredIconInfo, renderMenuArrow, renderModifiedInfo, renderOwnerInfo, renderPDFExport, renderSendNowInfo, renderSubscriptionInfo, shouldDisplayDeleteInfo

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, getExportEvent, getFeatures, getFolderBean, getFolderChildCount, getGoToArgument, getGoToEvent, getImageName, getImageSrc, getListComparator, getMstrExportEvent, getOringalChildCount, getSendNowEvent, getSortedChildUnits, getSortedList, getSubscriptionsEvent, getSupportedBeanType, getViewMediaReportEvent, getViewMediaRWEvent, initializeCss, initializeImages, initializeSelectedItemsList, initializeTransform, isEmptyList, isFeatureAvailable, isFolderEmpty, isObjectRunableinPauseMode, isObjectSelected, 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, getObjectAbbreviation, getObjectDescription, getObjectModificationTime, getObjectName, getOwnerName, getPathTransform, getVisualizationMode, getVisualizationMode, isUserEnabled, isVisualizationObject, isVisualizationObject, renderAbbreviationInfo, renderAbbreviationInfo, renderDescriptionInfo, renderIconInfo, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, renderLayeredIconInfo, renderLocationInfo, renderNameInfo, renderObject

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, 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, 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, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

FolderSearchResultsXHTMLTransform

public FolderSearchResultsXHTMLTransform()

Method Detail

addSummaryAttribute

public java.util.Map addSummaryAttribute()

Description copied from class: FolderViewTransform

Return the Summary Attribute to be used in the table for the transform.

Overrides:

addSummaryAttribute in class FolderViewTransform

Returns:

java.util.Map with the attribute name (as key) and the value.

Since:

MicroStrategy Web 8.0.2

renderEmptyList

public void renderEmptyList(MarkupOutput out,
                            WebFolder folder)

Deprecated.

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

Get the HTML to display when the folder does not have any contents to be rendered. Overwrites the parent method by showing a message indicating that the search returned no objects and some tips on how to extend the search.

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 setting special attributes if the event is not provided

Overrides:

generateAnchor in class FolderViewTransform

Parameters:

event - WebEvent instance from where the anchor information is to be initialized.

Returns:

AnchorTag initialized instance based on the information provided on the WebEvent

renderList

public void renderList(MarkupOutput out,
                       WebDisplayUnits list)

Deprecated.

please use and customize AbstractFolderTransform.renderList(MarkupOutput out) instead since this method will not be called by future releases.

Overwrites the parent method by adding a message about the count of objects and for adding a summary descriptor (localized string for This table displays the objects result of your search) for the global table that will hold the results.

Overrides:

renderList in class FolderViewTransform

Parameters:

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

list - WebDisplayUnits instance to be rendered

renderSearchResultsCount

public void renderSearchResultsCount(MarkupOutput out)

Get the HTML to be displayed which includes the number of elements found

Parameters:

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

Since:

MicroStrategy Web 8.0.1

renderSearchResultsCount

public void renderSearchResultsCount(MarkupOutput out,
                                     WebSearch search)

Get the HTML to be displayed which includes the number of elements found

Parameters:

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

search - the WebSearch instance with the results of the search.

getAdvancedSearchEvent

protected WebEvent getAdvancedSearchEvent(WebSearch search)

Get the WebEvent for obtaining the advanced search interface.

Parameters:

search - WebSearch instance currently used

Returns:

a WebEvent instance initialized with the event, or null if the application doesn't support it.

getEvent

public WebEvent getEvent(WebObjectInfo object)

Extends the parent method by changing the event of the folder bean to make sure it uses browse folder event, as well as for processing the shortcuts.

Overrides:

getEvent in class FolderViewTransform

Parameters:

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

Returns:

the WebEvent associated with browsing folders for the objects of type EnumDSSXMLObjectTypes.DssXmlTypeFolder. For any other object types, returns what the parent class would obtain. If the application does not support the event, returns null.

isObjectVisible

protected boolean isObjectVisible(WebObjectInfo object)

Description copied from class: AbstractFolderTransform

Utility method that checks if the object should be displayed or not, based on the information provided on the AbstractFolderTransform.maxObjectTypeCount formal parameter and the current number of objects of that type that have been rendered already

Overrides:

isObjectVisible in class AbstractFolderTransform

Parameters:

object - WebObjectInfo with the object to check for.

Returns:

True if the object should be displayed, otherwise returns False

Since:

MicroStrategy Web 9.0.0