Package com.microstrategy.web.app.transforms

Class FolderCreateDocumentTransform

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

com.microstrategy.web.app.transforms.FolderCreateReportXHTMLTransform

com.microstrategy.web.app.transforms.FolderCreateDocumentTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

FolderSummaryCreateDocumentTransform

public class FolderCreateDocumentTransform
extends FolderCreateReportXHTMLTransform

This class extends the FolderCreateReportXHTMLTransform by specializing in showing the new document folder content. It has two sections, showing the blank document on top, and on the bottom the rest of the items on the folder.

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 inherited from class com.microstrategy.web.app.transforms.FolderCreateReportXHTMLTransform

_blankObject, _blankObjectDesc, _blankObjectHeaderDesc, _blankViewReport, _templateHeaderDesc, blankObjectId, blankViewReportId, blankXdaObjectId, displaySection, FP_BLANK_REPORT_ID, FP_BLANK_VIEW_REPORT_ID, FP_BLANK_XDA_REPORT_ID, promptCreateStyle, promptExecuteStyle, promptStyle, valueDesignModeCheck

Fields inherited from class com.microstrategy.web.app.transforms.FolderIconRadioButtonTransform

FP_IMG_ANCHOR_JS_FLAG, FP_LABEL_ANCHOR_JS_FLAG, FP_RENDER_FORM_TAG, imgAnchorJS, labelAnchorJS, renderFormTag

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

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getArgumentName(WebEvent event, int argumentID)	For the given event, returns the name of the argument with the given ID.
protected WebEvent	getOpenObjectEvent()	Overwrites the original method for returning the EnumServletEvents.WebEventEditRW event instead.
boolean	hasCreateBlankObjectPrivileges()	Determines if the user has enough privileges for viewing the blank report option with this transform
boolean	hasCreateReportPrivileges()	This method will check Document Design and Document Run i.e. document execution privilege We are overwriting hasCreateReportPrivileges from base class.
void	initializeTransform(Transformable data)	Extends the parent method by searching for the blank report within the content of the folder, as specified on the FolderCreateReportXHTMLTransform.blankObjectId formal parameter.
boolean	isEmptyList()	Returns true if the list of elements from this folder available for display (AbstractFolderTransform.getSortedList()) is empty or not.
boolean	isEmptyList(WebDisplayUnits list)	Deprecated. please use isEmptyList() instead, where the list to be analyzed is the one obtained from AbstractFolderTransform.getSortedChildUnits().
void	renderButtonOptions(MarkupOutput out)	Overwrites the original method.
void	renderDashboardObject(MarkupOutput out, WebObjectInfo object)
protected void	renderDesignModeOption(MarkupOutput out, WebEvent createEvent, boolean designMode)	Render a check box giving the option to have the object selected run in design mode.
protected void	renderFormInputInfo(MarkupOutput out, WebEvent openEvent)	Render any hidden input information that has to be added while displaying the contents in the folder, according with the WebEvent specified.
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.FolderCreateReportXHTMLTransform

generateRadioButtonForObject, getCssName, getObjectDescription, getObjectName, hasCreateViewReportPrivileges, hasCreateXdaReportPrivileges, isDesignModeOptionChecked, isObjectVisible, renderBlankObject, renderIconInfo, renderList, renderNameInfo, renderTemplateList, renderTemplateList, setBoneProperties

Methods inherited from class com.microstrategy.web.app.transforms.FolderIconRadioButtonTransform

generateAnchor, getDescription, renderDescriptionInfo, renderItems, renderNextButton, renderObjectDescription, renderObjectImage, renderObjectName, transformForRequestSuccessful, wereItemsRendered

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, isFeatureAvailable, isFolderEmpty, isObjectRunableinPauseMode, isObjectSelected, isViewableReport, newContext, renderEmptyList, renderEmptyList, renderImage, renderJavaScript, renderList, renderObjectCount

Methods inherited from class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform

addCSSForObjectType, getDereferenceShortcuts, getImageTooltip, getIncrementalFetchComponent, getListItemAttributes, getNameWrapperTag, getObjectAbbreviation, getObjectModificationTime, getOwnerName, getPathTransform, getVisualizationMode, getVisualizationMode, isUserEnabled, isVisualizationObject, isVisualizationObject, renderAbbreviationInfo, renderAbbreviationInfo, renderDescriptionInfo, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, renderLayeredIconInfo, 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, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, 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

Constructor Detail

FolderCreateDocumentTransform

public FolderCreateDocumentTransform()

Default no-argument constructor. Initializes formal parameters.

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Extends the parent method by searching for the blank report within the content of the folder, as specified on the FolderCreateReportXHTMLTransform.blankObjectId formal parameter.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class FolderCreateReportXHTMLTransform

Parameters:

data - Transformable instance with the bean to be transformed.

renderFormInputInfo

