Package com.microstrategy.web.app.transforms

Class ThresholdsEditorTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

AdvancedThresholdsEditorTransform, SimpleThresholdsEditorTransform

public abstract class ThresholdsEditorTransform
extends AbstractEditorTransform
implements LayoutTransform

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

Modifier and Type	Field	Description
protected boolean	_isConditionalFormatting
protected ThresholdEditorBean	_teBean
protected static boolean	ALL_PROPERTIES
FormalParameter	conditionalFormattingHelpTopic	Indicates the type of help topic this editor uses when in conditional formatting mode.
static java.lang.String	FP_CONDITIONAL_FORMATTING_HELP_TOPIC	Constant specifying the name of the formal parameter for specifying the help topic for the conditional formatting editor
protected static boolean	NON_DEFAULT_ONLY

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Returns a textual description of the transform.
protected JsonGenerator	getFormatting(WebFormat wf)	This method returns a JsonGenerator containing all of the formatting for the supplied WebFormat.
protected JsonGenerator	getFormatting(WebThreshold wt, boolean nonDefaultOnly)	This method returns a JsonGenerator containing all of the formatting for the supplied WebThreshold.
protected void	initEditor(Editor editor)	Initializes the editor with the global settings.
void	initializeTransform(Transformable data)	This method initializes the private and protected fields of the transform.
protected boolean	isConditionalFormatting()
void	renderEditorContents(MarkupOutput out)	Generates the graphical output for the Editor
protected void	setCommonBoneProperties()	This method sets the common bone properties for both the advanced and simple threshold editors.

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

generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, 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, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, 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, 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

_teBean

protected ThresholdEditorBean _teBean

_isConditionalFormatting

protected boolean _isConditionalFormatting

FP_CONDITIONAL_FORMATTING_HELP_TOPIC

public static final java.lang.String FP_CONDITIONAL_FORMATTING_HELP_TOPIC

Constant specifying the name of the formal parameter for specifying the help topic for the conditional formatting editor

See Also:

Constant Field Values

conditionalFormattingHelpTopic

public FormalParameter conditionalFormattingHelpTopic

Indicates the type of help topic this editor uses when in conditional formatting mode.

ALL_PROPERTIES

protected static final boolean ALL_PROPERTIES

See Also:

Constant Field Values

NON_DEFAULT_ONLY

protected static final boolean NON_DEFAULT_ONLY

See Also:

Constant Field Values

Constructor Detail

ThresholdsEditorTransform

public ThresholdsEditorTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

This method initializes the private and protected fields of the transform.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractEditorTransform

Parameters:

data - bean that will be transformed

isConditionalFormatting

protected boolean isConditionalFormatting()

initEditor

protected void initEditor(Editor editor)

Description copied from class: AbstractEditorTransform

Initializes the editor with the global settings.

Overrides:

initEditor in class AbstractEditorTransform

Parameters:

editor - the Editor to modify.

renderEditorContents

public void renderEditorContents(MarkupOutput out)

Description copied from class: AbstractEditorTransform

Generates the graphical output for the Editor

Specified by:

renderEditorContents in class AbstractEditorTransform

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.

Specified by:

getDescription in interface Transform

Returns:

The textual description of the transform.

setCommonBoneProperties

protected void setCommonBoneProperties()

This method sets the common bone properties for both the advanced and simple threshold editors.

getFormatting

protected JsonGenerator getFormatting(WebThreshold wt,
                                      boolean nonDefaultOnly)

This method returns a JsonGenerator containing all of the formatting for the supplied WebThreshold.

Parameters:

wt - WebThreshold

nonDefaultOnly - boolean indicates whether to populate the JsonGenerator with all formatting properties, or only those that are different from the containers formatting.

Returns:

JsonGenerator

getFormatting

protected JsonGenerator getFormatting(WebFormat wf)

This method returns a JsonGenerator containing all of the formatting for the supplied WebFormat.

Parameters:

wf - WebFormat

Returns:

JsonGenerator