public abstract class

AbstractObjectInfoListTransform

extends AbstractAppTransform
implements LayoutTransform
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
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

AbstractObjectInfoListTransform is an abstract class that takes care of rendering a bean that holds WebObjectInfo instances on a list structure.

Summary

Constants
String FP_INCREMENTAL_FETCH_NAV_TYPE Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch.
String FP_INCREMENTAL_FETCH_PAGE_BLOCK Constant specifying the name of the formal parameter for defining the page block size for incremental fetch.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected String imgBlank This field is deprecated. please use _imgBlank instead
protected FormalParameter incrementalFetchNavigationType Formal parameter that specifies which type of incremental fetch navigation will be enabled.
public FormalParameter incrementalFetchPageBlock Indicates the number of pages to show per block for incremental fetch.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractObjectInfoListTransform()
Class constructor
tag.
Public Methods
Map addCSSForObjectType(WebObjectInfo object)
Return the class Attribute to be used in the table cell for the transform.
String getCssName(WebObjectInfo object)
Utility method that helps giving the CSS class to use based on the the object type of the WebObjectInfo instance.
abstract WebEvent getEvent(WebObjectInfo object)
Generate the event that allows users to request actions on a given object.
abstract int getGoToArgument()
abstract WebEvent getGoToEvent()
Map<String, String> getListItemAttributes(WebObjectInfo object)
Add attributes to List View Item
String getObjectAbbreviation(WebObjectInfo object)
Utility method for obtaining the abbreviation of the object being analyzed
String getObjectDescription(WebObjectInfo object)
Utility method for obtaining the description of the object being analyzed
String getObjectModificationTime(WebObjectInfo object)
Utility method for obtaining the modification time of the object being analyzed
String getObjectName(WebObjectInfo object)
Utility method for obtaining the name of the object being analyzed
String getOwnerName(WebObjectInfo object)
Utility method for obtaining the owner of the object being analyzed
abstract List getSortedList()
void initializeImages()
Initialize the images to be used by this transform.
abstract boolean isEmptyList()
boolean isUserEnabled(WebUser object)
Utility method for determining if the user object is enabled or not.
void renderAbbreviationInfo(MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)
Write out abbreviation information for a single object.
void renderAbbreviationInfo(MarkupOutput out, WebObjectInfo object)
Write out abbreviation information for a single object.
void renderDescriptionInfo(MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)
Write out description information for a single object.
void renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Write out description information for a single object.
void renderEmptyList(MarkupOutput out)
Generate HTML contents when the list of the underlying bean being rendered is empty
void renderIconInfo(MarkupOutput out, WebObjectInfo object)
Write out the image information for a single object.
void renderIncrementalFetch(MarkupOutput out)
Renders the incremental fetch links for the browse list, including the images.
void renderIsUserEnabled(MarkupOutput out, WebObjectInfo object)
Write out information about the object being enabled or not.
void renderIsUserEnabled(MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)
void renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object, boolean largeIconView)
overloaded...
void renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object)
Similar to renderIconInfo(MarkupOutput, WebObjectInfo), but instead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) and an inner SPAN for the layering effect, in case an additional image has to be included, on top of the original (for example, a shortcut arrow, a red error sign, etc).
void renderList(MarkupOutput out)
Generate HTML contents when the list of the underlying bean being rendered holds objects
void renderLocationInfo(MarkupOutput out, WebObjectInfo object)
Write out the location information for a single object, by using the PathTransform transform, including the ancestors of the specified object.
void renderModifiedInfo(MarkupOutput out, WebObjectInfo object)
Write out modified time information for a single object.
void renderNameInfo(MarkupOutput out, WebObjectInfo object)
Write out name information for a single object.
void renderObject(MarkupOutput out, WebObjectInfo object)
Generate HTML output for a single object from the list being processed.
void renderOwnerInfo(MarkupOutput out, WebObjectInfo object)
Write out owner information for a single object
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
abstract int getBlockPosition()
abstract int getBlockSize()
abstract int getChildCount()
boolean getDereferenceShortcuts(WebObjectInfo object)
Get 'dereferenceShortcuts' flag
String getImageName(WebObjectInfo object)
Utility method that helps giving the image name to use - based on the information available on the formal parameters and on the the object type of the WebObjectInfo instance.
String getImageTooltip(WebObjectInfo object)
According to the object's type, generate the tooltip that will be displayed with the image to render.
IncrementalFetch getIncrementalFetchComponent()
Generate and initialize the IncrementalFetch component that will enable navigating the different elements of the full list of results in case it is not displayed all together at the same time.
Tag getNameWrapperTag(WebObjectInfo object)
PathTransform getPathTransform()
Get the PathTransform for rendering the path in location info.
static int getVisualizationMode(AbstractAppTransform transform, WebObjectInfo object)
int getVisualizationMode(WebObjectInfo object)
static boolean isVisualizationObject(AbstractAppTransform transform, WebObjectInfo object)
boolean isVisualizationObject(WebObjectInfo object)
[Expand]
Inherited Methods
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_INCREMENTAL_FETCH_NAV_TYPE

Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch. Value is incrementalFetchNavigationType.

