Class ExpressionGenericTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
AbstractFilterElementTransform
,DerivedElementTransform
,FilterExpressionTransform
,SecurityFilterExpressionTransform
,ThresholdExpressionTransform
public class ExpressionGenericTransform extends AbstractAppTransform implements LayoutTransform
The ExpressionGenericTransform class is a LayoutTransform which transforms anExpressionBean
object. It is also meant to be the base class for filter-related transforms, such as theFilterElementTransform
for the filter editor. Many of the rendering methods on this interface are protected - the intention is to allow customizations to be done by extending this transform and overriding the methods which generate the appropriate output.- Since:
- MicroStrategy Web 8.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
ExpressionGenericTransform.Context
-
Field Summary
-
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 ExpressionGenericTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addAttDetails(WebAttribute attr)
protected void
addAttrsToTag(java.util.Map attrs, Tag tag)
protected void
addClickOnAttrSelectorButton(InputTag inputTag, WebEvent toggleSingleExprEvent, boolean isMultiFormQual)
protected void
addClickOnMetricSelectorButton(InputTag inputTag, WebEvent toggleMode, boolean isMetricExprQual)
protected void
addEventHiddenInputs(java.util.ArrayList eventList)
protected void
addOption(SelectTag tag, int value, java.lang.String desc, int selectedValue)
protected java.util.List
buildFlattenedList(int contextId, StringWrapper path)
protected int
calculateBlockBegin()
protected boolean
canEditOperator(WebNode leftNode, WebNode rightNode)
protected boolean
canEditSubexpression(WebNode node)
Returns whether the subexpression at the current node is editable or not.protected boolean
canFilterOnUnit(WebObjectInfo oi)
This method determines if the current object is allowed to be filtered upon.protected boolean
canMoveDown(WebNode node)
protected boolean
canMoveUp(WebNode node)
protected boolean
canSelectElements(WebAttribute webAttribute)
This method determines whether the attribute requires a lookup table to support elements qualification.protected boolean
canShowMetricTextOperators()
protected boolean
canToggleAQFormElements(WebAttribute webAttribute)
This method determines whether the user is allowed to toggle between attribute form and elements qualfication.protected AnchorTag
generateAnchor(WebEvent event)
Overwrites the parent method by setting requested attributesprotected void
generateDeleteSubExpressionClickJS(java.lang.String key, WebEvent deleteEvent, java.lang.StringBuffer onClickJS)
This method will render the JavaScript necessary to delete a sub expression.protected java.lang.String
generateMultiEventArgumentString(WebEvent[] eventList, java.lang.String[][] argsLists, boolean restoreState)
Generates the multiple event argument string for the given event list, with the given argument lists.protected java.lang.String
generateMultiEventArgumentString(WebEvent event, java.lang.String[] args, boolean restoreState)
Generates the multiple event argument string for the given event, with the given arguments.protected Tag
generateOptionTag(java.lang.String desc, java.lang.String value, boolean selected)
protected void
generateUpdateManagerEventJSString(java.lang.StringBuffer buf, java.lang.String beanPath, WebEvent event, java.lang.String[] args, boolean restoreState)
Generates the javascript for the onclick tag that is necessary to invoke the given event via the update manager.WebEvent
getAddConditionEvent()
Returns the add condition event, which signals the intent to open the add wizard.WebEvent
getAddElementsEvent()
Returns the event to be used for the add elements operation.protected WebEvent
getAddEmbeddedPromptEvent()
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.protected java.util.Map
getAttributesForAcceptButton()
This method will return any HTML attributes that should be added to the accept button for a subexpression being edited.protected java.util.Map
getAttributesForPromptButton()
boolean
getAutoApply()
Returns whether the auto-apply functionality is enabled.protected WebFolder
getAvailableObjectsFolder()
Returns the list of "available" objects to be used for the add wizard or for an attribute-to-attribute or metric-to-metric qualificiation.protected java.lang.String
getBeanName()
Returns the main bean's name.protected java.lang.String
getBeanPath()
Returns the main bean's path.protected int
getBeanStateLevel()
Returns the state level that the bean needs to be saved in for the transform to work properly.protected java.lang.String
getBeginJavaScriptCall()
Returns the client-side code necessary for executing js in links.protected java.lang.String
getBoneId()
Returns the id to be used for the JavaScript bone.WebEvent
getCancelAllEvent()
Returns the cancel all event, which will cancel all un-applied changes.WebEvent
getCancelEvent()
Returns the event to be used for the cancel button - this will undo the currently edited subexpression's changes.WebEvent
getClearAllEvent()
Returns the clear all event, which signals that the user wishes to clear the whole subexpression.WebEvent
getCloseEvent()
Returns the event to be used for the close button.protected java.lang.String
getConstantValue(WebNode parent, int ix, java.lang.String defaultValue)
java.util.Map
getContentTableAttributes()
This method returns the attributes which are to be put on the table surrounding the main content of the filter.protected java.lang.String
getContentTableClass()
Returns the CSS class recommended for the table containing the expression.WebEvent
getCreateSubexpressionEvent()
Returns the create subexpression event, which signals that the user is creating a new subexpression.java.lang.String
getCssName(WebObjectInfo object)
protected WebEvent
getDeleteEvent()
Returns the delete subexpression event.java.lang.String
getDescription()
Returns a textual description of the transform.java.lang.String
getDisplayName(WebObjectInfo object)
protected WebEvent
getEditEmbeddedPromptEvent()
WebEvent
getEditEvent()
Returns the edit event, which signals the intent to edit an existing subexpression.java.lang.String
getEditExpressionJS()
protected Editor
getEditor()
Returns an Editor object, which is used to render help/close buttons.WebEvent
getElemsSearchEvent()
Returns the event to be used for the element search action.protected java.lang.String
getEmptyFilterMessage()
Returns the message that should be used if the filter is empty.protected ExpressionBean
getEventTargetExpressionBean()
Returns the expression bean for getting events.java.lang.String
getExpBeanPath()
This function is designed for ThresholdExpressionTransform.ExpressionBean
getExpressionBean()
Returns the expression bean.protected int
getFilterType()
Returns the filter type, fromEnumFilterTypes
.WebEvent
getFirstPageEvent()
Returns the event to be used for going to the first page of element browsing.java.util.List
getFlattenedContexFolderList(int contextId)
java.lang.String
getFlattenedContextFolderPath(int contextId)
protected java.lang.String
getFormName()
protected WebAttributeForms
getForms(WebAttribute att, int formsCollectionType)
WebEvent
getHelpEvent()
Returns the event to be used for the help button.protected java.lang.String
getImageFolder()
Returns the folder that images are expected to be stored in.WebEvent
getLastPageEvent()
Returns the event to be used for going to the last page of element browsing.java.util.Map
getMainDivAttributes()
Returns the list of attributes to add to the main DIV that makes up the filter editor GUI.protected java.lang.String
getMetricName(WebShortcutNode shortcutNode)
protected WebShortcutNode
getMetricShortuctNode(WebNode node)
protected WebEvent
getMQAcceptEvent(boolean isMetricExprQual)
WebEvent
getNextPageEvent()
Returns the event to be used for going to the next page of element browsing.protected java.lang.String
getObjectAlias(WebObjectInfo ob)
Attempts to find the best object alias to use for the given object.protected java.lang.String
getOnClickJavaScript()
Returns any javascript to be excuted when the user clicks the element it's assigned to.java.lang.String
getOperatorName(int operatorType)
Checks for given WebOperator node function ID and returns corresponding localized function text.int
getPreferenceIntegerReplaceNull(java.lang.String prefName, int nullReplace)
WebEvent
getPrevPageEvent()
Returns the event to be used for going to the previous page of element browsing.protected java.lang.String
getPromptButtonSourcePath()
WebEvent
getRemoveElementsEvent()
Returns the event to be used for the remove elements operation.protected WebEvent
getRemovePromptEvent()
WebEvent
getRestoreStateEvent()
Returns the restore state event based upon the subexpression being edited.protected java.lang.String
getSeparator()
protected java.lang.String
getSpecailBeginJavaScriptCall()
Returns the client-side code necessary for executing js in links.java.lang.Class
getSupportedBeanType()
Returns the supported bean type for this transform.WebEvent
getToggleAQFormElemsEvent()
Returns the event to toggle between form and elements qualifications.WebEvent
getToggleOperatorEvent()
Returns the event to toggle the logical operator of an expression (AND/OR/NOT, etc).WebEvent
getToggleQualExprEvent()
Returns the event to toggle between single and multiple-part qualificiation - for example, single metric and multi metric, or single form and multi form.protected java.lang.String
getTooltipReportObjects()
This function return list of all metrics in workingset for tooltip in metric expression when view mode in on.protected java.lang.String
getValidateJavaScript()
protected WebWorkingSet
getWorkingSet()
Returns the working set object, if the filter is a report filter.boolean
includeOwnerInfo()
boolean
includeTimeInfo()
protected void
initExpressionBeanTransform(ExpressionBean expBean)
This method captures the reference to the expression bean and does some other initialization-related routines.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.protected void
initializeCartSettings(Cart cart, java.lang.String selectedAnswerListName, int elemsBlockBegin, int elemsBlockCount, int totalElements, WebAttribute attr)
void
initializeCss()
This method initializes the CSS names used by the transform.void
initializeTransform(Transformable data)
This method overrides the superclass' initializeTransform method - this is called to pick up the reference to the Transformable object passed to the transform and to do initialization of the transform.boolean
isAddWizardRequested()
Returns whether the bean is requesting the display of the add wizard.boolean
isApplyCancelEnabled()
Returns whether the apply/cancel buttons should be shown.boolean
isAutoSynchronizeEnabled()
This method returns whether the GUI should synchronize the expression on the expression bean with its source upon every operation.boolean
isEditable()
Returns whether the user is allowed to edit this expression.protected boolean
isFilterEditorFrameEmpty()
This method evaluates whether the filter editor frame is empty.protected boolean
isFilterEmpty(WebExpression expr)
Returns whether the given filter expression is empty.protected boolean
isItemKeptInCartAvailable()
Indicates preference value for whether or not to keep item in cart's available list.protected boolean
isMetricDimtyTooltipEnabled()
Returns whether the metric dimensionality should be rendered as a tooltip in the expression.boolean
isNotDhtml()
Used by layout to check for absence of DHTML mode.protected boolean
isObjectInTemplate(WebShortcutNode shortcutNode)
boolean
isShowObjectTags()
protected boolean
isStackedSubexpEnabled()
protected boolean
isSubexpressionInError(WebNode node)
Returns whether the subexpression at the current node is in error or not.boolean
isUpdateManagerEnabled()
This method can be overridden by child classes to signal whether or not to send all multiple event requests through the update manager.protected boolean
isViewFilter()
Returns whether this expression refers to a report's view filter.protected boolean
isViewReport()
protected Cart
newCart()
protected TransformContext
newContext()
Creates a new instance of a TransformContext.protected ExpressionFilterTransform
newFet()
protected void
renderAcceptButton(MarkupOutput out, WebEvent acceptEvent, java.lang.String[] eventArgList, boolean isDefault)
void
renderAddWizard(MarkupOutput out)
This method will render an HTML pull-down menu presenting a list of objects to qualify upon if the expression bean's edit mode is ExpressionEditModeSelectUnit.void
renderAddWizardButtons(MarkupOutput out)
This method renders the buttons for the add wizard.void
renderAddWizardDropdown(MarkupOutput out)
This method renders the object dropdown for the add wizard.void
renderAddWizardTransition(MarkupOutput out)
This method renders the transition between the rest of the filter and the add wizard (usually the word and).void
renderApplyCancelButtons(MarkupOutput out)
Function that displays apply and cancel buttons for the whole expression, when they are needed.protected void
renderAQEditMode(MarkupOutput out, WebNode node, int level)
This method will render an attribute qualification which is being edited by the user.protected void
renderAQListCart(WebNode node, Tag tableTag, WebEvent acceptEvent)
protected void
renderAQListEditMode(MarkupOutput out, WebNode node, int level)
This method renders an attribute qualficiation subexpression which is being edited in list mode - i.e.protected void
renderAQListFirstRow(WebOperatorNode node, Tag tableTag, WebEvent acceptEvent)
protected void
renderAQOperatorOption(MarkupOutput mo, int function, int descriptorId, int currentFunction)
protected void
renderAQOperatorOptions(MarkupOutput mo, int currentFunction, boolean unitComparison)
protected void
renderAQQualifyAttrForms(MarkupOutput out, WebNode operatorNode, WebFormShortcutNode formShortcutNode, WebEvent acceptEvent)
This method will render the list of attribute forms to qualify upon for an attribute form qualfication that is being edited.protected void
renderAQQualifyAttrForms(MarkupOutput out, WebNode operatorNode, WebFormShortcutNode formShortcutNode, WebEvent acceptEvent, boolean isConstPrompted)
protected void
renderAQQualifyConstantTextbox(MarkupOutput out, int function, java.lang.String value, WebEvent acceptEvent)
This method will render the constant textbox for an attribute form to constant value qualification.protected void
renderAQQualifyConstantTextbox(MarkupOutput out, int function, java.lang.String value, WebEvent acceptEvent, boolean isDisabledByConstPrompt)
protected void
renderAQQualifyEditMode(MarkupOutput out, WebNode node, int level, boolean isMultiFormQual)
This method will render an attribute form qualfication subexpression that is currently being edited.protected void
renderAQQualifyFunctions(MarkupOutput out, int function, boolean isMultiFormQual, WebEvent acceptEvent)
This method will render a list of functions that can be used to render an attribute form qualficiation subexpression in edit mode.protected void
renderAQQualifyFunctions(MarkupOutput out, int function, boolean isMultiFormQual, WebEvent acceptEvent, boolean isConstPrompted)
protected void
renderAQQualifyUnit(MarkupOutput out, WebNode node, WebEvent accpetEvent)
protected void
renderAQQualifyUnitComparison(MarkupOutput out, java.lang.String selectedAttributeID, java.lang.String selectedFormID, WebEvent acceptEvent)
This method will render the right-side pulldown of attribute forms for an attribute form to attribute form qualification.protected void
renderCancelButton(MarkupOutput out)
Renders the Cancel button for the wait page.void
renderCloseButton(MarkupOutput out)
This method will render the close button for the editor.protected void
renderConstantPromptArea(MarkupOutput out, WebPrompt constPrompt, int ndKey)
This method will render an existing constant prompt in a subexpression that is being edited.void
renderContent(MarkupOutput out)
This method renders the content of the filter editor.protected void
renderDescendantOptions(WebOperatorNode node, Tag tableTag, WebEvent acceptEvent)
protected void
renderDottedLine(MarkupOutput out)
Renders a dotted lined to be used as separator between edit forms and filter expression treeprotected void
renderDownButton(MarkupOutput mainOut, WebNode node)
void
renderEditorTitle(MarkupOutput out)
This method will simply render the title of the editor.void
renderEmptyFilterMessage(MarkupOutput out)
This method will check whether the filter that this transform is attempting to render is empty, and if it is, render a message saying that the filter is empty.protected void
renderErrorMessage(MarkupOutput out, java.lang.String imageTitle, java.lang.String errorMessage)
protected void
renderEventHiddenInputs(MarkupOutput out)
This method will render all of the hidden inputs for the events that will be used within the expression transform.protected void
renderExpression(MarkupOutput out)
protected void
renderFilterNode(MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)
This is the method which renders a single node within the filter.void
renderFilterTree(MarkupOutput out)
This method will render the actual filter expression tree in the GUI.void
renderGenericValidationErrorMessage(MarkupOutput out)
If the expression bean has a validation error waiting on it, this method will render a generic error message.void
renderHeader(MarkupOutput out)
This method will render the header portion of the document, which includes the empty filter message, add condition button, close all button, and auto-apply button.void
renderHeaderAddCondition(MarkupOutput out)
This method will render the add condition link, normally in the header of the editor.void
renderHeaderAutoApply(MarkupOutput out)
This method will render the "auto apply enabled" button in the filter editor GUI.void
renderHeaderClearAll(MarkupOutput out)
This method will render the "clear all" button in the filter editor.void
renderHelpButton(MarkupOutput out)
This method will render the help button for the editor.protected void
renderJavascript(MarkupOutput out)
This method renders all javascript that will be necessary for the ExpressionGenericTransform to work correctly.protected void
renderMeNodeEditMode(MarkupOutput out, WebNode node, int level)
This function will render the subexpression for a me node expression which is being edited by the user.protected void
renderMeNodeQualFunctions(MarkupOutput out, WebEvent acceptEvent, int function, int functionType)
protected void
renderMeNodeQualOperatorOptions(MarkupOutput mo, int currentFunction, int currentFunctionType)
protected void
renderMQConstantTextbox(MarkupOutput out, WebEvent acceptEvent, java.lang.String constValue, int function)
This method renders the constant textbox for a metric qualification subexpression.protected void
renderMQEditMode(MarkupOutput out, WebNode node, int level)
This function will render the subexpression for a metric qualfiication which is being edited by the user.protected void
renderMQFunctions(MarkupOutput out, WebEvent acceptEvent, int function, int functionType, boolean isMetricExprQual, boolean isConstPrompted)
protected void
renderMQOperatorOption(MarkupOutput mo, int function, int descriptorId, int currentFunction)
protected void
renderMQOperatorOption(MarkupOutput mo, int function, int functionType, int descriptorId, int currentFunction, int currentFunctionType)
protected void
renderMQOperatorOptions(MarkupOutput mo, int currentFunction, int currentFunctionType, boolean bUnitComparison)
protected void
renderMQUnitComparison(MarkupOutput out, java.lang.String metricID, WebEvent acceptEvent)
This method will render the unit comparison list for a metric-to-metric qualfication that is currently being edited..protected void
renderOperator(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, boolean isReportLimit, MarkupOutput mainOut, boolean useEditMode)
protected void
renderOperator(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, int level, boolean isReportLimit)
This method renders the given operator node.protected void
renderOperatorEditMode(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode)
This method renders an operator in edit mode.protected void
renderOperatorViewMode(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, boolean isReportLimit)
This method will render an operator node in view mode.protected void
renderPromptButton(MarkupOutput out, int promptType, java.lang.String inputID, boolean isDisabled)
protected void
renderPromptButton(MarkupOutput out, int promptType, java.lang.String inputID, boolean isDisabled, boolean isHidden)
protected void
renderRemoveSubexpressionButton(MarkupOutput out, WebNode node, boolean isEditableFilterExpr)
void
renderSeparator(MarkupOutput out)
Renders the separator that is used to indent subexpressions.void
renderSpecificValidationErrorMessage(MarkupOutput out)
If the expression bean has a validation error waiting on it, this method will render the specific error message for that error.protected void
renderSubExpression(MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)
This method renders a subexpression of the expression.protected void
renderSubexpressionBodyViewMode(MarkupOutput mainOut, WebExpression expr, WebNode node, int level, boolean isReportLimit, boolean isEditableFilterExpr)
protected void
renderSubexpressionBodyViewMode(WebExpression expr, WebNode node, int level, boolean isReportLimit, boolean isEditableFilterExpr, MarkupOutput mainOut)
Deprecated.protected void
renderSubExpressionEditMode(MarkupOutput out, WebNode node, int level)
This function renders a subexpression which is currently being edited by the user.protected void
renderSubExpressionViewMode(MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)
This is the generic method that renders a non-branch subexpression in view mode.void
renderTitle(MarkupOutput out)
This method renders the title portion of the GUI.protected void
renderUpAndDownButtons(MarkupOutput mainOut, WebNode node, boolean isEditableFilterExpr)
protected void
renderUpAndDownButtons(WebNode node, boolean isEditableFilterExpr, MarkupOutput mainOut)
Deprecated.Replaced by renderUpAndDownButtons(MarkupOutput mainOut, ....)protected void
renderUpButton(MarkupOutput mainOut, WebNode node)
protected void
renderUpButton(WebNode node, MarkupOutput mainOut)
Deprecated.Replaced by renderUpButtom(MarkupOutput,....)protected void
renderXDAMetricSelectorButton(MarkupOutput out)
protected void
setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on theAbstractAppTransform.scriptClass
formal parameter)
Usually called byAbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.protected void
setFormName(java.lang.String name)
protected boolean
shallRenderAcceptCancell()
protected boolean
shallRenderForm(WebAttributeForm form)
protected boolean
shouldShowObject(WebDisplayUnit unit)
Indicate if the unit should be shown.protected boolean
showCloseButton()
Returns whether to show a close button.protected boolean
supportsPromptEditor()
void
transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status isEnumRequestStatus.WebBeanRequestSuccessful
.protected boolean
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
-
_cssText
protected java.lang.String _cssText
-
_cssTitle
protected java.lang.String _cssTitle
-
_cssContent
protected java.lang.String _cssContent
-
_cssGlobalContent
protected java.lang.String _cssGlobalContent
-
_cssGlobal
protected java.lang.String _cssGlobal
-
_cssObjectName
protected java.lang.String _cssObjectName
-
_cssObjectNameNonEditable
protected java.lang.String _cssObjectNameNonEditable
-
_cssObjectNameInError
protected java.lang.String _cssObjectNameInError
- Since:
- MicroStrategy Web 8.0.1
-
_cssOperator
protected java.lang.String _cssOperator
-
_cssConstant
protected java.lang.String _cssConstant
-
_cssTextEditable
protected java.lang.String _cssTextEditable
-
_cssBranchOperatorEditable
protected java.lang.String _cssBranchOperatorEditable
-
_cssTextNonEditable
protected java.lang.String _cssTextNonEditable
-
_cssOperatorNonEditable
protected java.lang.String _cssOperatorNonEditable
-
_cssOperatorInError
protected java.lang.String _cssOperatorInError
- Since:
- MicroStrategy Web 8.0.1
-
_cssBranchOperatorNonEditable
protected java.lang.String _cssBranchOperatorNonEditable
-
_cssConstantNonEditable
protected java.lang.String _cssConstantNonEditable
-
_cssConstantInError
protected java.lang.String _cssConstantInError
- Since:
- MicroStrategy Web 8.0.1
-
_cssEditableSubexpTable
protected java.lang.String _cssEditableSubexpTable
-
_cssAddConditionNonEditable
protected java.lang.String _cssAddConditionNonEditable
- Since:
- MicroStrategy Web 8.0.1
-
_cssFilterActionType
protected java.lang.String _cssFilterActionType
- Since:
- MicroStrategy Web 9.0.0
-
PARAM_NAME_OLD_EDIT_MODE
protected static final java.lang.String PARAM_NAME_OLD_EDIT_MODE
- See Also:
- Constant Field Values
-
_formName
protected java.lang.String _formName
- Since:
- MicroStrategy Web 9.0.0
-
renderForm
protected boolean renderForm
- Since:
- MicroStrategy Web 9.0.0
-
_multiEvent
protected WebEvent _multiEvent
-
_applyEvent
protected WebEvent _applyEvent
-
_expressionBean
protected ExpressionBean _expressionBean
-
_titleParam
protected FormalParameterImpl _titleParam
-
_stackSubexpressionsParam
protected FormalParameterImpl _stackSubexpressionsParam
-
_defaultAttrQualModeParam
protected FormalParameterImpl _defaultAttrQualModeParam
-
_expandEmbeddedFiltersParam
protected FormalParameterImpl _expandEmbeddedFiltersParam
-
_separatorParam
protected FormalParameterImpl _separatorParam
-
_allowAQElemsSearchParam
protected FormalParameterImpl _allowAQElemsSearchParam
-
_allowAQSingleMultiFormToggleParam
protected FormalParameterImpl _allowAQSingleMultiFormToggleParam
-
_allowMQSingleMultiQualToggleParam
protected FormalParameterImpl _allowMQSingleMultiQualToggleParam
-
_allowAQFormElemsToggleParam
protected FormalParameterImpl _allowAQFormElemsToggleParam
-
_showAddConditionButton
protected FormalParameterImpl _showAddConditionButton
-
_helpTopicNameParam
protected FormalParameterImpl _helpTopicNameParam
Deprecated.
-
helpTopic
protected FormalParameter helpTopic
- Since:
- MicroStrategy Web 9.0.0
-
helpType
protected FormalParameter helpType
- Since:
- MicroStrategy Web 9.0.0
-
_clearFilterImageTxtParam
protected FormalParameterImpl _clearFilterImageTxtParam
-
_showDottedLineParam
protected FormalParameterImpl _showDottedLineParam
-
_hideIDFormsParam
protected FormalParameterImpl _hideIDFormsParam
-
_formsCollectionParam
protected FormalParameterImpl _formsCollectionParam
-
_showInlineAcceptCancelButtonsParam
protected FormalParameterImpl _showInlineAcceptCancelButtonsParam
- Since:
- MicroStrategy Web 9.0.0
-
_submitButtonNameParam
protected FormalParameterImpl _submitButtonNameParam
- Since:
- MicroStrategy Web 9.0.0
-
_dynamicDateDisplayParam
protected FormalParameterImpl _dynamicDateDisplayParam
- Since:
- MicroStrategy Web 8.0.2
-
DISPLAY_DYNAMIC_DATES_AS_STATIC
public static final int DISPLAY_DYNAMIC_DATES_AS_STATIC
- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
DISPLAY_DYNAMIC_DATES_AS_DYNAMIC
public static final int DISPLAY_DYNAMIC_DATES_AS_DYNAMIC
- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Description copied from interface:Transform
Returns a textual description of the transform.- Specified by:
getDescription
in interfaceTransform
- Returns:
- The textual description of the transform.
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Description copied from class:AbstractAppTransform
Generates the output when the bean's status isEnumRequestStatus.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.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
initializeCss
public void initializeCss()
This method initializes the CSS names used by the transform. It overrides the initializeCss method onAbstractAppTransform
.- Overrides:
initializeCss
in classAbstractAppTransform
-
initializeTransform
public void initializeTransform(Transformable data)
This method overrides the superclass' initializeTransform method - this is called to pick up the reference to the Transformable object passed to the transform and to do initialization of the transform. If this method is overridden, then it must be called by the overriding method in order for the transform to work properly.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- The Transformable object that is being transformed upon.
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type for this transform.- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
- A Class object representing the bean type this transform supports.
-
renderExpression
protected void renderExpression(MarkupOutput out) throws UnmodifiableException
- Throws:
UnmodifiableException
- Since:
- MicroStrategy Web 9.0.0
-
getMainDivAttributes
public java.util.Map getMainDivAttributes()
Returns the list of attributes to add to the main DIV 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.
-
renderTitle
public void renderTitle(MarkupOutput out)
This method renders the title portion of the GUI. This includes the title, empty filter message, help/close buttons, and the options at the top of the page such as Add Condition and Clear All.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderEditorTitle
public void renderEditorTitle(MarkupOutput out)
This method will simply render the title of the editor.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderCloseButton
public void renderCloseButton(MarkupOutput out)
This method will render the close button for the editor. To find the event to associate with this button, it will call getCloseEvent. If that method returns null, then no close button will be rendered.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderHelpButton
public void renderHelpButton(MarkupOutput out)
This method will render the help button for the editor. To find the event to associate with this button, it will call getHelpEvent. If that method returns null, then no help button will be rendered.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderHeader
public void renderHeader(MarkupOutput out)
This method will render the header portion of the document, which includes the empty filter message, add condition button, close all button, and auto-apply button.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderEmptyFilterMessage
public void renderEmptyFilterMessage(MarkupOutput out)
This method will check whether the filter that this transform is attempting to render is empty, and if it is, render a message saying that the filter is empty. If the filter is not empty, then nothing will be rendered.- Parameters:
out
- The MarkupOutput object to render the output to.
-
getEmptyFilterMessage
protected java.lang.String getEmptyFilterMessage()
Returns the message that should be used if the filter is empty.
-
generateAnchor
protected AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting requested attributes- Overrides:
generateAnchor
in classAbstractAppTransform
- Parameters:
event
-WebEvent
instance base for creating the anchor- Returns:
AnchorTag
intitialized instance with the information as provided
-
renderHeaderAddCondition
public void renderHeaderAddCondition(MarkupOutput out)
This method will render the add condition link, normally in the header of the editor.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderHeaderClearAll
public void renderHeaderClearAll(MarkupOutput out)
This method will render the "clear all" button in the filter editor.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderHeaderAutoApply
public void renderHeaderAutoApply(MarkupOutput out)
This method will render the "auto apply enabled" button in the filter editor GUI. Note that by default, this method is not implemented, and must be overridden by child classes if it is to do anything. This is because this only makes sense in certain filter editing contexts.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderContent
public void renderContent(MarkupOutput out)
This method renders the content of the filter editor. This is basically the full body of the filter, including the add wizard, the filter expression itself, and the apply/cancel buttons.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderApplyCancelButtons
public void renderApplyCancelButtons(MarkupOutput out)
Function that displays apply and cancel buttons for the whole expression, when they are needed.- Parameters:
out
- The MarkupOutput object to render the output to.
-
getContentTableAttributes
public java.util.Map getContentTableAttributes()
This method returns the attributes which are to be put on the table surrounding the main content of the filter. This can be overridden to change the attributes which are on the table.- Returns:
- A java.util.Map object whose keys are the attribute names, and the values are the attribute values. Both are String-typed.
-
renderFilterTree
public void renderFilterTree(MarkupOutput out)
This method will render the actual filter expression tree in the GUI. This is the lowest-level method that can be called by the layout to render the actual expression itself.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderSpecificValidationErrorMessage
public void renderSpecificValidationErrorMessage(MarkupOutput out)
If the expression bean has a validation error waiting on it, this method will render the specific error message for that error. If there is no validation error waiting, then this method will do nothing.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderGenericValidationErrorMessage
public void renderGenericValidationErrorMessage(MarkupOutput out)
If the expression bean has a validation error waiting on it, this method will render a generic error message. If there is no validation error waiting, then this method will do nothing.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderErrorMessage
protected void renderErrorMessage(MarkupOutput out, java.lang.String imageTitle, java.lang.String errorMessage)
- Since:
- MicroStrategy Web 8.0.1
-
isAddWizardRequested
public boolean isAddWizardRequested()
Returns whether the bean is requesting the display of the add wizard.- Returns:
- True if the add wizard should be shown, false otherwise.
-
renderAddWizardTransition
public void renderAddWizardTransition(MarkupOutput out)
This method renders the transition between the rest of the filter and the add wizard (usually the word and).- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderAddWizardDropdown
public void renderAddWizardDropdown(MarkupOutput out)
This method renders the object dropdown for the add wizard.- Parameters:
out
- The MarkupOutput object to render the output to.
-
canFilterOnUnit
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.
- Since:
- MicroStrategy Web 8.0.1
-
renderAddWizardButtons
public void renderAddWizardButtons(MarkupOutput out)
This method renders the buttons for the add wizard.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderAddWizard
public void renderAddWizard(MarkupOutput out)
This method will render an HTML pull-down menu presenting a list of objects to qualify upon if the expression bean's edit mode is ExpressionEditModeSelectUnit.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderSeparator
public void renderSeparator(MarkupOutput out)
Renders the separator that is used to indent subexpressions.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderSubExpressionEditMode
protected void renderSubExpressionEditMode(MarkupOutput out, WebNode node, int level)
This function renders a subexpression which is currently being edited by the user. It will generally render the common elements for a subexpression that is being edited then delegate to a type-specific render method.- Parameters:
out
- The MarkupOutput object to render the output to.node
- The current node being rendered.level
- The depth within the filter expression tree of this node.
-
renderMeNodeEditMode
protected void renderMeNodeEditMode(MarkupOutput out, WebNode node, int level)
This function will render the subexpression for a me node expression which is being edited by the user.- Parameters:
out
- The MarkupOutput object to render the output to.node
- The current node being rendered.level
- The depth within the filter expression tree of this node.- Since:
- MicroStrategy Web 9.0.0
-
getMetricShortuctNode
protected WebShortcutNode getMetricShortuctNode(WebNode node)
- Since:
- MicroStrategy Web 9.0.0
-
renderMQEditMode
protected void renderMQEditMode(MarkupOutput out, WebNode node, int level)
This function will render the subexpression for a metric qualfiication which is being edited by the user.- Parameters:
out
- The MarkupOutput object to render the output to.node
- The current node being rendered.level
- The depth within the filter expression tree of this node.
-
renderXDAMetricSelectorButton
protected void renderXDAMetricSelectorButton(MarkupOutput out)
-
addClickOnMetricSelectorButton
protected void addClickOnMetricSelectorButton(InputTag inputTag, WebEvent toggleMode, boolean isMetricExprQual)
-
isObjectInTemplate
protected boolean isObjectInTemplate(WebShortcutNode shortcutNode)
-
getMetricName
protected java.lang.String getMetricName(WebShortcutNode shortcutNode)
- Since:
- MicroStrategy Web 9.0.0
-
getMQAcceptEvent
protected WebEvent getMQAcceptEvent(boolean isMetricExprQual)
- Since:
- MicroStrategy Web 9.0.0
-
renderConstantPromptArea
protected void renderConstantPromptArea(MarkupOutput out, WebPrompt constPrompt, int ndKey)
This method will render an existing constant prompt in a subexpression that is being edited.- Since:
- MicroStrategy Web 9.0.0
-
renderMQFunctions
protected void renderMQFunctions(MarkupOutput out, WebEvent acceptEvent, int function, int functionType, boolean isMetricExprQual, boolean isConstPrompted)
- Since:
- MicroStrategy Web 9.0.0
-
renderMeNodeQualFunctions
protected void renderMeNodeQualFunctions(MarkupOutput out, WebEvent acceptEvent, int function, int functionType)
- Since:
- MicroStrategy Web 9.0.0
-
renderMQConstantTextbox
protected void renderMQConstantTextbox(MarkupOutput out, WebEvent acceptEvent, java.lang.String constValue, int function)
This method renders the constant textbox for a metric qualification subexpression.- Parameters:
out
- The MarkupOutput object to render the output to.acceptEvent
- The event that is used to accept the qualification.constValue
- The current constant value.function
- The current function being qualified upon.
-
renderAQEditMode
protected void renderAQEditMode(MarkupOutput out, WebNode node, int level)
This method will render an attribute qualification which is being edited by the user. It will render the common elements to all attribute qualfications then delegate to more specific rendering methods.- Parameters:
out
- The MarkupOutput object to render the output to.node
- The node being rendered.level
- The depth of the node in the expression tree.
-
addClickOnAttrSelectorButton
protected void addClickOnAttrSelectorButton(InputTag inputTag, WebEvent toggleSingleExprEvent, boolean isMultiFormQual)
-
renderAQListEditMode
protected void renderAQListEditMode(MarkupOutput out, WebNode node, int level)
This method renders an attribute qualficiation subexpression which is being edited in list mode - i.e. the attribute's elements are being qualified upon.- Parameters:
out
- The MarkupOutput object to render the output to.node
- The node being edited.level
- The depth of the subexpression in the tree.
-
renderDescendantOptions
protected void renderDescendantOptions(WebOperatorNode node, Tag tableTag, WebEvent acceptEvent)
-
getConstantValue
protected java.lang.String getConstantValue(WebNode parent, int ix, java.lang.String defaultValue)
-
renderAQListFirstRow
protected void renderAQListFirstRow(WebOperatorNode node, Tag tableTag, WebEvent acceptEvent)
-
newCart
protected Cart newCart()
-
addAttDetails
protected void addAttDetails(WebAttribute attr) throws WebObjectsException
- Throws:
WebObjectsException
-
isItemKeptInCartAvailable
protected boolean isItemKeptInCartAvailable()
Indicates preference value for whether or not to keep item in cart's available list.- Returns:
- boolean true if preference is on.
-
initializeCartSettings
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.
-
initializeCartSettings
protected void initializeCartSettings(Cart cart, java.lang.String selectedAnswerListName, int elemsBlockBegin, int elemsBlockCount, int totalElements, WebAttribute attr)
- Since:
- MicroStrategy Web 9.0.0
-
renderMQUnitComparison
protected void renderMQUnitComparison(MarkupOutput out, java.lang.String metricID, WebEvent acceptEvent)
This method will render the unit comparison list for a metric-to-metric qualfication that is currently being edited..- Parameters:
out
- The MarkupOutput object to render the output to.metricID
- The metric ID of the currently selected object in the pulldown.acceptEvent
- The event that is used to accept the qualificiation.
-
shouldShowObject
protected boolean shouldShowObject(WebDisplayUnit unit)
Indicate if the unit should be shown. It would be overridden by ThresholdExpressionTransform- Parameters:
unit
- the display unit- Returns:
- boolean, indicate if the unit should be shown.
-
renderFilterNode
protected void renderFilterNode(MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)
This is the method which renders a single node within the filter. It will recursively call itself and renderOperatorNode to render the whole expression.- Parameters:
out
- The MarkupOutput object to render the output to.expr
- The expression being rendered.node
- The node currently being rendered.level
- The level of the current node.isReportLimit
- Whether this expression refers to a report limit expression or the expression that is set on the ExpressionBean. If this is true, then the expression on the ExpressionBean is not the same as the expression being rendered here.
-
renderOperator
protected void renderOperator(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, int level, boolean isReportLimit)
This method renders the given operator node. It will render the HTML common to all operator nodes being rendered, then delegate to either renderOperatorEditMode or renderOperatorViewMode based upon whether the operator is being edited.- Parameters:
out
- The MarkupOutput object to render the output to.opNode
- The operator node being rendered.leftNode
- The left child of the operator node.rightNode
- The right child of the operator node.level
- The depth within the expression tree of the operator node.
-
renderOperator
protected void renderOperator(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, boolean isReportLimit, MarkupOutput mainOut, boolean useEditMode) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException
- Throws:
java.lang.IllegalStateException
java.lang.IllegalArgumentException
- Since:
- MicroStrategy Web 8.0.2
-
renderSubExpression
protected void renderSubExpression(MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)
This method renders a subexpression of the expression. It will render a few common GUI elements then delegate to renderSubExpressionEditMode and renderSubExpressionViewMode.- Parameters:
out
- The MarkupOutput object to render the output to.expr
- The expression being rendered.node
- The node being rendered.level
- The level of the node within the expression.isReportLimit
- Whether this expression refers to a report limit expression or the expression that is set on the ExpressionBean. If this is true, then the expression on the ExpressionBean is not the same as the expression being rendered here.
-
renderAQQualifyEditMode
protected void renderAQQualifyEditMode(MarkupOutput out, WebNode node, int level, boolean isMultiFormQual)
This method will render an attribute form qualfication subexpression that is currently being edited.- Parameters:
out
- The MarkupOutput object to render the output to.node
- The node currently being rendered.level
- The level of the currently rendered node within its expression tree.isMultiFormQual
- Whether this attribute form qualficiation is a form to form qualification or a form to constant qualificiation.
-
getAttributesForAcceptButton
protected java.util.Map getAttributesForAcceptButton()
This method will return any HTML attributes that should be added to the accept button for a subexpression being edited. This can be used to add javascript to the accept button, which can be used to assist customizations.- Returns:
- A java.util.Map containing attribute name-attribute value String pairs describing the attributes to add to the accept button.
-
renderAQQualifyAttrForms
protected void renderAQQualifyAttrForms(MarkupOutput out, WebNode operatorNode, WebFormShortcutNode formShortcutNode, WebEvent acceptEvent)
This method will render the list of attribute forms to qualify upon for an attribute form qualfication that is being edited.- Parameters:
out
- The MarkupOutput object to render the output to.operatorNode
- The node being rendered.formShortcutNode
- The form shortcut node representing the current selection.acceptEvent
- The event that is used to accept the qualification.
-
renderAQQualifyAttrForms
protected void renderAQQualifyAttrForms(MarkupOutput out, WebNode operatorNode, WebFormShortcutNode formShortcutNode, WebEvent acceptEvent, boolean isConstPrompted)
- Since:
- MicroStrategy Web 9.0.0
-
renderAQQualifyFunctions
protected void renderAQQualifyFunctions(MarkupOutput out, int function, boolean isMultiFormQual, WebEvent acceptEvent)
This method will render a list of functions that can be used to render an attribute form qualficiation subexpression in edit mode.- Parameters:
out
- The MarkupOutput object to render the output to.function
- The currently selected function.isMultiFormQual
- Whether this subexpression is a form-to-form qualficiation or form-to-constant qualification.acceptEvent
- The event that should be used to accept the qualification.
-
renderAQQualifyFunctions
protected void renderAQQualifyFunctions(MarkupOutput out, int function, boolean isMultiFormQual, WebEvent acceptEvent, boolean isConstPrompted)
- Since:
- MicroStrategy Web 9.0.0
-
renderAQQualifyConstantTextbox
protected void renderAQQualifyConstantTextbox(MarkupOutput out, int function, java.lang.String value, WebEvent acceptEvent)
This method will render the constant textbox for an attribute form to constant value qualification.- Parameters:
out
- The MarkupOutput object to render the output to.function
- The currently chosen function.value
- The current value of the constant node.acceptEvent
- The event to use to accept the qualification.
-
renderAQQualifyConstantTextbox
protected void renderAQQualifyConstantTextbox(MarkupOutput out, int function, java.lang.String value, WebEvent acceptEvent, boolean isDisabledByConstPrompt)
- Since:
- MicroStrategy Web 9.0.0
-
renderAQQualifyUnit
protected void renderAQQualifyUnit(MarkupOutput out, WebNode node, WebEvent accpetEvent)
-
renderAQQualifyUnitComparison
protected void renderAQQualifyUnitComparison(MarkupOutput out, java.lang.String selectedAttributeID, java.lang.String selectedFormID, WebEvent acceptEvent)
This method will render the right-side pulldown of attribute forms for an attribute form to attribute form qualification.- Parameters:
out
- The MarkupOutput object to render the output to.acceptEvent
- The event used to accept the qualification.
-
renderOperatorEditMode
protected void renderOperatorEditMode(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode)
This method renders an operator in edit mode. In this context, an operator refers to an AND/OR/AND NOT/OR NOT node. The edit mode will normally only occur in HTML mode, as those operators are edited via a DHTML menu in DHTML mode.- Parameters:
out
- The MarkupOutput object to render the output to.opNode
- The operator node being rendered.leftNode
- The left-hand child of the operator node.rightNode
- The right-hand child of the operator node.
-
renderOperatorViewMode
protected void renderOperatorViewMode(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, boolean isReportLimit)
This method will render an operator node in view mode. It will render the AND/OR/AND NOT/OR NOT operator node plus any shift buttons.- Parameters:
out
- The MarkupOutput object to render the output to.opNode
- The operator node being rendered.leftNode
- The left-hand child of the node.rightNode
- The right-hand child of the node.isReportLimit
- Whether this node comes from a report limit expression. If this is true, then the node does not come from the expression on the ExpressionBean.
-
canEditOperator
protected boolean canEditOperator(WebNode leftNode, WebNode rightNode)
- Since:
- MicroStrategy Web 8.0.2
-
renderSubExpressionViewMode
protected void renderSubExpressionViewMode(MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)
This is the generic method that renders a non-branch subexpression in view mode. It renders GUI elements such as the delete button and shift buttons, plus the expression itself.- Parameters:
out
- The MarkupOutput object to render the output to.expr
- The expression being rendered.node
- The currently rendered node.level
- The level of the node within the expression.isReportLimit
- Whether the expression is from the report limit. If this is true, then the expression passed in will not be the expression set on the ExpressionBean.
-
renderUpAndDownButtons
protected void renderUpAndDownButtons(WebNode node, boolean isEditableFilterExpr, MarkupOutput mainOut) throws UnmodifiableException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
Deprecated.Replaced by renderUpAndDownButtons(MarkupOutput mainOut, ....)- Parameters:
node
-isEditableFilterExpr
-mainOut
-- Throws:
UnmodifiableException
java.lang.IllegalArgumentException
java.lang.IllegalStateException
- Since:
- MicroStrategy Web 9.0.0
-
renderUpAndDownButtons
protected void renderUpAndDownButtons(MarkupOutput mainOut, WebNode node, boolean isEditableFilterExpr) throws UnmodifiableException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
- Throws:
UnmodifiableException
java.lang.IllegalArgumentException
java.lang.IllegalStateException
- Since:
- MicroStrategy Web 9.0.0
-
renderSubexpressionBodyViewMode
protected void renderSubexpressionBodyViewMode(MarkupOutput mainOut, WebExpression expr, WebNode node, int level, boolean isReportLimit, boolean isEditableFilterExpr) throws java.lang.ClassCastException, UnmodifiableException, java.lang.IllegalStateException, java.lang.IllegalArgumentException
- Parameters:
mainOut
-expr
-node
-level
-isReportLimit
-isEditableFilterExpr
-- Throws:
java.lang.ClassCastException
UnmodifiableException
java.lang.IllegalStateException
java.lang.IllegalArgumentException
- Since:
- MicroStrategy Web 9.0.0
-
newFet
protected ExpressionFilterTransform newFet()
- Since:
- MicroStrategy Web 9.0.0
-
renderSubexpressionBodyViewMode
protected void renderSubexpressionBodyViewMode(WebExpression expr, WebNode node, int level, boolean isReportLimit, boolean isEditableFilterExpr, MarkupOutput mainOut) throws java.lang.ClassCastException, UnmodifiableException, java.lang.IllegalStateException, java.lang.IllegalArgumentException
Deprecated.- Parameters:
expr
-node
-level
-isReportLimit
-isEditableFilterExpr
-mainOut
-- Throws:
java.lang.ClassCastException
UnmodifiableException
java.lang.IllegalStateException
java.lang.IllegalArgumentException
- Since:
- MicroStrategy Web 9.0.0
-
getEditExpressionJS
public java.lang.String getEditExpressionJS()
- Since:
- MicroStrategy Web 9.0.0
-
getExpBeanPath
public java.lang.String getExpBeanPath()
This function is designed for ThresholdExpressionTransform. It just return bean path the same as getBeanPath() in this class. and will be overridden in ThresholdExpressionTransform- Since:
- MicroStrategy Web 9.0.0
-
canMoveDown
protected boolean canMoveDown(WebNode node)
- Since:
- MicroStrategy Web 9.0.0
-
canMoveUp
protected boolean canMoveUp(WebNode node)
- Since:
- MicroStrategy Web 9.0.0
-
renderDownButton
protected void renderDownButton(MarkupOutput mainOut, WebNode node) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException, UnmodifiableException
- Throws:
java.lang.IllegalStateException
java.lang.IllegalArgumentException
UnmodifiableException
- Since:
- MicroStrategy Web 9.0.0
-
renderUpButton
protected void renderUpButton(WebNode node, MarkupOutput mainOut) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException, UnmodifiableException
Deprecated.Replaced by renderUpButtom(MarkupOutput,....)- Parameters:
node
-mainOut
-- Throws:
java.lang.IllegalStateException
java.lang.IllegalArgumentException
UnmodifiableException
- Since:
- MicroStrategy Web 9.0.0
-
renderUpButton
protected void renderUpButton(MarkupOutput mainOut, WebNode node) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException, UnmodifiableException
- Throws:
java.lang.IllegalStateException
java.lang.IllegalArgumentException
UnmodifiableException
- Since:
- MicroStrategy Web 9.0.0
-
renderRemoveSubexpressionButton
protected void renderRemoveSubexpressionButton(MarkupOutput out, WebNode node, boolean isEditableFilterExpr)
- Since:
- MicroStrategy Web 9.0.0
-
generateDeleteSubExpressionClickJS
protected void generateDeleteSubExpressionClickJS(java.lang.String key, WebEvent deleteEvent, java.lang.StringBuffer onClickJS)
This method will render the JavaScript necessary to delete a sub expression.- Parameters:
onClickJS
- The MarkupOutput object to render the output to.- Since:
- MicroStrategy Web 9.0.0
-
addEventHiddenInputs
protected void addEventHiddenInputs(java.util.ArrayList eventList)
-
renderEventHiddenInputs
protected void renderEventHiddenInputs(MarkupOutput out)
This method will render all of the hidden inputs for the events that will be used within the expression transform.- Parameters:
out
- The MarkupOutput object to render the output to.
-
renderCancelButton
protected void renderCancelButton(MarkupOutput out)
Description copied from class:AbstractAppTransform
Renders the Cancel button for the wait page.
It callsAbstractAppTransform.getCancelEvent()
to obtain the event for the button
The button is not rendered if:
-AbstractAppTransform.getCancelEvent()
returns null
-AbstractAppTransform.processingButtonsFlags
does not haveAbstractAppTransform.PROCESSING_BUTTONS_CANCEL
- Overrides:
renderCancelButton
in classAbstractAppTransform
- Parameters:
out
- output for this transform
-
shallRenderAcceptCancell
protected boolean shallRenderAcceptCancell()
- Since:
- MicroStrategy Web 9.0.0
-
renderAcceptButton
protected void renderAcceptButton(MarkupOutput out, WebEvent acceptEvent, java.lang.String[] eventArgList, boolean isDefault)
-
renderJavascript
protected void renderJavascript(MarkupOutput out)
This method renders all javascript that will be necessary for the ExpressionGenericTransform to work correctly.- Parameters:
out
- The MarkupOutput object to render the output to.
-
setBoneProperties
protected void setBoneProperties(JsonGenerator boneProps)
Description copied from class:AbstractAppTransform
Sets the necessary properties to the bone assigned to this transform (based on theAbstractAppTransform.scriptClass
formal parameter)
Usually called byAbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.- Overrides:
setBoneProperties
in classAbstractAppTransform
- Parameters:
boneProps
- the JsonGenerator object that contains the collection of bone properties.
-
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 therenderRegisterBone
method to indicate the id of the bone html element.- Overrides:
getBoneId
in classAbstractAppTransform
- Returns:
- String
- Since:
- MicroStrategy Web 9.0.0
- See Also:
AbstractAppTransform.renderRegisterBone(com.microstrategy.web.beans.MarkupOutput)
-
getAddElementsEvent
public WebEvent getAddElementsEvent()
Returns the event to be used for the add elements operation.- Returns:
- The add elements event.
-
getRemoveElementsEvent
public WebEvent getRemoveElementsEvent()
Returns the event to be used for the remove elements operation.- Returns:
- The remove elements event.
-
getElemsSearchEvent
public WebEvent getElemsSearchEvent()
Returns the event to be used for the element search action.- Returns:
- The elements search event.
-
getFirstPageEvent
public WebEvent getFirstPageEvent()
Returns the event to be used for going to the first page of element browsing.- Returns:
- The first page event.
-
getLastPageEvent
public WebEvent getLastPageEvent()
Returns the event to be used for going to the last page of element browsing.- Returns:
- The last page event.
-
getPrevPageEvent
public WebEvent getPrevPageEvent()
Returns the event to be used for going to the previous page of element browsing.- Returns:
- The previous page event.
-
getNextPageEvent
public WebEvent getNextPageEvent()
Returns the event to be used for going to the next page of element browsing.- Returns:
- The next page event.
-
getApplyEvent
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.
-
getCancelEvent
public WebEvent getCancelEvent()
Returns the event to be used for the cancel button - this will undo the currently edited subexpression's changes.- Overrides:
getCancelEvent
in classAbstractAppTransform
- Returns:
- The cancel event.
-
getHelpEvent
public WebEvent getHelpEvent()
Returns the event to be used for the help button.- Returns:
- The help event.
-
getCloseEvent
public WebEvent getCloseEvent()
Returns the event to be used for the close button.- Returns:
- The close event.
-
getCancelAllEvent
public WebEvent getCancelAllEvent()
Returns the cancel all event, which will cancel all un-applied changes.- Returns:
- The cancel all event.
-
getEditEvent
public WebEvent getEditEvent()
Returns the edit event, which signals the intent to edit an existing subexpression.- Returns:
- The edit event.
-
getDeleteEvent
protected WebEvent getDeleteEvent()
Returns the delete subexpression event.- Returns:
- The delete event.
- Since:
- MicroStrategy Web 9.0.0
-
getAddConditionEvent
public WebEvent getAddConditionEvent()
Returns the add condition event, which signals the intent to open the add wizard.- Returns:
- The add condition event.
-
getClearAllEvent
public WebEvent getClearAllEvent()
Returns the clear all event, which signals that the user wishes to clear the whole subexpression.- Returns:
- The clear all event.
-
getCreateSubexpressionEvent
public WebEvent getCreateSubexpressionEvent()
Returns the create subexpression event, which signals that the user is creating a new subexpression.- Returns:
- The create subexpression event.
-
getToggleAQFormElemsEvent
public WebEvent getToggleAQFormElemsEvent()
Returns the event to toggle between form and elements qualifications.- Returns:
- The toggle event for toggling between form and element qualificiations.
-
getToggleQualExprEvent
public WebEvent getToggleQualExprEvent()
Returns the event to toggle between single and multiple-part qualificiation - for example, single metric and multi metric, or single form and multi form.- Returns:
- The toggle event for toggling between single and multiple qualification.
-
getToggleOperatorEvent
public WebEvent getToggleOperatorEvent()
Returns the event to toggle the logical operator of an expression (AND/OR/NOT, etc).- Returns:
- The toggle event for toggling the logical operator of an expression.
- Since:
- MicroStrategy Web 8.0.1
-
getExpressionBean
public ExpressionBean getExpressionBean()
Returns the expression bean. This should be used by derived classes to retrieve the expression bean being rendered.- Returns:
- The
ExpressionBean
object being rendered.
-
getEventTargetExpressionBean
protected ExpressionBean getEventTargetExpressionBean()
Returns the expression bean for getting events. This should be used by derived classes to retrieve the expression bean that events should target.- Returns:
- The
ExpressionBean
object being targeted by events. - Since:
- MicroStrategy Web 9.0.0
-
isViewFilter
protected boolean isViewFilter()
Returns whether this expression refers to a report's view filter.- Returns:
- True if the expression refers to a view filter, false otherwise.
-
generateMultiEventArgumentString
protected final java.lang.String generateMultiEventArgumentString(WebEvent[] eventList, java.lang.String[][] argsLists, boolean restoreState)
Generates the multiple event argument string for the given event list, with the given argument lists. If restoreState is true, then the appropriate event to restore state will be appended to the beginning of the given events.- Parameters:
eventList
- The list of events.argsLists
- The list of argument lists, in the same order as the event list.restoreState
- Whether to include the restore state event.- Returns:
- The string representing the multiple event argument.
-
generateMultiEventArgumentString
protected final java.lang.String generateMultiEventArgumentString(WebEvent event, java.lang.String[] args, boolean restoreState)
Generates the multiple event argument string for the given event, with the given arguments. If restoreState is true, then the appropriate event to restore state will be appended to the beginning of the given event.- Parameters:
event
- The event.args
- The argument list - argument name/value pairs in a flat array (i.e. name1, value1, name2, value2,...).restoreState
- Whether to include the restore state event.- Returns:
- The string representing the multiple event argument.
-
generateUpdateManagerEventJSString
protected final void generateUpdateManagerEventJSString(java.lang.StringBuffer buf, java.lang.String beanPath, WebEvent event, java.lang.String[] args, boolean restoreState)
Generates the javascript for the onclick tag that is necessary to invoke the given event via the update manager. A String representing the javascript function call(s) necessary to invoke the given event.- Parameters:
beanPath
- The path of the bean the event is being run upon.event
- TheWebEvent
object representing the event to be run.args
- An argument list consisting of {event ID1, eventValue1, eventID2, eventValue2,...}. This can be null if there are no arugments.restoreState
- If this is true, then the best known restore state event will be added to the event.
-
getBeginJavaScriptCall
protected java.lang.String getBeginJavaScriptCall()
Returns the client-side code necessary for executing js in links. Also makes a call to getOnClickJavaScript.- Since:
- MicroStrategy Web 9.0.0
-
getSpecailBeginJavaScriptCall
protected java.lang.String getSpecailBeginJavaScriptCall()
Returns the client-side code necessary for executing js in links. Also makes a call to getOnClickJavaScript. It also adds a call to call getValidateJavaScript.- Since:
- MicroStrategy Web 9.0.0
-
getOnClickJavaScript
protected java.lang.String getOnClickJavaScript()
Returns any javascript to be excuted when the user clicks the element it's assigned to. This is used by the mstrThresholdExpressionEditor bone to tell the advanced thresholds editor to notify the ThresholdEditorBean that the expression is about to be edited.- Since:
- MicroStrategy Web 9.0.0
-
getValidateJavaScript
protected java.lang.String getValidateJavaScript()
- Since:
- MicroStrategy Web 9.0.0
-
getImageFolder
protected java.lang.String getImageFolder()
Returns the folder that images are expected to be stored in.- Returns:
- The image folder.
-
isFilterEmpty
protected boolean isFilterEmpty(WebExpression expr)
Returns whether the given filter expression is empty.- Parameters:
expr
- The expression to evaluate.- Returns:
- True if the given expression is empty, false otherwise.
-
getWorkingSet
protected WebWorkingSet getWorkingSet()
Returns the working set object, if the filter is a report filter. Otherwise, returns null.- Returns:
- A
WebWorkingSet
object if the filter is a report filter, or null otherwise.
-
getAvailableObjectsFolder
protected WebFolder getAvailableObjectsFolder()
Returns the list of "available" objects to be used for the add wizard or for an attribute-to-attribute or metric-to-metric qualificiation.- Returns:
- A
WebFolder
with the list of available objects.
-
isViewReport
protected boolean isViewReport()
- Returns:
- whether the report is a view report
- Since:
- MicroStrategy Web 9.0.0
-
isEditable
public boolean isEditable()
Returns whether the user is allowed to edit this expression.- Returns:
- True if the expression is editable, false otherwise.
-
getObjectAlias
protected java.lang.String getObjectAlias(WebObjectInfo ob)
Attempts to find the best object alias to use for the given object.- Parameters:
ob
- The object whose alias will be returned.- Returns:
- The alias to use for the object.
-
initExpressionBeanTransform
protected void initExpressionBeanTransform(ExpressionBean expBean)
This method captures the reference to the expression bean and does some other initialization-related routines. Note that subclasses of this transform must either:- Call initializeTransform with an ExpressionBean object.
- Call this method.
- Parameters:
expBean
- The ExpressionBean to transform.
-
getFilterType
protected int getFilterType()
Returns the filter type, fromEnumFilterTypes
.- Returns:
- The filter type of the expression.
-
getBeanName
protected java.lang.String getBeanName()
Returns the main bean's name.- Returns:
- The expression bean's name.
-
getBeanPath
protected java.lang.String getBeanPath()
Returns the main bean's path.- Overrides:
getBeanPath
in classAbstractAppTransform
- Returns:
- The expression bean's path.
- See Also:
WebComponent.getPath()
,AbstractAppTransform.renderRegisterBone(com.microstrategy.web.beans.MarkupOutput)
-
getAutoApply
public boolean getAutoApply()
Returns whether the auto-apply functionality is enabled. If this is true, the transform will render the GUI such that it expects that every operation will apply changes to the original expression automatically.- Returns:
- Whether auto-apply is enabled.
-
isAutoSynchronizeEnabled
public boolean isAutoSynchronizeEnabled()
This method returns whether the GUI should synchronize the expression on the expression bean with its source upon every operation. If this is false, then the apply/cancel buttons will be active.- Returns:
- Whether auto-synchronize is enabled for this transform.
-
isUpdateManagerEnabled
public boolean isUpdateManagerEnabled()
This method can be overridden by child classes to signal whether or not to send all multiple event requests through the update manager. By default, this is false, meaning that the update manager should not be used.- Returns:
- True if the update manager is enabled, false otherwise.
-
isApplyCancelEnabled
public boolean isApplyCancelEnabled()
Returns whether the apply/cancel buttons should be shown.- Returns:
- True if the apply/cancel buttons should be shown, false otherwise.
-
showCloseButton
protected boolean showCloseButton()
Returns whether to show a close button.- Returns:
- Whether to show a close button.
-
isMetricDimtyTooltipEnabled
protected boolean isMetricDimtyTooltipEnabled()
Returns whether the metric dimensionality should be rendered as a tooltip in the expression.- Returns:
- Whether to show the metric dimensionality in a tooltip.
-
getBeanStateLevel
protected int getBeanStateLevel()
Returns the state level that the bean needs to be saved in for the transform to work properly.- Returns:
- The bean state level required for the ExpressionBean.
-
getEditor
protected Editor getEditor()
Returns an Editor object, which is used to render help/close buttons.- Returns:
- An editor object.
-
isFilterEditorFrameEmpty
protected boolean isFilterEditorFrameEmpty()
This method evaluates whether the filter editor frame is empty. If this is true, then the renderEmptyFilterMessage method will render a message.- Returns:
- Whether the filter editor frame is empty.
-
getContentTableClass
protected java.lang.String getContentTableClass()
Returns the CSS class recommended for the table containing the expression.- Returns:
- The recommended content table CSS class.
-
getRestoreStateEvent
public WebEvent getRestoreStateEvent()
Returns the restore state event based upon the subexpression being edited.- Returns:
- The restore state event to use to restore state changes within the filter editor from the last rendering.
-
setFormName
protected void setFormName(java.lang.String name)
- Since:
- MicroStrategy Web 9.0.0
-
getFormName
protected java.lang.String getFormName()
- Since:
- MicroStrategy Web 9.0.0
-
renderDottedLine
protected void renderDottedLine(MarkupOutput out)
Renders a dotted lined to be used as separator between edit forms and filter expression tree- Parameters:
out
- where to write output
-
getOperatorName
public java.lang.String getOperatorName(int operatorType)
Checks for given WebOperator node function ID and returns corresponding localized function text.- Parameters:
operatorType
-- Returns:
- Operator name
-
getTooltipReportObjects
protected java.lang.String getTooltipReportObjects()
This function return list of all metrics in workingset for tooltip in metric expression when view mode in on.- Returns:
- String
-
calculateBlockBegin
protected int calculateBlockBegin()
-
isSubexpressionInError
protected boolean isSubexpressionInError(WebNode node)
Returns whether the subexpression at the current node is in error or not.- Returns:
- Whether the subexpression at the current node is in error or not.
- Since:
- MicroStrategy Web 8.0.1
-
canToggleAQFormElements
protected boolean canToggleAQFormElements(WebAttribute webAttribute)
This method determines whether the user is allowed to toggle between attribute form and elements qualfication.- Parameters:
webAttribute
- The attribute on which we have to decide if we should allow the toggle between attribute form and elements qualfication.- Returns:
- true if the user is allowed to toggle between attribute form and elements qualfication.
- Since:
- MicroStrategy Web 8.0.1
-
canSelectElements
protected boolean canSelectElements(WebAttribute webAttribute)
This method determines whether the attribute requires a lookup table to support elements qualification.- Parameters:
webAttribute
- The attribute on which we have to decide if it requires a lookup table to support elements qualification.- Returns:
- true if the attribute requires a lookup table to support elements qualification.
- Since:
- MicroStrategy Web 9.0.0
-
canEditSubexpression
protected boolean canEditSubexpression(WebNode node)
Returns whether the subexpression at the current node is editable or not.- Returns:
- Whether the subexpression at the current node is editable or not.
-
isStackedSubexpEnabled
protected boolean isStackedSubexpEnabled()
-
getSeparator
protected java.lang.String getSeparator()
-
addAttrsToTag
protected void addAttrsToTag(java.util.Map attrs, Tag tag)
-
isNotDhtml
public boolean isNotDhtml()
Used by layout to check for absence of DHTML mode.
-
newContext
protected TransformContext newContext()
Description copied from class:AbstractAppTransform
Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.- Overrides:
newContext
in classAbstractAppTransform
- Since:
- MicroStrategy Web 8.0.1
-
getForms
protected WebAttributeForms getForms(WebAttribute att, int formsCollectionType) throws java.lang.UnsupportedOperationException, java.lang.IllegalArgumentException
- Throws:
java.lang.UnsupportedOperationException
java.lang.IllegalArgumentException
-
useWorkingSetForFormLookup
protected boolean useWorkingSetForFormLookup()
- Since:
- MicroStrategy Web 9.0.0
-
shallRenderForm
protected boolean shallRenderForm(WebAttributeForm form)
- Since:
- MicroStrategy Web 8.0.2
-
renderAQOperatorOptions
protected void renderAQOperatorOptions(MarkupOutput mo, int currentFunction, boolean unitComparison)
- Since:
- MicroStrategy Web 8.0.2
-
renderAQOperatorOption
protected void renderAQOperatorOption(MarkupOutput mo, int function, int descriptorId, int currentFunction)
- Since:
- MicroStrategy Web 8.0.2
-
canShowMetricTextOperators
protected boolean canShowMetricTextOperators()
- Since:
- MicroStrategy Web 8.0.2
-
renderMQOperatorOptions
protected void renderMQOperatorOptions(MarkupOutput mo, int currentFunction, int currentFunctionType, boolean bUnitComparison)
- Since:
- MicroStrategy Web 9.0.0
-
renderMeNodeQualOperatorOptions
protected void renderMeNodeQualOperatorOptions(MarkupOutput mo, int currentFunction, int currentFunctionType)
- Since:
- MicroStrategy Web 9.0.0
-
renderMQOperatorOption
protected void renderMQOperatorOption(MarkupOutput mo, int function, int descriptorId, int currentFunction)
- Since:
- MicroStrategy Web 8.0.2
-
renderMQOperatorOption
protected void renderMQOperatorOption(MarkupOutput mo, int function, int functionType, int descriptorId, int currentFunction, int currentFunctionType)
- Since:
- MicroStrategy Web 8.0.2
-
supportsPromptEditor
protected boolean supportsPromptEditor()
- Since:
- MicroStrategy Web 9.0.0
-
getAttributesForPromptButton
protected java.util.Map getAttributesForPromptButton()
- Since:
- MicroStrategy Web 9.0.0
-
renderPromptButton
protected void renderPromptButton(MarkupOutput out, int promptType, java.lang.String inputID, boolean isDisabled)
- Since:
- MicroStrategy Web 9.0.0
-
renderPromptButton
protected void renderPromptButton(MarkupOutput out, int promptType, java.lang.String inputID, boolean isDisabled, boolean isHidden)
-
getEditEmbeddedPromptEvent
protected WebEvent getEditEmbeddedPromptEvent()
- Since:
- MicroStrategy Web 9.0.0
-
getAddEmbeddedPromptEvent
protected WebEvent getAddEmbeddedPromptEvent()
- Since:
- MicroStrategy Web 9.0.0
-
getRemovePromptEvent
protected WebEvent getRemovePromptEvent()
- Since:
- MicroStrategy Web 9.0.0
-
getPromptButtonSourcePath
protected java.lang.String getPromptButtonSourcePath()
- Since:
- MicroStrategy Web 9.0.0
-
getFlattenedContextFolderPath
public java.lang.String getFlattenedContextFolderPath(int contextId)
-
buildFlattenedList
protected java.util.List buildFlattenedList(int contextId, StringWrapper path)
-
getFlattenedContexFolderList
public java.util.List getFlattenedContexFolderList(int contextId)
-
includeOwnerInfo
public boolean includeOwnerInfo()
-
includeTimeInfo
public boolean includeTimeInfo()
-
isShowObjectTags
public boolean isShowObjectTags()
-
getCssName
public java.lang.String getCssName(WebObjectInfo object)
-
getDisplayName
public java.lang.String getDisplayName(WebObjectInfo object)
- Overrides:
getDisplayName
in classAbstractAppTransform
-
getPreferenceIntegerReplaceNull
public int getPreferenceIntegerReplaceNull(java.lang.String prefName, int nullReplace)
-
addOption
protected void addOption(SelectTag tag, int value, java.lang.String desc, int selectedValue)
-
generateOptionTag
protected Tag generateOptionTag(java.lang.String desc, java.lang.String value, boolean selected)
-
-