Package com.microstrategy.web.app.transforms

Class GridAutoStylesTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.GridAutoStylesTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class GridAutoStylesTransform
extends AbstractAppTransform
implements LayoutTransform

Title: GridAutoStylesTransform.

Description: Grid Auto style transform. Designed for generarating auto style pull-down menu.

Company: Microstrategy, Inc.

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
protected FormalParameter	imgGo	This is the image name for go image used in the transform in HTML only mode.
FormalParameter	renderForm	Specifies whether or not to render HTML form.

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
GridAutoStylesTransform()	Non-parameters Transform constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addCustomOption(SelectTag select)	Adds the option of "Custom" to the select box
protected void	addStyles(SelectTag select, WebFolder folder, java.lang.String currentStyleID, java.lang.String currentStyleName)	Add list of Grid styles to a select box.
protected WebEvent	getChangeStyleEvent()
java.lang.String	getDescription()	Returns class specification.
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
void	initializeCss()	initialize css information for the transform
void	initializeFormalParameters()	Initializes formal parameters used in this transform.
void	initializeImages()	initialize image information for the transform
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
protected boolean	isEnabled()	Returns true if the toolbar should be enabled.
void	renderContent(MarkupOutput out)	Renders transform output only when bean's status is successful.
protected void	renderHiddenInputs(MarkupOutput out)
void	renderLabel(MarkupOutput out)	Renders style title text.
void	renderList(MarkupOutput out)	Renders style content.
void	renderSubmitButton(MarkupOutput out)	Renders the submit button.
void	transformForRequestSuccessful(MarkupOutput out)	Generates the graphical output for the Projects Bean

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, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, 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, 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.LayoutTransform

getLayoutDefinition, setLayoutDefinition

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

renderForm

public FormalParameter renderForm

Specifies whether or not to render HTML form.

imgGo

protected FormalParameter imgGo

This is the image name for go image used in the transform in HTML only mode.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

Constructor Detail

GridAutoStylesTransform

public GridAutoStylesTransform()

Non-parameters Transform constructor. It initializes transform formal parameters.

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform. In particular it initialize the indent field based on the value of the initialIndent formal parameter, and the isDHTML based on the bean's OutputFormat. It also invokes the initializeImages and initializeCss methods.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractAppTransform

Parameters:

data - Transformable data, mostly bean being transformed.

initializeImages

public void initializeImages()

initialize image information for the transform

Overrides:

initializeImages in class AbstractAppTransform

initializeCss

public void initializeCss()

initialize css information for the transform

Overrides:

initializeCss in class AbstractAppTransform

initializeFormalParameters

public void initializeFormalParameters()

Initializes formal parameters used in this transform.

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Generates the graphical output for the Projects Bean

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - MarkupOutput instance where to create the HTML output

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Returns the supported bean type. This transform supports GridAutoStylesBean instances

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

GridAutoStylesBean instance.

getDescription

public java.lang.String getDescription()

Returns class specification.

Specified by:

getDescription in interface Transform

Returns:

String text.

renderContent

public void renderContent(MarkupOutput out)

Renders transform output only when bean's status is successful.

Parameters:

out - where to write the output.

renderHiddenInputs

protected void renderHiddenInputs(MarkupOutput out)

renderLabel

public void renderLabel(MarkupOutput out)

Renders style title text.

Parameters:

out - where to write output.

renderSubmitButton

public void renderSubmitButton(MarkupOutput out)

Renders the submit button.

Parameters:

out - where to write output.

renderList

public void renderList(MarkupOutput out)

Renders style content.
It'll render all styles in a pull-down menu list.

Parameters:

out - where to write output.

isEnabled

protected boolean isEnabled()

Returns true if the toolbar should be enabled.

Returns:

boolean

addStyles

protected void addStyles(SelectTag select,
                         WebFolder folder,
                         java.lang.String currentStyleID,
                         java.lang.String currentStyleName)

Add list of Grid styles to a select box.

Parameters:

select - SelectTag the select tag

folder - WebFolder the web folder containing the styles to add

currentStyleID - String the current style ID

currentStyleName - String the current style name (used only if the ID is not found)

addCustomOption

protected void addCustomOption(SelectTag select)

Adds the option of "Custom" to the select box

Parameters:

select - SelectTag

getChangeStyleEvent

protected WebEvent getChangeStyleEvent()