public abstract class

AbstractServerPropertiesTransform

extends AbstractAdminTransform
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
Known Direct Subclasses

Class Overview

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.

Summary

Constants
String FP_UPPER_LEFT_CORNER_IMAGE
String FP_UPPER_RIGHT_CORNER_IMAGE
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected AdminBean _adminBean
protected String _imgUpperLeftCorner
protected String _imgUpperRightCorner
protected Messages _msgs
protected WebEvent cancelEvent
protected String cssHR
protected String cssHeaderTable
protected String cssInvalidPropertyName
protected String cssMainTable
protected String cssMainTableHeading
protected String cssPropertyName
protected String cssPropertyValue
protected String cssSubHeading
protected String cssSubmitButton
protected String cssValuesTable
protected WebEvent deleteEvent
protected Preferences prefs
public FormalParameter upperLeftCorner This field is deprecated. FP created but not used anywhere in Transform or children objects.
public FormalParameter upperRightCorner This field is deprecated. FP created but not used anywhere in Transform or children objects.
[Expand]
Inherited Fields
From class com.microstrategy.web.admin.transforms.AbstractAdminTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractServerPropertiesTransform()
Default empty constructor.
Public Methods
String getDescription()
Returns the textual description of the transform
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.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status of the bean which is transformed by this transform is "Successful".
Protected Methods
ImageTag getInfoTooltip(String descriptor)
String getPreference(String preferenceName, String inputName)
Returns the value of the preference with the given name.
abstract WebEvent getSaveConnectEvent()
abstract String getTitle()
void renderSaveButton(MarkupOutput out)
void renderServerError(MarkupOutput out)
void showCheckBoxOption(MarkupOutput out, String name, String description, String argument, boolean selected)
void showCheckBoxOption(MarkupOutput out, String name, String description, String argument, boolean selected, String tooltip)
void showConnectionPropertyName(MarkupOutput out, String value, String preferenceName, String validPropertyStyle, String inValidPropertyStyle)
void showConnectionPropertyName(MarkupOutput out, String value, String preferenceName)
void showEditBoxOption(MarkupOutput out, String name, String argument, String inputValue)
void showHR(MarkupOutput out)
void showOption(MarkupOutput out, String name, Tag option)
void showOptionHeading(MarkupOutput out, String name, String description)
void showRadioButtonOption(MarkupOutput out, String name, String description, String argument, String value, boolean selected)
void showSubHeading(MarkupOutput out, String text)
void showSubmitButtons(MarkupOutput out)
abstract void transformBody(MarkupOutput out)
[Expand]
Inherited Methods
From class com.microstrategy.web.admin.transforms.AbstractAdminTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_UPPER_LEFT_CORNER_IMAGE

Constant Value: "upperLeftCorner"

public static final String FP_UPPER_RIGHT_CORNER_IMAGE

Constant Value: "upperRightCorner"

Fields

protected AdminBean _adminBean

protected String _imgUpperLeftCorner

protected String _imgUpperRightCorner

protected Messages _msgs

protected WebEvent cancelEvent

protected String cssHR

protected String cssHeaderTable

protected String cssInvalidPropertyName

protected String cssMainTable

protected String cssMainTableHeading

protected String cssPropertyName

protected String cssPropertyValue

protected String cssSubHeading

protected String cssSubmitButton

protected String cssValuesTable

protected WebEvent deleteEvent

protected Preferences prefs

public FormalParameter upperLeftCorner

This field is 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.

public FormalParameter upperRightCorner

This field is 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.

Public Constructors

public AbstractServerPropertiesTransform ()

Default empty constructor. Initialize formal parameters.

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the textual description of the transform

public void initializeCss ()

Initializes the Css Class Strings used by this transform.

public void initializeImages ()

Initializes the images used by this transform.

public void initializeTransform (Transformable data)

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

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

public void transformForRequestSuccessful (MarkupOutput out)

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

Parameters
out Output by this transform

Protected Methods

protected ImageTag getInfoTooltip (String descriptor)

protected String getPreference (String preferenceName, 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.

protected abstract WebEvent getSaveConnectEvent ()

protected abstract String getTitle ()

protected void renderSaveButton (MarkupOutput out)

protected void renderServerError (MarkupOutput out)

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

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

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

protected void showConnectionPropertyName (MarkupOutput out, String value, String preferenceName)

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

protected void showHR (MarkupOutput out)

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

protected void showOptionHeading (MarkupOutput out, String name, String description)

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

protected void showSubHeading (MarkupOutput out, String text)

protected void showSubmitButtons (MarkupOutput out)

protected abstract void transformBody (MarkupOutput out)