Package com.microstrategy.web.app.transforms

Class ObjectSiblingsTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.ObjectSiblingsTransform

All Implemented Interfaces:

AppTransform, Transform

public class ObjectSiblingsTransform
extends AbstractAppTransform

This transforms renders a list of siblings of a WebObject. It supports all ObjectBeans.
To do this, it just retrieves the parentFolderBean of the ObjectBean and transforms it applying the style defined in the "folderStyle" FormalParamter.

Since:

MicroStrategy Web 7.3.1 or earlier

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
FormalParameter	folderBeanStyle	Indicates the name of the style to use for rendering the sibling information of the object.
static java.lang.String	FP_FOLDER_STYLE	Constant specifying the name of the formal parameter for defining the style to use for transforming the folder.
static java.lang.String	FP_SELECTED_NAME	Constant specifying the name of the formal parameter for defining the formal parameter to use for marking the selected object.
FormalParameter	selectedName	Indicates the name of the formal parameter to use on the style specified for indicating where to set the current selected object if this is to be done according to the object being transformed.

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
ObjectSiblingsTransform()	default no-args constructor

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Return description for this Transform
FolderBean	getFolderBean()	Retrieves the ObjectBean's parent FolderBean.
protected TransformInstance	getFolderTransform(FolderBean fb)
protected ObjectBean	getObjectBean()	Get the objectBean target of this transform
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform, such as width and height.
void	transformForRequestInError(MarkupOutput out)	Overwrites by ignoring the state and rendering as the status was succesful.
void	transformForRequestProcessing(MarkupOutput out)	Overwrites by ignoring the state and rendering as the status was succesful.
void	transformForRequestSuccessful(MarkupOutput out)	Transform when the status is "Successful".
void	transformForRequestWaitingForUserInput(MarkupOutput out)	Overwrites by ignoring the state and rendering as the status was succesful.

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, 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, 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

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

folderBeanStyle

public FormalParameter folderBeanStyle

Indicates the name of the style to use for rendering the sibling information of the object.
The name of the style specified on this formal parameter has to be a valid style transform defined on the Style Catalog. The default value is FolderStyleBullet.

selectedName

public FormalParameter selectedName

Indicates the name of the formal parameter to use on the style specified for indicating where to set the current selected object if this is to be done according to the object being transformed.
The value has to be a valid formal parameter name of the style defined on the folderBeanStyle parameter.

Since:

MicroStrategy Web 8.0.0

FP_FOLDER_STYLE

public static final java.lang.String FP_FOLDER_STYLE

Constant specifying the name of the formal parameter for defining the style to use for transforming the folder. Value is folderBeanStyle.

See Also:

Constant Field Values

FP_SELECTED_NAME

public static final java.lang.String FP_SELECTED_NAME

Constant specifying the name of the formal parameter for defining the formal parameter to use for marking the selected object. Value is selectedName.

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

Constructor Detail

ObjectSiblingsTransform

public ObjectSiblingsTransform()

default no-args constructor

Method Detail

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.

getFolderTransform

protected TransformInstance getFolderTransform(FolderBean fb)

Since:

MicroStrategy Web 8.0.0

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Transform when the status is "Successful".

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

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

transformForRequestProcessing

public void transformForRequestProcessing(MarkupOutput out)

Overwrites by ignoring the state and rendering as the status was succesful. ObjectBeans, even when their processing, should already have their path info.

Overrides:

transformForRequestProcessing in class AbstractAppTransform

Parameters:

out - MarkupOutput instance that will be the output by this transform

See Also:

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

transformForRequestInError

public void transformForRequestInError(MarkupOutput out)

Overwrites by ignoring the state and rendering as the status was succesful. ObjectBeans, even when in error, we should already have their path info.

Overrides:

transformForRequestInError in class AbstractAppTransform

Parameters:

out - MarkupOutput instance that will be the output by this transform

See Also:

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

transformForRequestWaitingForUserInput

public void transformForRequestWaitingForUserInput(MarkupOutput out)

Overwrites by ignoring the state and rendering as the status was succesful. ObjectBeans, even when their processing, should already have their path info.

Overrides:

transformForRequestWaitingForUserInput in class AbstractAppTransform

Parameters:

out - MarkupOutput instance that will be the output by this transform

See Also:

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

getFolderBean

public FolderBean getFolderBean()

Retrieves the ObjectBean's parent FolderBean. This is the Bean that actually gets transform and generates the output.

Returns:

the FolderBean instance used with this transform

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Description copied from class: AbstractAppTransform

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

a root class/interface supported by this transform.

getDescription

public java.lang.String getDescription()

Return description for this Transform

Returns:

'This transform just returns the HTML generated by the document.'

getObjectBean

protected ObjectBean getObjectBean()

Get the objectBean target of this transform

Returns:

the ObjectBean instance used with this transform