Package com.microstrategy.web.app.transforms

Class MojoFolderTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractMojoTransform

com.microstrategy.web.app.transforms.MojoFolderTransform

All Implemented Interfaces:

AppTransform, Transform

public class MojoFolderTransform
extends AbstractMojoTransform

Nested Class Summary

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

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FP_INCLUDE_ANCESTOR_INFO
static java.lang.String	FP_INCLUDE_AVAILABLE_VIEW_MEDIA
static java.lang.String	FP_INCLUDE_HIDDEN_ANCESTORS
static java.lang.String	FP_INCLUDE_MODIFICATION_TIME
static java.lang.String	FP_INCLUDE_OBJECT_DESC
static java.lang.String	FP_OB_CONTEXT_ID
static java.lang.String	FP_SEARCH_PATTERN
static java.lang.String	FP_SHOW_OBJECT_TAGS
static java.lang.String	FP_SORT_ASCENDING
static java.lang.String	FP_SORT_FIELD
static java.lang.String	FP_USE_ENCODING

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

FP_NAME_CONTENT_TYPE

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	addCustomCSSClass(WebObjectInfo objInfo)	This method is created to be overridden by the users who want to customize the icons for each object.
Block	createFolderBlock()
Block	createObjectInfoBlock(WebObjectInfo objInfo, SimpleList ancs)
java.lang.String	getDescription()	Returns a textual description of the transform.
static java.lang.String	getTagStringList(WebObjectInfo oi, WebLinkItems relatedLinkItems)
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform, such as width and height.
void	transformForRequestSuccessful(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful.

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

createErrorBlock, renderShell

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, getContext, 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, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, 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, renderSubBlock, renderUserHelpAnchor, setBoneProperties, 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.Transform

canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

FP_SORT_ASCENDING

public static final java.lang.String FP_SORT_ASCENDING

See Also:

Constant Field Values

FP_SORT_FIELD

public static final java.lang.String FP_SORT_FIELD

See Also:

Constant Field Values

FP_INCLUDE_OBJECT_DESC

public static final java.lang.String FP_INCLUDE_OBJECT_DESC

See Also:

Constant Field Values

FP_OB_CONTEXT_ID

public static final java.lang.String FP_OB_CONTEXT_ID

See Also:

Constant Field Values

FP_INCLUDE_ANCESTOR_INFO

public static final java.lang.String FP_INCLUDE_ANCESTOR_INFO

See Also:

Constant Field Values

FP_USE_ENCODING

public static final java.lang.String FP_USE_ENCODING

See Also:

Constant Field Values

FP_INCLUDE_MODIFICATION_TIME

public static final java.lang.String FP_INCLUDE_MODIFICATION_TIME

See Also:

Constant Field Values

FP_SEARCH_PATTERN

public static final java.lang.String FP_SEARCH_PATTERN

See Also:

Constant Field Values

FP_INCLUDE_AVAILABLE_VIEW_MEDIA

public static final java.lang.String FP_INCLUDE_AVAILABLE_VIEW_MEDIA

See Also:

Constant Field Values

FP_INCLUDE_HIDDEN_ANCESTORS

public static final java.lang.String FP_INCLUDE_HIDDEN_ANCESTORS

See Also:

Constant Field Values

FP_SHOW_OBJECT_TAGS

public static final java.lang.String FP_SHOW_OBJECT_TAGS

See Also:

Constant Field Values

Constructor Detail

MojoFolderTransform

public MojoFolderTransform()

Default no-argument constructor. Initializes formal parameters.

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: Transform

Returns a textual description of the transform.

Returns:

The textual description of the transform.

initializeTransform

public void initializeTransform(Transformable data)

Description copied from class: AbstractAppTransform

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractAppTransform

Parameters:

data - the bean to transform.

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

createFolderBlock

public Block createFolderBlock()
                        throws java.lang.Exception

Throws:

java.lang.Exception

createObjectInfoBlock

public Block createObjectInfoBlock(WebObjectInfo objInfo,
                                   SimpleList ancs)
                            throws java.lang.Exception

Throws:

java.lang.Exception

addCustomCSSClass

public java.lang.String addCustomCSSClass(WebObjectInfo objInfo)

This method is created to be overridden by the users who want to customize the icons for each object. The users can create their own conditions along with different output strings indicating the custom css classes.

Parameters:

objInfo -

Returns:

A string indicates the CSS Class name for the icon of that object

getTagStringList

public static java.lang.String getTagStringList(WebObjectInfo oi,
                                                WebLinkItems relatedLinkItems)