public class

PreferencesUserGroupsTransform

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

Class Overview

This Transform renders the list of user groups as defined in the Preferences bean

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
PreferencesUserGroupsTransform()
Public Methods
String getDescription()
Class getSupportedBeanType()
Returns the supported bean type.
void transformForRequestSuccessful(MarkupOutput out)
Renders a transform when the state of the page is ready.
void transformForRequestWaitingForUserInput(MarkupOutput out)
Renders a transform when the state of the page is waiting for user input.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided
[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.Transform

Public Constructors

public PreferencesUserGroupsTransform ()

Public Methods

public String getDescription ()

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 transformForRequestSuccessful (MarkupOutput out)

Renders a transform when the state of the page is ready.

Parameters
out where the output must be generated

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Renders a transform when the state of the page is waiting for user input. The preferences page is always in RequestWaitingForUserInput status so the user preferences will be rendered at this state.

Parameters
out where the output must be generated

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes if the event is not provided

Parameters
event WebEvent
Returns
  • AnchorTag