public abstract class

AbstractSubscriptionsEditorTransform

extends AbstractEditorTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.AbstractSubscriptionsEditorTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This class is the base class for the Editors used for subscription.

Summary

Nested Classes
class AbstractSubscriptionsEditorTransform.RecipientContext  
Constants
String FP_OBJECT_INFO_STYLE Name for the formal parameter: objectInfoStyle
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter objectInfoStyle Formal parameter: Indicate which style should be used for rendering the object information
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractSubscriptionsEditorTransform()
Default no-args constructor, initialize formal parameters.
Public Methods
String getDescription()
Returns the textual description of current transform class.
abstract String getSaveMessage()
Returns a string containing an error message
abstract String getSubscriptionCountMessage()
Get the message for the Subscriptions count.
SubscriptionEditorBean getSubscriptionEditorBean()
Returns current instance of SubscriptionEditorBean being transformed.
WebEvent getSubscriptionsEvent()
Gets the subscriptions event
Class getSupportedBeanType()
Returns the supported bean type.
void initializeCss()
Initialize the CSS classes to be used by this transform.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
abstract boolean isDisabled()
Specifies whether or not this transform has been disabled.
void renderAreYouSure(MarkupOutput out)
void renderCancelButton(MarkupOutput out)
Renders the Cancel button for the wait page.
void renderDuplicateMessage(MarkupOutput out)
void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Subscription Editor Bean
void renderEditorMessage(MarkupOutput out)
Include JavaScript code needed for this component.
void renderErrorMessage(MarkupOutput out)
void renderMobileMessage(MarkupOutput out)
void renderOverwriteMessage(MarkupOutput out)
Renders the Overwrite message text in the dialog.
void renderOverwriteObjectInfo(MarkupOutput out)
Renders the Object information for the overwrite dialog.
void renderOverwriteTitle(MarkupOutput out)
Renders the message that appears to display as a title on the overwrite subscription mode.
void renderOverwriteTriggerInfo(MarkupOutput out)
The methdos renders the schedule's trigger
void renderOverwriteWarningMessage(MarkupOutput out)
Renders the overwrite warning message in a div.
void renderSaveButton(MarkupOutput out)
void renderSaveMessage(MarkupOutput out)
void renderSubscriptionsCountMessage(MarkupOutput out)
Renders the message "You have ## subscriptions to this report."
abstract void renderSusbcriptionDialog(MarkupOutput out)
Generates the graphical output for the content of the Subscription Editor Bean
Protected Methods
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)
Tag generateForm()
WebEvent getCancelEvent()
Returns the Save As event after setting a couple of arguments specific to the transform.
WebEvent getOverwriteEvent()
Returns the event for overwrite dialog after setting a couple of arguments specific to the transform.
WebEvent getSaveEvent()
Returns the Save As event after setting a couple of arguments specific to the transform.
WebEvent getUpdatePropertiesEvent(SubscriptionBean sb)
void initEditor(Editor editor)
Initialize the editor with the global settings.
void renderHiddenInputs(MarkupOutput out)
void renderJavascript(MarkupOutput out)
This method should be used by the Editor transforms to generate any javascript necessary.
void setWidgetCommonProperties(DefaultSubscriptionWidget widget, WebEvent event)
setWidgetCommonProperties
void setWidgetFileAndPrintProperties(SubscriptionFileWidget widget, WebEvent event)
setWidgetFileAndPrintProperties
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
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_OBJECT_INFO_STYLE

Name for the formal parameter: objectInfoStyle

Constant Value: "objectInfoStyle"

Fields

public FormalParameter objectInfoStyle

Formal parameter: Indicate which style should be used for rendering the object information

Public Constructors

public AbstractSubscriptionsEditorTransform ()

Default no-args constructor, initialize formal parameters.

Public Methods

public String getDescription ()

Returns the textual description of current transform class.

Returns
  • String the description of the transform.

public abstract String getSaveMessage ()

Returns a string containing an error message

Returns
  • String