Constant Value: "incrementalFetchNavigationType"

public static final String FP_INCREMENTAL_FETCH_PAGE_BLOCK

Constant specifying the name of the formal parameter for defining the page block size for incremental fetch. Value is incrementalFetchPageBlock.

Constant Value: "incrementalFetchPageBlock"

Fields

protected String imgBlank

This field is deprecated.
please use _imgBlank instead

Property that holds the file and path information for a transparent/blank image

protected FormalParameter incrementalFetchNavigationType

Formal parameter that specifies which type of incremental fetch navigation will be enabled. Allowed values: a valid bitwise combination of NAVIGATION_BUTTONS_FIRST_LAST and/or NAVIGATION_BUTTONS_PREVIOUS_NEXT , NAVIGATION_BUTTONS_PREVIOUS_NEXT_SET

public FormalParameter incrementalFetchPageBlock

Indicates the number of pages to show per block for incremental fetch.
Default value is 5, so the incremental fetch will render the navigation arrows for moving up and down five pages at the time.

Public Constructors

public AbstractObjectInfoListTransform ()

Class constructor

Public Methods

public Map addCSSForObjectType (WebObjectInfo object)

Return the class Attribute to be used in the table cell for the transform.

Parameters
object WebObjectInfo to be rendered.
Returns
  • java.util.Map with the attribute name (as key) and the value.

public String getCssName (WebObjectInfo object)

Utility method that helps giving the CSS class to use based on the the object type of the WebObjectInfo instance.

Parameters
object The WebObjectInfo for which it's image name is required.
Returns
  • a String with the name of the CSS class that should be associated with the WebObjectInfo information to display. If the type specified does not match the predefined list of styles, then it returns an empty string.

public abstract WebEvent getEvent (WebObjectInfo object)

Generate the event that allows users to request actions on a given object.

Parameters
object WebObjectInfo base object for a request.
Returns
  • WebEvent instance corresponding to the event enabled for the WebObjectInfo provided. If no possible manipulation on the object is authorized, null will be returned.

public abstract int getGoToArgument ()

Returns
  • the identifier of the argument on the getGoToEvent() event where the element to navigate to will be specified.

public abstract WebEvent getGoToEvent ()

Returns
  • WebEvent instance with the information for handling incremental fetch requests on the list of objects being rendered by this transform. If not supported, it will return null

public Map<String, String> getListItemAttributes (WebObjectInfo object)

Add attributes to List View Item tag. By Default, add CSS class attribute to support banding effect in list view This function is currently called in User Management and Security Role pages to add CSS class attribute to every other tag in the listView

. Returns a map containing the attributes to add to the container of every object in the list of contents.

Parameters
object WebObjectInfo - List View Item
Returns
  • Map

public String getObjectAbbreviation (WebObjectInfo object)

Utility method for obtaining the abbreviation of the object being analyzed

Parameters
object WebObjectInfo instance to be processed.
Returns
  • value of the abbreviation property of the object.

