public class

FolderViewXMLTransform

extends FolderViewTransform
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.FolderViewTransform
               ↳ com.microstrategy.web.app.transforms.FolderViewXMLTransform

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderViewTransform
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
FolderViewXMLTransform()
Public Methods
void renderCurFolderAccessGranted(MarkupOutput out)
void renderCurFolderID(MarkupOutput out)
void renderCurFolderName(MarkupOutput out)
void renderCurFolderPath(MarkupOutput out)
void renderObjectAccessGranted(MarkupOutput out, WebObjectInfo object)
void renderObjectDescription(MarkupOutput out, WebObjectInfo object)
Write out the object's description.
void renderObjectID(MarkupOutput out, WebObjectInfo object)
Write out the object's ID.
void renderObjectName(MarkupOutput out, WebObjectInfo object)
Write out the object's name.
void renderObjectSubType(MarkupOutput out, WebObjectInfo object)
Write out the object's type.
void renderObjectType(MarkupOutput out, WebObjectInfo object)
Write out the object's type.
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void renderShortcutInfo(MarkupOutput out, WebObjectInfo object)
Write out "1" if the object is a shortcut
Protected Methods
boolean isObjectVisible(WebObjectInfo object)
Utility method that checks if the object should be displayed or not, based on the information provided on the maxObjectTypeCount formal parameter and the current number of objects of that type that have been rendered already
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderViewTransform
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

Public Constructors

public FolderViewXMLTransform ()

Public Methods

public void renderCurFolderAccessGranted (MarkupOutput out)

public void renderCurFolderID (MarkupOutput out)

public void renderCurFolderName (MarkupOutput out)

public void renderCurFolderPath (MarkupOutput out)

public void renderObjectAccessGranted (MarkupOutput out, WebObjectInfo object)

public void renderObjectDescription (MarkupOutput out, WebObjectInfo object)

Write out the object's description.

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

public void renderObjectID (MarkupOutput out, WebObjectInfo object)

Write out the object's ID.

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

public void renderObjectName (MarkupOutput out, WebObjectInfo object)

Write out the object's name.

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

public void renderObjectSubType (MarkupOutput out, WebObjectInfo object)

Write out the object's type. This will be a value from EnumDSSXMLObjectSubTypes.

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

public void renderObjectType (MarkupOutput out, WebObjectInfo object)

Write out the object's type. This will be a value from EnumDSSXMLObjectTypes.

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

public void renderShell (MarkupOutput out)

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Parameters
out output by this transform

public void renderShortcutInfo (MarkupOutput out, WebObjectInfo object)

Write out "1" if the object is a shortcut

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

Protected Methods

protected boolean isObjectVisible (WebObjectInfo object)

Utility method that checks if the object should be displayed or not, based on the information provided on the maxObjectTypeCount formal parameter and the current number of objects of that type that have been rendered already

Parameters
object WebObjectInfo with the object to check for.
Returns
  • True if the object should be displayed, otherwise returns False