Package com.microstrategy.web.app.transforms

Class AbstractSubscriptionsEditorTransform

    • Field Detail

      • objectInfoStyle

        public FormalParameter objectInfoStyle
        Formal parameter: Indicate which style should be used for rendering the object information
        Since:
        MicroStrategy Web 9.0.0

      • FP_OBJECT_INFO_STYLE

        public static final java.lang.String FP_OBJECT_INFO_STYLE
        Name for the formal parameter: objectInfoStyle
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractSubscriptionsEditorTransform

        public AbstractSubscriptionsEditorTransform()
        Default no-args constructor, initialize formal parameters.

    • Method Detail

      • renderSusbcriptionDialog

        public abstract void renderSusbcriptionDialog​(MarkupOutput out)
        Generates the graphical output for the content of the Subscription Editor Bean
        Parameters:
        out - MarkupOutput instance where to create the HTML output.

      • renderEditorMessage

        public void renderEditorMessage​(MarkupOutput out)
        Include JavaScript code needed for this component.
        Parameters:
        out - where to write output.

      • renderSubscriptionsCountMessage

        public void renderSubscriptionsCountMessage​(MarkupOutput out)
        Renders the message "You have ## subscriptions to this report."
        Parameters:
        out - The HTML output

      • generateAnchor

        protected AnchorTag generateAnchor​(WebEvent event)
        Overwrites the parent method by setting a default css class and to include the typical information regardless of its DHTML environment (thus disabling any default onclick definition)
        Overrides:
        generateAnchor in class AbstractAppTransform
        Parameters:
        event - WebEvent instance to use as base for the link
        Returns:
        AnchorTag instance initialized with the event information

      • renderErrorMessage

        public void renderErrorMessage​(MarkupOutput out)
        Parameters:
        out - MarkupOutput

      • getSaveMessage

        public abstract java.lang.String getSaveMessage()
        Returns a string containing an error message
        Returns:
        String

      • renderSaveMessage

        public void renderSaveMessage​(MarkupOutput out)
        Parameters:
        out - MarkupOutput

      • getSaveEvent

        protected WebEvent getSaveEvent()
        Returns the Save As event after setting a couple of arguments specific to the transform.
        Returns:
        WebEvent - corresponding to save

      • getCancelEvent

        protected WebEvent getCancelEvent()
        Returns the Save As event after setting a couple of arguments specific to the transform.
        Overrides:
        getCancelEvent in class AbstractAppTransform
        Returns:
        the cancel event

      • renderSaveButton

        public void renderSaveButton​(MarkupOutput out)
        Parameters:
        out - MarkupOutput

      • renderOverwriteMessage

        public void renderOverwriteMessage​(MarkupOutput out)
        Renders the Overwrite message text in the dialog.
        Parameters:
        out - - the MarkupOutput to be used

      • renderOverwriteWarningMessage

        public void renderOverwriteWarningMessage​(MarkupOutput out)
        Renders the overwrite warning message in a div.
        Parameters:
        out - - the MarkupOutput to use

      • renderMobileMessage

        public void renderMobileMessage​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.1

      • renderAreYouSure

        public void renderAreYouSure​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.1

      • renderDuplicateMessage

        public void renderDuplicateMessage​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.1

      • getOverwriteEvent

        protected WebEvent getOverwriteEvent()
        Returns the event for overwrite dialog after setting a couple of arguments specific to the transform.
        Returns:
        WebEvent corresponding to the Overwrite

      • renderOverwriteObjectInfo

        public void renderOverwriteObjectInfo​(MarkupOutput out)
        Renders the Object information for the overwrite dialog.
        Parameters:
        out - - MarkupOutput to be used

      • renderOverwriteTriggerInfo

        public void renderOverwriteTriggerInfo​(MarkupOutput out)
        The methdos renders the schedule's trigger
        Parameters:
        out - - MarkupOutput to be used

      • renderOverwriteTitle

        public void renderOverwriteTitle​(MarkupOutput out)
        Renders the message that appears to display as a title on the overwrite subscription mode.
        Parameters:
        out - MarkupOutput to be used

      • initEditor

        protected void initEditor​(Editor editor)
        Initialize the editor with the global settings.
        Overrides:
        initEditor in class AbstractEditorTransform
        Parameters:
        editor - Editor instance, abstraction of the container where output is rendered.

      • isDisabled

        public abstract boolean isDisabled()
        Specifies whether or not this transform has been disabled.
        Returns:
        true if disabled.

      • getSubscriptionEditorBean

        public SubscriptionEditorBean getSubscriptionEditorBean()
        Returns current instance of SubscriptionEditorBean being transformed.
        Returns:
        SubscriptionEditorBean instance.

      • getDescription

        public java.lang.String getDescription()
        Returns the textual description of current transform class.
        Returns:
        String the description of the transform.

      • getSubscriptionCountMessage

        public abstract java.lang.String getSubscriptionCountMessage()
        Get the message for the Subscriptions count.
        Returns:
        Message with the number of subscriptions

      • getSubscriptionsEvent

        public WebEvent getSubscriptionsEvent()
        Gets the subscriptions event
        Returns:
        WebEvent - the WebEventOpenObjectSubscriptions Event

      • setWidgetCommonProperties

        protected void setWidgetCommonProperties​(com.microstrategy.web.app.transforms.DefaultSubscriptionWidget widget,
                                         WebEvent event)
        setWidgetCommonProperties
        Parameters:
        widget - DefaultSubscriptionWidget
        event - WebEvent

      • setWidgetFileAndPrintProperties

        protected void setWidgetFileAndPrintProperties​(SubscriptionFileWidget widget,
                                               WebEvent event)
        setWidgetFileAndPrintProperties
        Parameters:
        widget - SubscriptionFileWidget
        event - WebEvent

      • renderHiddenInputs

        protected void renderHiddenInputs​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • getUpdatePropertiesEvent

        protected WebEvent getUpdatePropertiesEvent​(SubscriptionBean sb)
        Since:
        MicroStrategy Web 9.0.0