Package com.microstrategy.web.app.transforms

Class GuiElementsBlockTransform

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.GuiElementsBlockTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

DocumentGridToolbarBlockLoaderTransform, FloatingEditorBlockTransform, ReportGridToolbarBlockLoaderTransform, RibbonToolbarTransform

public class GuiElementsBlockTransform
extends AbstractAppWidgetTransform

Provides several methods usefull for block transformation typically used on the block layout file

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.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
GuiElementsBlockTransform()

Method Summary

Modifier and Type	Method	Description
java.util.ArrayList<java.util.List<java.lang.String>>	getAutoStyles()	Return the list of available autostyles.
java.lang.String	getDescription()	Returns a textual description of the transform.
java.lang.String	getElementID(java.util.List<java.lang.String> obj)	Extracts the ID from a Shortcut element.
java.lang.String	getElementName(java.util.List<java.lang.String> obj)	Extracts the ID from a Shortcut element.
java.lang.String	getListAttribute(Shortcut shortcut, java.lang.String name)	Extracts an attribute node from a Shortcut element.
protected ShortcutList	getPicker(java.lang.String pickerName)	Return a specific Picker's ShortcutList.
java.util.ArrayList<Shortcut>	getPickerList(java.lang.String name)	Return the requested picker list.
protected java.lang.String	getRequestKeyValue(java.lang.String keyName)	Returns the value of a RequestKey using the getRequestKeys method then getValue.
java.lang.String	getRequestParameterValue(java.lang.String name, java.lang.String defaultValue)
java.lang.String	getRequestParameterValueEncoded(java.lang.String name, java.lang.String defaultValue)
java.lang.String	getShortcutDescriptor(Shortcut shortcut)	Extracts the descriptors from a Shortcut element.
boolean	isFeatureAvailable(java.lang.String feature)	Convenience method.
void	removeListItems(BlockList list, java.lang.String indexString)	Removes items from a BlockList.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppWidgetTransform

buildFlattenedExpression, getAttForms, getChildWidget, 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, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeTransform, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, 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, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

GuiElementsBlockTransform

public GuiElementsBlockTransform()

Method Detail

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.

isFeatureAvailable

public boolean isFeatureAvailable(java.lang.String feature)

Description copied from class: AbstractAppTransform

Convenience method. Maps the isFeatureAvailable method of the Bean currently bean Transformed.

Overrides:

isFeatureAvailable in class AbstractAppTransform

Parameters:

feature - the feature Id.

Returns:

true by default, or whatever _bean.isFeatureAvailable(feature) returns;

getPicker

protected ShortcutList getPicker(java.lang.String pickerName)

Return a specific Picker's ShortcutList.

Parameters:

pickerName - The name of the picker to retrieve.

Returns:

A ShortcutList that contains the picker elements.

removeListItems

public void removeListItems(BlockList list,
                            java.lang.String indexString)

Removes items from a BlockList.

Parameters:

list - The BlockList to be edited.

indexString - A comma delimited string of indexes to be removed from the list.

getPickerList

public java.util.ArrayList<Shortcut> getPickerList(java.lang.String name)

Return the requested picker list. This method will verify each Shortcut using it's feature id's if present in the picker.

Parameters:

name - The name of the desired picker from the pageConfig.xml file.

Returns:

An ArrayList populated with the Shortcut elements for this picker.

getListAttribute

public java.lang.String getListAttribute(Shortcut shortcut,
                                         java.lang.String name)

Extracts an attribute node from a Shortcut element.

Parameters:

shortcut - The current Shortcut from a picker list.

name - The name of the requested attribute.

Returns:

A String containing the requested attribute value.

getShortcutDescriptor

public java.lang.String getShortcutDescriptor(Shortcut shortcut)

Extracts the descriptors from a Shortcut element.

Parameters:

shortcut - The current Shortcut from a picker list.

Returns:

A String containing the requested descriptor value.

getAutoStyles

public java.util.ArrayList<java.util.List<java.lang.String>> getAutoStyles()

Return the list of available autostyles.

Returns:

An ArrayList populated with lists of elements for this picker, each list has in 0 the id and in 1 the name.

getElementID

public java.lang.String getElementID(java.util.List<java.lang.String> obj)

Extracts the ID from a Shortcut element.

Parameters:

obj - shortcut The current Shortcut from a picker list.

Returns:

A String containing the requested descriptor value.

getElementName

public java.lang.String getElementName(java.util.List<java.lang.String> obj)

Extracts the ID from a Shortcut element.

Parameters:

obj - shortcut The current Shortcut from a picker list.

Returns:

A String containing the requested descriptor value.

getRequestKeyValue

protected java.lang.String getRequestKeyValue(java.lang.String keyName)

Returns the value of a RequestKey using the getRequestKeys method then getValue.

Parameters:

keyName - The name of the RequestKey to return.

Returns:

The String value of the specified RequestKey.

getRequestParameterValue

public java.lang.String getRequestParameterValue(java.lang.String name,
                                                 java.lang.String defaultValue)

Parameters:

name -

defaultValue -

Returns:

the value of a parameter using the getRequestKeyValue or the default string if null

getRequestParameterValueEncoded

public java.lang.String getRequestParameterValueEncoded(java.lang.String name,
                                                        java.lang.String defaultValue)

Parameters:

name -

defaultValue -

Returns:

encode value of a parameter return by getRequestParameterValue