Package com.microstrategy.web.app.transforms

Class AllObjectBrowserHTMLTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractEditorTransform

com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform

com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform

com.microstrategy.web.app.transforms.FolderObjectExplorerTransform

com.microstrategy.web.app.transforms.AllObjectBrowserTransform

com.microstrategy.web.app.transforms.AllObjectBrowserHTMLTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class AllObjectBrowserHTMLTransform
extends AllObjectBrowserTransform

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AllObjectBrowserTransform

AllObjectBrowserTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	sSpaces

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

promptString, promptStringID

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

INCREMENTAL_FETCH_NEXT, INCREMENTAL_FETCH_PREVIOUS, populateChildren, tree

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

_imgCheck, _oeBean, checkImage, displayFormatPickerName, FP_CHECK_IMAGE, FP_DISPLAY_FORMAT_PICKER_NAME, FP_INCREMENTAL_FETCH_NAV_TYPE, FP_INCREMENTAL_FETCH_PAGE_BLOCK, FP_SHOW_CURRENT_IN_ANCESTORS_LIST, ID_POSTFIX, incrementalFetchNavigationType, incrementalFetchPageBlock, showCurrentInAncestorsList

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

_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_INCLUDE_DYNAMIC_SCRIPT, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID

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
AllObjectBrowserHTMLTransform()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getFolderContentsSelectNameHTML()	returns the name the select box for folder contentss in HTML will have
protected java.util.ArrayList	getHiddenInputsEventList()	Returns the list of events that will be included in the hidden inputs section.
protected WebEvent	getModifyFilterEvent()	Returns a WebEvent instance containing the event to use when adding an element to the filter.
protected WebEvent	getModifyGridEvent()	Returns a WebEvent instance containing the event to use when adding unit to the grid.
protected java.lang.String	getObjectInfoParameter(WebObjectInfo woi)	Outputs a string formatted the way the objectInfo argument of the event requires it
protected boolean	isTargetingFilter()
void	renderFolderContentHTML(MarkupOutput out, WebObjectInfo woi)	Renders a single non-folder content item from the current folder in HTML mode
void	renderFolderContentsHTML(MarkupOutput out)	Renders the current folder's non-folder contents title when in HTML mode
void	renderFolderContentsSubmitButtonHTML(MarkupOutput out)	Renders the submit button for the folde's non-folder contents section in HTML mode
void	renderFolderContentsTitleHTML(MarkupOutput out)	Renders the current folder's non-folder contents title when in HTML mode
void	renderFolderLinkOptions(MarkupOutput out)	Renders a set of options for a select input containing the different object browser forlder links available for the current context.
void	renderFoldersHTML(MarkupOutput out)	Renders the current folder's subfolders when in HTML mode
void	renderFoldersSubmitButtonHTML(MarkupOutput out)	Renders the submit button for the folde's subfolders section in HTML mode
void	renderFoldersTitleHTML(MarkupOutput out)	Renders the current folder's subfolders title when in HTML mode
void	renderListHTML(MarkupOutput out)	Renders the current folder's content in HTML mode
void	renderOpenParent(MarkupOutput out)	Renders the upFolder button for the Object Browser.
protected boolean	shouldGenerateNewForm()

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

constructEntireTree, getAncestorsOptionTags, getAncestorsSelectTag, getBrowseUnitAnchor, getChangeDisplayFormatEvent, getContext, getContextMenu, getContextMenuAttributes, getDescription, getJavascriptTyAttribute, getSearchBox, initializeTransform, isDimension, isRenderAsTree, isStartingFolder, newContext, newTreeNode, newTreeNodeLink, renderDisplayFormatIcon, renderJavascript, renderUnit, shouldAddLinks, shouldDisplayObject

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

addLinksAsOption, generateIncrementalFetchNode, generateIncrementalFetchNode, generateSearchNode, getCssName, getFolderRoot, getLinkAttributes, getLinkCssName, getList, getReportViewMode, getSupportedBeanType, getTooltipInfo, getTooltipTitle, getUnitAttributes, getUnitName, getVisualizationMode, getVisualizationMode, isFolder, isTreeRoot, isVisualizationObject, isVisualizationObject, renderLayeredIconInfo, renderPromptString, shouldRenderFolderLinks, shouldRenderLinks

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

addLinks, createNewNode, isRenderEntireTree, populateTreeNodes, populateWithChildren, renderEditorContents, renderTree

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

addAncestorsOptionsToSelectTag, addCurrentFolderToAncestorList, addOpenParentImg, addOpenParentImg, getBlockPosition, getBlockSize, getBrowseEvent, getChildCount, getExplorerClientSideHelper, getExplorerScriptClass, getForm, getGoToArgument, getID, getIncrementalFetchComponent, getOKEvent, getOpenParentEvent, getOption, getSearchButton, getSearchEvent, getUnitAnchor, getUnitDesc, initializeImages, isUseOptionTitle, renderAncestors, renderChangeFormatDropDown, renderDisplayFormatPickers, renderErrorMessage, renderHiddenInputs, renderIncrementalFetch, renderLayeredIconInfo, renderObjectCount, renderSearch, renderSearchBox, renderSearchButton, renderSearchEventArgs, setUseOptionTitle, shouldDisplayErrorMessage, shouldShowDummyFolderOption

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

generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, initHelp, renderEditor, renderEditorElement, setFocusFieldId, transformForRequestInError, transformForRequestSuccessful

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, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, 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, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

sSpaces

protected static final java.lang.String sSpaces

See Also:

Constant Field Values

Constructor Detail

AllObjectBrowserHTMLTransform

public AllObjectBrowserHTMLTransform()

Method Detail

renderOpenParent

public void renderOpenParent(MarkupOutput out)

Description copied from class: AllObjectBrowserTransform

Renders the upFolder button for the Object Browser.

Overrides:

renderOpenParent in class AllObjectBrowserTransform

Parameters:

out - MarkupOutput

renderListHTML

public void renderListHTML(MarkupOutput out)
                    throws java.lang.IndexOutOfBoundsException,
                           WebObjectsException,
                           WebBeanException,
                           UnmodifiableException

Renders the current folder's content in HTML mode

Parameters:

out - MarkupOutput instance where the HTML output is to be saved.

Throws:

WebObjectsException

WebBeanException

java.lang.IndexOutOfBoundsException

UnmodifiableException

renderFoldersTitleHTML

public void renderFoldersTitleHTML(MarkupOutput out)

Renders the current folder's subfolders title when in HTML mode

Parameters:

out - MarkupOutput instance where the HTML output is to be saved.

renderFoldersSubmitButtonHTML

public void renderFoldersSubmitButtonHTML(MarkupOutput out)

Renders the submit button for the folde's subfolders section in HTML mode

Parameters:

out - MarkupOutput instance where the HTML output is to be saved.

renderFoldersHTML

public void renderFoldersHTML(MarkupOutput out)
                       throws WebObjectsException,
                              WebBeanException

Renders the current folder's subfolders when in HTML mode

Parameters:

out - MarkupOutput instance where the HTML output is to be saved.

Throws:

WebObjectsException

WebBeanException

renderFolderLinkOptions

public void renderFolderLinkOptions(MarkupOutput out)

Renders a set of options for a select input containing the different object browser forlder links available for the current context.

Parameters:

out - MarkupOutput

renderFolderContentsTitleHTML

public void renderFolderContentsTitleHTML(MarkupOutput out)

Renders the current folder's non-folder contents title when in HTML mode

Parameters:

out - MarkupOutput instance where the HTML output is to be saved.

renderFolderContentsSubmitButtonHTML

public void renderFolderContentsSubmitButtonHTML(MarkupOutput out)

Renders the submit button for the folde's non-folder contents section in HTML mode

Parameters:

out - MarkupOutput instance where the HTML output is to be saved.

renderFolderContentsHTML

public void renderFolderContentsHTML(MarkupOutput out)
                              throws WebObjectsException,
                                     WebBeanException

Renders the current folder's non-folder contents title when in HTML mode

Parameters:

out - MarkupOutput instance where the HTML output is to be saved.

Throws:

WebObjectsException

WebBeanException

renderFolderContentHTML

public void renderFolderContentHTML(MarkupOutput out,
                                    WebObjectInfo woi)

Renders a single non-folder content item from the current folder in HTML mode

Parameters:

out - MarkupOutput

getFolderContentsSelectNameHTML

protected java.lang.String getFolderContentsSelectNameHTML()

returns the name the select box for folder contentss in HTML will have

Returns:

String

getModifyGridEvent

protected WebEvent getModifyGridEvent()

Returns a WebEvent instance containing the event to use when adding unit to the grid.

Returns:

WebEvent

getModifyFilterEvent

protected WebEvent getModifyFilterEvent()

Returns a WebEvent instance containing the event to use when adding an element to the filter.

Returns:

WebEvent

getObjectInfoParameter

protected java.lang.String getObjectInfoParameter(WebObjectInfo woi)

Outputs a string formatted the way the objectInfo argument of the event requires it

Parameters:

woi - WebObjectInfo object

Returns:

a String with the following format: ID|Type|Subtype|Alias|Name or

getHiddenInputsEventList

protected java.util.ArrayList getHiddenInputsEventList()

Returns the list of events that will be included in the hidden inputs section.

Overrides:

getHiddenInputsEventList in class AbstractObjectExplorerTransform

Returns:

ArrayList

isTargetingFilter

protected boolean isTargetingFilter()

shouldGenerateNewForm

protected boolean shouldGenerateNewForm()

Overrides:

shouldGenerateNewForm in class AbstractObjectExplorerTransform