Class ElementPickerTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.ElementPickerTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class ElementPickerTransform extends AbstractAppTransform
This transform renders the element picker used in prompts.- Since:
- MicroStrategy Web 8.0.1
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description FormalParameter
editorLayoutFile
Indicates the name of the definition file associated with the editor.static java.lang.String
FP_EDITOR_LAYOUT_FILE
Constant defining the formal parameter name - Editor Layout file.java.lang.String
FP_TITLE_LABEL_ID
Constant defining the formal parameter name - pane title.FormalParameter
titleLabelID
The title to be used for the pane.-
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 ElementPickerTransform()
Default constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns a textual description of the transform.java.lang.Class
getSupportedBeanType()
Returns the supported bean type.protected void
initEditor(Editor editor)
Initializes the editor with the global settings.protected void
initializeCartProperties(CartElementPicker cartElemPicker)
Initializes the cart properties.protected void
initializeCartSearchAndIncrementalFetch(CartElementPicker cartElemPicker)
Initialize the Search and incremental fetch propertiesvoid
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform, such as width and height.void
renderEditor(MarkupOutput out)
Main method to render the output of an editor.protected void
renderHiddenInputs(MarkupOutput out)
Render hidden inputs forEnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ANY_PROMPTS
protected void
renderJavascript(MarkupOutput out)
Renders the javascript for the transform.void
renderOutput(MarkupOutput out)
Creates aCartElementPicker
instance and initializes the cart properties and then renders the cart into theMarkupOutput
.void
transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status isEnumRequestStatus.WebBeanRequestSuccessful
.-
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, initializeWebComponent, 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, renderShell, 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.Transform
canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports
-
-
-
-
Field Detail
-
editorLayoutFile
public FormalParameter editorLayoutFile
Indicates the name of the definition file associated with the editor.
-
FP_EDITOR_LAYOUT_FILE
public static final java.lang.String FP_EDITOR_LAYOUT_FILE
Constant defining the formal parameter name - Editor Layout file.- See Also:
- Constant Field Values
-
titleLabelID
public FormalParameter titleLabelID
The title to be used for the pane.
-
FP_TITLE_LABEL_ID
public final java.lang.String FP_TITLE_LABEL_ID
Constant defining the formal parameter name - pane title.- See Also:
- Constant Field Values
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractAppTransform
This method initialize the private and protected fields of the transform, such as width and height. It also invokes the
This method is automatically called from theinitializeWebComponent
,initializeImages
andinitializeCss
methods.transform
method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- the bean to transform.- See Also:
AbstractAppTransform.initializeTransform(com.microstrategy.web.beans.Transformable)
-
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.transformForRequestSuccessful(com.microstrategy.web.beans.MarkupOutput)
-
renderJavascript
protected void renderJavascript(MarkupOutput out)
Renders the javascript for the transform. CallsrenderRegisterBone
to register the bone.- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
getDescription
public java.lang.String getDescription()
Description copied from interface:Transform
Returns a textual description of the transform.- Returns:
- The textual description of the transform.
- See Also:
Transform.getDescription()
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Description copied from class:AbstractAppTransform
Returns the supported bean type. This abstract Transform supports allWebComponents
so every sub-class should override this method to return the class of theBean
the Transform is expecting, for example:public class CustomReportClass extends AbstractAppTransform { public Class getSupportedBeanType() { //This Transform is expected to work only with a ReportBean, //therefore this method needs to return this class: return ReportBean.class; } }
- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
- a root class/interface supported by this transform.
-
initEditor
protected void initEditor(Editor editor)
Initializes the editor with the global settings.- Parameters:
editor
- theEditor
to modify.
-
renderEditor
public void renderEditor(MarkupOutput out)
Main method to render the output of an editor. It creates anEditor
and initializes the editor and callsrenderOutput
method to render the contents into the editor's contents.- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
renderOutput
public void renderOutput(MarkupOutput out)
Creates aCartElementPicker
instance and initializes the cart properties and then renders the cart into theMarkupOutput
.- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
initializeCartProperties
protected void initializeCartProperties(CartElementPicker cartElemPicker)
Initializes the cart properties.- Parameters:
cartElemPicker
- - theCartElementPicker
to be initialized
-
initializeCartSearchAndIncrementalFetch
protected void initializeCartSearchAndIncrementalFetch(CartElementPicker cartElemPicker)
Initialize the Search and incremental fetch properties- Parameters:
cartElemPicker
- - theCartElementPicker
to be initialized
-
renderHiddenInputs
protected void renderHiddenInputs(MarkupOutput out)
Render hidden inputs forEnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ANY_PROMPTS
- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
-