public class

ObjectSiblingsTransform

extends AbstractAppTransform
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

Class Overview

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.

Summary

Constants
String FP_FOLDER_STYLE Constant specifying the name of the formal parameter for defining the style to use for transforming the folder.
String FP_SELECTED_NAME Constant specifying the name of the formal parameter for defining the formal parameter to use for marking the selected object.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter folderBeanStyle Indicates the name of the style to use for rendering the sibling information of the object.
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.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ObjectSiblingsTransform()
default no-args constructor
Public Methods
String getDescription()
Return description for this Transform
FolderBean getFolderBean()
Retrieves the ObjectBean's parent FolderBean.
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.
Protected Methods
TransformInstance getFolderTransform(FolderBean fb)
ObjectBean getObjectBean()
Get the objectBean target of this transform
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final 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.

Constant Value: "folderBeanStyle"

public static final 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.

Constant Value: "selectedName"

Fields

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.

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.

Public Constructors

public ObjectSiblingsTransform ()

default no-args constructor

Public Methods

public String getDescription ()

Return description for this Transform

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

public FolderBean getFolderBean ()

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

Returns

public Class getSupportedBeanType ()

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;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public void initializeTransform (Transformable data)

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.

Parameters
data the bean to transform.

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.

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

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.

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

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is "Successful".

Parameters
out output by this transform

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.

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

Protected Methods

protected TransformInstance getFolderTransform (FolderBean fb)

protected ObjectBean getObjectBean ()

Get the objectBean target of this transform

Returns