Class FolderListTransform
- 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.FolderListTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
FolderSearchResultsTransform
@Deprecated public class FolderListTransform extends AbstractFolderTransform
Deprecated.UseFolderViewTransform
insteadThis Transform renders the content of a folder a detailed list of objects. Each object is rendered on it's own row.- 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 static java.lang.String
FP_FIRST_ARROW_DISABLED_IMAGE
Deprecated.static java.lang.String
FP_FIRST_ARROW_IMAGE
Deprecated.static java.lang.String
FP_LAST_ARROW_DISABLED_IMAGE
Deprecated.static java.lang.String
FP_LAST_ARROW_IMAGE
Deprecated.static java.lang.String
FP_LEFT_ARROW_DISABLED_IMAGE
Deprecated.static java.lang.String
FP_LEFT_ARROW_IMAGE
Deprecated.static java.lang.String
FP_RIGHT_ARROW_DISABLED_IMAGE
Deprecated.static java.lang.String
FP_RIGHT_ARROW_IMAGE
Deprecated.static java.lang.String
FP_SELECT_IMAGE
Deprecated.Constant specifying the name of the formal parameter for defining the select image.static java.lang.String
FP_TABLE_WIDTH_IN_PIXELS
Deprecated.Constant specifying the name of the formal parameter for defining the width in pixels of the table where the folder contents will be displayed.FormalParameter
imgFirstArrow
Deprecated.FormalParameter
imgFirstArrowDisabled
Deprecated.FormalParameter
imgLastArrow
Deprecated.FormalParameter
imgLastArrowDisabled
Deprecated.FormalParameter
imgLeftArrow
Deprecated.FormalParameter
imgLeftArrowDisabled
Deprecated.FormalParameter
imgRightArrow
Deprecated.FormalParameter
imgRightArrowDisabled
Deprecated.FormalParameter
selectImage
Deprecated.Indicates the image to use when displaying a select box, for options like subscriptions and edit.FormalParameter
tableWidthInPixels
Deprecated.Indicates the width in pixels the table to render with the folder contents will have.-
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 FolderListTransform()
Deprecated.Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getDescription()
Deprecated.Return description for this Transform.WebEvent
getExportEvent(WebObjectInfo object)
Deprecated.Overwrites the parent method by assigning a target to the event, corresponding to the user preference on where the export result should be displayedWebEvent
getPDFExportEvent(WebObjectInfo object)
Deprecated.Overwrites the parent method by assigning a target to the event, corresponding to the user preference on where the export result should be displayedvoid
initializeImages()
Deprecated.Initializes the name of the images to use on this transform's output.void
renderDeleteInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out delete information for a single object, as a link based on the event generated by thegetDeleteEvent()
method and the user privileges, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.void
renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out description information for a single object.void
renderEditInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out edit information for a single object, as a link based on the event generated by thegetEditEvent()
method and the user privileges, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.void
renderExport(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out information for exporting a single object, as a link based on the event generated by thegetExportEvent()
method and the user privileges, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.void
renderHeaders(MarkupOutput out)
Deprecated.Writes the table header for the list view display if they have been requested by the user when specifying the levelFlag formal parameter.void
renderIconInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out the image information for a single object.void
renderItems(MarkupOutput out)
Deprecated.Renders the contents of the foldervoid
renderList(MarkupOutput out, WebDisplayUnits list)
Deprecated.Renders the list of objects contained in the folder as an HTML TABLE.void
renderList(MarkupOutput out, WebDisplayUnits list, java.lang.String summary)
Deprecated.Renders the list of objects contained in the folder as an HTML TABLE.void
renderLocationInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out the location information for a single object, by using theObjectPathTransform
transform, including the ancestors of the specified object.void
renderModifiedInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out modified time information for a single object.void
renderNameInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out name information for a single object.void
renderObject(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out information for a single object, depending on the levelFlag formal parameter which specifies which details are to be rendered.void
renderOwnerInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out owner information for a single object.void
renderPDFExport(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out information for exporting to PDF a single object, as a link based on the event generated by thegetPDFExportEvent()
method and the user privileges, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.void
renderSendNowInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out narrocast send now information for a single object, as a link based on the event generated by thegetSendNowEvent()
method, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.void
renderSubscriptionInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out subscription information for a single object, as a link based on the event generated by thegetSubscriptionsEvent()
method and the user privileges, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.-
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, 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
-
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
-
selectImage
public FormalParameter selectImage
Deprecated.Indicates the image to use when displaying a select box, for options like subscriptions and edit.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
imgFirstArrow
@Deprecated public FormalParameter imgFirstArrow
Deprecated.Indicates the image to use when displaying the incremental fetch arrow for going to the first set of pages.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
imgFirstArrowDisabled
@Deprecated public FormalParameter imgFirstArrowDisabled
Deprecated.Indicates the image to use when displaying the disabled incremental fetch arrow for going to the first set of pages.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
imgLeftArrow
@Deprecated public FormalParameter imgLeftArrow
Deprecated.Indicates the image to use when displaying the incremental fetch arrow for going to the previous set of pages.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
imgLeftArrowDisabled
@Deprecated public FormalParameter imgLeftArrowDisabled
Deprecated.Indicates the image to use when displaying the disabled incremental fetch arrow for going to the previous set of pages.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
imgRightArrow
@Deprecated public FormalParameter imgRightArrow
Deprecated.Indicates the image to use when displaying the incremental fetch arrow for going to the next set of pages.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
imgRightArrowDisabled
@Deprecated public FormalParameter imgRightArrowDisabled
Deprecated.Indicates the image to use when displaying the disabled incremental fetch arrow for going to the next set of pages.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
imgLastArrow
@Deprecated public FormalParameter imgLastArrow
Deprecated.Indicates the image to use when displaying the incremental fetch arrow for going to the last set of pages.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
imgLastArrowDisabled
@Deprecated public FormalParameter imgLastArrowDisabled
Deprecated.Indicates the image to use when displaying the disabled incremental fetch arrow for going to the last set of pages.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
tableWidthInPixels
public FormalParameter tableWidthInPixels
Deprecated.Indicates the width in pixels the table to render with the folder contents will have.
If no value is specified, or if the default value 0 is assigned, the width will be relative to the context where the table is inserted.
-
FP_SELECT_IMAGE
public static final java.lang.String FP_SELECT_IMAGE
Deprecated.Constant specifying the name of the formal parameter for defining the select image. Value is selectImage.- See Also:
- Constant Field Values
-
FP_FIRST_ARROW_IMAGE
@Deprecated public static final java.lang.String FP_FIRST_ARROW_IMAGE
Deprecated.Constant specifying the name of the formal parameter for defining the first arrow image. Value is imgFirstArrow.- See Also:
- Constant Field Values
-
FP_FIRST_ARROW_DISABLED_IMAGE
@Deprecated public static final java.lang.String FP_FIRST_ARROW_DISABLED_IMAGE
Deprecated.Constant specifying the name of the formal parameter for defining the disabled first arrow image. Value is imgFirstArrowDisabled.- See Also:
- Constant Field Values
-
FP_LAST_ARROW_IMAGE
@Deprecated public static final java.lang.String FP_LAST_ARROW_IMAGE
Deprecated.Constant specifying the name of the formal parameter for defining the last arrow image. Value is imgLastArrow.- See Also:
- Constant Field Values
-
FP_LAST_ARROW_DISABLED_IMAGE
@Deprecated public static final java.lang.String FP_LAST_ARROW_DISABLED_IMAGE
Deprecated.Constant specifying the name of the formal parameter for defining the disabled last arrow image. Value is imgLastArrowDisabled.- See Also:
- Constant Field Values
-
FP_LEFT_ARROW_IMAGE
@Deprecated public static final java.lang.String FP_LEFT_ARROW_IMAGE
Deprecated.Constant specifying the name of the formal parameter for defining the left arrow image. Value is imgLeftArrow.- See Also:
- Constant Field Values
-
FP_LEFT_ARROW_DISABLED_IMAGE
@Deprecated public static final java.lang.String FP_LEFT_ARROW_DISABLED_IMAGE
Deprecated.Constant specifying the name of the formal parameter for defining the disabled left arrow image. Value is imgLeftArrowDisabled.- See Also:
- Constant Field Values
-
FP_RIGHT_ARROW_IMAGE
@Deprecated public static final java.lang.String FP_RIGHT_ARROW_IMAGE
Deprecated.Constant specifying the name of the formal parameter for defining the rigth arrow image. Value is imgRightArrow.- See Also:
- Constant Field Values
-
FP_RIGHT_ARROW_DISABLED_IMAGE
@Deprecated public static final java.lang.String FP_RIGHT_ARROW_DISABLED_IMAGE
Deprecated.Constant specifying the name of the formal parameter for defining the disabled right arrow image. Value is imgRightArrowDisabled.- See Also:
- Constant Field Values
-
FP_TABLE_WIDTH_IN_PIXELS
public static final java.lang.String FP_TABLE_WIDTH_IN_PIXELS
Deprecated.Constant specifying the name of the formal parameter for defining the width in pixels of the table where the folder contents will be displayed. Value is tableWidthInPixes.- See Also:
- Constant Field Values
-
-
Method Detail
-
initializeImages
public void initializeImages()
Deprecated.Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.- Overrides:
initializeImages
in classAbstractFolderTransform
-
renderList
public void renderList(MarkupOutput out, WebDisplayUnits list, java.lang.String summary)
Deprecated.Renders the list of objects contained in the folder as an HTML TABLE. The header and each one of the objects inside the folder will be displayed as a row of the main table.- Parameters:
out
-MarkupOutput
instance with the output by this transoformlist
-WebDisplayUnits
list with the objects to rendersummary
- aString
with a custom Summary attribute to add to the HTML table to generate
-
renderItems
public void renderItems(MarkupOutput out)
Deprecated.Renders the contents of the folder- Parameters:
out
-MarkupOutput
instance where the HTML content to display will be saved.- Since:
- MicroStrategy Web 8.0.0
-
renderList
public void renderList(MarkupOutput out, WebDisplayUnits list)
Deprecated.Renders the list of objects contained in the folder as an HTML TABLE. The header and each one of the objects inside the folder will be displayed as a row of the main table.
No Summary attribute will be added to the main table unless the user has selected Accessibility Mode from Preferences, in which case the localized string for This table displays the requested folder contents will be used by default.- Specified by:
renderList
in classAbstractFolderTransform
- Parameters:
out
-MarkupOutput
instance with the output by this transformlist
-WebDisplayUnits
list with the objects to render
-
renderHeaders
public void renderHeaders(MarkupOutput out)
Deprecated.Writes the table header for the list view display if they have been requested by the user when specifying the levelFlag formal parameter. The contents will be inside an HTML TR tag created by this method, and it will add the required cells depending on the headers indicated on the formal parameter.
This method requires an HTML TABLE tag to be opened beforehand. By default, therenderList()
method takes care of this.- Parameters:
out
-MarkupOutput
instance which includes the HTML for the header of the table to be used on the transform
-
renderObject
public void renderObject(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out information for a single object, depending on the levelFlag formal parameter which specifies which details are to be rendered.
This method renders its contents as part of an HTML TR tag, therefore it is required that the parent TABLE is opened first. By default, therenderList()
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)
Deprecated.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 thegetEvent()
method, is available.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- 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)
Deprecated.Write out name information for a single object.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- 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)
Deprecated.Write out description information for a single object.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- 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)
Deprecated.Write out owner information for a single object.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- 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)
Deprecated.Write out modified time information for a single object.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- Overrides:
renderModifiedInfo
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderLocationInfo
public void renderLocationInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out the location information for a single object, by using theObjectPathTransform
transform, including the ancestors of the specified object.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- Overrides:
renderLocationInfo
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)
Deprecated.Write out subscription information for a single object, as a link based on the event generated by thegetSubscriptionsEvent()
method and the user privileges, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderSendNowInfo
public void renderSendNowInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out narrocast send now information for a single object, as a link based on the event generated by thegetSendNowEvent()
method, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderDeleteInfo
public void renderDeleteInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out delete information for a single object, as a link based on the event generated by thegetDeleteEvent()
method and the user privileges, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderEditInfo
public void renderEditInfo(MarkupOutput out, WebObjectInfo object)
Deprecated.Write out edit information for a single object, as a link based on the event generated by thegetEditEvent()
method and the user privileges, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
getExportEvent
public WebEvent getExportEvent(WebObjectInfo object)
Deprecated.Overwrites the parent method by assigning a target to the event, corresponding to the user preference on where the export result should be displayed- 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)
Deprecated.Write out information for exporting a single object, as a link based on the event generated by thegetExportEvent()
method and the user privileges, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
getPDFExportEvent
public WebEvent getPDFExportEvent(WebObjectInfo object)
Deprecated.Overwrites the parent method by assigning a target to the event, corresponding to the user preference on where the export result should be displayed- 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)
Deprecated.Write out information for exporting to PDF a single object, as a link based on the event generated by thegetPDFExportEvent()
method and the user privileges, in a form of an image which source is specified by the user in theFP_SELECT_IMAGE
formal parameter.
The HTML contents this method generates are inside an HTML TD tag, therefore it is required that the corresponding TABLE and TR parents are opened first. By default,renderList()
andrenderObject()
take care of it.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
getDescription
public java.lang.String getDescription()
Deprecated.Return description for this Transform.- Returns:
String
with the description for the transform.
-
-