Package com.microstrategy.web.app.transforms

Class FilterObjectBrowserTransform

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

com.microstrategy.web.app.transforms.FilterObjectBrowserTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class FilterObjectBrowserTransform
extends FolderProjectBrowserTransform

Title: FilterObjectBrowserTransform

Description: The class is used to transform a Folder Bean into it's Object Brwoser mode.

Copyright: Copyright (c) 2005

Company: Microstrategy, Inc.

Since:

MicroStrategy Web 9.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.FolderProjectBrowserTransform

allowBrowseDimension, checkImage, contextID, cssBody, cssFileSearch, folderLinksLocation, FP_ALLOW_BROWSE_DIMENSION, FP_CHECK_IMAGE, FP_CONTEXT_ID, FP_FOLDER_LINKS_LOCATION, FP_HTML_GRAPHIC_MODE, FP_LEVEL_CHANGE_JS, FP_RENDER_FORM, FP_RENDER_LINKS_ANCESTORS, FP_SEARCH_BOX_JS, FP_SEARCH_JS, FP_UP_FOLDER_JS, htmlGraphicMode, levelChangeJS, renderForm, renderLinksAncestors, searchBoxJS, searchJS, sSpaces, upFolderJS

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

Method Summary

Modifier and Type	Method	Description
java.util.Map	getContainerAttributes()	Returns a Map containing any attribute that must be added to the list's container.
protected java.lang.String	getFolderContentsSelectNameHTML()	returns the name the select box for folder contentss in HTML will have
protected java.util.ArrayList	getHiddenInputsEventList()	Returns the list of events that will be included in the hidden inputs section.
protected WebEvent	getModifyFilterEvent()	Returns a WebEvent instance containing the event to use when adding an element to the filter.
protected java.lang.String	getObjectInfoParameter(WebObjectInfo woi)	Outputs a string formatted the way the objectInfo argument of the event requires it
protected WebComponent	getProjectBrowserBean()	Returns a WebComponent instance representing the ProjectBrowser bean from where the transform will obtain information from.
protected java.lang.String	getScriptClass()	Returns the name of the javaScript class (if any) to be associated with the component.
protected void	initHeightAndWidthFromPreferences()	Initializes the _height and _width of this component from the bone dimesions retrieved from Preferences.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
void	renderFolderContentHTML(MarkupOutput out, WebObjectInfo woi)	Renders a single non-folder content item from the current folder in HTML mode
void	renderFolderContentsSubmitButtonHTML(MarkupOutput out)	Renders the submit button for the folde's non-folder contents section in HTML mode
void	renderList(MarkupOutput out)	Renders the list of objects contained in the folder as a list with small icons.
void	transformForRequestSuccessful(MarkupOutput out)	Transforms the assosciated WebBean when its status is EnumRequestStatus.WebBeanRequestSuccessful.

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

generateAnchor, getBrowseEvent, getBrowseParentFolderEvent, getDescription, getEvent, getFodlerLinksContextId, getFolderLinkClasses, getFolderLinkList, getFolderLinksContextId, getFolderObjects, getFolderRoot, getForm, getJavascriptTyAttribute, getLinkAttributes, getNonFolderObjects, getObjectName, getProjectID, getSearchEvent, getSubfolders, getSubFolders, getTooltipInfo, getTooltipTitle, initializeCss, initializeImages, isFolder, isNamedFolder, renderAncestorsSelector, renderBrowser, renderBrowserContent, renderClearSearch, renderFolderContentsHTML, renderFolderContentsTitleHTML, renderFolderLink, renderFolderLinkOptions, renderFolderLinks, renderFolderObjects, renderFoldersHTML, renderFoldersSubmitButtonHTML, renderFoldersTitleHTML, renderHiddenInputs, renderLayeredIconInfo, renderListHTML, renderNameInfo, renderObjectName, renderOpenParentLink, renderSearchBox, renderSearchButton, renderSearchSection, renderSubfolders, setFolderRoot, setUpFolderJS, shouldRenderFolderLinks

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

getObjectAttributes, postAnchorGenerated, renderLayeredIconInfo, renderList, renderObject, 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, initializeSelectedItemsList, isEmptyList, isFeatureAvailable, isFolderEmpty, isObjectRunableinPauseMode, isObjectSelected, isObjectVisible, isViewableReport, newContext, renderEmptyList, renderEmptyList, renderImage, renderJavaScript, renderObjectCount, setBoneProperties

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