public String getObjectDescription (WebObjectInfo object)

Utility method for obtaining the description of the object being analyzed

Parameters
object WebObjectInfo instance to be processed.
Returns
  • value of the description property of the object. If handling a shortcut, it will obtain the property of the original target object and return this as result. By default the result might be encoded - as indicated on the Administrator's settings - for its proper display on HTML.

public String getObjectModificationTime (WebObjectInfo object)

Utility method for obtaining the modification time of the object being analyzed

Parameters
object WebObjectInfo instance to be processed.
Returns
  • value of the modification time property of the object. If handling a shortcut, it will obtain the property of the original target object and return this as result. If no modification time can be found, it will return its creation time.

public String getObjectName (WebObjectInfo object)

Utility method for obtaining the name of the object being analyzed

Parameters
object WebObjectInfo instance to be processed.
Returns
  • value of the name property of the object. If handling a shortcut, it will obtain the property of the original target object and return this as result. By default the result will be encoded for its proper display on HTML.

public String getOwnerName (WebObjectInfo object)

Utility method for obtaining the owner of the object being analyzed

Parameters
object WebObjectInfo instance to be processed.
Returns
  • value of the owner property of the object.

public abstract List getSortedList ()

Returns
  • a List instance with all the elements from the bean to be rendered by this transform. The contents will already be sorted if required.

public void initializeImages ()

Initialize the images to be used by this transform.

public abstract boolean isEmptyList ()

Returns
  • true if the underlying object list is empty.

public boolean isUserEnabled (WebUser object)

Utility method for determining if the user object is enabled or not.

Parameters
object WebUser instance to be processed.
Returns
  • value of the enabled property of the object.

public void renderAbbreviationInfo (MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)

Write out abbreviation information for a single object.

Parameters
out MarkupOutput instance where the contents generated will be stored.
object WebObjectInfo instance to be rendered.
renderBlankspace If abbreviation is not available, if this flag is true it will render a white space for it, otherwise it will not render anything.

public void renderAbbreviationInfo (MarkupOutput out, WebObjectInfo object)

Write out abbreviation information for a single object.

Parameters
out MarkupOutput instance where the contents generated will be stored.
object WebObjectInfo instance to be rendered.

public void renderDescriptionInfo (MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)

Write out description information for a single object.

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.
renderBlankspace boolean to specify whether it should render a empty cell when it is empty. (otherwise no content is rendered).

public void renderDescriptionInfo (MarkupOutput out, WebObjectInfo object)

Write out description information for a single object.

Parameters
out MarkupOutput instance where the contents generated will be stored.
object WebObjectInfo instance to be rendered.

public void renderEmptyList (MarkupOutput out)

Generate HTML contents when the list of the underlying bean being rendered is empty

Parameters
out MarkupOutput instance where the contents generated will be stored.

public void renderIconInfo (MarkupOutput out, WebObjectInfo object)

Write out the image information for a single object. The css class of the image (which defines the GIF to use) is determined by the object type. The image will be rendered as a link if the event according to the object type, provided by the getEvent() method, is available.

Parameters
out MarkupOutput instance where the contents generated will be stored.
object WebObjectInfo instance to be rendered.

public void renderIncrementalFetch (MarkupOutput out)

Renders the incremental fetch links for the browse list, including the images.

Parameters
out MarkupOutput instance which includes the HTML for the header of the table to be used on the transform

public void renderIsUserEnabled (MarkupOutput out, WebObjectInfo object)

Write out information about the object being enabled or not. This method by default only generates contents for the WebUser object types.

Parameters
out MarkupOutput instance where the contents generated will be stored.
object WebObjectInfo instance to be rendered.

public void renderIsUserEnabled (MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)

public void renderLayeredIconInfo (MarkupOutput out, WebObjectInfo object, boolean largeIconView)

overloaded... Similar to renderIconInfo(MarkupOutput, WebObjectInfo), but instead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) and an inner SPAN for the layering effect, in case an additional image has to be included, on top of the original (for example, a shortcut arrow, a red error sign, etc).

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.
largeIconView flag for a largeIconView or listView