public abstract String getSubscriptionCountMessage ()

Get the message for the Subscriptions count.

Returns
  • Message with the number of subscriptions

public SubscriptionEditorBean getSubscriptionEditorBean ()

Returns current instance of SubscriptionEditorBean being transformed.

Returns
  • SubscriptionEditorBean instance.

public WebEvent getSubscriptionsEvent ()

Gets the subscriptions event

Returns
  • WebEvent - the WebEventOpenObjectSubscriptions Event

public Class getSupportedBeanType ()

Returns the supported bean type.

Returns
  • Class SubscriptionEditorBean.class

public void initializeCss ()

Initialize the CSS classes to be used by this transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.

Parameters
data bean that will be transformed

public abstract boolean isDisabled ()

Specifies whether or not this transform has been disabled.

Returns
  • true if disabled.

public void renderAreYouSure (MarkupOutput out)

public void renderCancelButton (MarkupOutput out)

Renders the Cancel button for the wait page.
It calls getCancelEvent() to obtain the event for the button
The button is not rendered if:
- getCancelEvent() returns null
- processingButtonsFlags does not have PROCESSING_BUTTONS_CANCEL

Parameters
out - the MarkupOutput

public void renderDuplicateMessage (MarkupOutput out)

public void renderEditorContents (MarkupOutput out)

Generates the graphical output for the Subscription Editor Bean

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderEditorMessage (MarkupOutput out)

Include JavaScript code needed for this component.

Parameters
out where to write output.

public void renderErrorMessage (MarkupOutput out)

Parameters
out MarkupOutput

public void renderMobileMessage (MarkupOutput out)

public void renderOverwriteMessage (MarkupOutput out)

Renders the Overwrite message text in the dialog.

Parameters
out - the MarkupOutput to be used

public void renderOverwriteObjectInfo (MarkupOutput out)

Renders the Object information for the overwrite dialog.

Parameters
out - MarkupOutput to be used

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

public void renderOverwriteTriggerInfo (MarkupOutput out)

The methdos renders the schedule's trigger

Parameters
out - MarkupOutput to be used

public void renderOverwriteWarningMessage (MarkupOutput out)

Renders the overwrite warning message in a div.

Parameters
out - the MarkupOutput to use

public void renderSaveButton (MarkupOutput out)

Parameters
out MarkupOutput

public void renderSaveMessage (MarkupOutput out)

Parameters
out MarkupOutput

public void renderSubscriptionsCountMessage (MarkupOutput out)

Renders the message "You have ## subscriptions to this report."

Parameters
out The HTML output

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.

Protected Methods

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)

Parameters
event WebEvent instance to use as base for the link
Returns
  • AnchorTag instance initialized with the event information

protected Tag generateForm ()

protected WebEvent getCancelEvent ()

Returns the Save As event after setting a couple of arguments specific to the transform.

Returns
  • the cancel event

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

protected WebEvent getSaveEvent ()

Returns the Save As event after setting a couple of arguments specific to the transform.

Returns
  • WebEvent - corresponding to save

protected WebEvent getUpdatePropertiesEvent (SubscriptionBean sb)

protected void initEditor (Editor editor)

Initialize the editor with the global settings.

Parameters
editor Editor instance, abstraction of the container where output is rendered.

protected void renderHiddenInputs (MarkupOutput out)

protected void renderJavascript (MarkupOutput out)

This method should be used by the Editor transforms to generate any javascript necessary.
The default implementation includes a call to the ClientSideHelper to render the dynamic scrips and the registerBone call.

Parameters
out MarkupOutput where the output should be rendered.

protected void setWidgetCommonProperties (DefaultSubscriptionWidget widget, WebEvent event)

setWidgetCommonProperties

Parameters
widget DefaultSubscriptionWidget
event WebEvent

protected void setWidgetFileAndPrintProperties (SubscriptionFileWidget widget, WebEvent event)

setWidgetFileAndPrintProperties

Parameters
widget SubscriptionFileWidget
event WebEvent