public class

ViewFilterElementTransform

extends FilterElementTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.ExpressionGenericTransform
           ↳ com.microstrategy.web.app.transforms.AbstractFilterElementTransform
             ↳ com.microstrategy.web.app.transforms.FilterElementTransform
               ↳ com.microstrategy.web.app.transforms.ViewFilterElementTransform
Known Direct Subclasses

Class Overview

Filter Element used to display the View Filter on the report page.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.ExpressionGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FilterElementTransform
From class com.microstrategy.web.app.transforms.AbstractFilterElementTransform
From class com.microstrategy.web.app.transforms.ExpressionGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ViewFilterElementTransform()
Public Methods
WebEvent getApplyEvent()
Returns the event to be used for the apply button - this will handle synchronization of the ExpressionBean with the object it was retrieved from.
Map getMainDivAttributes()
Returns the list of attributes to add to the main
that makes up the filter editor GUI.
Protected Methods
boolean canFilterOnUnit(WebObjectInfo oi)
This method determines if the current object is allowed to be filtered upon.
WebEvent getMQAcceptEvent(boolean isMetricExprQual)
void initializeCartSettings(Cart cart, WebEvent acceptEvent, int elemsBlockBegin, int elemsBlockCount, int totalElements, WebAttribute attr)
This method will initialize the shopping cart object used to render an attribute element list qualification.
void renderAcceptButton(MarkupOutput out, WebEvent acceptEvent, String[] eventArgList, boolean isDefault)
void renderMoveNodeToViewLimitButton(MarkupOutput mainOut, WebNode node)
void renderUpAndDownButtons(MarkupOutput mainOut, WebNode node, boolean isEditableFilterExpr)
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
boolean useBackendDetails()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FilterElementTransform
From class com.microstrategy.web.app.transforms.AbstractFilterElementTransform
From class com.microstrategy.web.app.transforms.ExpressionGenericTransform
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 ViewFilterElementTransform ()

Public Methods

public WebEvent getApplyEvent ()

Returns the event to be used for the apply button - this will handle synchronization of the ExpressionBean with the object it was retrieved from.

Returns
  • The apply event.

public Map getMainDivAttributes ()

Returns the list of attributes to add to the main

that makes up the filter editor GUI. These attributes must primarily be included for the javascript concerning the filter editor to work properly.

Returns
  • A java.util.Map object whose keys are the attribute names, and the values are the attribute values. Both are String-typed.

Protected Methods

protected boolean canFilterOnUnit (WebObjectInfo oi)

This method determines if the current object is allowed to be filtered upon.

Parameters
oi The WebObjectInfo unit which needs to be shown in the filterable drop down list.
Returns
  • true if the current object is allowed to be filtered upon.

protected WebEvent getMQAcceptEvent (boolean isMetricExprQual)

protected void initializeCartSettings (Cart cart, WebEvent acceptEvent, int elemsBlockBegin, int elemsBlockCount, int totalElements, WebAttribute attr)

This method will initialize the shopping cart object used to render an attribute element list qualification.

Parameters
cart The Cart object being initialized.
acceptEvent The event to use to accept the qualficiation.
elemsBlockBegin The blockBegin parameter for the available elements to retrieve.
elemsBlockCount The blockBegin parameter for the available elements to retrieve.
totalElements The total number of elements in the element list of available elements.

protected void renderAcceptButton (MarkupOutput out, WebEvent acceptEvent, String[] eventArgList, boolean isDefault)

protected void renderMoveNodeToViewLimitButton (MarkupOutput mainOut, WebNode node)

Throws
IllegalArgumentException
IllegalStateException
UnmodifiableException

protected void renderUpAndDownButtons (MarkupOutput mainOut, WebNode node, boolean isEditableFilterExpr)

Throws
UnmodifiableException
IllegalArgumentException
IllegalStateException

protected void setBoneProperties (JsonGenerator boneProps)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
boneProps the JsonGenerator object that contains the collection of bone properties.

protected boolean useBackendDetails ()