Package com.microstrategy.web.admin.transforms

Class AbstractServerPropertiesTransform

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

All Implemented Interfaces:

AppTransform, Transform

Direct Known Subclasses:

HelpSetupTransform, OfficeTransform, OtherConfigurationTransform, SecurityTransform, ServerPropertiesTransform, TrustRelationshipTransform, UsherConfigTransform

public abstract class AbstractServerPropertiesTransform
extends AbstractAdminTransform

This class acts as a parent for the server properties class and for the security properties class. It has all the common methods and events which are shared across these two classes.

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 AdminBean	_adminBean
protected java.lang.String	_imgUpperLeftCorner
protected java.lang.String	_imgUpperRightCorner
protected Messages	_msgs
protected WebEvent	cancelEvent
protected java.lang.String	cssHeaderTable
protected java.lang.String	cssHR
protected java.lang.String	cssInvalidPropertyName
protected java.lang.String	cssMainTable
protected java.lang.String	cssMainTableHeading
protected java.lang.String	cssPropertyName
protected java.lang.String	cssPropertyValue
protected java.lang.String	cssSubHeading
protected java.lang.String	cssSubmitButton
protected java.lang.String	cssValuesTable
protected WebEvent	deleteEvent
static java.lang.String	FP_UPPER_LEFT_CORNER_IMAGE
static java.lang.String	FP_UPPER_RIGHT_CORNER_IMAGE
protected Preferences	prefs
FormalParameter	upperLeftCorner	Deprecated. FP created but not used anywhere in Transform or children objects.
FormalParameter	upperRightCorner	Deprecated. FP created but not used anywhere in Transform or children objects.

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
AbstractServerPropertiesTransform()	Default empty constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Returns the textual description of the transform
protected ImageTag	getInfoTooltip(java.lang.String descriptor)
protected java.lang.String	getPreference(java.lang.String preferenceName, java.lang.String inputName)	Returns the value of the preference with the given name.
protected abstract WebEvent	getSaveConnectEvent()
protected abstract java.lang.String	getTitle()
void	initializeCss()	Initializes the Css Class Strings used by this transform.
void	initializeImages()	Initializes the images used by this transform.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
protected void	renderSaveButton(MarkupOutput out)
protected void	renderServerError(MarkupOutput out)
protected void	showCheckBoxOption(MarkupOutput out, java.lang.String name, java.lang.String description, java.lang.String argument, boolean selected)
protected void	showCheckBoxOption(MarkupOutput out, java.lang.String name, java.lang.String description, java.lang.String argument, boolean selected, java.lang.String tooltip)
protected void	showConnectionPropertyName(MarkupOutput out, java.lang.String value, java.lang.String preferenceName)
protected void	showConnectionPropertyName(MarkupOutput out, java.lang.String value, java.lang.String preferenceName, java.lang.String validPropertyStyle, java.lang.String inValidPropertyStyle)
protected void	showEditBoxOption(MarkupOutput out, java.lang.String name, java.lang.String argument, java.lang.String inputValue)
protected void	showHR(MarkupOutput out)
protected void	showOption(MarkupOutput out, java.lang.String name, Tag option)
protected void	showOptionHeading(MarkupOutput out, java.lang.String name, java.lang.String description)
protected void	showRadioButtonOption(MarkupOutput out, java.lang.String name, java.lang.String description, java.lang.String argument, java.lang.String value, boolean selected)
protected void	showSubHeading(MarkupOutput out, java.lang.String text)
protected void	showSubmitButtons(MarkupOutput out)
protected abstract void	transformBody(MarkupOutput out)
void	transformForRequestSuccessful(MarkupOutput out)	Transform when the status of the bean which is transformed by this transform is "Successful".

Methods inherited from class com.microstrategy.web.admin.transforms.AbstractAdminTransform

getSupportedBeanType, 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, 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.Transform

canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

_adminBean

protected AdminBean _adminBean

Since:

MicroStrategy Web 8.0.0

_msgs

protected Messages _msgs

cssMainTable

protected java.lang.String cssMainTable

cssHeaderTable

protected java.lang.String cssHeaderTable

cssValuesTable

protected java.lang.String cssValuesTable

cssMainTableHeading

protected java.lang.String cssMainTableHeading

cssSubHeading

protected java.lang.String cssSubHeading

cssPropertyName

protected java.lang.String cssPropertyName

cssInvalidPropertyName

protected java.lang.String cssInvalidPropertyName

cssPropertyValue

protected java.lang.String cssPropertyValue

cssHR

protected java.lang.String cssHR

cssSubmitButton

protected java.lang.String cssSubmitButton

cancelEvent

protected WebEvent cancelEvent

