public class

GuiElementsBlockTransform

extends AbstractAppWidgetTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
           ↳ com.microstrategy.web.app.transforms.GuiElementsBlockTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Provides several methods usefull for block transformation typically used on the block layout file

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
GuiElementsBlockTransform()
Public Methods
ArrayList<List<String>> getAutoStyles()
Return the list of available autostyles.
String getDescription()
String getElementID(List<String> obj)
Extracts the ID from a Shortcut element.
String getElementName(List<String> obj)
Extracts the ID from a Shortcut element.
String getListAttribute(Shortcut shortcut, String name)
Extracts an attribute node from a Shortcut element.
ArrayList<Shortcut> getPickerList(String name)
Return the requested picker list.
String getRequestParameterValue(String name, String defaultValue)
String getRequestParameterValueEncoded(String name, String defaultValue)
String getShortcutDescriptor(Shortcut shortcut)
Extracts the descriptors from a Shortcut element.
boolean isFeatureAvailable(String feature)
Convenience method.
void removeListItems(BlockList list, String indexString)
Removes items from a BlockList.
Protected Methods
ShortcutList getPicker(String pickerName)
Return a specific Picker's ShortcutList.
String getRequestKeyValue(String keyName)
Returns the value of a RequestKey using the getRequestKeys method then getValue.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
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 GuiElementsBlockTransform ()

Public Methods

public ArrayList<List<String>> getAutoStyles ()

Return the list of available autostyles.

Returns
  • An ArrayList populated with lists of elements for this picker, each list has in 0 the id and in 1 the name.

public String getDescription ()

public String getElementID (List<String> obj)

Extracts the ID from a Shortcut element.

Parameters
obj shortcut The current Shortcut from a picker list.
Returns
  • A String containing the requested descriptor value.

public String getElementName (List<String> obj)

Extracts the ID from a Shortcut element.

Parameters
obj shortcut The current Shortcut from a picker list.
Returns
  • A String containing the requested descriptor value.

public String getListAttribute (Shortcut shortcut, String name)

Extracts an attribute node from a Shortcut element.

Parameters
shortcut The current Shortcut from a picker list.
name The name of the requested attribute.
Returns
  • A String containing the requested attribute value.

public ArrayList<Shortcut> getPickerList (String name)

Return the requested picker list. This method will verify each Shortcut using it's feature id's if present in the picker.

Parameters
name The name of the desired picker from the pageConfig.xml file.
Returns
  • An ArrayList populated with the Shortcut elements for this picker.

public String getRequestParameterValue (String name, String defaultValue)

Returns
  • the value of a parameter using the getRequestKeyValue or the default string if null

public String getRequestParameterValueEncoded (String name, String defaultValue)

Returns
  • encode value of a parameter return by getRequestParameterValue

public String getShortcutDescriptor (Shortcut shortcut)

Extracts the descriptors from a Shortcut element.

Parameters
shortcut The current Shortcut from a picker list.
Returns
  • A String containing the requested descriptor value.

public boolean isFeatureAvailable (String feature)

Convenience method. Maps the isFeatureAvailable method of the Bean currently bean Transformed.

Parameters
feature the feature Id.
Returns
  • true by default, or whatever _bean.isFeatureAvailable(feature) returns;

public void removeListItems (BlockList list, String indexString)

Removes items from a BlockList.

Parameters
list The BlockList to be edited.
indexString A comma delimited string of indexes to be removed from the list.

Protected Methods

protected ShortcutList getPicker (String pickerName)

Return a specific Picker's ShortcutList.

Parameters
pickerName The name of the picker to retrieve.
Returns

protected String getRequestKeyValue (String keyName)

Returns the value of a RequestKey using the getRequestKeys method then getValue.

Parameters
keyName The name of the RequestKey to return.
Returns
  • The String value of the specified RequestKey.