public class

FrameGenericTransform

extends AbstractAppTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.FrameGenericTransform
Known Direct Subclasses

Class Overview

This transforms renders a FrameBean using a LayoutBuilder. It's iFrame aware, so it provides methods to render elements as iFrame components.

Summary

Constants
String FP_CUSTOM_JS_FEATURES Constant specifying any extra features that will be send down to the client.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected Document _defaultLayout
protected FormalParameter customJavaScriptFeatures name for the formal parameter "customJavaScriptFeatures".
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FrameGenericTransform()
Public Methods
String getCustomColorDescriptor(String c)
String getDecimalSeparator()
String getDescription()
The description of this transform for the Style Catalog
Class getSupportedBeanType()
Returns the supported bean type.
int getUserDpi()
ArrayList<String> getUserPalette()
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

void renderCurrentEditor(MarkupOutput out)
void renderData(MarkupOutput out)
void renderEditorMessage(MarkupOutput out)
void renderIFrameComponent(MarkupOutput out, String name)
void renderObjectBrowser(MarkupOutput out, String name, String style)
this method renders the object browser bean with is-container set to true NOTE: the reason we need this method for now is because of the need to do partial update when expanding a node of the object browser tree view TODO need to get rid of this method and the corresponding layout file hack once the is-container attribute is controlled by individual web-bean
void transformForRequestCanceled(MarkupOutput out)
Transform when the status is Canceled.
void transformForRequestInError(MarkupOutput out)
Transform when the status is In Error.
void transformForRequestNotInited(MarkupOutput out)
Transform when the status is Not initialized.
void transformForRequestProcessing(MarkupOutput out)
Transform when the status is Processing.
void transformForRequestSuccessful(MarkupOutput out)
Method that generates the output when the bean is Successful.
void transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the status is Waiting for user input.
Protected Methods
void appendCustomFeatures(JsonGenerator features)
void displayComponent(MarkupOutput out, String name, String value)
Display a string as an iFrame component.
void displayComponent(MarkupOutput out, String name, MarkupOutput value, boolean canComment)
void displayComponent(MarkupOutput out, String name, String value, boolean canComment)
Display a string as an iFrame component.
void generateSimpleMode(MarkupOutput out)
[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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_CUSTOM_JS_FEATURES

Constant specifying any extra features that will be send down to the client.

Constant Value: "customJavaScriptFeatures"

Fields

protected Document _defaultLayout

protected FormalParameter customJavaScriptFeatures

name for the formal parameter "customJavaScriptFeatures".

Public Constructors

public FrameGenericTransform ()

Public Methods

public String getCustomColorDescriptor (String c)

public String getDecimalSeparator ()

public String getDescription ()

The description of this transform for the Style Catalog

Returns
  • This is the generic Transform for a FrameBean. It uses the LayoutBuilder to generate its layout

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 int getUserDpi ()

public ArrayList<String> getUserPalette ()

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 renderCurrentEditor (MarkupOutput out)

public void renderData (MarkupOutput out)

public void renderEditorMessage (MarkupOutput out)

public void renderIFrameComponent (MarkupOutput out, String name)

public void renderObjectBrowser (MarkupOutput out, String name, String style)

this method renders the object browser bean with is-container set to true NOTE: the reason we need this method for now is because of the need to do partial update when expanding a node of the object browser tree view TODO need to get rid of this method and the corresponding layout file hack once the is-container attribute is controlled by individual web-bean

public void transformForRequestCanceled (MarkupOutput out)

Transform when the status is Canceled.

Parameters
out output by this transform

public void transformForRequestInError (MarkupOutput out)

Transform when the status is In Error.

Parameters
out output by this transform

public void transformForRequestNotInited (MarkupOutput out)

Transform when the status is Not initialized.

Parameters
out output by this transform

public void transformForRequestProcessing (MarkupOutput out)

Transform when the status is Processing.

Parameters
out output by this transform

public void transformForRequestSuccessful (MarkupOutput out)

Method that generates the output when the bean is Successful.

Parameters
out where to write the output of the method.

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Transform when the status is Waiting for user input.

Parameters
out output by this transform

Protected Methods

protected void appendCustomFeatures (JsonGenerator features)

protected void displayComponent (MarkupOutput out, String name, String value)

Display a string as an iFrame component.

Parameters
out The HTML output
name the Component name
value the String to render.

protected void displayComponent (MarkupOutput out, String name, MarkupOutput value, boolean canComment)

protected void displayComponent (MarkupOutput out, String name, String value, boolean canComment)

Display a string as an iFrame component.

Parameters
out The HTML output
name the Component name
value the String to render.
canComment if true contents will be displayed inside a COMMENT tag

protected void generateSimpleMode (MarkupOutput out)