Package com.microstrategy.web.app.transforms

Class FolderSaveAsBrowserTransform

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

com.microstrategy.web.app.transforms.FolderProjectBrowserTransform

com.microstrategy.web.app.transforms.FolderSaveAsBrowserTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

FolderOMDBrowserTransform

public class FolderSaveAsBrowserTransform
extends FolderProjectBrowserTransform

Since:

MicroStrategy Web 8.0.1

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	createFolderJS	Formal parameter: The JavaScript code to execute when clicking on the create Folder Button
FormalParameter	filterContextID	Formal parameter: The folderlinks context id for the save as filter tab
static java.lang.String	FP_CREATE_FOLDER_JS	Name for the formal parameter: createFolderJS
static java.lang.String	FP_FILTER_CONTEXT_ID	Name for the formal parameter: filterContextID
static java.lang.String	FP_SHOW_CREATE_FOLDER_BUTTON	Constant for the name of the showCreateFolderButton Formal Parameter.
static java.lang.String	FP_SHOW_CREATE_FOLDER_DIAOLOG	Constant for the name of the showCreateFolderDialog Formal Parameter.
static java.lang.String	FP_TEMPLATE_CONTEXT_ID	Name for the formal parameter: templateContextID
FormalParameter	showCreateFolderButton	Indicates if the create folder toggle button is to be shown or not.
FormalParameter	showCreateFolderDialog	Indicates if the create new folder dialog is to be shown or not.
FormalParameter	templateContextID	Formal parameter: The folderlinks context id for the save as filter tab

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

allowBrowseDimension, checkImage, contextID, cssBody, cssFileSearch, folderLinksLocation, FP_ALLOW_BROWSE_DIMENSION, FP_CHECK_IMAGE, FP_CONTEXT_ID, FP_FOLDER_LINKS_LOCATION, FP_HTML_GRAPHIC_MODE, FP_LEVEL_CHANGE_JS, FP_RENDER_FORM, FP_RENDER_LINKS_ANCESTORS, FP_SEARCH_BOX_JS, FP_SEARCH_JS, FP_UP_FOLDER_JS, htmlGraphicMode, levelChangeJS, renderForm, renderLinksAncestors, searchBoxJS, searchJS, sSpaces, upFolderJS

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

folderJS, FP_FOLDER_JS, FP_OBJECT_CLICK_JS, objectClickJS

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
FolderSaveAsBrowserTransform()	Default Constructor.

Method Summary

Modifier and Type	Method	Description
int	getFodlerLinksContextId()	Deprecated. please use getFolderLinksContextId() instead
int	getFolderLinksContextId()	Returns the context id (from EnumObjectBrowserContexts) to use
void	renderBrowserContent(MarkupOutput out)	Renders the Project Browser's elements based on the information provided by the fodler bean.
void	renderCreateFolderButton(MarkupOutput out)	Renders the button that opens the create folder dialog

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

generateAnchor, getBrowseEvent, getBrowseParentFolderEvent, getDescription, getEvent, getFolderContentsSelectNameHTML, getFolderLinkClasses, getFolderLinkList, getFolderObjects, getFolderRoot, getForm, getHiddenInputsEventList, getJavascriptTyAttribute, getLinkAttributes, getNonFolderObjects, getObjectName, getProjectID, getSearchEvent, getSubfolders, getSubFolders, getTooltipInfo, getTooltipTitle, initializeCss, initializeImages, initializeTransform, isFolder, isNamedFolder, renderAncestorsSelector, renderBrowser, renderClearSearch, renderFolderContentHTML, renderFolderContentsHTML, renderFolderContentsSubmitButtonHTML, renderFolderContentsTitleHTML, renderFolderLink, renderFolderLinkOptions, renderFolderLinks, renderFolderObjects, renderFoldersHTML, renderFoldersSubmitButtonHTML, renderFoldersTitleHTML, renderHiddenInputs, renderLayeredIconInfo, renderList, renderListHTML, renderNameInfo, renderObjectName, renderOpenParentLink, renderSearchBox, renderSearchButton, renderSearchSection, renderSubfolders, setFolderRoot, setUpFolderJS, shouldRenderFolderLinks, transformForRequestSuccessful

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

