Package com.microstrategy.web.app.transforms

Class FrameGenericTransform

    • Field Detail

      • FP_CUSTOM_JS_FEATURES

        public static final java.lang.String FP_CUSTOM_JS_FEATURES
        Constant specifying any extra features that will be send down to the client.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • customJavaScriptFeatures

        protected FormalParameter customJavaScriptFeatures
        name for the formal parameter "customJavaScriptFeatures".
        Since:
        MicroStrategy Web 9.0.0

      • _defaultLayout

        protected org.w3c.dom.Document _defaultLayout

    • Constructor Detail

      • FrameGenericTransform

        public FrameGenericTransform()

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

      • generateSimpleMode

        protected void generateSimpleMode​(MarkupOutput out)

      • appendCustomFeatures

        protected void appendCustomFeatures​(JsonGenerator features)
        Since:
        MicroStrategy Web 9.0.0

      • renderCurrentEditor

        public void renderCurrentEditor​(MarkupOutput out)

      • renderEditorMessage

        public void renderEditorMessage​(MarkupOutput out)

      • renderIFrameComponent

        public void renderIFrameComponent​(MarkupOutput out,
                                  java.lang.String name)

      • displayComponent

        protected void displayComponent​(MarkupOutput out,
                                java.lang.String name,
                                MarkupOutput value,
                                boolean canComment)
        Since:
        MicroStrategy Web 9.0.0

      • displayComponent

        protected void displayComponent​(MarkupOutput out,
                                java.lang.String name,
                                java.lang.String value)
        Display a string as an iFrame component.
        Parameters:
        out - The HTML output
        name - the Component name
        value - the String to render.

      • displayComponent

        protected void displayComponent​(MarkupOutput out,
                                java.lang.String name,
                                java.lang.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

      • getDescription

        public java.lang.String getDescription()
        The description of this transform for the Style Catalog
        Specified by:
        getDescription in interface Transform
        Returns:
        This is the generic Transform for a FrameBean. It uses the LayoutBuilder to generate its layout

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

      • renderObjectBrowser

        public void renderObjectBrowser​(MarkupOutput out,
                                java.lang.String name,
                                java.lang.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
        Since:
        MicroStrategy Web 9.0.0

      • getUserPalette

        public java.util.ArrayList<java.lang.String> getUserPalette()
        Since:
        MicroStrategy Web 9.0.0

      • getCustomColorDescriptor

        public java.lang.String getCustomColorDescriptor​(java.lang.String c)
        Since:
        MicroStrategy Web 9.0.0

      • getUserDpi

        public int getUserDpi()
        Since:
        MicroStrategy Web 9.0.0

      • getDecimalSeparator

        public java.lang.String getDecimalSeparator()
        Since:
        MicroStrategy Web 9.0.0