public class

ViewFilterEditorRWTransform

extends ViewFilterElementPanelTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.ViewFilterElementPanelTransform
           ↳ com.microstrategy.web.app.transforms.ViewFilterEditorRWTransform

Class Overview

Transforms the View Filter panel bean to display the View Filter Editor used for grids in documents

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.ViewFilterElementPanelTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ViewFilterEditorRWTransform()
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.
boolean getAutoApply()
Whether the current filter's autoapply setting is true or false.
WebBeanError getWebBeanErrorInfo()
boolean isApplyCancelEnabled()
Overrides the superclass' behavior and returns a false to determine if the apply and cancel buttons are to be rendered.
boolean isEditableOrEmpty()
This method returns if the editor is either editable or if it is empty.
void renderEditor(MarkupOutput out)
Main method to render the output of an editor
void transformForRequestInError(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestEndsInError.
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
String getBoneId()
Returns the id to be used for the JavaScript bone.
void initEditor(Editor editor)
Initializes the editor with the global settings.
boolean isDesignMode()
Overrides the superclass' isDesignMode method.
boolean isMetricDimtyTooltipEnabled()
Overrides the superclass' behavior on whether to show the metric dimensionality tooltip.
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.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.ViewFilterElementPanelTransform
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 ViewFilterEditorRWTransform ()

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 boolean getAutoApply ()

Whether the current filter's autoapply setting is true or false.

Returns
  • The current auto apply setting.

public WebBeanError getWebBeanErrorInfo ()

Returns
  • the error info

public boolean isApplyCancelEnabled ()

Overrides the superclass' behavior and returns a false to determine if the apply and cancel buttons are to be rendered. For the RW view filter the enclosing editor renders the apply, ok and cancel buttons.

Returns
  • True if the apply/cancel buttons should be shown, false otherwise.

public boolean isEditableOrEmpty ()

This method returns if the editor is either editable or if it is empty. It is used to determine if we should render the title bar div.

Returns
  • Whether the editor is either editable or if it is empty.

public void renderEditor (MarkupOutput out)

Main method to render the output of an editor

Parameters
out MarkupOutput instance where to create the HTML output

public void transformForRequestInError (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestEndsInError. This method just calls displayError(MarkupOutput, String, String, Exception) with the title and message based on the error code from the bean's ErrorInfo, as provided by the the getErrorTitle and getErrorMessage methods accordingly.
Transforms that would like to generate customized output based on the error should extend this method.

Parameters
out output by this transform

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 String getBoneId ()

Returns the id to be used for the JavaScript bone.
This method is used by the renderRegisterBone method to indicate the id of the bone html element.

Returns
  • String

protected void initEditor (Editor editor)

Initializes the editor with the global settings.

Parameters
editor the Editor to modify.

protected boolean isDesignMode ()

Overrides the superclass' isDesignMode method. This method checks with the owner ReportFrameBean to determine whether the report is in design mode or not.

protected boolean isMetricDimtyTooltipEnabled ()

Overrides the superclass' behavior on whether to show the metric dimensionality tooltip.

Returns
  • Whether to show the metric dimensionality in a tooltip.

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.