public class

GroupPathTransform

extends AbstractAdminPathTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractAdminPathTransform
           ↳ com.microstrategy.web.app.transforms.GroupPathTransform

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAdminPathTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAdminPathTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
GroupPathTransform()
Public Methods
int getAncestorIndex(WebObjectInfo ancestor)
Performs a search within the ancestors list for the given ancestor object and return its corresponding index.
List getAncestorsList()
String getDescription()
Return description for this Transform
Class getSupportedBeanType()
Returns the supported bean type.
void renderAncestor(MarkupOutput out, WebObjectInfo ancestor)
void renderAncestors(MarkupOutput out)
Renders the list of ancestors.
void renderCurrentItem(MarkupOutput out)
Renders the curent item
void renderEveryoneAsAncestor(MarkupOutput out)
void renderGoOneUp(MarkupOutput out)
Renders the Up One level button.
void renderGoUserManager(MarkupOutput out)
boolean shouldRenderEveryoneAsParent()
Protected Methods
WebEvent getGoParentPageEvent()
String getGoParentPageTooltip()
WebEvent getGoUserManagerEvent()
GroupPathBean getGroupPathBean()
WebEvent getOpenAncestorEvent(WebObjectInfo ancestor)
WebEvent getOpenEveryoneGroupEvent()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAdminPathTransform
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 GroupPathTransform ()

Public Methods

public int getAncestorIndex (WebObjectInfo ancestor)

Performs a search within the ancestors list for the given ancestor object and return its corresponding index.

public List getAncestorsList ()

public String getDescription ()

Return description for this Transform

Returns
  • description for the transform

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public void renderAncestor (MarkupOutput out, WebObjectInfo ancestor)

public void renderAncestors (MarkupOutput out)

Renders the list of ancestors.

Parameters
out the transform's output

public void renderCurrentItem (MarkupOutput out)

Renders the curent item

Parameters
out the transform's output

public void renderEveryoneAsAncestor (MarkupOutput out)

public void renderGoOneUp (MarkupOutput out)

Renders the Up One level button.

Parameters
out Markupoutput

public void renderGoUserManager (MarkupOutput out)

public boolean shouldRenderEveryoneAsParent ()

Protected Methods

protected WebEvent getGoParentPageEvent ()

protected String getGoParentPageTooltip ()

protected WebEvent getGoUserManagerEvent ()

protected GroupPathBean getGroupPathBean ()

protected WebEvent getOpenAncestorEvent (WebObjectInfo ancestor)

protected WebEvent getOpenEveryoneGroupEvent ()