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

String	FP_CREATE_REPORT_DISPLAY_SECTION	Constant specifying the name of the formal parameter for defining which sections will be displayed in the Create Report page.
String	FP_DATAMART_IMAGE	Constant specifying the name of the formal parameter for defining the datamart image.
String	FP_DOCUMENT_IMAGE	Constant specifying the name of the formal parameter for defining the document image.
String	FP_EXEC_TARGET	Determines how the user want's to execute the Report/Document object.
String	FP_FILTER_IMAGE	Constant specifying the name of the formal parameter for defining the filter image.
String	FP_FOLDER_IMAGE	Constant specifying the name of the formal parameter for defining the folder image.
String	FP_GRAPH_IMAGE	Constant specifying the name of the formal parameter for defining the graph image.
String	FP_GRID_GRAPH_IMAGE	Constant specifying the name of the formal parameter for defining the gridGraph image.
String	FP_IMAGE_HEIGTH	Constant specifying the name of the formal parameter for defining the image height.
String	FP_IMAGE_WIDTH	Constant specifying the name of the formal parameter for defining the image width.
String	FP_LEVEL_FLAG	Constant specifying the name of the formal parameter for defining the level flag.
String	FP_MAX_OBJECT_TYPE_COUNT	Constant specifying the name of the formal parameter for defining the maximum object type count.
String	FP_REPORT_IMAGE	Constant specifying the name of the formal parameter for defining the report image.
String	FP_RW_DOCUMENT_IMAGE	Constant specifying the name of the formal parameter for defining the report writing document image.
String	FP_SORT_ASCENDING	Constant specifying the name of the formal parameter for defining the sort order of the folder contents.
String	FP_SORT_FIELD	Constant specifying the name of the formal parameter for defining the field from which the folder contents will be sorted.
String	FP_TABLE_ID	Constant specifying the name of the formal parameter for defining the table ID and NAME attributes of the HTML table to render.
String	FP_TEMPLATE_IMAGE	Constant specifying the name of the formal parameter for defining the template image.
int	LEVEL_ALL	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_CONFIRM_DELETE	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_DELETE	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_DESCRIPTION	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_DISPLAY_HEADERS	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EDIT	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EMPTY_FOLDER_MESSAGE	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EXPORT_EXCEL	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EXPORT_PDF	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_FOLDER_INFORMATION	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_INCREMENTAL_FETCH	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_LOCATION	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_MODIFIED	Allowed value for the {@link #leveimport com.microstrategy.web.objects.rw.; import com.microstrategy.web.tags.; import com.microstrategy.web.transform.*; er.
int	LEVEL_NAME	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_OWNER	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_SEND_NOW	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_SUBSCRIPTION	Allowed value for the `levelFlag` formal parameter.

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

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

Public Constructors
	FolderDeleteObjectTransform() Default no-argument constructor.

Public Methods
String	getDescription() Returns this transform's description.
ArrayList	getSelectedObjects()
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	renderButtonBar(MarkupOutput out) This method is deprecated. please use `renderButtonBar(MarkupOutput, WebObjectInfo)`
void	renderDeleteConfirmation(MarkupOutput out) This method is deprecated. please use `renderDeleteConfirmation(MarkupOutput, WebObjectInfo)`
void	renderDeleteConfirmation(MarkupOutput out, WebObjectInfo selectedObject) Renders the delete confirmation question text.
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

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

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

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

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, 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 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 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 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 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.

Interfaces

Classes

FolderDeleteObjectTransform

Class Overview

Summary

Public Constructors

public FolderDeleteObjectTransform ()

Public Methods

public String getDescription ()

Returns

public ArrayList getSelectedObjects ()

public void renderButtonBar (MarkupOutput out, WebObjectInfo selectedObject)

Parameters

public void renderButtonBar (MarkupOutput out)

Parameters

public void renderDeleteConfirmation (MarkupOutput out)

Parameters

public void renderDeleteConfirmation (MarkupOutput out, WebObjectInfo selectedObject)

Parameters

public void renderDeleteForm (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderDeleteTitle (MarkupOutput out)

Parameters

public void renderList (MarkupOutput out, WebDisplayUnits list)

Parameters

public void renderObject (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderObject (MarkupOutput out)

Parameters

Protected Methods

protected WebEvent getCancelEvent (WebObjectInfo object)

Parameters

Returns

protected WebEvent getDeleteObjectEvent (WebObjectInfo object)

Parameters

Returns