public class

SortGeneralTransform

extends AbstractAppTransform
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.SortGeneralTransform

Summary

Constants
String FP_RENDER_FORM
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter renderForm Indicates whether the editor will create its own form.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SortGeneralTransform()
Public Methods
String getDescription()
Returns the textual description of the transform
boolean getIsGridSelected()
Indicates whether the sort editor is being used to sort a selected grid
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
ArrayList<Integer> numberOfSortKeys()
Returns a list of integers until the value of the set preference.
void renderAscendingRadioButtonByAxis(MarkupOutput out, int axis, String descriptorKey)
void renderAscendingRadioButtonByAxis(MarkupOutput out, int axis)
void renderColSortingUnits(MarkupOutput out)
void renderDescendingRadioButtonByAxis(MarkupOutput out, int axis, String descriptorKey)
void renderDescendingRadioButtonByAxis(MarkupOutput out, int axis)
void renderHiddenInputs(MarkupOutput out)
Renders the list of hidden inputs required by the editor
void renderRespectParent(MarkupOutput out, int axis, String descriptorKey)
void renderSortNumber(MarkupOutput out, Integer value)
void renderTemplateUnits(MarkupOutput out)
The method renders a select box containing all the available template units for row sorting and its forms in case a grid has been selected or the attributes of the default data set associated with a document.
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
WebEvent getSortProcessEvent()
[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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_RENDER_FORM

Constant Value: "renderForm"

Fields

public FormalParameter renderForm

Indicates whether the editor will create its own form.

Public Constructors

public SortGeneralTransform ()

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public boolean getIsGridSelected ()

Indicates whether the sort editor is being used to sort a selected grid

Returns
  • true if a grid has been selected by the user.

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports SortEditorBean instances

Returns
  • SortEditorBean.class

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.

Parameters
data bean that will be transformed

public ArrayList<Integer> numberOfSortKeys ()

Returns a list of integers until the value of the set preference.

Returns
  • list of integers

public void renderAscendingRadioButtonByAxis (MarkupOutput out, int axis, String descriptorKey)

public void renderAscendingRadioButtonByAxis (MarkupOutput out, int axis)

public void renderColSortingUnits (MarkupOutput out)

public void renderDescendingRadioButtonByAxis (MarkupOutput out, int axis, String descriptorKey)

public void renderDescendingRadioButtonByAxis (MarkupOutput out, int axis)

public void renderHiddenInputs (MarkupOutput out)

Renders the list of hidden inputs required by the editor

Parameters
out MarkupOutput instance where to create the HTML output

public void renderRespectParent (MarkupOutput out, int axis, String descriptorKey)

public void renderSortNumber (MarkupOutput out, Integer value)

public void renderTemplateUnits (MarkupOutput out)

The method renders a select box containing all the available template units for row sorting and its forms in case a grid has been selected or the attributes of the default data set associated with a document.

Parameters
out MarkupOutput instance where to create the HTML output

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 WebEvent getSortProcessEvent ()

Returns
  • an intance of the Sort Editor Process event the editor uses