Class AttributeFormsEditorTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractEditorTransform
-
- com.microstrategy.web.app.transforms.AttributeFormsEditorTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class AttributeFormsEditorTransform extends AbstractEditorTransform implements LayoutTransform
This class generates the output for the
AttributeFormsEditorBean
. It is used to allow users to select the forms of an attribute to be displayed in a grid.The forms are displayed in a "shopping cart" interface, that is, a list of available forms is rendered on the left, and the list of selected forms is rendered on the right. Users can select forms and move them from the available to the selected and the other way around. To display the shopping cart this Transform utilizes a
Cart
GUI-element which provides all the necessary infrastructure to generate the corresponding HTML.In some scenarios this Transform may also presents a dropdown list which allows the user to select the corresponding attribute to whom the attribute forms shall be selected. This is controlled by the
This Transform implementsshowAttributeList()
method.LayoutTransform
, therefore its render methods can be invoked using a custom layout-xml. When this is the case, the layout-xml specified in the style-catalog controls which methods are called and in which order. Otherwise, the default output of this transform is divided as follows:EditorContents ----------------------------------------------------- | Attribute list | submitButton | ----------------------------------------------------- | | | Attribute Forms List | | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Since:
- MicroStrategy Web 8.0.0
-
-
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
availableSize
Specifies the size of the Available listbox of the shopping cart.FormalParameter
goImage
Indicates the image to use for the submit button.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_INCLUDE_DYNAMIC_SCRIPT, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID
-
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 AttributeFormsEditorTransform()
Default empty constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected WebEvent
getAttributeFormsProcessEvent()
Returns an instance of the event responsible for processing the editor's actionsprotected Cart
getCart()
Creates and initializes theCart
instance used by this Transform.java.lang.String
getDescription()
Returns a textual description of this transform to be used in WYSIWYG tools.java.lang.Class
getSupportedBeanType()
Returns the class of the bean supported by this transform, in this case:AttributeFormsEditorBean.class
protected void
initializeCart(Cart cart)
Initializes theCart
instance used by this Transform.void
initializeImages()
Initialize the images to be used by this transform.void
initializeTransform(Transformable data)
This method initializes the private and protected fields of the transform.void
renderAttributeList(MarkupOutput out)
Generates a dropdown with the list of attributes available in the report.void
renderCart(MarkupOutput out)
Generates the "shopping cart" with the list of available and selected attribute forms.void
renderEditorContents(MarkupOutput out)
Main entry point of this transform.protected void
renderHiddenInputs(MarkupOutput out)
Generates the hidden<INPUT>
tags required by the AttributeFormsProcessEvent.void
renderSubmitButton(MarkupOutput out)
Generates the HTML for the button that applies editor changes.boolean
showAttributeList()
Controls whether the attribute list dropdown should be displayed to the user.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, initHelp, renderEditor, renderEditorElement, renderJavascript, setFocusFieldId, transformForRequestInError, 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, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, 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, 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
-
goImage
public FormalParameter goImage
Indicates the image to use for the submit button.
-
availableSize
public FormalParameter availableSize
Specifies the size of the Available listbox of the shopping cart.
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractEditorTransform
This method initializes the private and protected fields of the transform.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractEditorTransform
- Parameters:
data
- bean that will be transformed
-
initializeImages
public void initializeImages()
Description copied from class:AbstractAppTransform
Initialize the images to be used by this transform.- Overrides:
initializeImages
in classAbstractAppTransform
-
initializeCart
protected void initializeCart(Cart cart)
Initializes theCart
instance used by this Transform.- Parameters:
cart
-Cart
to be initialzied.
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the class of the bean supported by this transform, in this case:AttributeFormsEditorBean.class
- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
AttributeFormsEditorBean.class
-
getCart
protected Cart getCart()
Creates and initializes theCart
instance used by this Transform.- Returns:
- The
Cart
object used to render the available and selected attributes forms.
-
getDescription
public java.lang.String getDescription()
Returns a textual description of this transform to be used in WYSIWYG tools.- Specified by:
getDescription
in interfaceTransform
- Returns:
- "This class generates the output for the AttributeFormsEditorBean. It is used to allow users to select the forms of an attribute to be displayed in a grid."
-
showAttributeList
public boolean showAttributeList()
Controls whether the attribute list dropdown should be displayed to the user. It will returnfalse
in DHTML mode, or the value of theAttributeFormsEditorBean.getShowAttributeList()
method.- Returns:
true
if the attribute list should be displayed.
-
getAttributeFormsProcessEvent
protected WebEvent getAttributeFormsProcessEvent()
Returns an instance of the event responsible for processing the editor's actions- Returns:
- the EnumAttributeFormsEditorEvents.WebEventAttributeFormsProcess event
-
renderEditorContents
public void renderEditorContents(MarkupOutput out)
Main entry point of this transform. Generates the graphical output for this editor.- Specified by:
renderEditorContents
in classAbstractEditorTransform
- Parameters:
out
- MarkupOutput to generate the HTML.
-
renderAttributeList
public void renderAttributeList(MarkupOutput out)
Generates a dropdown with the list of attributes available in the report.- Parameters:
out
- MarkupOutput to generate the HTML.
-
renderSubmitButton
public void renderSubmitButton(MarkupOutput out)
Generates the HTML for the button that applies editor changes.- Parameters:
out
- MarkupOutput to generate the HTML.
-
renderCart
public void renderCart(MarkupOutput out)
Generates the "shopping cart" with the list of available and selected attribute forms. This method retrieve the forms list fromAttributeFormsEditorBean.getAttributeForms()
, with it, it populates twoCartElements
collections and then delegates to theCart
GUI-element the HTML generation.- Parameters:
out
- MarkupOutput to generate the HTML.
-
renderHiddenInputs
protected void renderHiddenInputs(MarkupOutput out)
Generates the hidden<INPUT>
tags required by the AttributeFormsProcessEvent.- Parameters:
out
- MarkupOutput to generate the HTML.
-
-