Package com.microstrategy.web.app.transforms

Class FolderSmallIconTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

FolderProjectBrowserTransform, FolderSaveAsXHTMLTransform

public class FolderSmallIconTransform
extends AbstractFolderTransform

This class displays the content of a FolderBean as a list of small icons.
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

Modifier and Type	Field	Description
FormalParameter	folderJS	Formal parameter: The javascript function to execute when you click on the folder links
static java.lang.String	FP_FOLDER_JS	Name for the formal parameter: folderJS
static java.lang.String	FP_OBJECT_CLICK_JS	Name for the formal parameter: objectClickJS
FormalParameter	objectClickJS	Formal parameter: The javascript function to execute when you click on a folder's subitem

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

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.
java.lang.String	getDescription()	Return the description for this Transform
java.util.Map	getObjectAttributes(WebObjectInfo object)	Returns a Map object containing the attributes the object's main container will have
protected java.lang.String	getTooltipInfo(WebObjectInfo item)	Returns the tooltip to add to each individual item in the Folder's list.
protected void	postAnchorGenerated(AnchorTag anchor)
void	renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object)	generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).
void	renderList(MarkupOutput out, WebDisplayUnits list)	Deprecated. please use and customize AbstractFolderTransform.renderList(MarkupOutput out) instead since this method won't be called by future releases.
void	renderNameInfo(MarkupOutput out, WebObjectInfo object)	Write out name information for a single object.
void	renderObject(MarkupOutput out, WebObjectInfo object)	Renders the WebObjectInfo object requested according to the specifications of this transform: a small icon and the object name's information.
void	renderObjectName(MarkupOutput out, WebObjectInfo object)	Renders only the name of the object passed as a parameter
protected void	setObjectClickJS(java.util.HashMap __result, WebObjectInfo object)	Set the onclick Js event

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, isObjectVisible, 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, 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, generateAnchor, 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

objectClickJS

public FormalParameter objectClickJS

Formal parameter: The javascript function to execute when you click on a folder's subitem

Since:

MicroStrategy Web 8.0.1

folderJS

public FormalParameter folderJS

Formal parameter: The javascript function to execute when you click on the folder links

Since:

MicroStrategy Web 8.0.2

FP_OBJECT_CLICK_JS

public static final java.lang.String FP_OBJECT_CLICK_JS

Name for the formal parameter: objectClickJS

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

FP_FOLDER_JS

public static final java.lang.String FP_FOLDER_JS

Name for the formal parameter: folderJS

Since:

MicroStrategy Web 8.0.2

See Also:

Constant Field Values

Constructor Detail

FolderSmallIconTransform

public FolderSmallIconTransform()

Default no-argument constructor. Initializes formal parameters.

Method Detail

renderList

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

Deprecated.

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

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

Specified by:

renderList in class AbstractFolderTransform

Parameters:

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

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

getObjectAttributes

public java.util.Map getObjectAttributes(WebObjectInfo object)

Returns a Map object containing the attributes the object's main container will have

Parameters:

object - WebObjectInfo to be rendered.

Returns:

Map

Since:

MicroStrategy Web 8.0.1

setObjectClickJS

protected void setObjectClickJS(java.util.HashMap __result,
                                WebObjectInfo object)

Set the onclick Js event

Parameters:

__result -

object -

Since:

MicroStrategy Web 8.0.2

renderObject

public void renderObject(MarkupOutput out,
                         WebObjectInfo object)

Renders the WebObjectInfo object requested according to the specifications of this transform: a small icon and the object name's information.

Overrides:

renderObject in class AbstractObjectInfoListTransform

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

renderObjectName

public void renderObjectName(MarkupOutput out,
                             WebObjectInfo object)

Renders only the name of the object passed as a parameter

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo

Since:

MicroStrategy Web 8.0.1

renderNameInfo

public void renderNameInfo(MarkupOutput out,
                           WebObjectInfo object)

Write out name information for a single object. The string will be rendered as a link if the event according to the object type, provided by the AbstractFolderTransform.getEvent(com.microstrategy.web.objects.WebObjectInfo) method is available.

Overrides:

renderNameInfo in class AbstractObjectInfoListTransform

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

postAnchorGenerated

protected void postAnchorGenerated(AnchorTag anchor)

Since:

MicroStrategy Web 9.0.0

getDescription

public java.lang.String getDescription()

Return the description for this Transform

Returns:

String with the description for the transform.

getContainerAttributes

public java.util.Map getContainerAttributes()

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

Returns:

Map key-value pairs of attributes.

Since:

MicroStrategy Web 8.0.1

getTooltipInfo

protected java.lang.String getTooltipInfo(WebObjectInfo item)

Returns the tooltip to add to each individual item in the Folder's list.

Parameters:

item - WebObjectInfo the folder's child.

Returns:

String the tooltip to add to the HTML output.

Since:

MicroStrategy Web 8.0.1

renderLayeredIconInfo

public void renderLayeredIconInfo(MarkupOutput out,
                                  WebObjectInfo object)

generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).

Overrides:

renderLayeredIconInfo in class AbstractObjectInfoListTransform

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

Since:

MicroStrategy Web 9.0.0