public class

FolderRadioButtonTransform

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.FolderRadioButtonTransform
Known Direct Subclasses

This class is deprecated.
Please use FolderIconRadioButtonTransform instead

Class Overview

This transform renders the contents of a folder as a list of objects with radio buttons. The radio button is displayed only if an event has been defined by the by the getOpenObjectEvent() method to open the selected item, in which case the radio button value will be the object identifier.

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
FolderRadioButtonTransform()
Class constructor, initializes the formal parameters.
Public Methods
String getDescription()
Return the description for this Transform
void renderItems(MarkupOutput out)
Renders each one of the items inside the folder being transformed.
void renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. please note that this method will later on be replaced by using renderList(MarkupOutput) directly, having the list of children to be rendered there will come from the getSortedList() method. Please consider then overwriting the code from renderList(MarkupOutput) instead of from this method.
void renderNextButton(MarkupOutput out)
Renders a button for allowing the selected object in the radio button list to be executed.
void renderObject(MarkupOutput out, WebObjectInfo object)
Renders the WebObjectInfo object requested according to the specifications of this transform.
Protected Methods
WebEvent getOpenObjectEvent()
Creates and initializes a WebEvent for having the object opened or run.
void renderFormInputInfo(MarkupOutput out, WebEvent openEvent)
Render any hidden input information that has to be added while displaying the contents in the folder, according with the WebEvent specified.
void renderRadioButtonForObject(MarkupOutput out, WebEvent openEvent, WebObjectInfo object, boolean selected)
Render the radio button for the WebObjectInfo specified, according with the WebEvent defined.
[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 FolderRadioButtonTransform ()

Class constructor, initializes the formal parameters.

Public Methods

public String getDescription ()

Return the description for this Transform

Returns
  • String with the description for the transform.

public void renderItems (MarkupOutput out)

Renders each one of the items inside the folder being transformed.

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 note that this method will later on be replaced by using renderList(MarkupOutput) directly, having the list of children to be rendered there will come from the getSortedList() method. Please consider then overwriting the code from renderList(MarkupOutput) instead of from this method.

Renders the folder contents in a radio list button format, consisting on a main HTML TABLE, and where each one of the objects inside the folder get rendered as a TR inside of it. All the objects will belong to a main FORM, which event specification is given by the getOpenObjectEvent() method. For submitting this FORM, a button will be displayed at the end of the list, specified by the renderNextButton() method.

Parameters
out MarkupOutput instance to modify with the transform's output.
list WebDisplayUnits instance with the list of objects that will be rendered by this transform, as contents of the folder being analyzed.

public void renderNextButton (MarkupOutput out)

Renders a button for allowing the selected object in the radio button list to be executed.
The HTML contents generated by this method are inside an HTML TR tag, therefore the main TABLE tag where this row will exist has to be created beforehand. By default, the renderList() method takes care of it.

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

public void renderObject (MarkupOutput out, WebObjectInfo object)

Renders the WebObjectInfo object requested according to the specifications of this transform.
The HTML contents generated by this method are inside a TR tag with two cells (one for the radio button, another for the object name and description), therefore the parent TABLE needs to be opened beforehand. By default, the renderList() method takes care of that.

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.

Protected Methods

protected WebEvent getOpenObjectEvent ()

Creates and initializes a WebEvent for having the object opened or run.

Returns
  • a WebEvent instance initialized, or null if the application does not support the event.

protected void renderFormInputInfo (MarkupOutput out, WebEvent openEvent)

Render any hidden input information that has to be added while displaying the contents in the folder, according with the WebEvent specified. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.

Parameters
out MarkupOutput where the HTML output will be saved
openEvent WebEvent representing the action to do with the given object

protected void renderRadioButtonForObject (MarkupOutput out, WebEvent openEvent, WebObjectInfo object, boolean selected)

Render the radio button for the WebObjectInfo specified, according with the WebEvent defined. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.

Parameters
out MarkupOutput where the HTML output will be saved
openEvent WebEvent representing the action to do with the given object
object WebObjectInfo currently being processed
selected boolean indicating if the radio button should be selected or not