public class

SubscriptionFileWidgetImpl

extends AbstractGuiElement
implements GuiElement SubscriptionFileWidget

java.lang.Object
↳	com.microstrategy.web.app.gui.AbstractGuiElement
	↳	com.microstrategy.web.app.transforms.SubscriptionFileWidgetImpl

Known Direct Subclasses

SubscriptionCacheWidgetImpl, SubscriptionMobileWidgetImpl

Known Indirect Subclasses

AlertsSubscriptionMobileWidgetImpl, SubscriptionHistoryListWidgetImpl, SubscriptionPersonalViewTransform.SubscriptionPersonalViewWidgetImpl

Summary

Fields
protected static String	CALENDAR_BUTTON
protected static String	CONTACTS_PANE
protected static String	EXISTING_ADDRESSES_PANE
protected static String	NEW_ADDRESSES_PANE

[Expand]

Inherited Fields

From class com.microstrategy.web.app.gui.AbstractGuiElement

Protected Constructors
	SubscriptionFileWidgetImpl() Default no arguments constructor.

Public Methods
String	getBurstArg()
WebSubscriptionDeliveryModeProperties	getDeliveryMode()
String	getDeviceId()
boolean	getExpandLayouts()
int	getExpandPageBy()
int	getExpandUseSeparateSheets()
String	getFileNameArg()
String	getFileNameSpaceDelimiterArg()
boolean	getIsDefaultFormatMode()
boolean	getIsExpandPageByAvailable()
boolean	getIsSendNowAvailable()
String	getTriggerId()
String	getTriggerName()
SimpleList	getTriggers()
boolean	getUseDatasetCache()
boolean	getUseImmediateDelivery()
boolean	getUseSendPreviewNow()
boolean	isCompressionEnabled()
boolean	isDatasetCacheAvailable()
boolean	isNonSchedulable()
boolean	isPageByChangedorNot()
boolean	isSendNowSet()
void	renderBurstShoppingCart(MarkupOutput out) Render schedules Shopping Cart
MarkupOutput	renderElement() Renders the element using the global arguments.
void	renderFileNameSpaceDelimiter(Tag divFileName)
abstract void	setCompressionEnabled(boolean value)
abstract void	setContactsBrowserbean(ContactsBrowserBean bean)
abstract void	setContextMenuManager(ContextMenuManager contextMenuManager)
void	setDatasetCacheAailable(boolean isDatasetCacheAvailable)
abstract void	setExpandLayouts(boolean value)
abstract void	setExpandPageBy(int value)
abstract void	setExpandUseSeparateSheets(int value)
void	setIsBulkExport(boolean value)
abstract void	setIsCustomMessageAvailable(boolean value)
abstract void	setIsDefaultFormatMode(boolean value)
void	setIsDeliveryNotificationAvailable(boolean value)
abstract void	setIsExpandLayoutsAvailable(boolean value)
abstract void	setIsExpandPageByAvailable(boolean value)
void	setIsNonSchedulable(boolean isNonSchedulable)
void	setIsSendNowAvailable(boolean value)
void	setPageByChanged(boolean value)
void	setSendNow(boolean value)
abstract void	setSubscriptionObjectViewType(int subscriptionObjectViewType)
abstract void	setTransformContextMap(Map map)
void	setTriggerId(String value)
void	setTriggers(SimpleList value)
void	setUseDatasetCache(boolean useDatasetCache)
void	setUseImmediateDelivery(boolean immediateDelivery)
void	setUseSendPreviewNow(boolean sendPreviewNow)
void	setWebComponent(WebComponent value) set the `WebComponent` object associated with this gui element

