Package com.microstrategy.web.app.transforms

Class FolderDeleteObjectTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class FolderDeleteObjectTransform
extends AbstractFolderTransform

This class renders the object info of the first selected item and shows an HTML Form to have it deleted.

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

Method Summary

Modifier and Type	Method	Description
protected WebEvent	getCancelEvent(WebObjectInfo object)	Returns an initialized WebEvent for being able to cancel the deletion of the WebObjectInfo indicated.
protected WebEvent	getDeleteObjectEvent(WebObjectInfo object)	Returns an initialized WebEvent for being able to delete the WebObjectInfo indicated.
java.lang.String	getDescription()	Returns this transform's description.
java.util.ArrayList	getSelectedObjects()
void	renderButtonBar(MarkupOutput out)	Deprecated. please use renderButtonBar(MarkupOutput out, WebObjectInfo selectedObject)
void	renderButtonBar(MarkupOutput out, WebObjectInfo selectedObject)	Renders the delete form information and buttons for allowing the user to confirm if s/he wants to delete the object or not.
void	renderDeleteConfirmation(MarkupOutput out)	Deprecated. please use renderDeleteConfirmation(MarkupOutput out, WebObjectInfo selectedObject)
void	renderDeleteConfirmation(MarkupOutput out, WebObjectInfo selectedObject)	Renders the delete confirmation question text.
void	renderDeleteForm(MarkupOutput out, WebObjectInfo object)	Deprecated. call renderButtonBar(MarkupOutput out) instead.
void	renderDeleteTitle(MarkupOutput out)	Render the title corresponding to the message this transform will display
void	renderList(MarkupOutput out, WebDisplayUnits list)	Deprecated. please use and customize AbstractFolderTransform.renderList(MarkupOutput out) instead.
void	renderObject(MarkupOutput out)	Deprecated. please use renderObject(MarkupOutput out, WebObjectInfo object)
void	renderObject(MarkupOutput out, WebObjectInfo object)	Renders the object information of the object to delete (internally it uses an ObjectInfoTransform to accomplish this).

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

Constructor Detail

FolderDeleteObjectTransform

public FolderDeleteObjectTransform()

Default no-argument constructor. Initializes formal parameters.

Method Detail

getSelectedObjects

public java.util.ArrayList getSelectedObjects()

Since:

MicroStrategy Web 8.0.1

renderList

public void renderList(MarkupOutput out,
                       WebDisplayUnits list)

Deprecated.

please use and customize AbstractFolderTransform.renderList(MarkupOutput out) instead. This method will not be called by future releases.

Renders the folder contents with the single object that has been selected to be removed, as indicated by the AbstractFolderTransform.isObjectSelected(WebObjectInfo object) method. All the other children not selected will not be rendered.

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 available on the folder, by default these will not be rendered.

renderDeleteTitle

public void renderDeleteTitle(MarkupOutput out)

Render the title corresponding to the message this transform will display

Parameters:

out - MarkupOutput instance where the HTML content to display will be saved.

Since:

MicroStrategy Web 8.0.0

renderDeleteForm

public void renderDeleteForm(MarkupOutput out,
                             WebObjectInfo object)

Deprecated.

call renderButtonBar(MarkupOutput out) instead.

Renders the delete form for asking the user to confirm if s/he wants to delete the object or not.

Parameters:

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

object - WebObjectInfo object marked as the one to be deleted.

renderButtonBar

public void renderButtonBar(MarkupOutput out,
                            WebObjectInfo selectedObject)

Renders the delete form information and buttons for allowing the user to confirm if s/he wants to delete the object or not.

Parameters:

out - MarkupOutput instance where the HTML content to display will be saved.

selectedObject - WebObjectInfo instance to be deleted

Since:

MicroStrategy Web 8.0.1

renderButtonBar

public void renderButtonBar(MarkupOutput out)

Deprecated.

please use renderButtonBar(MarkupOutput out, WebObjectInfo selectedObject)

Renders the delete form information and buttons for allowing the user to confirm if s/he wants to delete the object or not.

Parameters:

out - MarkupOutput instance where the HTML content to display will be saved.

Since:

MicroStrategy Web 8.0.0

renderDeleteConfirmation

public void renderDeleteConfirmation(MarkupOutput out,
                                     WebObjectInfo selectedObject)

Renders the delete confirmation question text.

Parameters:

out - MarkupOutput instance where the HTML content to display will be saved.

selectedObject - WebObjectInfo instance to be deleted

Since:

MicroStrategy Web 8.0.1

renderDeleteConfirmation

public void renderDeleteConfirmation(MarkupOutput out)

Deprecated.

please use renderDeleteConfirmation(MarkupOutput out, WebObjectInfo selectedObject)

Renders the delete confirmation question text.

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)

Deprecated.

please use renderObject(MarkupOutput out, WebObjectInfo object)

Renders the information of the object to be deleted. Internally, calls for the renderObject(MarkupOutput out, WebObjectInfo object) method.

Parameters:

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

Since:

MicroStrategy Web 8.0.0

renderObject

public void renderObject(MarkupOutput out,
                         WebObjectInfo object)

Renders the object information of the object to delete (internally it uses an ObjectInfoTransform to accomplish this).

Overrides:

renderObject in class AbstractObjectInfoListTransform

Parameters:

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

object - WebObjectInfo object marked to be deleted.

getDescription

public java.lang.String getDescription()

Returns this transform's description.

Returns:

description for the transform

getDeleteObjectEvent

protected WebEvent getDeleteObjectEvent(WebObjectInfo object)

Returns an initialized WebEvent for being able to delete the WebObjectInfo indicated.

Parameters:

object - the WebObjectInfo instance which will be deleted if the event is called.

Returns:

an initialized WebEvent object if the application supports it. Otherwise, will return null.

getCancelEvent

protected WebEvent getCancelEvent(WebObjectInfo object)

Returns an initialized WebEvent for being able to cancel the deletion of the WebObjectInfo indicated.

Parameters:

object - the WebObjectInfo instance is intended to be deleted, unless this event gets called.

Returns:

an initialized WebEvent object if the application supports it. Otherwise, will return null.