Package com.microstrategy.web.app.transforms

Class FolderBulletTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

FolderBulletReportsTransform, FolderBulletRWTransform

public class FolderBulletTransform
extends AbstractFolderTransform

This class renders the folders content as a bulleted list

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

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

AbstractFolderTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
FormalParameter	appendBeanState	Indicates if the state of all the beans should be appended to the links to generate or not.
FormalParameter	bulletImage	Indicates the image to be used as bullet before every item displayed.
static java.lang.String	FP_APPEND_BEAN_STATE	Constant specifying the name of the formal parameter for defining if the state of the beans should be appended or not.
static java.lang.String	FP_BULLET_IMAGE	Constant specifying the name of the formal parameter for defining the image to be used as bullet.
static java.lang.String	FP_BULLET_STYLE	Indicates whether to use layered icon or regular bullet image for bullet item.
FormalParameter	useLayeredIcon	Indicates whether to use layered icon or regular bullet image for bullet item.

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
FolderBulletTransform()	Default no-argument constructor.

Method Summary

Modifier and Type	Method	Description
protected AnchorTag	generateAnchor(WebEvent event)	Overwrites parent method by removing the children state according to the formal parameter values for the transform
java.lang.String	getDescription()	Returns this transform's description
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	renderBulletList(MarkupOutput out)	Deprecated. please use AbstractFolderTransform.renderList(MarkupOutput out) instead.
void	renderBulletList(MarkupOutput out, WebDisplayUnits list)	Deprecated. please use AbstractFolderTransform.renderList(MarkupOutput out) instead.
void	renderList(MarkupOutput out, WebDisplayUnits list)	Renders the folder contents when it does have children.
void	renderObject(MarkupOutput out, WebObjectInfo object)	Renders the WebObjectInfo object requested according to the specifications of this transform.

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, getEvent, 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, isViewableReport, newContext, renderEmptyList, 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, renderLayeredIconInfo, renderLocationInfo, renderModifiedInfo, renderNameInfo, 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

Field Detail

appendBeanState

public FormalParameter appendBeanState

Indicates if the state of all the beans should be appended to the links to generate or not.

bulletImage

public FormalParameter bulletImage

Indicates the image to be used as bullet before every item displayed.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

useLayeredIcon

public FormalParameter useLayeredIcon

Indicates whether to use layered icon or regular bullet image for bullet item.

Since:

MicroStrategy Web 9.0.0

FP_APPEND_BEAN_STATE

public static final java.lang.String FP_APPEND_BEAN_STATE

Constant specifying the name of the formal parameter for defining if the state of the beans should be appended or not. Value is appendBeanState.

See Also:

Constant Field Values

FP_BULLET_IMAGE

public static final java.lang.String FP_BULLET_IMAGE

Constant specifying the name of the formal parameter for defining the image to be used as bullet. Value is bulletImage.

See Also:

Constant Field Values

FP_BULLET_STYLE

public static final java.lang.String FP_BULLET_STYLE

Indicates whether to use layered icon or regular bullet image for bullet item. Value is useLayeredIcon.

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

FolderBulletTransform

public FolderBulletTransform()

Default no-argument constructor. Initializes formal parameters.

Method Detail

renderList

public void renderList(MarkupOutput out,
                       WebDisplayUnits list)

Description copied from class: AbstractFolderTransform

Renders the folder contents when it does have children.

Specified by:

renderList in class AbstractFolderTransform

Parameters:

out - MarkupOutput instance to modify with the transform's output.

list - WebDisplayUnits instance with the list of objects that will be rendered by this transform, as contents of the folder being analyzed.

renderBulletList

@Deprecated
public void renderBulletList(MarkupOutput out,
                             WebDisplayUnits list)

Deprecated.

please use AbstractFolderTransform.renderList(MarkupOutput out) instead. The list of children to be rendered there can be obtained from the AbstractFolderTransform.getSortedList() method.

Renders the folder contents as a list with bullets.

Parameters:

out - MarkupOutput instance to modify with the transform's output.

list - WebDisplayUnits instance with the list of objects that will be rendered by this transform, as contents of the folder being analyzed.

Since:

MicroStrategy Web 8.0.0

renderBulletList

@Deprecated
public void renderBulletList(MarkupOutput out)
                      throws WebBeanException,
                             WebObjectsException

Deprecated.

please use AbstractFolderTransform.renderList(MarkupOutput out) instead. The list of children to be rendered there will come from the AbstractFolderTransform.getSortedList() method.

Renders the folder contents as a list with bullets. Obtains the list of children to display from the AbstractFolderTransform.getSortedChildUnits() method.

Parameters:

out - MarkupOutput instance to modify with the transform's output. be rendered by this transform, as contents of the folder being analyzed.

Throws:

WebBeanException - if an error happens while obtaining the output of this transform

WebObjectsException - if an error happens while obtaining the output of this transform

Since:

MicroStrategy Web 8.0.0

generateAnchor

protected AnchorTag generateAnchor(WebEvent event)

Overwrites parent method by removing the children state according to the formal parameter values for the transform

Overrides:

generateAnchor in class AbstractAppTransform

Parameters:

event - WebEvent instance with the information to include on the link

Returns:

AnchorTag instance for the HTML anchor generated.

Since:

MicroStrategy Web 8.0.0

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

renderObject

public void renderObject(MarkupOutput out,
                         WebObjectInfo object)

Renders the WebObjectInfo object requested according to the specifications of this transform.
The HTML contents generated by this method are inside a TR tag, where one of its cells is used for rendering the image specified on the bulletImage formal parameter, and another cell for displaying the object's name. It is required that the parent TABLE tag is already opened. By default, the renderList() takes care of it.

Overrides:

renderObject in class AbstractObjectInfoListTransform

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

getDescription

public java.lang.String getDescription()

Returns this transform's description

Returns:

String with the description for the transform