public class

PromptObjectBrowsingTransform

extends PromptCartTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
         ↳ com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform
           ↳ com.microstrategy.web.app.transforms.PromptCartTransform
             ↳ com.microstrategy.web.app.transforms.PromptObjectBrowsingTransform

This class is deprecated.
Use PromptObjectBrowsingXHTMLTransform instead

Class Overview

Renders prompt content in a "shopping cart" style with a browseable folder path.
It extends PromptCartTransform by adding a folder path above the prompt question and by allowing end-user to navigate to available subfolders. Also, it will only display objects that are defined in prompt definition; this means that if only templates are to be displayed then any instance will be displayed if found under given subfolder.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.beans.EnumPromptsBeanEvents
Fields
protected String _backToParentFolderImage
public FormalParameter backToParentFolderImage Image for going up in browsing path for object prompts.
protected String browsePath Browse path string.
public FormalParameter cssItemName Formal parameter of the prefix to append to all css class names
public FormalParameter folderPathSeparator Character used as separator in browsing path for object prompts.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.PromptCartTransform
From class com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform
From class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
Public Constructors
PromptObjectBrowsingTransform()
Default no-args constructor, initialize all the formal parameters.
Public Methods
boolean canTransform(Transformable data)
Indicates whether or not given component can be transformed.
String getDescription()
Indicates class description.
void initializeImages()
Initializes all images to be used in this transform.
void renderBackParentButton(MarkupOutput out)
Renders 'Back' button.
void renderCart(MarkupOutput out)
Renders a shopping cart.
void renderFoldersPath(MarkupOutput out)
Renders folders formatted path text.
void renderLabel(MarkupOutput out, String labelName)
Renders an HTML label.
void renderPromptContent(MarkupOutput out)
Renders prompt HTML content.
void renderSubFolderPullDown(MarkupOutput out)
Renders subfolders pull down menu.
Protected Methods
Boolean isThereAnyFolderToRender()
Determines whether there's a root folder as default point for browsing.
void updateIncrementalFetchCartProperties()
Updates incremental fetch properties in Cart object.
void writeAncestors(MarkupOutput out, SimpleList ancestors, int currentAncestor)
Recursevily renders folder anscestors names.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.PromptCartTransform
From class com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform
From class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.transform.Transform

Fields

protected String _backToParentFolderImage

public FormalParameter backToParentFolderImage

Image for going up in browsing path for object prompts.
Object Prompts might support object browsing. This is done by displaying a browsing path above given prompt question. This path is similar to that used for displaying location of a given report. This image represents the button for allowing end-users to browse up in the hierarchy.

protected String browsePath

Browse path string.

public FormalParameter cssItemName

Formal parameter of the prefix to append to all css class names

public FormalParameter folderPathSeparator

Character used as separator in browsing path for object prompts.
This flag is used as text value.

Public Constructors

public PromptObjectBrowsingTransform ()

Default no-args constructor, initialize all the formal parameters.

Public Methods

public boolean canTransform (Transformable data)

Indicates whether or not given component can be transformed.
Extends canTransform() by returning true only if the prompt is of type EnumWebPromptType.WebPromptTypeObjects

Parameters
data object (PromptObject) to transform
Returns
  • true if the data is a PromptObject of a Expression WebPrompt, which can be transformed.

public String getDescription ()

Indicates class description.

Returns
  • String description.

public void initializeImages ()

Initializes all images to be used in this transform.
It also invokes parent method so all shared images get initialized as well.

public void renderBackParentButton (MarkupOutput out)

Renders 'Back' button.
THis button will enable end-user to navigate the different folders available to the parent one.

Parameters
out MarkupOutput instance where the output HTML will be stored.

public void renderCart (MarkupOutput out)

Renders a shopping cart.
It invokes renderAvailable(), renderArrows() and renderSelected().

Parameters
out MarkupOutput where to write the output of the method.

public void renderFoldersPath (MarkupOutput out)

Renders folders formatted path text.

Parameters
out MarkupOutput where to write the output of the method.

public void renderLabel (MarkupOutput out, String labelName)

Renders an HTML label.

Parameters
out MarkupOutput where to write the output of the method.
labelName string of label to be displayed.

public void renderPromptContent (MarkupOutput out)

Renders prompt HTML content.

Parameters
out MarkupOutput where to write the output of the method.

public void renderSubFolderPullDown (MarkupOutput out)

Renders subfolders pull down menu.

Parameters
out MarkupOutput where to write the output of the method.

Protected Methods

protected Boolean isThereAnyFolderToRender ()

Determines whether there's a root folder as default point for browsing.
This is determined only if there are folder objects in available units.

Returns
  • boolean true if there's a starting point for browsing.

protected void updateIncrementalFetchCartProperties ()

Updates incremental fetch properties in Cart object.
Mostly, the total of units is calculated after processing available units, hence, we need to reflect this in Cart incremental fetch properties only if Incremental fetch is enabled (isIncrementalFetchAvailable() is invoked). Incremental Fetch object is obtained from Prompt's cart infrastructure. This function updates its Block Count, Block Begin and Total count properties.

protected void writeAncestors (MarkupOutput out, SimpleList ancestors, int currentAncestor)

Recursevily renders folder anscestors names.

Parameters
out where to write the output of the method.
ancestors list of folder ancestors
currentAncestor current ancestor being rendered.