Package com.microstrategy.web.app.transforms

Class ViewFilterEditorRWTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class ViewFilterEditorRWTransform
extends ViewFilterElementPanelTransform

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

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

AbstractAppTransform.Context

Field Summary

Fields inherited from class com.microstrategy.web.app.transforms.ViewFilterElementPanelTransform

_clearFilterImageTxtParam, _cssAddConditionNonEditable, _defaultAttrQualModeParam, _filterElement, _helpTopicNameParam, _showAddConditionButton, _titleParam, helpTopic, helpType

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors

Constructor	Description
ViewFilterEditorRWTransform()

Method Summary

Modifier and Type	Method	Description
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.
protected java.lang.String	getBoneId()	Returns the id to be used for the JavaScript bone.
WebBeanError	getWebBeanErrorInfo()
protected void	initEditor(Editor editor)	Initializes the editor with the global settings.
boolean	isApplyCancelEnabled()	Overrides the superclass' behavior and returns a false to determine if the apply and cancel buttons are to be rendered.
protected boolean	isDesignMode()	Overrides the superclass' isDesignMode method.
boolean	isEditableOrEmpty()	This method returns if the editor is either editable or if it is empty.
protected boolean	isMetricDimtyTooltipEnabled()	Overrides the superclass' behavior on whether to show the metric dimensionality tooltip.
void	renderEditor(MarkupOutput out)	Main method to render the output of an editor
protected void	setBoneProperties(JsonGenerator boneProps)	Sets the necessary properties to the bone assigned to this transform (based on the AbstractAppTransform.scriptClass formal parameter) Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput) Can be overwritten to add or modify bone properties.
void	transformForRequestInError(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestEndsInError.
void	transformForRequestSuccessful(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful.

Methods inherited from class com.microstrategy.web.app.transforms.ViewFilterElementPanelTransform

generateMultiEventArgumentString, generateMultiEventArgumentString, generateUpdateManagerEventJSString, getAddConditionEvent, getBeanStateLevel, getCancelAllEvent, getClearAllEvent, getCloseEvent, getDescription, getEditor, getEmptyFilterMessage, getFormAttributes, getHelpEvent, getImageFolder, getMainDivAttributes, getRestoreStateEvent, getScriptClass, getStringFromDescriptorFP, getSupportedBeanType, initializeCss, initializeTransform, isAutoSynchronizeEnabled, isEditable, isFilterEditorFrameEmpty, isOpen, renderApplyCancelButtons, renderCloseButton, renderEditorTitle, renderEmptyFilterMessage, renderEventHiddenInputs, renderHeaderAddCondition, renderHeaderAutoApply, renderHeaderClearAll, renderHelpButton, renderJavascript, renderViewFilter

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, hasSubBlock, initHeightAndWidthFromPreferences, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.LayoutTransform

getLayoutDefinition, setLayoutDefinition

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

ViewFilterEditorRWTransform

public ViewFilterEditorRWTransform()

Method Detail

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.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.

Overrides:

transformForRequestSuccessful in class ViewFilterElementPanelTransform

Parameters:

out - output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

transformForRequestInError

public void transformForRequestInError(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestEndsInError. This method just calls AbstractAppTransform.displayError(com.microstrategy.web.beans.MarkupOutput, java.lang.String, java.lang.String, java.lang.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.

Overrides:

transformForRequestInError in class ViewFilterElementPanelTransform

Parameters:

out - output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

getWebBeanErrorInfo

public WebBeanError getWebBeanErrorInfo()

Overrides:

getWebBeanErrorInfo in class AbstractAppTransform

Returns:

the error info

renderEditor

public void renderEditor(MarkupOutput out)

Main method to render the output of an editor

Parameters:

out - MarkupOutput instance where to create the HTML output

initEditor

protected void initEditor(Editor editor)

Initializes the editor with the global settings.

Parameters:

editor - the Editor to modify.

isEditableOrEmpty

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.

Overrides:

isEditableOrEmpty in class ViewFilterElementPanelTransform

Returns:

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

setBoneProperties

protected void setBoneProperties(JsonGenerator boneProps)

Description copied from class: AbstractAppTransform

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

Overrides:

setBoneProperties in class ViewFilterElementPanelTransform

Parameters:

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

isDesignMode

protected boolean isDesignMode()

Description copied from class: ViewFilterElementPanelTransform

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

Overrides:

isDesignMode in class ViewFilterElementPanelTransform

isMetricDimtyTooltipEnabled

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.

isApplyCancelEnabled

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.

Overrides:

isApplyCancelEnabled in class ViewFilterElementPanelTransform

Returns:

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

See Also:

ExpressionGenericTransform.isApplyCancelEnabled()

getAutoApply

public boolean getAutoApply()

Description copied from class: ViewFilterElementPanelTransform

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

Overrides:

getAutoApply in class ViewFilterElementPanelTransform

Returns:

The current auto apply setting.

getBoneId

protected java.lang.String getBoneId()

Description copied from class: AbstractAppTransform

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.

Overrides:

getBoneId in class ViewFilterElementPanelTransform

Returns:

String

See Also:

AbstractAppTransform.renderRegisterBone(com.microstrategy.web.beans.MarkupOutput)

getApplyEvent

public WebEvent getApplyEvent()

Description copied from class: ViewFilterElementPanelTransform

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

Overrides:

getApplyEvent in class ViewFilterElementPanelTransform

Returns:

The apply event.