public class

SortEditorTransform

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

Class Overview

This transform renders the list of projects to show to the user for logging in.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SortEditorTransform()
Public Methods
String getDescription()
Returns the textual description of the transform
boolean getHasGroupByUnits()
Indicates whether the document has group by attributes.
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 renderAscendingRadioButton(MarkupOutput out)
Renders a radio button to select the ascending order for sorting by template units/document attributes.
void renderColTabLink(MarkupOutput out)
void renderCurrentTabContent(MarkupOutput out)
void renderDescendingRadioButton(MarkupOutput out)
Renders a radio button to select the descending order for sorting by template units/document attributes.
void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Projects Bean
void renderGroupByAscendingRadioButton(MarkupOutput out, SortDefinition sortDef)
Renders a radio button to select the ascending order for sorting group by attributes.
void renderGroupByDescendingRadioButton(MarkupOutput out, SortDefinition sortDef)
Renders a radio button to select the descending order for sorting group by attributes.
void renderGroupByForms(MarkupOutput out, SortDefinition sortDef)
The method renders a select box containing all the available forms to sort by associated with the group by information included in the sortDef parameter.
void renderGroupByInfo(MarkupOutput out)
Renders the Sort Group By section for Documents
void renderHiddenInputs(MarkupOutput out)
Renders the list of hidden inputs required by the editor
void renderRowTabLink(MarkupOutput out)
void renderSortByInfo(MarkupOutput out)
Renders the sort options for the selected grid and for the document attributes
void renderSortNumber(MarkupOutput out, Integer value)
void renderTemplateUnits(MarkupOutput out)
The method renders a select box containing all the available template units and its forms in case a grid has been selected or the attributes of the default data set associated with a document.
Protected Methods
WebEvent getSortProcessEvent()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
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 SortEditorTransform ()

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public boolean getHasGroupByUnits ()

Indicates whether the document has group by attributes.

Returns
  • true if the are group by attributes in the document

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

Renders a radio button to select the ascending order for sorting by template units/document attributes.

Parameters
out MarkupOutput instance where to create the HTML output

public void renderColTabLink (MarkupOutput out)

public void renderCurrentTabContent (MarkupOutput out)

public void renderDescendingRadioButton (MarkupOutput out)

Renders a radio button to select the descending order for sorting by template units/document attributes.

Parameters
out MarkupOutput instance where to create the HTML output

public void renderEditorContents (MarkupOutput out)

Generates the graphical output for the Projects Bean

Parameters
out MarkupOutput instance where to create the HTML output

public void renderGroupByAscendingRadioButton (MarkupOutput out, SortDefinition sortDef)

Renders a radio button to select the ascending order for sorting group by attributes.

Parameters
out MarkupOutput instance where to create the HTML output
sortDef SortDefinition instance containing the sort information associated with a group by attribute

public void renderGroupByDescendingRadioButton (MarkupOutput out, SortDefinition sortDef)

Renders a radio button to select the descending order for sorting group by attributes.

Parameters
out MarkupOutput instance where to create the HTML output
sortDef SortDefinition instance containing the sort information associated with a group by attribute

public void renderGroupByForms (MarkupOutput out, SortDefinition sortDef)

The method renders a select box containing all the available forms to sort by associated with the group by information included in the sortDef parameter.

Parameters
out MarkupOutput instance where to create the HTML output
sortDef SortDefinition instance containing the sort information associated with a group by attribute

public void renderGroupByInfo (MarkupOutput out)

Renders the Sort Group By section for Documents

Parameters
out MarkupOutput instance where to create the HTML output

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

public void renderSortByInfo (MarkupOutput out)

Renders the sort options for the selected grid and for the document attributes

Parameters
out MarkupOutput instance where to create the HTML output

public void renderSortNumber (MarkupOutput out, Integer value)

public void renderTemplateUnits (MarkupOutput out)

The method renders a select box containing all the available template units 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

Protected Methods

protected WebEvent getSortProcessEvent ()

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