public void renderLayeredIconInfo (MarkupOutput out, WebObjectInfo object)

Similar to renderIconInfo(MarkupOutput, WebObjectInfo), but instead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) and an inner SPAN for the layering effect, in case an additional image has to be included, on top of the original (for example, a shortcut arrow, a red error sign, etc).

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

public void renderList (MarkupOutput out)

Generate HTML contents when the list of the underlying bean being rendered holds objects

Parameters
out MarkupOutput instance where the contents generated will be stored.

public void renderLocationInfo (MarkupOutput out, WebObjectInfo object)

Write out the location information for a single object, by using the PathTransform transform, including the ancestors of the specified object.

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

public void renderModifiedInfo (MarkupOutput out, WebObjectInfo object)

Write out modified time information for a single object.

Parameters
out MarkupOutput instance where the contents generated will be stored.
object WebObjectInfo instance to be rendered.

public void renderNameInfo (MarkupOutput out, WebObjectInfo object)

Write out name information for a single object.
The text will be rendered as a link if the event according to the object type, provided by the getEvent() method, is available.

Parameters
out MarkupOutput instance where the contents generated will be stored.
object WebObjectInfo instance to be rendered.

public void renderObject (MarkupOutput out, WebObjectInfo object)

Generate HTML output for a single object from the list being processed.

Parameters
out MarkupOutput instance where the contents generated will be stored.
object WebObjectInfo instance to be rendered.

public void renderOwnerInfo (MarkupOutput out, WebObjectInfo object)

Write out owner information for a single object

Parameters
out MarkupOutput instance where the contents generated will be stored.
object WebObjectInfo instance to be rendered.

public void transformForRequestSuccessful (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Parameters
out output by this transform

Protected Methods

protected abstract int getBlockPosition ()

Returns
  • value of the property indicating the index of the first element currently being viewed as part of the list output. Used for incremental fetch purposes.

protected abstract int getBlockSize ()

Returns
  • value of the property indicating the number of elements included on a single 'page' of the list output. Used for incremental fetch purposes.

protected abstract int getChildCount ()

Returns
  • the total number of elements that are included on the list that could be rendered by this transform. Used for incremental fetch purposes.

protected boolean getDereferenceShortcuts (WebObjectInfo object)

Get 'dereferenceShortcuts' flag

Returns
  • Default 'true' - //retun true to be consistent with existing behavior

protected String getImageName (WebObjectInfo object)

Utility method that helps giving the image name to use - based on the information available on the formal parameters and on the the object type of the WebObjectInfo instance.

Parameters
object The WebObjectInfo for which it's image name is required.
Returns
  • a String with the name of the image associated with the WebObjectInfo. If the type specified does not match the predefined list of styles, then it returns the file name and path for the blank (transparent) image.

protected String getImageTooltip (WebObjectInfo object)

According to the object's type, generate the tooltip that will be displayed with the image to render. For example, when the object type is DssXmlTypeFolder, it will generate the corresponding localized descriptor for Open Folder.

Parameters
object The WebObjectInfo for which it's tooltip is required.
Returns
  • A String with the tooltip to set to the image associated with the WebObjectInfo.

protected IncrementalFetch getIncrementalFetchComponent ()

Generate and initialize the IncrementalFetch component that will enable navigating the different elements of the full list of results in case it is not displayed all together at the same time.

Returns

protected Tag getNameWrapperTag (WebObjectInfo object)

Parameters
object WebObjectInfo instance to be rendered.
Returns
  • a Tag instance with the name of the object to render already embedded. Might return null, in which case the object name will have to be obtained by calling the getObjectName(WebObjectInfo) method separately.

protected PathTransform getPathTransform ()

Get the PathTransform for rendering the path in location info.

protected static int getVisualizationMode (AbstractAppTransform transform, WebObjectInfo object)

protected int getVisualizationMode (WebObjectInfo object)

protected static boolean isVisualizationObject (AbstractAppTransform transform, WebObjectInfo object)

protected boolean isVisualizationObject (WebObjectInfo object)