Package com.microstrategy.web.app.transforms

Class XDADataExplorerTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class XDADataExplorerTransform
extends AbstractObjectExplorerTransform

Since:

MicroStrategy Web 8.0.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	XDADataExplorerTransform.Context	Extends AbstractAppTransform.Context by providing a link to the current WebObjectInfo.

Field Summary

Fields

Modifier and Type	Field	Description
protected FormalParameter	_browseRootParam
protected FormalParameter	_filterObjectType

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

Method Summary

Modifier and Type	Method	Description
protected java.lang.StringBuffer	addAncestorsOptionsToSelectTag(SelectTag tag)	Adds the ancestors option tags to the supplied select tag.
protected SelectTag	getAncestorsSelectTag()	Returns a >select< Tag instance object containing the list\ of the object's ancestors
protected WebEvent	getBrowseEvent()	Returns a new instance of the event use for browsing across objects
protected TransformContext	getContext()	Returns the instance of TransformContext with context information for this Transform.
protected java.lang.String	getCssName(WebDisplayUnit du)	Retruns the css class to use on the container of the object presented in the list of contents.
protected WebEvent	getOpenParentEvent()	Returns a new instance of the event use to go to open the object's parent
protected Tag	getOption(WebDisplayUnit du, java.lang.String indent)	Returns an option Tag containing the display unit provided.
java.lang.Class	getSupportedBeanType()	Get the class of objects this transform is able to handle, which is XDADataExplorerBean.
java.util.Map	getUnitAttributes(WebDisplayUnit du)	Returns a map containing the attributes to add to the container of every object in the list of contents.
protected void	initEditor(Editor editor)	Initializes the editor with the global settings.
void	initializeTransform(Transformable data)	Initializes transform formal parameters
boolean	isHidden(WebDisplayUnit du)
protected TransformContext	newContext()	Creates a new instance of a TransformContext.
void	renderContextMenus(MarkupOutput out)	Renders the context menu context to use in the transform
void	renderOpenParent(MarkupOutput out)	Renders the up folder button if ancestors are present.
void	renderUnit(MarkupOutput out, WebDisplayUnit du)	Returns the give unit in the component's contents list.
protected boolean	shouldShowDummyFolderOption()

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

addCurrentFolderToAncestorList, addOpenParentImg, addOpenParentImg, getAncestorsOptionTags, getBlockPosition, getBlockSize, getChangeDisplayFormatEvent, getChildCount, getDescription, getExplorerClientSideHelper, getExplorerScriptClass, getForm, getGoToArgument, getHiddenInputsEventList, getID, getIncrementalFetchComponent, getOKEvent, getSearchBox, getSearchButton, getSearchEvent, getUnitAnchor, getUnitDesc, getUnitName, initializeImages, isUseOptionTitle, renderAncestors, renderChangeFormatDropDown, renderDisplayFormatPickers, renderEditorContents, renderErrorMessage, renderHiddenInputs, renderIncrementalFetch, renderLayeredIconInfo, renderObjectCount, renderSearch, renderSearchBox, renderSearchButton, renderSearchEventArgs, setUseOptionTitle, shouldDisplayErrorMessage, shouldGenerateNewForm

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

generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initHelp, renderEditor, renderEditorElement, renderJavascript, 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, 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

_browseRootParam

protected FormalParameter _browseRootParam

_filterObjectType

protected FormalParameter _filterObjectType

Constructor Detail

XDADataExplorerTransform

public XDADataExplorerTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Initializes transform formal parameters

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractObjectExplorerTransform

Parameters:

data - Transformable instance to be associated with this transform.

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Get the class of objects this transform is able to handle, which is XDADataExplorerBean.

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

a Class instance with the information about the beans this transform is able to manipulate.

getAncestorsSelectTag

protected SelectTag getAncestorsSelectTag()

Returns a >select< Tag instance object containing the list\ of the object's ancestors

Overrides:

getAncestorsSelectTag in class AbstractObjectExplorerTransform

Returns:

SelectTag

addAncestorsOptionsToSelectTag

protected java.lang.StringBuffer addAncestorsOptionsToSelectTag(SelectTag tag)

Adds the ancestors option tags to the supplied select tag. Return a string buffer with the proper indenting if needed for additional options.

Overrides:

addAncestorsOptionsToSelectTag in class AbstractObjectExplorerTransform

Parameters:

tag -

Returns:

StringBuffer

shouldShowDummyFolderOption

protected boolean shouldShowDummyFolderOption()

Overrides:

shouldShowDummyFolderOption in class AbstractObjectExplorerTransform

getOption

protected Tag getOption(WebDisplayUnit du,
                        java.lang.String indent)

Returns an option Tag containing the display unit provided.

Overrides:

getOption in class AbstractObjectExplorerTransform

Parameters:

du - WebDisplayUnit to open

indent - String

renderOpenParent

public void renderOpenParent(MarkupOutput out)

Renders the up folder button if ancestors are present.

Overrides:

renderOpenParent in class AbstractObjectExplorerTransform

Parameters:

out - MarkupOutput

getBrowseEvent

protected WebEvent getBrowseEvent()

Returns a new instance of the event use for browsing across objects

Overrides:

getBrowseEvent in class AbstractObjectExplorerTransform

Returns:

WebEvent

getOpenParentEvent

protected WebEvent getOpenParentEvent()

Returns a new instance of the event use to go to open the object's parent

Overrides:

getOpenParentEvent in class AbstractObjectExplorerTransform

Returns:

WebEvent

getUnitAttributes

public java.util.Map getUnitAttributes(WebDisplayUnit du)

Returns a map containing the attributes to add to the container of every object in the list of contents.

Overrides:

getUnitAttributes in class AbstractObjectExplorerTransform

Parameters:

du - WebDisplayUnit

Returns:

Map

renderUnit

public void renderUnit(MarkupOutput out,
                       WebDisplayUnit du)

Description copied from class: AbstractObjectExplorerTransform

Returns the give unit in the component's contents list.

Overrides:

renderUnit in class AbstractObjectExplorerTransform

Parameters:

out - MarkupOutput

du - WebDisplayUnit

See Also:

AbstractObjectExplorerTransform.renderUnit(MarkupOutput, WebDisplayUnit)

isHidden

public boolean isHidden(WebDisplayUnit du)

newContext

protected TransformContext newContext()

Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.

Overrides:

newContext in class AbstractAppTransform

getContext

protected TransformContext getContext()

Description copied from class: AbstractAppTransform

Returns the instance of TransformContext with context information for this Transform.

Overrides:

getContext in class AbstractAppTransform

See Also:

AbstractAppTransform.getContextMenu(java.lang.String)

renderContextMenus

public void renderContextMenus(MarkupOutput out)

Renders the context menu context to use in the transform

Overrides:

renderContextMenus in class AbstractAppTransform

Parameters:

out - where to write the output of the method.

getCssName

protected java.lang.String getCssName(WebDisplayUnit du)

Description copied from class: AbstractObjectExplorerTransform

Retruns the css class to use on the container of the object presented in the list of contents.

Specified by:

getCssName in class AbstractObjectExplorerTransform

Parameters:

du - WebDisplayUnit

Returns:

String

initEditor

protected void initEditor(Editor editor)

Description copied from class: AbstractEditorTransform

Initializes the editor with the global settings.

Overrides:

initEditor in class AbstractEditorTransform

Parameters:

editor - the Editor to modify.

Since:

MicroStrategy Web 8.1.0