Protected Methods
void	addToOnLoadJSCalls(String jsCall)
boolean	canBurst()
boolean	checkCompressionEnabled()
boolean	displayZipOptions()
boolean	getUseDeliveryNotification()
boolean	isRecipientInstance()
void	renderAdvancedOptions(MarkupOutput out)
void	renderAdvancedOptionsStart(MarkupOutput out)
void	renderBurst(Tag containerTag)
GGCalendar	renderCalendar(MarkupOutput out)
void	renderDelimiters(Tag fieldSetSubscription)
void	renderDeliveryNotification(Tag parentDiv)
void	renderFileName(Tag fieldSetSubscription)
void	renderFileNameSpaceDelimiterInfoImage(Tag parentDiv)
boolean	renderHTMLFormatAsNone()
void	renderInfoImage(Tag parentDiv)
void	renderInfoImage(Tag parentDiv, boolean isSubfolder)
void	renderLocations(MarkupOutput out)
void	renderObjectName(MarkupOutput out, String name)
void	renderOnLoadJavascript(MarkupOutput out)
void	renderSendNow(Tag fieldSetSubscription)
void	renderSendNowTrigger(SelectTag selectTag, boolean sendNowSelected)
void	renderSendPreviewCheckbox(Tag fieldSetSubscription)
Tag	renderSingleSelect(String labelText, String arg, Map<String, String> options, String selected)
void	renderSubscriptionAndTrigger(Tag fieldSetSubscription)
void	renderSubscriptionName(MarkupOutput out)
void	renderSubscriptionType(MarkupOutput out)
void	setBoneProperties(JsonGenerator bone)
void	setCompressionOptions() Iterates through all available formats and sets the displayZip variable which will be used while rendering the zip options
boolean	shouldRenderHTMLFormat()

[Expand]

Inherited Methods

From class com.microstrategy.web.app.gui.AbstractGuiElement

From class java.lang.Object

From interface com.microstrategy.web.app.gui.GuiElement

abstract AppContext	getAppContext() Get the `AppContext` instance used by this element
abstract String	getDescriptor(String key) Get the descriptor associated with the string key given
abstract String	getDescriptor(int key) Get the descriptor associated with the numeric key given
abstract EventManager	getEventManager() get the `EventManager` object associated with this gui element
abstract String	getExtraInput() get extra input info for the gui element
abstract String	getExtraUrl() get extra url info for the gui element
abstract WebFeatures	getFeatures() Get the `WebFeatures` instance used by this element
abstract Messages	getMessages() Get the `Messages` instance used by this element
abstract String	getName() Get the name property of this GUI element
abstract boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
abstract WebComponent	getWebComponent() Get the `WebComponent` instance used by this element
abstract boolean	renderElement(MarkupOutput out)
abstract MarkupOutput	renderElement() Render the GUI Element represented by this instance
abstract void	setAppContext(AppContext value) Set the `AppContext` instance to be used by this element
abstract void	setExtraInput(String newValue) set extra input info for the gui element
abstract void	setExtraUrl(String newValue) set extra url info for the gui element
abstract void	setName(String editorName) Set the name property of this GUI element
abstract void	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output
abstract void	setWebComponent(WebComponent value) Set the `WebComponent` instance to be used by this element

From interface com.microstrategy.web.app.transforms.SubscriptionFileWidget

Fields

protected static String CALENDAR_BUTTON

protected static String CONTACTS_PANE

protected static String EXISTING_ADDRESSES_PANE

protected static String NEW_ADDRESSES_PANE

Protected Constructors

protected SubscriptionFileWidgetImpl ()

Default no arguments constructor. Initialize the widget with default values.

Public Methods

public String getBurstArg ()

public WebSubscriptionDeliveryModeProperties getDeliveryMode ()

public String getDeviceId ()

public boolean getExpandLayouts ()

public int getExpandPageBy ()

public int getExpandUseSeparateSheets ()

public String getFileNameArg ()

public String getFileNameSpaceDelimiterArg ()

public boolean getIsDefaultFormatMode ()

public boolean getIsExpandPageByAvailable ()

public boolean getIsSendNowAvailable ()

public String getTriggerId ()

public String getTriggerName ()

public SimpleList getTriggers ()

public boolean getUseDatasetCache ()

