public class

FolderIconRadioButtonTransform

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

Class Overview

This transform renders the contents of a folder as a list of objects with icons and radio buttons. The Radio button is only presented, though, if an eventId has been set to open the selected item.

Summary

Constants
String FP_IMG_ANCHOR_JS_FLAG Constant specifying the name of the formal parameter for defining the JS function to be invoked when selecting object image.
String FP_LABEL_ANCHOR_JS_FLAG Constant specifying the name of the formal parameter for defining the JS function to be invoked when selecting object label name.
String FP_RENDER_FORM_TAG
[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
Fields
public FormalParameter imgAnchorJS Indicates whether or not to render an HTML anchor (JS method) surrounding object's image.
public FormalParameter labelAnchorJS Indicates whether or not to render an HTML anchor (JS method) surrounding object name.
public FormalParameter renderFormTag Indicates whether to render the form surrounding the folder contents.
[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
FolderIconRadioButtonTransform()
Public Methods
String getDescription()
Return the description for this Transform
void renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Renders the description information of the given object.
void renderIconInfo(MarkupOutput out, WebObjectInfo object)
Renders the HTML code for displaying the image sthat will be associated with the object to show to the user.
void renderItems(MarkupOutput out)
Renders the contents of the provided folder
void renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. please use and customize renderList(MarkupOutput) instead since this method will not be called on future releases.
void renderNameInfo(MarkupOutput out, WebObjectInfo object)
Renders the name information of the given object.
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.
void renderObjectDescription(MarkupOutput out, WebObjectInfo object)
This method is deprecated. please use renderDescriptionInfo(MarkupOutput, WebObjectInfo) instead
void renderObjectImage(MarkupOutput out, WebObjectInfo object)
This method is deprecated. please use renderIconInfo(MarkupOutput, WebObjectInfo) instead
void renderObjectName(MarkupOutput out, WebObjectInfo object)
This method is deprecated. please use renderNameInfo(MarkupOutput, WebObjectInfo) instead
void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.
boolean wereItemsRendered()
Indicates if elements were rendered as part of this transform.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided
Tag generateRadioButtonForObject(WebEvent openEvent, WebObjectInfo object, boolean selected)
Generates the radio button for the WebObjectInfo specified, according with the WebEvent specified.
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.
[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

Constants

public static final String FP_IMG_ANCHOR_JS_FLAG

Constant specifying the name of the formal parameter for defining the JS function to be invoked when selecting object image.

Constant Value: "imgAnchorJS"

public static final String FP_LABEL_ANCHOR_JS_FLAG

Constant specifying the name of the formal parameter for defining the JS function to be invoked when selecting object label name.

Constant Value: "labelAnchorJS"

public static final String FP_RENDER_FORM_TAG

Constant Value: "renderFormTag"

Fields

public FormalParameter imgAnchorJS

Indicates whether or not to render an HTML anchor (JS method) surrounding object's image.
This formal parameter will indicate a JS function name to be invoked when object's image is selected. It'll affect renderObjectImage() function behavior. Default value is empty String

public FormalParameter labelAnchorJS

Indicates whether or not to render an HTML anchor (JS method) surrounding object name.
This formal parameter will indicate a JS function name to be invoked when object link name is selected. It'll affect renderObjectName() function behavior. Default value is empty String

public FormalParameter renderFormTag

Indicates whether to render the form surrounding the folder contents.

Public Constructors

public FolderIconRadioButtonTransform ()

Public Methods

public String getDescription ()

Return the description for this Transform

Returns
  • String with the description for the transform.

public void renderDescriptionInfo (MarkupOutput out, WebObjectInfo object)

Renders the description information of the given object.

Parameters
out MarkupOutput instance to modify with the transform's output.
object WebObjectInfo instance being displayed

public void renderIconInfo (MarkupOutput out, WebObjectInfo object)

Renders the HTML code for displaying the image sthat will be associated with the object to show to the user.
If imgAnchorJS formal parameter's value is different to empty String and DHTML is on, then label will be consisted of an HTML anchor that will invoke a JS function denoted by this formal parameter.

Parameters
out MarkupOutput instance to modify with the transform's output.
object WebObjectInfo instance being analyzed

public void renderItems (MarkupOutput out)

Renders the contents of the provided folder

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

public void renderList (MarkupOutput out, WebDisplayUnits list)

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

Renders the folder contents in a radio list button format with icons, consisting on a series of DIV HTML tags. 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 renderNameInfo (MarkupOutput out, WebObjectInfo object)

Renders the name information of the given object. Since it's a radio button transform, it will associate a radio button with the name label.
If labelAnchorJS formal parameter's value is different to empty String and DHTML is on, then label will be consisted of an HTML anchor that will invoke a JS function denoted by this formal parameter.

Parameters
out MarkupOutput instance to modify with the transform's output.
object WebObjectInfo instance being displayed

public void renderNextButton (MarkupOutput out)

Renders a button for allowing the selected object in the radio button list to be executed.

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.
Builds a series of DIV tags where the information coming from the renderObjectImage(MarkupOutput, WebObjectInfo), renderObjectName(MarkupOutput, WebObjectInfo) and renderObjectDescription(MarkupOutput, WebObjectInfo) methods generate.

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

public void renderObjectDescription (MarkupOutput out, WebObjectInfo object)

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

Renders the description information of the given object.

Parameters
out MarkupOutput instance to modify with the transform's output.
object WebObjectInfo instance being displayed

public void renderObjectImage (MarkupOutput out, WebObjectInfo object)

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

Renders the HTML code for displaying the image sthat will be associated with the object to show to the user.
If imgAnchorJS formal parameter's value is different to empty String and DHTML is on, then label will be consisted of an HTML anchor that will invoke a JS function denoted by this formal parameter.

Parameters
out MarkupOutput instance to modify with the transform's output.
object WebObjectInfo instance being analyzed

public void renderObjectName (MarkupOutput out, WebObjectInfo object)

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

Renders the name information of the given object. Since it's a radio button transform, it will associate a radio button with the name label.
If labelAnchorJS formal parameter's value is different to empty String and DHTML is on, then label will be consisted of an HTML anchor that will invoke a JS function denoted by this formal parameter.

Parameters
out MarkupOutput instance to modify with the transform's output.
object WebObjectInfo instance being displayed

public void transformForRequestSuccessful (MarkupOutput out)

Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public boolean wereItemsRendered ()

Indicates if elements were rendered as part of this transform.

Returns
  • boolean value indicating if elements were already rendered by this transform. For this condition to be true, the renderObjectName method should have been already called and successfully generate a radio button for it. If overwritting the renderObjectName method then this other method should also be updated.

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes if the event is not provided

Parameters
event WebEvent
Returns
  • AnchorTag

protected Tag generateRadioButtonForObject (WebEvent openEvent, WebObjectInfo object, boolean selected)

Generates the radio button for the WebObjectInfo specified, 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
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
Returns
  • the Tag initialized instance corresponding to the radio button generated.

protected WebEvent getOpenObjectEvent ()

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

Returns
  • a WebEvent instance initialized associated with the REPORT_EVENT_EXECUTE event. Returns 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