addCSSForObjectType, getCssName, getDereferenceShortcuts, getImageTooltip, getIncrementalFetchComponent, getListItemAttributes, getNameWrapperTag, getObjectAbbreviation, getObjectDescription, getObjectModificationTime, getOwnerName, getPathTransform, getVisualizationMode, getVisualizationMode, isUserEnabled, isVisualizationObject, isVisualizationObject, renderAbbreviationInfo, renderAbbreviationInfo, renderDescriptionInfo, renderDescriptionInfo, renderIconInfo, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, 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, getRefreshEvent, getRequestKeys, getResourcesFolder, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, 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, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

FilterObjectBrowserTransform

public FilterObjectBrowserTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform. Extends initializeTransform by initializing the cache of this transform's Formal parameters.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class FolderProjectBrowserTransform

Parameters:

data - Transformable instance with the bean to be transformed.

getScriptClass

protected java.lang.String getScriptClass()

Description copied from class: AbstractAppTransform

Returns the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component.

A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.

Overrides:

getScriptClass in class AbstractAppTransform

Returns:

String representing the name of a javaScript class

initHeightAndWidthFromPreferences

protected void initHeightAndWidthFromPreferences()

Description copied from class: AbstractAppTransform

Initializes the _height and _width of this component from the bone dimesions retrieved from Preferences. The format of the preference is : id1:width:heigth@id2:width:height@....

Overrides:

initHeightAndWidthFromPreferences in class AbstractAppTransform

getContainerAttributes

public java.util.Map getContainerAttributes()

Returns a Map containing any attribute that must be added to the list's container.

Overrides:

getContainerAttributes in class FolderSmallIconTransform

Returns:

Map key-value pairs of attributes.

renderList

public void renderList(MarkupOutput out)

Renders the list of objects contained in the folder as a list with small icons.

Overrides:

renderList in class FolderProjectBrowserTransform

Parameters:

out - MarkupOutput instance where the HTML output is to be saved.

renderFolderContentsSubmitButtonHTML

public void renderFolderContentsSubmitButtonHTML(MarkupOutput out)

Renders the submit button for the folde's non-folder contents section in HTML mode

Overrides:

renderFolderContentsSubmitButtonHTML in class FolderProjectBrowserTransform

Parameters:

out - MarkupOutput instance where the HTML output is to be saved.

renderFolderContentHTML

public void renderFolderContentHTML(MarkupOutput out,
                                    WebObjectInfo woi)

Renders a single non-folder content item from the current folder in HTML mode

Overrides:

renderFolderContentHTML in class FolderProjectBrowserTransform

Parameters:

out - MarkupOutput

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Transforms the assosciated WebBean when its status is EnumRequestStatus.WebBeanRequestSuccessful.

Overrides:

transformForRequestSuccessful in class FolderProjectBrowserTransform

Parameters:

out - MarkupOutput instance where the contents of this transform will be saved.

See Also:

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

getObjectInfoParameter

protected java.lang.String getObjectInfoParameter(WebObjectInfo woi)

Outputs a string formatted the way the objectInfo argument of the event requires it

Returns:

a String with the following format: ID|Type|Subtype|Alias|Name or

getHiddenInputsEventList

protected java.util.ArrayList getHiddenInputsEventList()

Returns the list of events that will be included in the hidden inputs section.

Overrides:

getHiddenInputsEventList in class FolderProjectBrowserTransform

Returns:

ArrayList

getModifyFilterEvent

protected WebEvent getModifyFilterEvent()

Returns a WebEvent instance containing the event to use when adding an element to the filter.

Returns:

WebEvent

getFolderContentsSelectNameHTML

protected java.lang.String getFolderContentsSelectNameHTML()

returns the name the select box for folder contentss in HTML will have

Overrides:

getFolderContentsSelectNameHTML in class FolderProjectBrowserTransform

Returns:

String

getProjectBrowserBean

protected WebComponent getProjectBrowserBean()

Returns a WebComponent instance representing the ProjectBrowser bean from where the transform will obtain information from.

Returns:

WebComponent