Class PromptHierarchyWidgetTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
-
- com.microstrategy.web.app.transforms.AbstractPromptWidgetTransform
-
- com.microstrategy.web.app.transforms.PromptExpressionWidgetTransform
-
- com.microstrategy.web.app.transforms.PromptHierarchyWidgetTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class PromptHierarchyWidgetTransform extends PromptExpressionWidgetTransform
This transform is used to render a hierarchy qualification prompt. This transform is responsible for the initial rendering of the prompt. Subsequent calls to browse each hierarchy element is done using a call to the 'browseHierarchy' task. Please check the task definition (browseHierarchy.xml) for more information about the style/transform used for rendering incremental hierarchy information.- Since:
- MicroStrategy Web 9.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.transforms.PromptExpressionWidgetTransform
_ep, _expPromptBean
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractPromptWidgetTransform
_prompt, _promptAppBean, _promptPosition, displayModel
-
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 PromptHierarchyWidgetTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List
getAttributeOrElementList()
Returns the list of available list (attribute or element).int
getAvailableBlockBegin()
Returns the block begin of the available list.int
getAvailableBlockCount()
Returns the block count of the available list.int
getAvailableTotalCount()
Returns the total count of the available list.java.lang.String
getCurrentTreeNodeLocation()
Returns the location of the current node in the flattened ancestor tree.java.util.List
getDrillDownPaths()
Returns a list of the drill down paths.java.util.List
getDrillUpPaths()
Returns the list of drill up paths.java.util.List
getFlattenedAvailablesAncestors()
Returns a flattened list of the ancestors tree of the available list.java.lang.Class
getSupportedBeanType()
Gets the class of objects this transform is able to handle.void
initializeWebComponent(Transformable data)
Initialize the web component to be used by the transform.boolean
isAttributeExpandedToElements()
Returns whether the attribute has been expanded to list its elements.boolean
isElementSearchDisabled()
Returns whether the element search is disabled.boolean
isLeafAttribute()
Returns whether the expanded attribute is leaf attribute or not.boolean
isSearchRequired()
Returns whether a search is required for element browsing.boolean
shouldHideSingleFilter()
boolean
showSearchBox()
Returns whether GUI should show the search box or not.-
Methods inherited from class com.microstrategy.web.app.transforms.PromptExpressionWidgetTransform
getAllFormsInteger, getAllowedFunctions, getAnswer, getAttForms, getAvailableFolderWidget, getAvailableFolderWidget, getAvailableFolderWidget, getDefaultAnswerAsString, getDefaultFunction, getDescription, getDisplayedForms, getEmptyTreeText, getRestriction, getSearchObject, getSearchRequiredText, getSuggestedAnswers, hasNonEmptySearchResults, isAllowDisplayOutputLevelSelector, isAttributeQualification, isAvailableFlattenedExisting, isHierarchyQualification, isMetricQualification, isSAPQualification, shouldRenderDualCart, shouldRenderNoneOption, showIncrementalFetch
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractPromptWidgetTransform
allowMultipleUserAnswer, allowSingleUserAnswer, getAnswerFormat, getAnswerOption, getAnswerRestriction, getChildWidget, getChildWidget, getDataFormsWidget, getDefaultAnswer, getDefaultSavingAnswer, getDisplayProperty, getDisplayStyleName, getElementsAsList, getErrorMessage, getItemWidget, getNamePrefixForSingleSavedAnswer, getPromptIndex, getPromptMeaning, getPromptName, getPromptTitle, getPropertyDefaultSelection, getPropertyHeightValue, getPropertyValue, getPropertyWidthValue, getSavedAnswers, getSearchTypes, hasError, hasSavedAnswers, isAutoCloseAnswer, isAvailableFolderAvailable, isCartStyle, isCheckboxStyle, isDefaultAnswer, isDisplayingModel, isDisplaySearchPropOn, isHICart_or_TreeStyle, isHICartStyle, isListStyle, isMultiListStyle, isNonCartStyle, isOneByOneDisplayMode, isPropertyWidthFixed, isPulldownStyle, isRadioStyle, isReprompting, isSingleListStyle, isTextboxStyle, isTreeStyle, isTrimmedTree, isUseFolderStructure, showObjectDescription, showSearchBoxOrTreeStyle, usingDefaultAnswer
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
buildFlattenedExpression, getAttForms, getChildWidget, getCssName, getIserverNodeFunction, getObjectInfoCssName, getPreferenceValueReplaceNull, getSelf, includeAncestorInfo, includeFolderInfo, includeOwnerInfo, includeTimeInfo, insertChildren, inTreeStructure, isNull, isShowObjectTags, renderShell, renderTest, transformForRequestSuccessful
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeTransform, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, 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
-
-
-
-
Method Detail
-
initializeWebComponent
public void initializeWebComponent(Transformable data)
Description copied from class:AbstractAppTransform
Initialize the web component to be used by the transform.- Specified by:
initializeWebComponent
in interfaceAppTransform
- Overrides:
initializeWebComponent
in classPromptExpressionWidgetTransform
- Parameters:
data
- the bean to transform.
-
isSearchRequired
public boolean isSearchRequired()
Returns whether a search is required for element browsing.- Returns:
- Whether a search is required for element browsing.
-
getAttributeOrElementList
public java.util.List getAttributeOrElementList()
Returns the list of available list (attribute or element).- Returns:
- The list of available list (attribute or element).
-
getFlattenedAvailablesAncestors
public java.util.List getFlattenedAvailablesAncestors()
Returns a flattened list of the ancestors tree of the available list. Refer toPreorderEnumeration
for how the ancestor tree has been flattened.- Returns:
- A flattened list of the ancestor tree of the available list.
-
getCurrentTreeNodeLocation
public java.lang.String getCurrentTreeNodeLocation()
Returns the location of the current node in the flattened ancestor tree. The available list is the content of the current node.- Returns:
- the location of the current node in the flattened ancestor tree.
-
isAttributeExpandedToElements
public boolean isAttributeExpandedToElements()
Returns whether the attribute has been expanded to list its elements. When this is true, then the available list could contain elements instead of hierarchies or attributes. This is important since both attribute and hierarchy are ofWebObjectInfo
type, but element is ofWebElement
type.- Returns:
- Whether the attribute has been expanded to list its elements.
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Gets the class of objects this transform is able to handle.- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classPromptExpressionWidgetTransform
- Returns:
- a
Class
instance with the information about the beans this transform is able to manipulate.
-
getAvailableBlockBegin
public int getAvailableBlockBegin()
Returns the block begin of the available list.- Returns:
- The block begin of the available list.
-
getAvailableBlockCount
public int getAvailableBlockCount()
Returns the block count of the available list.- Returns:
- The block count of the available list.
-
getAvailableTotalCount
public int getAvailableTotalCount()
Returns the total count of the available list.- Returns:
- The total count of the available list.
-
getDrillUpPaths
public java.util.List getDrillUpPaths()
Returns the list of drill up paths. When the first entry point attribute has been expanded, this method would return the drill up paths for that entry point. In other case, it would just return an empty list.- Returns:
- The list of drill up paths.
-
showSearchBox
public boolean showSearchBox()
Returns whether GUI should show the search box or not.- Overrides:
showSearchBox
in classAbstractPromptWidgetTransform
- Returns:
- whether GUI should show the search box or not.
-
isElementSearchDisabled
public boolean isElementSearchDisabled()
Returns whether the element search is disabled. For example, currently we can not perform search on certain XDA/MDX prompt.- Returns:
- Whether the element search is disabled.
-
getDrillDownPaths
public java.util.List getDrillDownPaths()
Returns a list of the drill down paths. When the first entry point attribute has been expanded, this method would return the drill down paths for that entry point. In other case, it would just return an empty list.- Returns:
- A list of the drill down paths.
-
isLeafAttribute
public boolean isLeafAttribute()
Returns whether the expanded attribute is leaf attribute or not. When the first entry point attribute has been expanded, this method would return whether the current attribute is the leaf attribute in the hierarchy. In other case, it would just return false.- Returns:
true
if expanded attribute is the leaf attribute in hierarchy. Otherwise returnsfalse
-
shouldHideSingleFilter
public boolean shouldHideSingleFilter()
-
-