Package com.microstrategy.web.app.transforms

Class SecondaryDataSourcesEditorTransform

  • All Implemented Interfaces:
    AppTransform, LayoutTransform, Transform
    public class SecondaryDataSourcesEditorTransform
extends AbstractEditorTransform
implements LayoutTransform
    Transform used to display the content of the Secondary Data Providers editor.
    This editor is used to link grids in documents with other grids for custom visualizations and widgets.
    It is only available for visualizations/widgets that support secondary providers.
    Since:
    MicroStrategy Web 8.1.1

    • Constructor Detail

      • SecondaryDataSourcesEditorTransform

        public SecondaryDataSourcesEditorTransform()

    • Method Detail

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

      • getScriptClass

        protected java.lang.String getScriptClass()
        Returns the name of the javaScript class to be associated with the component
        Overrides:
        getScriptClass in class AbstractAppTransform
        Returns:
        mstrSecondaryDataSourcesImpl, the default bone for editors.

      • getCart

        protected Cart getCart()
        Creates and initializes the Cart instance used by this Transform.
        Returns:
        The Cart object used to render the available and selected visualizations.

      • renderCart

        public void renderCart​(MarkupOutput out)
        Renders the Shopping Cart with the available and selected secondary data providers.
        Parameters:
        out - MarkupOutput to generate the HTML.

      • initializeCart

        protected void initializeCart​(Cart cart)
        Initializes the Cart instance used by this Transform.
        Parameters:
        cart - Cart to be initialized.

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Transform
        Returns a textual description of the transform.
        Specified by:
        getDescription in interface Transform
        Returns:
        The textual description of the transform.