protected void renderFormInputInfo(MarkupOutput out,
                                   WebEvent openEvent)

Render any hidden input information that has to be added while displaying the contents in the folder, according with the WebEvent specified. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.

Overrides:

renderFormInputInfo in class FolderIconRadioButtonTransform

Parameters:

out - MarkupOutput where the HTML output will be saved

openEvent - WebEvent representing the action to do with the given object

hasCreateBlankObjectPrivileges

public boolean hasCreateBlankObjectPrivileges()

Determines if the user has enough privileges for viewing the blank report option with this transform

Overrides:

hasCreateBlankObjectPrivileges in class FolderCreateReportXHTMLTransform

Returns:

boolean value indicating if the blank object should be available to the user or not.

hasCreateReportPrivileges

public boolean hasCreateReportPrivileges()

This method will check Document Design and Document Run i.e. document execution privilege We are overwriting hasCreateReportPrivileges from base class. In base class it checks for create report privilege But for document we need to check WebFeatureDocumentDesignMode and WebFeatureRWDocumentExecution -- DE161946

Overrides:

hasCreateReportPrivileges in class FolderCreateReportXHTMLTransform

Returns:

boolean value indicating if the blank view report should be available to the user.

isEmptyList

public boolean isEmptyList()

Description copied from class: AbstractFolderTransform

Returns true if the list of elements from this folder available for display (AbstractFolderTransform.getSortedList()) is empty or not.

Overrides:

isEmptyList in class FolderCreateReportXHTMLTransform

Returns:

true if the underlying object list is empty.

Since:

MicroStrategy Web 9.0.0

isEmptyList

@Deprecated
public boolean isEmptyList(WebDisplayUnits list)

Deprecated.

please use isEmptyList() instead, where the list to be analyzed is the one obtained from AbstractFolderTransform.getSortedChildUnits().

Indicates if there will be objects to display from the instance sent in as parameter. The check by default is the count of document objects included on the list.

Overrides:

isEmptyList in class FolderCreateReportXHTMLTransform

Parameters:

list - WebDisplayUnits list instance initialized with the objects to render

Returns:

boolean value indicating if there are objects to be displayed out of this list.

getOpenObjectEvent

protected WebEvent getOpenObjectEvent()

Overwrites the original method for returning the EnumServletEvents.WebEventEditRW event instead.

Overrides:

getOpenObjectEvent in class FolderCreateReportXHTMLTransform

Returns:

a WebEvent instance intialized if the application supports it. Otherwise, returns null

renderButtonOptions

public void renderButtonOptions(MarkupOutput out)

Overwrites the original method. By default the option available is to run the object in design mode.

Overrides:

renderButtonOptions in class FolderCreateReportXHTMLTransform

Parameters:

out - MarkupOutput where the HTML output will be saved

renderDesignModeOption

protected void renderDesignModeOption(MarkupOutput out,
                                      WebEvent createEvent,
                                      boolean designMode)

Render a check box giving the option to have the object selected run in design mode. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.

Overrides:

renderDesignModeOption in class FolderCreateReportXHTMLTransform

Parameters:

out - MarkupOutput where the HTML output will be saved

createEvent - WebEvent representing the action to do with the given object

designMode - boolean indicating if design mode is selected.

getArgumentName

protected java.lang.String getArgumentName(WebEvent event,
                                           int argumentID)

For the given event, returns the name of the argument with the given ID. When overriding an specific getEvent method, clients can override this method as well to provide the corresponding argument for the new event. Since the getOpenObjectEvent() method was redefined, this method is also updated for returning the correct object identifier argument from it.

Overrides:

getArgumentName in class FolderCreateReportXHTMLTransform

Parameters:

event - WebEvent from which retrieve the argument

argumentID - argument Id from where to get its name.

Returns:

the argument name as defined by the event.

renderObject

public void renderObject(MarkupOutput out,
                         WebObjectInfo object)

Description copied from class: FolderIconRadioButtonTransform

Renders the WebObjectInfo object requested according to the specifications of this transform.
Builds a series of DIV tags where the information coming from the FolderIconRadioButtonTransform.renderObjectImage(com.microstrategy.web.beans.MarkupOutput, com.microstrategy.web.objects.WebObjectInfo), FolderIconRadioButtonTransform.renderObjectName(com.microstrategy.web.beans.MarkupOutput, com.microstrategy.web.objects.WebObjectInfo) and FolderIconRadioButtonTransform.renderObjectDescription(com.microstrategy.web.beans.MarkupOutput, com.microstrategy.web.objects.WebObjectInfo) methods generate.

Overrides:

renderObject in class FolderIconRadioButtonTransform

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

Since:

MicroStrategy Web 9.0.0

renderDashboardObject

public void renderDashboardObject(MarkupOutput out,
                                  WebObjectInfo object)

Since:

MicroStrategy Web 9.0.0