Class AbstractFilterElementTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
FilterElementRWTransform
,FilterElementTransform
public abstract class AbstractFilterElementTransform extends ExpressionGenericTransform
- Since:
- MicroStrategy Web 8.0.1
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.ExpressionGenericTransform
ExpressionGenericTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected FilterElementBean
_filterElement
-
Fields inherited from class com.microstrategy.web.app.transforms.ExpressionGenericTransform
_allowAQElemsSearchParam, _allowAQFormElemsToggleParam, _allowAQSingleMultiFormToggleParam, _allowMQSingleMultiQualToggleParam, _applyEvent, _clearFilterImageTxtParam, _cssAddConditionNonEditable, _cssBranchOperatorEditable, _cssBranchOperatorNonEditable, _cssConstant, _cssConstantInError, _cssConstantNonEditable, _cssContent, _cssEditableSubexpTable, _cssFilterActionType, _cssGlobal, _cssGlobalContent, _cssObjectName, _cssObjectNameInError, _cssObjectNameNonEditable, _cssOperator, _cssOperatorInError, _cssOperatorNonEditable, _cssText, _cssTextEditable, _cssTextNonEditable, _cssTitle, _defaultAttrQualModeParam, _dynamicDateDisplayParam, _expandEmbeddedFiltersParam, _expressionBean, _formName, _formsCollectionParam, _helpTopicNameParam, _hideIDFormsParam, _multiEvent, _separatorParam, _showAddConditionButton, _showDottedLineParam, _showInlineAcceptCancelButtonsParam, _stackSubexpressionsParam, _submitButtonNameParam, _titleParam, DISPLAY_DYNAMIC_DATES_AS_DYNAMIC, DISPLAY_DYNAMIC_DATES_AS_STATIC, helpTopic, helpType, PARAM_NAME_OLD_EDIT_MODE, renderForm
-
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 AbstractFilterElementTransform()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
existsMultipleNonemptyFilters()
This method returns whether there exist multiple nonempty filters.protected java.lang.String
getBeanName()
Overrides getBeanName on the superclass with the FilterElement's bean name.protected int
getBeanStateLevel()
Overrides the superclass' getBeanStateLevel.java.lang.Class
getSupportedBeanType()
Returns the supported bean type for this transform.protected abstract WebWorkingSet
getWorkingSet()
Returns the working set object, if the filter is a report filter.protected abstract void
initExpressionBeanTransform(FilterElementBean _filterElem)
void
initializeTransform(Transformable data)
Overrides the initializeTransform method with type-specific initialization data.protected abstract boolean
isDesignMode()
boolean
isEditable()
This method is to return whether the expression should be considered to be editable or not.boolean
isReportFilter()
Returns whether the report filter is being rendered.boolean
isUpdateManagerEnabled()
If this method returns true, then the transform will send all multiple events through the update manager.void
renderContent(MarkupOutput out)
This method overrides the renderContent method on the superclass, and ensures rendering of report limits in addition to (or in the case of MDX reports, instead of) the filter.void
renderPostAggregationLimitSummary(MarkupOutput out)
Renders Report Limit summary section below Filter Expression.protected boolean
showCloseButton()
This method overrides the showCloseButton method on the superclass, and decides, based upon application context, whether it is correct to show the close button.-
Methods inherited from class com.microstrategy.web.app.transforms.ExpressionGenericTransform
addAttDetails, addAttrsToTag, addClickOnAttrSelectorButton, addClickOnMetricSelectorButton, addEventHiddenInputs, addOption, buildFlattenedList, calculateBlockBegin, canEditOperator, canEditSubexpression, canFilterOnUnit, canMoveDown, canMoveUp, canSelectElements, canShowMetricTextOperators, canToggleAQFormElements, generateAnchor, generateDeleteSubExpressionClickJS, generateMultiEventArgumentString, generateMultiEventArgumentString, generateOptionTag, generateUpdateManagerEventJSString, getAddConditionEvent, getAddElementsEvent, getAddEmbeddedPromptEvent, getApplyEvent, getAttributesForAcceptButton, getAttributesForPromptButton, getAutoApply, getAvailableObjectsFolder, getBeanPath, getBeginJavaScriptCall, getBoneId, getCancelAllEvent, getCancelEvent, getClearAllEvent, getCloseEvent, getConstantValue, getContentTableAttributes, getContentTableClass, getCreateSubexpressionEvent, getCssName, getDeleteEvent, getDescription, getDisplayName, getEditEmbeddedPromptEvent, getEditEvent, getEditExpressionJS, getEditor, getElemsSearchEvent, getEmptyFilterMessage, getEventTargetExpressionBean, getExpBeanPath, getExpressionBean, getFilterType, getFirstPageEvent, getFlattenedContexFolderList, getFlattenedContextFolderPath, getFormName, getForms, getHelpEvent, getImageFolder, getLastPageEvent, getMainDivAttributes, getMetricName, getMetricShortuctNode, getMQAcceptEvent, getNextPageEvent, getObjectAlias, getOnClickJavaScript, getOperatorName, getPreferenceIntegerReplaceNull, getPrevPageEvent, getPromptButtonSourcePath, getRemoveElementsEvent, getRemovePromptEvent, getRestoreStateEvent, getSeparator, getSpecailBeginJavaScriptCall, getToggleAQFormElemsEvent, getToggleOperatorEvent, getToggleQualExprEvent, getTooltipReportObjects, getValidateJavaScript, includeOwnerInfo, includeTimeInfo, initExpressionBeanTransform, initializeCartSettings, initializeCartSettings, initializeCss, isAddWizardRequested, isApplyCancelEnabled, isAutoSynchronizeEnabled, isFilterEditorFrameEmpty, isFilterEmpty, isItemKeptInCartAvailable, isMetricDimtyTooltipEnabled, isNotDhtml, isObjectInTemplate, isShowObjectTags, isStackedSubexpEnabled, isSubexpressionInError, isViewFilter, isViewReport, newCart, newContext, newFet, renderAcceptButton, renderAddWizard, renderAddWizardButtons, renderAddWizardDropdown, renderAddWizardTransition, renderApplyCancelButtons, renderAQEditMode, renderAQListCart, renderAQListEditMode, renderAQListFirstRow, renderAQOperatorOption, renderAQOperatorOptions, renderAQQualifyAttrForms, renderAQQualifyAttrForms, renderAQQualifyConstantTextbox, renderAQQualifyConstantTextbox, renderAQQualifyEditMode, renderAQQualifyFunctions, renderAQQualifyFunctions, renderAQQualifyUnit, renderAQQualifyUnitComparison, renderCancelButton, renderCloseButton, renderConstantPromptArea, renderDescendantOptions, renderDottedLine, renderDownButton, renderEditorTitle, renderEmptyFilterMessage, renderErrorMessage, renderEventHiddenInputs, renderExpression, renderFilterNode, renderFilterTree, renderGenericValidationErrorMessage, renderHeader, renderHeaderAddCondition, renderHeaderAutoApply, renderHeaderClearAll, renderHelpButton, renderJavascript, renderMeNodeEditMode, renderMeNodeQualFunctions, renderMeNodeQualOperatorOptions, renderMQConstantTextbox, renderMQEditMode, renderMQFunctions, renderMQOperatorOption, renderMQOperatorOption, renderMQOperatorOptions, renderMQUnitComparison, renderOperator, renderOperator, renderOperatorEditMode, renderOperatorViewMode, renderPromptButton, renderPromptButton, renderRemoveSubexpressionButton, renderSeparator, renderSpecificValidationErrorMessage, renderSubExpression, renderSubexpressionBodyViewMode, renderSubexpressionBodyViewMode, renderSubExpressionEditMode, renderSubExpressionViewMode, renderTitle, renderUpAndDownButtons, renderUpAndDownButtons, renderUpButton, renderUpButton, renderXDAMetricSelectorButton, setBoneProperties, setFormName, shallRenderAcceptCancell, shallRenderForm, shouldShowObject, supportsPromptEditor, transformForRequestSuccessful, useWorkingSetForFormLookup
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, 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, transformForRequestInError, 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
-
-
-
-
Field Detail
-
_filterElement
protected FilterElementBean _filterElement
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Overrides the initializeTransform method with type-specific initialization data. This MUST be overridden by any classes which extend this transform if they do not transform on a FilterElement object, because this initializeTransform method assumes that the Transformable passed to it is of type FilterElement.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classExpressionGenericTransform
- Parameters:
data
- The object that is being transformed.
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Description copied from class:ExpressionGenericTransform
Returns the supported bean type for this transform.- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classExpressionGenericTransform
- Returns:
- A Class object representing the bean type this transform supports.
-
isEditable
public boolean isEditable()
This method is to return whether the expression should be considered to be editable or not. If this is true, then the transform may render the expression with editing capabilities. If this is false, then the transform should render the expression in a view-only mode.- Overrides:
isEditable
in classExpressionGenericTransform
- Returns:
- True if the expression should be editable, false otherwise.
-
getBeanName
protected java.lang.String getBeanName()
Overrides getBeanName on the superclass with the FilterElement's bean name.- Overrides:
getBeanName
in classExpressionGenericTransform
- Returns:
- The expression bean's name.
-
getBeanStateLevel
protected int getBeanStateLevel()
Overrides the superclass' getBeanStateLevel. It uses the context of the FilterElement to determine the level of state which must be saved for the bean.- Overrides:
getBeanStateLevel
in classExpressionGenericTransform
- Returns:
- The bean state level required for the ExpressionBean.
-
showCloseButton
protected boolean showCloseButton()
This method overrides the showCloseButton method on the superclass, and decides, based upon application context, whether it is correct to show the close button.- Overrides:
showCloseButton
in classExpressionGenericTransform
- Returns:
- Whether to show a close button.
-
isReportFilter
public boolean isReportFilter()
Returns whether the report filter is being rendered.- Returns:
- True if the report filter is being rendered, false otherwise.
-
isUpdateManagerEnabled
public boolean isUpdateManagerEnabled()
If this method returns true, then the transform will send all multiple events through the update manager. If this is false, then the transform will generate its own multiple events.- Overrides:
isUpdateManagerEnabled
in classExpressionGenericTransform
- Returns:
- True if the update manager is enabled, false otherwise.
-
renderContent
public void renderContent(MarkupOutput out)
This method overrides the renderContent method on the superclass, and ensures rendering of report limits in addition to (or in the case of MDX reports, instead of) the filter.- Overrides:
renderContent
in classExpressionGenericTransform
- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderPostAggregationLimitSummary
public void renderPostAggregationLimitSummary(MarkupOutput out)
Renders Report Limit summary section below Filter Expression.- Parameters:
out
- The MarkupOutput object to render the output to.
-
isDesignMode
protected abstract boolean isDesignMode()
-
initExpressionBeanTransform
protected abstract void initExpressionBeanTransform(FilterElementBean _filterElem)
-
existsMultipleNonemptyFilters
public abstract boolean existsMultipleNonemptyFilters()
This method returns whether there exist multiple nonempty filters. If so, the default layout behavior is to render some space between the two filters. This will happen when either both a report limit and filter are being rendered, or when two limits are being rendered, for an MDX report.- Returns:
- True if there exist multiple nonempty filters, false otherwise.
-
getWorkingSet
protected abstract WebWorkingSet getWorkingSet()
Description copied from class:ExpressionGenericTransform
Returns the working set object, if the filter is a report filter. Otherwise, returns null.- Overrides:
getWorkingSet
in classExpressionGenericTransform
- Returns:
- A
WebWorkingSet
object if the filter is a report filter, or null otherwise. - Since:
- MicroStrategy Web 9.0.0
-
-