Class AbstractPreferencesTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractPreferencesTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
PreferencesGenericTransform
,PreferencesLogoutTransform
,PreferencesNCTransform
public abstract class AbstractPreferencesTransform extends AbstractAppTransform implements LayoutTransform
This abstract class is the base for all preferences Transforms.- 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
_upperLeftCornerImage
Deprecated.The formal parameter associated with this property has been deprecated.protected java.lang.String
_upperRightCornerImage
Deprecated.The formal parameter associated with this property has been deprecated.FormalParameter
formID
Specifies the ID to use for the preferences' HTML Form.static java.lang.String
FP_FORM_ID
Constant specifying the ID to use for the preferences's HTML Form.static java.lang.String
FP_LEVEL_FLAG
Constant specifying the name of the formal parameter for defining the level flag.static java.lang.String
FP_UPPER_LEFT_CORNER_IMAGE
Constant specifying the image for the upper left corner of the preferences.static java.lang.String
FP_UPPER_RIGHT_CORNER_IMAGE
Constant specifying the image for the upper right corner of the preferences.static int
LEVEL_ALL
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_APPLY
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_APPLY_TO
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_FORM
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_LOAD_DEFAULTS
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_PREFERENCES
Allowed value for thelevelFlag
formal parameter.FormalParameter
levelFlag
Indicates the level of information to use when displaying the preferences bean.FormalParameter
upperLeftCornerImage
Deprecated.This image is no longer required, the header of the preferences page is defined with css stylesFormalParameter
upperRightCornerImage
Deprecated.This image is no longer required, the header of the preferences page is defined with css styles-
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 AbstractPreferencesTransform()
Default empty constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns the textual description of the transformprotected java.lang.String
getFormID()
Returns the ID to use for the form that contains the preferences inputs.protected WebEvent
getLoadDefaultsEvent()
protected java.lang.String
getPreference(java.lang.String name)
Returns the value of the preference with the given name, at the given levelprotected java.lang.String
getPreference(java.lang.String name, PreferenceLevel level)
Returns the value of the preference with the given name.protected PreferencesBean
getPreferencesBean()
Returns the current PreferencesBeanprotected java.lang.String
getPropertyValue(java.lang.String propertyValue, java.lang.String argumentName)
Check to see if the property comes in the request keys.java.lang.Class
getSupportedBeanType()
Returns the supported bean type.java.lang.String
getTitle()
protected WebEvent
getUpdateEvent()
Returns the update WebEvent used to update the Preferences value.void
initializeImages()
Initialize the images to be used by this transform.void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform, such as width and height.protected boolean
isAdminLevel()
void
renderApplyChanges(MarkupOutput out)
void
renderApplyChangesButton(MarkupOutput out)
void
renderApplyChangesCombobox(MarkupOutput out)
Renders a combobox with the options to "Apply to current project" or to all projectsvoid
renderFormEnd(MarkupOutput out, WebEvent event)
Renders the Form end tagvoid
renderFormStart(MarkupOutput out, WebEvent event)
Renders the start of the Preference's Form.void
renderImage(MarkupOutput out, java.lang.String image)
Renders a transform's imagevoid
renderInvalidMessage(MarkupOutput out)
protected void
renderJavascript(MarkupOutput out)
This method is called to generate all javascript functions related to this transform.void
renderLoadDefaults(MarkupOutput out)
void
renderNoteInformation(MarkupOutput out)
abstract void
renderPreference(java.lang.String preferenceName, MarkupOutput out)
Deprecated.Call the corresponding renderXXX method directly.protected void
renderPreferenceBodyNote(MarkupOutput out, java.lang.String preferenceName, java.lang.String text)
Renders a note for a Preference.protected void
renderPreferenceBodyNote(java.lang.String preferenceName, java.lang.String bodynote, MarkupOutput out)
Deprecated.This method cannot be invoked from a layout-xml.protected void
renderPreferenceBodyText(MarkupOutput out, java.lang.String preferenceName, java.lang.String text)
Renders the text of a Preference.protected void
renderPreferenceBodyText(MarkupOutput out, java.lang.String preferenceName, java.lang.String text, java.lang.String tagID)
Renders the text of a Preference.protected void
renderPreferenceBodyText(MarkupOutput out, java.lang.String preferenceName, java.lang.String text, java.lang.String[] notes)
Renders the text of a Preference.protected void
renderPreferenceBodyText(java.lang.String preferenceName, java.lang.String bodytext, MarkupOutput out)
Deprecated.This method cannot be invoked from a layout-xml.protected void
renderPreferenceHeader(MarkupOutput out, java.lang.String preferenceName, java.lang.String header)
Renders the title of a Preference.protected void
renderPreferenceHeader(java.lang.String preferenceName, java.lang.String header, MarkupOutput out)
Deprecated.This method cannot be invoked from a layout-xml.void
renderSaveMessage(MarkupOutput out)
If a preference was updated and there were no errors, this method shows a success message to the user.void
renderSaveMessageText(MarkupOutput out)
Render the save message text that should be presented to the user once the saving has been successful.void
renderTitle(MarkupOutput out)
void
renderUpdateConfirmation(MarkupOutput out)
Render a confirmation message to show updating is successful or error happened.protected abstract void
transformBody(MarkupOutput out)
Abstract method that must be override by the concrete class.protected void
transformFooter(MarkupOutput out)
Generates the footer of the Preferences dialogvoid
transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the PreferencesBean when the bean is succesfull.void
transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the status isWaitingForUserInputessful
.protected void
transformHeader(MarkupOutput out)
Generates the Header of the Preferences dialog-
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, initializeCss, 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, 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
-
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
-
LEVEL_PREFERENCES
public static final int LEVEL_PREFERENCES
Allowed value for thelevelFlag
formal parameter. Specifies that the transform will display the preferences section.
Value = 1- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_APPLY
public static final int LEVEL_APPLY
Allowed value for thelevelFlag
formal parameter. Specifies that the transform will display the apply button.
Value = 2- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_APPLY_TO
public static final int LEVEL_APPLY_TO
Allowed value for thelevelFlag
formal parameter. Specifies that the transform will display the apply to select box.
If missing the preferences will be saved to the current project only.
Value = 4- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_LOAD_DEFAULTS
public static final int LEVEL_LOAD_DEFAULTS
Allowed value for thelevelFlag
formal parameter. Specifies that the transform will display the Load Defaults button.
Value = 8- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_FORM
public static final int LEVEL_FORM
Allowed value for thelevelFlag
formal parameter. Specifies that the transform will render a form tag surrounding the whole output.
Value = 8- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
LEVEL_ALL
public static final int LEVEL_ALL
Allowed value for thelevelFlag
formal parameter. Convenience flag to indicate all possible LEVEL values.
Value = 16777215- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
levelFlag
public FormalParameter levelFlag
Indicates the level of information to use when displaying the preferences bean.
The information include the preferences section, the apply to select box and the load defaults button Default value isLEVEL_ALL
- Since:
- MicroStrategy Web 8.0.0
-
upperLeftCornerImage
public FormalParameter upperLeftCornerImage
Deprecated.This image is no longer required, the header of the preferences page is defined with css stylesSpecifies the image for the upper left corner of the preferences' frame.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the Usage:
This may be changed to change the look and feel (i.e. color) of the preferences page.
-
upperRightCornerImage
public FormalParameter upperRightCornerImage
Deprecated.This image is no longer required, the header of the preferences page is defined with css stylesSpecifies the image for the upper right corner of the preferences' frame.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the Usage:
This may be changed to change the look and feel (i.e. color) of all preferences pages.
-
formID
public FormalParameter formID
Specifies the ID to use for the preferences' HTML Form.
Allowed Values:
Any string allowed in an ID tag of an HTML form.
Usage:
This may be changed to execute some Javascript that needs to make reference to the preferences form with a specific name.
-
FP_LEVEL_FLAG
public static final java.lang.String FP_LEVEL_FLAG
Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
FP_UPPER_RIGHT_CORNER_IMAGE
public static final java.lang.String FP_UPPER_RIGHT_CORNER_IMAGE
Constant specifying the image for the upper right corner of the preferences.- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
FP_UPPER_LEFT_CORNER_IMAGE
public static final java.lang.String FP_UPPER_LEFT_CORNER_IMAGE
Constant specifying the image for the upper left corner of the preferences.- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
FP_FORM_ID
public static final java.lang.String FP_FORM_ID
Constant specifying the ID to use for the preferences's HTML Form.- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
_upperLeftCornerImage
protected java.lang.String _upperLeftCornerImage
Deprecated.The formal parameter associated with this property has been deprecated.
-
_upperRightCornerImage
protected java.lang.String _upperRightCornerImage
Deprecated.The formal parameter associated with this property has been deprecated.
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Returns the textual description of the transform- Specified by:
getDescription
in interfaceTransform
- Returns:
- the textual description of the transform
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractAppTransform
This method initialize the private and protected fields of the transform, such as width and height. It also invokes the
This method is automatically called from theinitializeWebComponent
,initializeImages
andinitializeCss
methods.transform
method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- the bean to transform.
-
renderUpdateConfirmation
public void renderUpdateConfirmation(MarkupOutput out)
Render a confirmation message to show updating is successful or error happened.- Parameters:
out
- output by this transform
-
transformForRequestWaitingForUserInput
public void transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the status isWaitingForUserInputessful
. Overwrites by showing the Preferences form.- Overrides:
transformForRequestWaitingForUserInput
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the PreferencesBean when the bean is succesfull. It just renders a "Success" message but calls againtransformForRequestWaitingForUserInput
so the user might change Preferences again.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
where to save the HTML to render to the user- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformHeader
protected void transformHeader(MarkupOutput out)
Generates the Header of the Preferences dialog- Parameters:
out
- where to create the output
-
renderTitle
public void renderTitle(MarkupOutput out)
- Since:
- MicroStrategy Web 8.0.1
-
getTitle
public java.lang.String getTitle()
- Returns:
- the Title for the dialog. By default the current group.
-
transformFooter
protected void transformFooter(MarkupOutput out)
Generates the footer of the Preferences dialog- Parameters:
out
- where to create the output
-
renderApplyChanges
public void renderApplyChanges(MarkupOutput out)
- Since:
- MicroStrategy Web 8.0.1
-
renderApplyChangesButton
public void renderApplyChangesButton(MarkupOutput out)
- Since:
- MicroStrategy Web 8.0.1
-
renderApplyChangesCombobox
public void renderApplyChangesCombobox(MarkupOutput out)
Renders a combobox with the options to "Apply to current project" or to all projects- Since:
- MicroStrategy Web 8.0.1
-
renderLoadDefaults
public void renderLoadDefaults(MarkupOutput out)
- Since:
- MicroStrategy Web 8.0.1
-
transformBody
protected abstract void transformBody(MarkupOutput out)
Abstract method that must be override by the concrete class. This is called to generate the main body of the Preference dialog- Parameters:
out
- where to create the output
-
renderPreferenceHeader
protected void renderPreferenceHeader(java.lang.String preferenceName, java.lang.String header, MarkupOutput out)
Deprecated.This method cannot be invoked from a layout-xml. Instead, callrenderPreferenceHeader(MarkupOutput, String preferenceName, String text)
.Renders the title of a Preference.- Parameters:
preferenceName
- the preference nameheader
- the title to displayout
- where to create the output
-
renderPreferenceHeader
protected void renderPreferenceHeader(MarkupOutput out, java.lang.String preferenceName, java.lang.String header)
Renders the title of a Preference.- Parameters:
preferenceName
- the preference nameheader
- the title to displayout
- where to create the output- Since:
- MicroStrategy Web 8.0.1
-
renderPreferenceBodyText
protected void renderPreferenceBodyText(java.lang.String preferenceName, java.lang.String bodytext, MarkupOutput out)
Deprecated.This method cannot be invoked from a layout-xml. Instead, callrenderPreferenceBodyText(MarkupOutput, String preferenceName, String text)
.Renders the text of a Preference. If the preference value is marked as invalid, then the text is highlighted.- Parameters:
preferenceName
- the preference namebodytext
- the title to displayout
- where to create the output
-
renderPreferenceBodyText
protected void renderPreferenceBodyText(MarkupOutput out, java.lang.String preferenceName, java.lang.String text)
Renders the text of a Preference.- Parameters:
out
- where to create the outputpreferenceName
- the preference nametext
- the title to display- Since:
- MicroStrategy Web 8.0.1
-
renderPreferenceBodyText
protected void renderPreferenceBodyText(MarkupOutput out, java.lang.String preferenceName, java.lang.String text, java.lang.String tagID)
Renders the text of a Preference. This method associate the text label to its corresponding radiobox or checkbox.- Parameters:
preferenceName
- the preference nametext
- the title to displaytagID
- the element ID with which this text is associatedout
- where to create the output- Since:
- MicroStrategy Web 9.0.0
-
renderPreferenceBodyText
protected void renderPreferenceBodyText(MarkupOutput out, java.lang.String preferenceName, java.lang.String text, java.lang.String[] notes)
Renders the text of a Preference.- Parameters:
out
- where to create the outputpreferenceName
- the preference nametext
- the title to displaynotes
-- Since:
- MicroStrategy Web 8.0.1
-
renderNoteInformation
public void renderNoteInformation(MarkupOutput out)
- Since:
- MicroStrategy Web 8.0.1
-
renderPreferenceBodyNote
protected void renderPreferenceBodyNote(java.lang.String preferenceName, java.lang.String bodynote, MarkupOutput out)
Deprecated.This method cannot be invoked from a layout-xml. Instead, callrenderPreferenceBodyNote(MarkupOutput, String preferenceName, String text)
.Renders the text of a Preference.- Parameters:
preferenceName
- the preference namebodynote
- the text to displayout
-MarkupOutput
instance where to create the output
-
renderPreferenceBodyNote
protected void renderPreferenceBodyNote(MarkupOutput out, java.lang.String preferenceName, java.lang.String text)
Renders a note for a Preference.- Parameters:
out
-MarkupOutput
instance where to create the outputpreferenceName
- the preference nametext
- the text to display- Since:
- MicroStrategy Web 8.0.1
-
renderJavascript
protected void renderJavascript(MarkupOutput out)
This method is called to generate all javascript functions related to this transform.- Since:
- MicroStrategy Web 8.0.1
-
renderImage
public void renderImage(MarkupOutput out, java.lang.String image)
Renders a transform's image- Overrides:
renderImage
in classAbstractAppTransform
- Parameters:
out
- where to write the output of the method.image
- the image name
-
renderFormStart
public void renderFormStart(MarkupOutput out, WebEvent event)
Renders the start of the Preference's Form. This method also renders the hidden inputs associated with the event- Parameters:
out
- where to write the output of the method.event
- the WebEvent to render
-
getFormID
protected java.lang.String getFormID()
Returns the ID to use for the form that contains the preferences inputs. This is the value of theformID
formal parameter.- Since:
- MicroStrategy Web 8.0.1
-
renderFormEnd
public void renderFormEnd(MarkupOutput out, WebEvent event)
Renders the Form end tag- Parameters:
out
- where to write the output of the method.
-
renderSaveMessageText
public void renderSaveMessageText(MarkupOutput out)
Render the save message text that should be presented to the user once the saving has been successful.- Parameters:
out
- MarkupOutput where to write the output of the method- Since:
- MicroStrategy Web 8.0.0
-
renderSaveMessage
public void renderSaveMessage(MarkupOutput out)
If a preference was updated and there were no errors, this method shows a success message to the user.- Parameters:
out
- where to write the output of the method.
-
renderInvalidMessage
public void renderInvalidMessage(MarkupOutput out)
-
getPreference
protected java.lang.String getPreference(java.lang.String name, PreferenceLevel level)
Returns the value of the preference with the given name. The value is automatically selected for the current level.- Parameters:
name
- the name (key) of the preferencelevel
- level at which the preference should be requested- Returns:
- preference.getValue() for the current level.
-
getPropertyValue
protected java.lang.String getPropertyValue(java.lang.String propertyValue, java.lang.String argumentName)
Check to see if the property comes in the request keys.
If yes, it will return the value of the @param argumentName from the request keys.
If not, it will return back the value which was passed in.
Note:This happens when there are validation error for instance.- Parameters:
propertyValue
- the value of the property- Returns:
- the property value
-
getPreference
protected java.lang.String getPreference(java.lang.String name)
Returns the value of the preference with the given name, at the given level- Parameters:
name
- name of the preference- Returns:
- preference.getValue() for the requested level
-
getPreferencesBean
protected PreferencesBean getPreferencesBean()
Returns the current PreferencesBean- Returns:
- this PreferencesBean
-
getUpdateEvent
protected WebEvent getUpdateEvent()
Returns the update WebEvent used to update the Preferences value.- Returns:
- a WebEvent to use for updating
-
getLoadDefaultsEvent
protected WebEvent getLoadDefaultsEvent()
- Since:
- MicroStrategy Web 8.0.0
-
isAdminLevel
protected boolean isAdminLevel()
-
initializeImages
public void initializeImages()
Initialize the images to be used by this transform.- Overrides:
initializeImages
in classAbstractAppTransform
-
renderPreference
public abstract void renderPreference(java.lang.String preferenceName, MarkupOutput out)
Deprecated.Call the corresponding renderXXX method directly.Render individual preferences based on the name provided- Parameters:
preferenceName
- name id of the preference- Since:
- MicroStrategy Web 7.5.1
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Description copied from class:AbstractAppTransform
Returns the supported bean type. This abstract Transform supports allWebComponents
so every sub-class should override this method to return the class of theBean
the Transform is expecting, for example:public class CustomReportClass extends AbstractAppTransform { public Class getSupportedBeanType() { //This Transform is expected to work only with a ReportBean, //therefore this method needs to return this class: return ReportBean.class; } }
- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
- a root class/interface supported by this transform.
-
-