public boolean getUseImmediateDelivery ()

public boolean getUseSendPreviewNow ()

public boolean isCompressionEnabled ()

public boolean isDatasetCacheAvailable ()

public boolean isNonSchedulable ()

public boolean isPageByChangedorNot ()

public boolean isSendNowSet ()

public void renderBurstShoppingCart (MarkupOutput out)

Render schedules Shopping Cart

public MarkupOutput renderElement ()

Renders the element using the global arguments.

Returns

a MarkupOutput with the Subscription Widget.

public void renderFileNameSpaceDelimiter (Tag divFileName)

public abstract void setCompressionEnabled (boolean value)

public abstract void setContactsBrowserbean (ContactsBrowserBean bean)

public abstract void setContextMenuManager (ContextMenuManager contextMenuManager)

public void setDatasetCacheAailable (boolean isDatasetCacheAvailable)

public abstract void setExpandLayouts (boolean value)

public abstract void setExpandPageBy (int value)

public abstract void setExpandUseSeparateSheets (int value)

public void setIsBulkExport (boolean value)

public abstract void setIsCustomMessageAvailable (boolean value)

public abstract void setIsDefaultFormatMode (boolean value)

public void setIsDeliveryNotificationAvailable (boolean value)

public abstract void setIsExpandLayoutsAvailable (boolean value)

public abstract void setIsExpandPageByAvailable (boolean value)

public void setIsNonSchedulable (boolean isNonSchedulable)

public void setIsSendNowAvailable (boolean value)

public void setPageByChanged (boolean value)

public void setSendNow (boolean value)

public abstract void setSubscriptionObjectViewType (int subscriptionObjectViewType)

public abstract void setTransformContextMap (Map map)

public void setTriggerId (String value)

public void setTriggers (SimpleList value)

public void setUseDatasetCache (boolean useDatasetCache)

public void setUseImmediateDelivery (boolean immediateDelivery)

public void setUseSendPreviewNow (boolean sendPreviewNow)

public void setWebComponent (WebComponent value)

set the WebComponent object associated with this gui element

Parameters

value	the WebComponent object

Protected Methods

protected void addToOnLoadJSCalls (String jsCall)

protected boolean canBurst ()

protected boolean checkCompressionEnabled ()

protected boolean displayZipOptions ()

protected boolean getUseDeliveryNotification ()

protected boolean isRecipientInstance ()

protected void renderAdvancedOptions (MarkupOutput out)

protected void renderAdvancedOptionsStart (MarkupOutput out)

protected void renderBurst (Tag containerTag)

protected GGCalendar renderCalendar (MarkupOutput out)

protected void renderDelimiters (Tag fieldSetSubscription)

protected void renderDeliveryNotification (Tag parentDiv)

protected void renderFileName (Tag fieldSetSubscription)

protected void renderFileNameSpaceDelimiterInfoImage (Tag parentDiv)

protected boolean renderHTMLFormatAsNone ()

protected void renderInfoImage (Tag parentDiv)

protected void renderInfoImage (Tag parentDiv, boolean isSubfolder)

protected void renderLocations (MarkupOutput out)

protected void renderObjectName (MarkupOutput out, String name)

protected void renderOnLoadJavascript (MarkupOutput out)

protected void renderSendNow (Tag fieldSetSubscription)

protected void renderSendNowTrigger (SelectTag selectTag, boolean sendNowSelected)

protected void renderSendPreviewCheckbox (Tag fieldSetSubscription)

protected Tag renderSingleSelect (String labelText, String arg, Map<String, String> options, String selected)

protected void renderSubscriptionAndTrigger (Tag fieldSetSubscription)

protected void renderSubscriptionName (MarkupOutput out)

protected void renderSubscriptionType (MarkupOutput out)

protected void setBoneProperties (JsonGenerator bone)

protected void setCompressionOptions ()

Iterates through all available formats and sets the displayZip variable which will be used while rendering the zip options

Interfaces

Classes