Package com.microstrategy.web.app.transforms

Class ImageLayoutVisualizationPropertiesTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.VisualizationPropertiesTransform

com.microstrategy.web.app.transforms.ImageLayoutVisualizationPropertiesTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class ImageLayoutVisualizationPropertiesTransform
extends VisualizationPropertiesTransform

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
static java.lang.String	DISPLAY_MODE_AREA_MASHUP
static java.lang.String	DISPLAY_MODE_AUTOMATIC
static java.lang.String	DISPLAY_MODE_BUBBLE
static java.lang.String	FP_SHAPE_FILE_PATH	Name of the shapeFilePath formal parameter
FormalParameter	shapeFilePath	Deprecated. This parameter is not used anymore.

Fields inherited from class com.microstrategy.web.app.transforms.VisualizationPropertiesTransform

_rb, _rwb, _template, _vb, colorPickerName, FP_COLOR_PICKER_NAME

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
ImageLayoutVisualizationPropertiesTransform()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getScriptClass()	Returns the name of the javaScript class (if any) to be associated with the component.
protected java.lang.String	getVisPropValue(java.lang.String propName)
boolean	isValidGrid()
void	renderMaxSizeValTextbox(MarkupOutput out, java.lang.String propName)
void	renderValidationError(MarkupOutput out)
protected void	setBoneProperties(JsonGenerator boneProps)	Sets the necessary properties to the bone assigned to this transform (based on the AbstractAppTransform.scriptClass formal parameter) Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput) Can be overwritten to add or modify bone properties.

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

getColorPicker, getDescription, getEditorBean, getHashListFromString, getStyleShellDiv, getTemplateName, getWebTemplate, initializeTransform, isDescriptor, isDialog, isOpen, isRW, renderCheckbox, renderCheckbox, renderCheckbox, renderCheckbox, renderCheckbox, renderColorDropdown, renderColorPicker, renderColorPicker, renderHiddenInput, renderHiddenInput, renderHiddenInput, renderJavascript, renderRadio, renderRadio, renderRadio, renderRadio, renderRadio, renderRadio, renderSecondaryDataProvidersSelectbox, renderSelectBox, renderSelectBox, renderSelectBox, renderSelectBox, renderSelectBox, renderSelectBox, renderTabs, renderTextarea, renderTextarea, renderTextarea, renderTextarea, renderTextarea, renderTextbox, renderTextbox, renderTextbox, renderTextbox, renderTextbox, setExtraAttributesOnInput, 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, getStringValue, getStyleRequestContext, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, 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, 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, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

FP_SHAPE_FILE_PATH

public static final java.lang.String FP_SHAPE_FILE_PATH

Name of the shapeFilePath formal parameter

See Also:

Constant Field Values

DISPLAY_MODE_AUTOMATIC

public static final java.lang.String DISPLAY_MODE_AUTOMATIC

See Also:

Constant Field Values

DISPLAY_MODE_AREA_MASHUP

public static final java.lang.String DISPLAY_MODE_AREA_MASHUP

See Also:

Constant Field Values

DISPLAY_MODE_BUBBLE

public static final java.lang.String DISPLAY_MODE_BUBBLE

See Also:

Constant Field Values

shapeFilePath

@Deprecated
public FormalParameter shapeFilePath

Deprecated.

This parameter is not used anymore. Please modify the "src" attribute of <ShapeFileMaps> node in pageConfig.xml to apply custom shapeFile

Indicates the path to the shape file

Constructor Detail

ImageLayoutVisualizationPropertiesTransform

public ImageLayoutVisualizationPropertiesTransform()

Method Detail

setBoneProperties

protected void setBoneProperties(JsonGenerator boneProps)

Description copied from class: AbstractAppTransform

Sets the necessary properties to the bone assigned to this transform (based on the AbstractAppTransform.scriptClass formal parameter)
Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Overrides:

setBoneProperties in class VisualizationPropertiesTransform

Parameters:

boneProps - the JsonGenerator object that contains the collection of bone properties.

renderMaxSizeValTextbox

public void renderMaxSizeValTextbox(MarkupOutput out,
                                    java.lang.String propName)

getVisPropValue

protected java.lang.String getVisPropValue(java.lang.String propName)

Overrides:

getVisPropValue in class VisualizationPropertiesTransform

Parameters:

propName - The property name

Returns:

The value of a visualization Property

getScriptClass

protected java.lang.String getScriptClass()

Description copied from class: AbstractAppTransform

Returns the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component.

A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.

Overrides:

getScriptClass in class AbstractAppTransform

Returns:

String representing the name of a javaScript class

isValidGrid

public boolean isValidGrid()

renderValidationError

public void renderValidationError(MarkupOutput out)