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

FolderCreateReportXHTMLTransform

Known Indirect Subclasses

FolderCreateDocumentTransform, FolderSummaryCreateDocumentTransform, FolderSummaryCreateReportTransform

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

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

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

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

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.

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

Interfaces

Classes

FolderIconRadioButtonTransform

Class Overview

Summary

Constants

public static final String FP_IMG_ANCHOR_JS_FLAG

public static final String FP_LABEL_ANCHOR_JS_FLAG

public static final String FP_RENDER_FORM_TAG

Fields

public FormalParameter imgAnchorJS

public FormalParameter labelAnchorJS

public FormalParameter renderFormTag

Public Constructors

public FolderIconRadioButtonTransform ()

Public Methods

public String getDescription ()

Returns

public void renderDescriptionInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderIconInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderItems (MarkupOutput out)

Parameters

public void renderList (MarkupOutput out, WebDisplayUnits list)

Parameters

public void renderNameInfo (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderNextButton (MarkupOutput out)

Parameters

public void renderObject (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderObjectDescription (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderObjectImage (MarkupOutput out, WebObjectInfo object)

Parameters

public void renderObjectName (MarkupOutput out, WebObjectInfo object)

Parameters

public void transformForRequestSuccessful (MarkupOutput out)

Parameters

public boolean wereItemsRendered ()

Returns

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Parameters

Returns

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

Parameters

Returns

protected WebEvent getOpenObjectEvent ()

Returns

protected void renderFormInputInfo (MarkupOutput out, WebEvent openEvent)

Parameters