deleteEvent

protected WebEvent deleteEvent

prefs

protected Preferences prefs

upperLeftCorner

@Deprecated
public FormalParameter upperLeftCorner

Deprecated.

FP created but not used anywhere in Transform or children objects.

Name of the image used to indicate the upper left corner of the dialog box.

_imgUpperLeftCorner

protected java.lang.String _imgUpperLeftCorner

upperRightCorner

@Deprecated
public FormalParameter upperRightCorner

Deprecated.

FP created but not used anywhere in Transform or children objects.

Name of the image used to indicate the upper right corner of the dialog box.

_imgUpperRightCorner

protected java.lang.String _imgUpperRightCorner

FP_UPPER_LEFT_CORNER_IMAGE

public static final java.lang.String FP_UPPER_LEFT_CORNER_IMAGE

See Also:

Constant Field Values

FP_UPPER_RIGHT_CORNER_IMAGE

public static final java.lang.String FP_UPPER_RIGHT_CORNER_IMAGE

See Also:

Constant Field Values

Constructor Detail

AbstractServerPropertiesTransform

public AbstractServerPropertiesTransform()

Default empty constructor. Initialize formal parameters.

Method Detail

getDescription

public java.lang.String getDescription()

Returns the textual description of the transform

Returns:

the textual description of the transform

initializeTransform

public void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform. It also invokes the initializeImages and initializeCss methods.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractAppTransform

Parameters:

data - The data (bean) that this transform is going to transform.

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Transform when the status of the bean which is transformed by this transform is "Successful".

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - Output by this transform

See Also:

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

transformBody

protected abstract void transformBody(MarkupOutput out)

getTitle

protected abstract java.lang.String getTitle()

getSaveConnectEvent

protected abstract WebEvent getSaveConnectEvent()

showSubHeading

protected void showSubHeading(MarkupOutput out,
                              java.lang.String text)

showSubmitButtons

protected void showSubmitButtons(MarkupOutput out)

renderSaveButton

protected void renderSaveButton(MarkupOutput out)

Parameters:

out -

Since:

MicroStrategy Web 8.0.0

showConnectionPropertyName

protected void showConnectionPropertyName(MarkupOutput out,
                                          java.lang.String value,
                                          java.lang.String preferenceName)

showConnectionPropertyName

protected void showConnectionPropertyName(MarkupOutput out,
                                          java.lang.String value,
                                          java.lang.String preferenceName,
                                          java.lang.String validPropertyStyle,
                                          java.lang.String inValidPropertyStyle)

showCheckBoxOption

protected void showCheckBoxOption(MarkupOutput out,
                                  java.lang.String name,
                                  java.lang.String description,
                                  java.lang.String argument,
                                  boolean selected)

showCheckBoxOption

protected void showCheckBoxOption(MarkupOutput out,
                                  java.lang.String name,
                                  java.lang.String description,
                                  java.lang.String argument,
                                  boolean selected,
                                  java.lang.String tooltip)

showEditBoxOption

protected void showEditBoxOption(MarkupOutput out,
                                 java.lang.String name,
                                 java.lang.String argument,
                                 java.lang.String inputValue)

Since:

MicroStrategy Web 9.4.0

showOption

protected void showOption(MarkupOutput out,
                          java.lang.String name,
                          Tag option)

Since:

MicroStrategy Web 8.0.0

showOptionHeading

protected void showOptionHeading(MarkupOutput out,
                                 java.lang.String name,
                                 java.lang.String description)

Since:

MicroStrategy Web 8.0.1

showRadioButtonOption

protected void showRadioButtonOption(MarkupOutput out,
                                     java.lang.String name,
                                     java.lang.String description,
                                     java.lang.String argument,
                                     java.lang.String value,
                                     boolean selected)

showHR

protected void showHR(MarkupOutput out)

initializeCss

public void initializeCss()

Initializes the Css Class Strings used by this transform.

Overrides:

initializeCss in class AbstractAppTransform

initializeImages

public void initializeImages()

Initializes the images used by this transform.

Overrides:

initializeImages in class AbstractAppTransform

getPreference

protected java.lang.String getPreference(java.lang.String preferenceName,
                                         java.lang.String inputName)

Returns the value of the preference with the given name. The value is automatically selected for the current level. If there is any validation error while saving the preference, this method will return the value of inputName from the request keys.

Parameters:

preferenceName - the name (key) of the preference

inputName - the name of the HTML input element for the preference

Returns:

The value of the requested preference. This is either from the request keys or from the preferences collection.

getInfoTooltip

protected ImageTag getInfoTooltip(java.lang.String descriptor)

renderServerError

protected void renderServerError(MarkupOutput out)