getContainerAttributes, getObjectAttributes, postAnchorGenerated, renderLayeredIconInfo, renderList, renderObject, setObjectClickJS

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, getExportEvent, getExportEvent, getFeatures, getFlashExportEvent, getFolderBean, getFolderChildCount, getGoToArgument, getGoToEvent, getHtmlExportEvent, getImageName, getImageSrc, getListComparator, getMstrExportEvent, getOringalChildCount, getPDFExportEvent, getSendNowEvent, getSortedChildUnits, getSortedList, getSubscriptionsEvent, getSupportedBeanType, getViewMediaReportEvent, getViewMediaRWEvent, initializeSelectedItemsList, isEmptyList, isFeatureAvailable, isFolderEmpty, isObjectRunableinPauseMode, isObjectSelected, isObjectVisible, isViewableReport, newContext, renderEmptyList, renderEmptyList, renderImage, renderJavaScript, renderObjectCount, setBoneProperties

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

addCSSForObjectType, getCssName, getDereferenceShortcuts, getImageTooltip, getIncrementalFetchComponent, getListItemAttributes, getNameWrapperTag, getObjectAbbreviation, getObjectDescription, getObjectModificationTime, getOwnerName, getPathTransform, getVisualizationMode, getVisualizationMode, isUserEnabled, isVisualizationObject, isVisualizationObject, renderAbbreviationInfo, renderAbbreviationInfo, renderDescriptionInfo, renderDescriptionInfo, renderIconInfo, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, 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, 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, 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

createFolderJS

public FormalParameter createFolderJS

Formal parameter: The JavaScript code to execute when clicking on the create Folder Button

filterContextID

public FormalParameter filterContextID

Formal parameter: The folderlinks context id for the save as filter tab

templateContextID

public FormalParameter templateContextID

Formal parameter: The folderlinks context id for the save as filter tab

showCreateFolderButton

public FormalParameter showCreateFolderButton

Indicates if the create folder toggle button is to be shown or not. The value can true or false. If the value is false, the button to open the create folder dialog will not be shown. If the value is set to false and the value of the showCreateFolderDialog formal parameter is set to true, the create folder dialog will always be shown open on the save page. This formal parameter is applicaable only in DHTML mode as in HTML mode the create fodler dialog is always open.

showCreateFolderDialog

public FormalParameter showCreateFolderDialog

Indicates if the create new folder dialog is to be shown or not. The value can true or false. If the value is false, then the user will never be able to see the create new folder dialog and he will never see the toggle button used to open the create folder dialog either.

FP_CREATE_FOLDER_JS

public static final java.lang.String FP_CREATE_FOLDER_JS

Name for the formal parameter: createFolderJS

See Also:

Constant Field Values

FP_SHOW_CREATE_FOLDER_BUTTON

public static final java.lang.String FP_SHOW_CREATE_FOLDER_BUTTON

Constant for the name of the showCreateFolderButton Formal Parameter.

See Also:

showCreateFolderButton, Constant Field Values

FP_SHOW_CREATE_FOLDER_DIAOLOG

public static final java.lang.String FP_SHOW_CREATE_FOLDER_DIAOLOG

Constant for the name of the showCreateFolderDialog Formal Parameter.

See Also:

showCreateFolderDialog, Constant Field Values

FP_FILTER_CONTEXT_ID

public static final java.lang.String FP_FILTER_CONTEXT_ID

Name for the formal parameter: filterContextID

See Also:

Constant Field Values

FP_TEMPLATE_CONTEXT_ID

public static final java.lang.String FP_TEMPLATE_CONTEXT_ID

Name for the formal parameter: templateContextID

See Also:

Constant Field Values

Constructor Detail

FolderSaveAsBrowserTransform

public FolderSaveAsBrowserTransform()

Default Constructor. Initializes the formal parameters contextID, levelChangeJS, searchJS and renderForm.

Method Detail

renderCreateFolderButton

public void renderCreateFolderButton(MarkupOutput out)

Renders the button that opens the create folder dialog

Parameters:

out - MarkupOutput

renderBrowserContent

public void renderBrowserContent(MarkupOutput out)
                          throws WebObjectsException,
                                 WebBeanException

Renders the Project Browser's elements based on the information provided by the fodler bean. This method is called by the renderBrowser method.

Overrides:

renderBrowserContent in class FolderProjectBrowserTransform

Parameters:

out - MarkupOutput

Throws:

WebObjectsException

WebBeanException

getFodlerLinksContextId

public int getFodlerLinksContextId()

Deprecated.

please use getFolderLinksContextId() instead

Returns the context id (from EnumObjectBrowserContexts) to use

Overrides:

getFodlerLinksContextId in class FolderProjectBrowserTransform

Returns:

int

getFolderLinksContextId

public int getFolderLinksContextId()

Returns the context id (from EnumObjectBrowserContexts) to use

Overrides:

getFolderLinksContextId in class FolderProjectBrowserTransform

Returns:

int

Since:

MicroStrategy Web 9.0.0