Class AbstractDiagnosticsTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.admin.transforms.AbstractAdminTransform
-
- com.microstrategy.web.admin.transforms.AbstractDiagnosticsTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
- Direct Known Subclasses:
DiagnosticsPropertiesTransform
,DiagnosticsStatisticsTransform
,DiagnosticsViewerTransform
public abstract class AbstractDiagnosticsTransform extends AbstractAdminTransform
Title: AbstractDiagnosticsTransform This abstact class can be used as base for the different transforms related with the Diagnostics feature.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
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 java.lang.String
_imgLeftCorner
Image to use for the left corner of the header to display.protected java.lang.String
_imgRightCorner
Image to use for the right corner of the header to displayprotected java.lang.String
cssGlobal
This property keeps the css style class name to use globally on the interface to display to the user.protected java.lang.String
cssHeaderTable
This property keeps the css style class name to use for the main header to display on the interface.protected java.lang.String
cssMainTableHeading
This property keeps the css style class name to use for the table that will hold the table heading to display to the user.-
Fields inherited from class com.microstrategy.web.admin.transforms.AbstractAdminTransform
needToUpdateStyleForDoubleByte
-
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 AbstractDiagnosticsTransform()
Class constructor, initializes formal parameters.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected WebEvent
getApplyDiagnosticsEvent(DiagnosticsBean bean)
Generate the event that will be used for applying or saving the diagnostics configuration specified on the form.protected java.lang.String
getArgumentName(WebEvent event, int argumentId)
Get the name of the argument assigned to theWebEvent
, based on the indicated id.protected DiagnosticsBean
getDiagnosticsBean()
Returns the currentDiagnosticsBean
instance being transformedprotected WebEvent
getLoadDefaultsEvent(DiagnosticsBean bean)
Generate the event that will be used for loading the default values of the diagnostics configuration specified on the form.java.lang.Class
getSupportedBeanType()
Returns the supported bean type.protected abstract java.lang.String
getTitle()
Returns the title for the interface to displayvoid
initializeCss()
Initialize the css classes to use while displaying this transformvoid
initializeImages()
Initializes the images to be used by this transformvoid
initializeTransform(Transformable data)
This method initializes the private and protected fields of the transform.abstract void
renderDiagnosticOutput(MarkupOutput out)
Generate the output the transform instance is to generate for theDiagnosticsBean
bean.void
renderDialogHeader(MarkupOutput out)
Render the main dialog header to display to the user on the pageprotected void
renderSubmitButtons(MarkupOutput out, WebEvent applyDiagnostics, WebEvent loadDefaults, java.lang.String applyString, java.lang.String loadString)
Display the submit buttons corresponding to the saveDiagnostics eventvoid
transformForRequestSuccessful(MarkupOutput out)
Transform when the status of the bean which is transformed by this transform isEnumRequestStatus.WebBeanRequestSuccessful
-
Methods inherited from class com.microstrategy.web.admin.transforms.AbstractAdminTransform
initializeDoubleByte, updateStyleForButtons
-
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, 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, 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.Transform
canTransform, getDescription, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports
-
-
-
-
Field Detail
-
_imgLeftCorner
protected java.lang.String _imgLeftCorner
Image to use for the left corner of the header to display.
-
_imgRightCorner
protected java.lang.String _imgRightCorner
Image to use for the right corner of the header to display
-
cssGlobal
protected java.lang.String cssGlobal
This property keeps the css style class name to use globally on the interface to display to the user.
-
cssHeaderTable
protected java.lang.String cssHeaderTable
This property keeps the css style class name to use for the main header to display on the interface.
-
cssMainTableHeading
protected java.lang.String cssMainTableHeading
This property keeps the css style class name to use for the table that will hold the table heading to display to the user.
-
-
Method Detail
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type. This transform supportsDiagnosticsBean
instances- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAdminTransform
- Returns:
DiagnosticBean.class
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Transform when the status of the bean which is transformed by this transform isEnumRequestStatus.WebBeanRequestSuccessful
- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
instance where the contents to display by this transform are to be saved- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderDiagnosticOutput
public abstract void renderDiagnosticOutput(MarkupOutput out)
Generate the output the transform instance is to generate for theDiagnosticsBean
bean.- Parameters:
out
-MarkupOutput
instance where the contents to display by this transform are to be saved
-
initializeTransform
public void initializeTransform(Transformable data)
This method initializes the private and protected fields of the transform. It also invokes theinitializeImages()
andinitializeCss()
methods and re-defines the values for thecssFile
andcssPrefix
formal parameters.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- theTransformable
data representing the bean that this instance is going to transform.
-
initializeCss
public void initializeCss()
Initialize the css classes to use while displaying this transform- Overrides:
initializeCss
in classAbstractAppTransform
-
initializeImages
public void initializeImages()
Initializes the images to be used by this transform- Overrides:
initializeImages
in classAbstractAppTransform
-
renderDialogHeader
public void renderDialogHeader(MarkupOutput out)
Render the main dialog header to display to the user on the page- Parameters:
out
-MarkupOutput
instance where the HTML to display will be saved
-
getApplyDiagnosticsEvent
protected WebEvent getApplyDiagnosticsEvent(DiagnosticsBean bean)
Generate the event that will be used for applying or saving the diagnostics configuration specified on the form.- Parameters:
bean
-DiagnosticsBean
being transformed- Returns:
- a
WebEvent
with the corresponding event,null
if the application does not support it.
-
getLoadDefaultsEvent
protected WebEvent getLoadDefaultsEvent(DiagnosticsBean bean)
Generate the event that will be used for loading the default values of the diagnostics configuration specified on the form.- Parameters:
bean
-DiagnosticsBean
being transformed- Returns:
- a
WebEvent
with the corresponding event,null
if the application does not support it.
-
getArgumentName
protected java.lang.String getArgumentName(WebEvent event, int argumentId)
Get the name of the argument assigned to theWebEvent
, based on the indicated id. This method can be overwritten with an event-argumentId mapping in case the original event defined on the application is customized.- Overrides:
getArgumentName
in classAbstractAppTransform
- Parameters:
event
-WebEvent
from where the argument name will be retrievedargumentId
-int
with the identifier of the argument to search for on the event- Returns:
- the corresponding name of the event for the specified id. If it is
not found, it will return
null
.
-
getDiagnosticsBean
protected DiagnosticsBean getDiagnosticsBean()
Returns the currentDiagnosticsBean
instance being transformed- Returns:
- the
DiagnosticsBean
instance associated with this transform.
-
getTitle
protected abstract java.lang.String getTitle()
Returns the title for the interface to display- Returns:
- the text to display as title of the transform
-
renderSubmitButtons
protected void renderSubmitButtons(MarkupOutput out, WebEvent applyDiagnostics, WebEvent loadDefaults, java.lang.String applyString, java.lang.String loadString)
Display the submit buttons corresponding to the saveDiagnostics event- Parameters:
out
-MarkupOutput
instance to modifyapplyDiagnostics
-WebEvent
instance with the initialized event for applying the propertiesloadDefaults
-WebEvent
instance with the initialized event for loading the original default values of the propertiesapplyString
-String
with the descriptor for the button that will be used for applying the changes on the form.loadString
-String
with the descriptor for the button that will be used for loading default values on the form.
-
-