public class

UserGroupTransform

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

Summary

[Expand]
Inherited Constants
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.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
UserGroupTransform()
Public Methods
boolean canCreateGroup()
int getGoToArgument()
WebEvent getGoToEvent()
WebEvent getNewGroupEvent()
WebEvent getNewUserEvent()
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

Protected Methods
int getBlockPosition()
int getBlockSize()
int getChildCount()
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.
UserGroupBean getUserGroupBean()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.UserEntitiesTransform
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 UserGroupTransform ()

Public Methods

public boolean canCreateGroup ()

public int getGoToArgument ()

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

public 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 WebEvent getNewGroupEvent ()

public WebEvent getNewUserEvent ()

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 initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

Protected Methods

protected 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 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 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 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 UserGroupBean getUserGroupBean ()