public class

DeployWidgetTask

extends AbstractAppTask
java.lang.Object
   ↳ com.microstrategy.web.tasks.AbstractBaseTask
     ↳ com.microstrategy.web.app.tasks.AbstractAppTask
       ↳ com.microstrategy.web.app.tasks.DeployWidgetTask

Class Overview

This task deploys a widget from a folder by doing the following:
WEB
- copying the SWF found on the folder
- copying the GIF file found on the folder
- adding the widget definition from the widgetChanges.xml to the application's widgets.xml
- adding icon class definition on mstr.css
DESKTOP
- adding the widget definition from the widgetChanges.xml to the application's widgets.xml
NCS
- copying the SWF found on the folder > LocalAccess
OFFICE
- copying the SWF found on the folder > LocalAccess

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.tasks.AbstractBaseTask
Fields
protected TaskParameterMetadata cssFilePathTaskParam
[Expand]
Inherited Fields
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
DeployWidgetTask()
Public Methods
String getDescriptor(int key, AppContext appContext)
Returns a descriptor based on a key
void processRequest(TaskRequestContext context, TaskOutput to)
The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the processRequest(TaskRequestContext, MarkupOutput) version.
Protected Methods
void updateWidgetsCssFile(AppContext appContext, String cssFilePath, Widget newWidget)
Updates the css file where the icon for widgets is defined.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.tasks.AbstractAppTask
From class com.microstrategy.web.tasks.AbstractBaseTask
From class java.lang.Object
From interface com.microstrategy.web.tasks.Task

Fields

protected TaskParameterMetadata cssFilePathTaskParam

Public Constructors

public DeployWidgetTask ()

Public Methods

public String getDescriptor (int key, AppContext appContext)

Returns a descriptor based on a key

Parameters
key the descriptor's key
appContext the AppContext object
Returns
  • a descriptor based on a key

public void processRequest (TaskRequestContext context, TaskOutput to)

The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the processRequest(TaskRequestContext, MarkupOutput) version.

Parameters
context The TaskRequestContext object that maintains the state of the request.
to The TaskOutput that contains the output generated by the Task.
Throws
TaskException

Protected Methods

protected void updateWidgetsCssFile (AppContext appContext, String cssFilePath, Widget newWidget)

Updates the css file where the icon for widgets is defined. (i.e. mstr.css)

Parameters
appContext the AppContext object
cssFilePath the path to the css file
newWidget the new Widget object