Class FolderIconTransform
- 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.FolderIconTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
FolderSaveAsTransform
,FolderSummaryTransform
public class FolderIconTransform extends AbstractFolderTransform
This class displays the content of aFolderBean
as a list of icons organized in columns.- 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
columnsNumber
Indicates the number of columns with information to be used when displaying the contents of the transform.static java.lang.String
FP_COLUMNS_NUMBER
Constant specifying the name of the formal parameter for defining the number of columns.-
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 FolderIconTransform()
Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getDescription()
Return the description for this TransformWebEvent
getExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, by default a new window will be opened when exporting.WebEvent
getPDFExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, by default a new window will be opened when exporting to PDF.void
renderDeleteInfo(MarkupOutput out, WebObjectInfo object)
Write out delete information for a single object, consisting on a text link if the event provided by theAbstractFolderTransform.getDeleteEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.void
renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Write out description information for a single object.void
renderEditInfo(MarkupOutput out, WebObjectInfo object)
Write out edit information for a single object, consisting on a text link if the event provided by theAbstractFolderTransform.getEditEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.void
renderExport(MarkupOutput out, WebObjectInfo object)
Write out information for exporting a single object, consisting on a text link if the event provided by thegetExportEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.void
renderIconInfo(MarkupOutput out, WebObjectInfo object)
Write out the image information for a single object.void
renderItems(MarkupOutput out)
Renders the contents of the folder as an HTMLTABLE
with the required rows and columns (as requested on thecolumnsNumber
formal parameter).void
renderList(MarkupOutput out, WebDisplayUnits list)
Deprecated.please use and customizeAbstractFolderTransform.renderList(MarkupOutput out)
instead since this method will not be called on future releases.void
renderModifiedInfo(MarkupOutput out, WebObjectInfo object)
Write out modified time information for a single object.void
renderNameInfo(MarkupOutput out, WebObjectInfo object)
Write out name information for a single object.void
renderObject(MarkupOutput out, WebObjectInfo object)
Renders theWebObjectInfo
object requested according to the specifications of this transform.void
renderOwnerInfo(MarkupOutput out, WebObjectInfo object)
Write out owner information for a single object.void
renderPDFExport(MarkupOutput out, WebObjectInfo object)
Write out information for exporting to PDF a single object, consisting on a text link if the event provided by thegetPDFExportEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.void
renderSendNowInfo(MarkupOutput out, WebObjectInfo object)
Write out Narrowcast Send Now information for a single object, consisting on a text link if the event provided by theAbstractFolderTransform.getSendNowEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.void
renderSubscriptionInfo(MarkupOutput out, WebObjectInfo object)
Write out subscription information for a single object, consisting on a text link if the event provided by theAbstractFolderTransform.getSubscriptionsEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.-
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, getFeatures, getFlashExportEvent, getFolderBean, getFolderChildCount, getGoToArgument, getGoToEvent, getHtmlExportEvent, getImageName, getImageSrc, getListComparator, getMstrExportEvent, getOringalChildCount, 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, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, renderLayeredIconInfo, renderLayeredIconInfo, renderLocationInfo
-
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, 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
-
columnsNumber
public FormalParameter columnsNumber
Indicates the number of columns with information to be used when displaying the contents of the transform.
The value indicates how the HTML table will be generated. By default, the number of columns it will have is 2.
-
FP_COLUMNS_NUMBER
public static final java.lang.String FP_COLUMNS_NUMBER
Constant specifying the name of the formal parameter for defining the number of columns. Value is columnsNumber.- See Also:
- Constant Field Values
-
-
Method Detail
-
renderList
public void renderList(MarkupOutput out, WebDisplayUnits list)
Deprecated.please use and customizeAbstractFolderTransform.renderList(MarkupOutput out)
instead since this method will not be called on future releases.Unless a specific layout has been defined, this method renders the list of objects contained in the folder as an HTMLTABLE
with the required rows and as many cells as columns indicated by the user on thecolumnsNumber
formal parameter, plus smaller empty columns in between these for separating the contents.- Specified by:
renderList
in classAbstractFolderTransform
- 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.
-
renderItems
public void renderItems(MarkupOutput out)
Renders the contents of the folder as an HTMLTABLE
with the required rows and columns (as requested on thecolumnsNumber
formal parameter).- Parameters:
out
-MarkupOutput
instance where the HTML content to display will be saved.- Since:
- MicroStrategy Web 8.0.0
-
renderObject
public void renderObject(MarkupOutput out, WebObjectInfo object)
Renders theWebObjectInfo
object requested according to the specifications of this transform.
The HTML contents generated by this method are inside of up to two HTML TD tags: one for the image and another for the rest of the object information. TheAbstractFolderTransform.levelFlag
formal parameters indicate which fields are to be displayed. It is required that the parentTR
andTABLE
should be opened beforehand. By default, therenderItems(MarkupOutput out)
method takes care of that.- Overrides:
renderObject
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderIconInfo
public void renderIconInfo(MarkupOutput out, WebObjectInfo object)
Write out the image information for a single object. The source of the image is determined by the object type and the image formal parameters the user defined for this transform. The image will be rendered as a link if the event according to the object type, provided by theAbstractFolderTransform.getEvent(com.microstrategy.web.objects.WebObjectInfo)
method, is available.- Overrides:
renderIconInfo
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
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 theAbstractFolderTransform.getEvent(com.microstrategy.web.objects.WebObjectInfo)
method, is available.- Overrides:
renderNameInfo
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderDescriptionInfo
public void renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Write out description information for a single object.- Overrides:
renderDescriptionInfo
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderOwnerInfo
public void renderOwnerInfo(MarkupOutput out, WebObjectInfo object)
Write out owner information for a single object.- Overrides:
renderOwnerInfo
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderModifiedInfo
public void renderModifiedInfo(MarkupOutput out, WebObjectInfo object)
Write out modified time information for a single object.- Overrides:
renderModifiedInfo
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderSubscriptionInfo
public void renderSubscriptionInfo(MarkupOutput out, WebObjectInfo object)
Write out subscription information for a single object, consisting on a text link if the event provided by theAbstractFolderTransform.getSubscriptionsEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderSendNowInfo
public void renderSendNowInfo(MarkupOutput out, WebObjectInfo object)
Write out Narrowcast Send Now information for a single object, consisting on a text link if the event provided by theAbstractFolderTransform.getSendNowEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
getExportEvent
public WebEvent getExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, by default a new window will be opened when exporting.- Overrides:
getExportEvent
in classAbstractFolderTransform
- Parameters:
object
- theWebObjectInfo
instance which will be exported if the event is called.- Returns:
- an initialized
WebEvent
object if the application supports it. Otherwise, will returnnull
. - Since:
- MicroStrategy Web 8.0.0
-
renderExport
public void renderExport(MarkupOutput out, WebObjectInfo object)
Write out information for exporting a single object, consisting on a text link if the event provided by thegetExportEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
getPDFExportEvent
public WebEvent getPDFExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, by default a new window will be opened when exporting to PDF.- Overrides:
getPDFExportEvent
in classAbstractFolderTransform
- Parameters:
object
- theWebObjectInfo
instance which will be exported if the event is called.- Returns:
- an initialized
WebEvent
object if the application supports it. Otherwise, will returnnull
. - Since:
- MicroStrategy Web 8.0.0
-
renderPDFExport
public void renderPDFExport(MarkupOutput out, WebObjectInfo object)
Write out information for exporting to PDF a single object, consisting on a text link if the event provided by thegetPDFExportEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderDeleteInfo
public void renderDeleteInfo(MarkupOutput out, WebObjectInfo object)
Write out delete information for a single object, consisting on a text link if the event provided by theAbstractFolderTransform.getDeleteEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderEditInfo
public void renderEditInfo(MarkupOutput out, WebObjectInfo object)
Write out edit information for a single object, consisting on a text link if the event provided by theAbstractFolderTransform.getEditEvent(com.microstrategy.web.objects.WebObjectInfo)
method is available and the user has the required privileges.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
getDescription
public java.lang.String getDescription()
Return the description for this Transform- Returns:
String
with the description for the transform.
-
-