public class

FolderDeleteObjectTransform

extends AbstractFolderTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
           ↳ com.microstrategy.web.app.transforms.AbstractFolderTransform
             ↳ com.microstrategy.web.app.transforms.FolderDeleteObjectTransform

Class Overview

This class renders the object info of the first selected item and shows an HTML Form to have it deleted.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderDeleteObjectTransform()
Default no-argument constructor.
Public Methods
String getDescription()
Returns this transform's description.
ArrayList getSelectedObjects()
void renderButtonBar(MarkupOutput out)
This method is deprecated. please use renderButtonBar(MarkupOutput, WebObjectInfo)
void renderButtonBar(MarkupOutput out, WebObjectInfo selectedObject)
Renders the delete form information and buttons for allowing the user to confirm if s/he wants to delete the object or not.
void renderDeleteConfirmation(MarkupOutput out, WebObjectInfo selectedObject)
Renders the delete confirmation question text.
void renderDeleteConfirmation(MarkupOutput out)
This method is deprecated. please use renderDeleteConfirmation(MarkupOutput, WebObjectInfo)
void renderDeleteForm(MarkupOutput out, WebObjectInfo object)
This method is deprecated. call renderButtonBar(MarkupOutput) instead.
void renderDeleteTitle(MarkupOutput out)
Render the title corresponding to the message this transform will display
void renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. please use and customize renderList(MarkupOutput) instead. This method will not be called by future releases.
void renderObject(MarkupOutput out, WebObjectInfo object)
Renders the object information of the object to delete (internally it uses an ObjectInfoTransform to accomplish this).
void renderObject(MarkupOutput out)
This method is deprecated. please use renderObject(MarkupOutput, WebObjectInfo)
Protected Methods
WebEvent getCancelEvent(WebObjectInfo object)
Returns an initialized WebEvent for being able to cancel the deletion of the WebObjectInfo indicated.
WebEvent getDeleteObjectEvent(WebObjectInfo object)
Returns an initialized WebEvent for being able to delete the WebObjectInfo indicated.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public FolderDeleteObjectTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Returns this transform's description.

Returns
  • description for the transform

public ArrayList getSelectedObjects ()

public void renderButtonBar (MarkupOutput out)

This method is deprecated.
please use renderButtonBar(MarkupOutput, WebObjectInfo)

Renders the delete form information and buttons for allowing the user to confirm if s/he wants to delete the object or not.

Parameters
out MarkupOutput instance where the HTML content to display will be saved.

public void renderButtonBar (MarkupOutput out, WebObjectInfo selectedObject)

Renders the delete form information and buttons for allowing the user to confirm if s/he wants to delete the object or not.

Parameters
out MarkupOutput instance where the HTML content to display will be saved.
selectedObject WebObjectInfo instance to be deleted

public void renderDeleteConfirmation (MarkupOutput out, WebObjectInfo selectedObject)

Renders the delete confirmation question text.

Parameters
out MarkupOutput instance where the HTML content to display will be saved.
selectedObject WebObjectInfo instance to be deleted

public void renderDeleteConfirmation (MarkupOutput out)

This method is deprecated.
please use renderDeleteConfirmation(MarkupOutput, WebObjectInfo)

Renders the delete confirmation question text.

Parameters
out MarkupOutput instance where the HTML content to display will be saved.

public void renderDeleteForm (MarkupOutput out, WebObjectInfo object)

This method is deprecated.
call renderButtonBar(MarkupOutput) instead.

Renders the delete form for asking the user to confirm if s/he wants to delete the object or not.

Parameters
out MarkupOutput instance to modify with the transform's output.
object WebObjectInfo object marked as the one to be deleted.

public void renderDeleteTitle (MarkupOutput out)

Render the title corresponding to the message this transform will display

Parameters
out MarkupOutput instance where the HTML content to display will be saved.

public void renderList (MarkupOutput out, WebDisplayUnits list)

This method is deprecated.
please use and customize renderList(MarkupOutput) instead. This method will not be called by future releases.

Renders the folder contents with the single object that has been selected to be removed, as indicated by the isObjectSelected(WebObjectInfo) method. All the other children not selected will not be rendered.

Parameters
out MarkupOutput instance to modify with the transform's output.
list WebDisplayUnits instance with the list of objects available on the folder, by default these will not be rendered.

public void renderObject (MarkupOutput out, WebObjectInfo object)

Renders the object information of the object to delete (internally it uses an ObjectInfoTransform to accomplish this).

Parameters
out MarkupOutput instance to modify with the transform's output.
object WebObjectInfo object marked to be deleted.

public void renderObject (MarkupOutput out)

This method is deprecated.
please use renderObject(MarkupOutput, WebObjectInfo)

Renders the information of the object to be deleted. Internally, calls for the renderObject(MarkupOutput, WebObjectInfo) method.

Parameters
out MarkupOutput instance to modify with the transform's output.

Protected Methods

protected WebEvent getCancelEvent (WebObjectInfo object)

Returns an initialized WebEvent for being able to cancel the deletion of the WebObjectInfo indicated.

Parameters
object the WebObjectInfo instance is intended to be deleted, unless this event gets called.
Returns
  • an initialized WebEvent object if the application supports it. Otherwise, will return null.

protected WebEvent getDeleteObjectEvent (WebObjectInfo object)

Returns an initialized WebEvent for being able to delete the WebObjectInfo indicated.

Parameters
object the WebObjectInfo instance which will be deleted if the event is called.
Returns
  • an initialized WebEvent object if the application supports it. Otherwise, will return null.