public class

SecurityRoleEditorTransform

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

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public String FP_RENDER_FORM String constant holding the name of the renderForm formal parameter.
public FormalParameter renderForm Indicates if this transform should render a form for holding the inner fields
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractPrivilegesEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SecurityRoleEditorTransform()
Public Methods
String getDescription()
Returns a textual description of the transform.
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.

void renderDescription(MarkupOutput out)
void renderDescriptionField(MarkupOutput out)
void renderDescriptionLabel(MarkupOutput out)
void renderJavascriptLinks(MarkupOutput out)
void renderName(MarkupOutput out)
void renderNameField(MarkupOutput out)
void renderNameLabel(MarkupOutput out)
void renderPrivileges(MarkupOutput out)
void renderPrivilegesField(MarkupOutput out)
void renderPrivilegesLabel(MarkupOutput out)
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
Map getAttributesPrivilegeDiv(WebPrivilegeEntry priv)
String getEventArgumentName(WebEvent event, int argumentId)
WebEvent getModifyPropertiesEvent()
SecurityRoleBean getSecurityRoleBean()
WebSecurityRole getWebSecurityRole()
void renderCategory(MarkupOutput out, WebPrivilegeCategory category)
void renderCategoryCheckbox(MarkupOutput out, WebPrivilegeCategory category)
void renderCategoryName(MarkupOutput out, WebPrivilegeCategory cat)
void renderPrivilegeCheckbox(MarkupOutput out, WebPrivilegeEntry priv, boolean isGranted)
Renders a single privilege checkbox.
void renderPrivilegeName(MarkupOutput out, WebPrivilegeEntry priv)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractPrivilegesEditorTransform
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

Fields

public String FP_RENDER_FORM

String constant holding the name of the renderForm formal parameter. Value is renderForm

public FormalParameter renderForm

Indicates if this transform should render a form for holding the inner fields

Public Constructors

public SecurityRoleEditorTransform ()

Public Methods

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of 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 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.

public void renderDescription (MarkupOutput out)

public void renderDescriptionField (MarkupOutput out)

public void renderDescriptionLabel (MarkupOutput out)

public void renderJavascriptLinks (MarkupOutput out)

public void renderName (MarkupOutput out)

public void renderNameField (MarkupOutput out)

public void renderNameLabel (MarkupOutput out)

public void renderPrivileges (MarkupOutput out)

public void renderPrivilegesField (MarkupOutput out)

public void renderPrivilegesLabel (MarkupOutput out)

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 Map getAttributesPrivilegeDiv (WebPrivilegeEntry priv)

protected String getEventArgumentName (WebEvent event, int argumentId)

protected WebEvent getModifyPropertiesEvent ()

protected SecurityRoleBean getSecurityRoleBean ()

protected WebSecurityRole getWebSecurityRole ()

protected void renderCategory (MarkupOutput out, WebPrivilegeCategory category)

protected void renderCategoryCheckbox (MarkupOutput out, WebPrivilegeCategory category)

protected void renderCategoryName (MarkupOutput out, WebPrivilegeCategory cat)

protected void renderPrivilegeCheckbox (MarkupOutput out, WebPrivilegeEntry priv, boolean isGranted)

Renders a single privilege checkbox.

protected void renderPrivilegeName (MarkupOutput out, WebPrivilegeEntry priv)