Class PreferencesGenericTransform
- 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
-
- com.microstrategy.web.app.transforms.PreferencesGenericTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
AbstractOptionsTransform
,PreferencesDocumentTransform
,PreferencesDrillTransform
,PreferencesFolderTransform
,PreferencesGeneralTransform
,PreferencesGraphTransform
,PreferencesGridTransform
,PreferencesInboxTransform
,PreferencesOfficeTransform
,PreferencesProjectTransform
,PreferencesPromptsLayoutTransform
,PreferencesPromptsTransform
,PreferencesSecurityTransform
public class PreferencesGenericTransform extends AbstractPreferencesTransform
The PreferencesGenericTransform is the base class for rendering preferences in Microstrategy Web.
It has several layout-aware helper methods which will render a preference in a particular type of HTML input element.
This class is not tied to rendering a specific preference but it is rather a generic class which can render any preference in the specified HTML input type format.
Some of the HTML input types in which it can render a preference are checkbox, radio button, select option and text field.
- 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 static java.lang.String
ORIENTATION_HORIZONTAL
A constant to specify if you want to render each of the value of a preference in a horizontal fashion next to each other.static java.lang.String
ORIENTATION_VERTICAL
A constant to specify if you want to render each of the value of a preference in a vertical fashion below each other.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
_upperLeftCornerImage, _upperRightCornerImage, formID, FP_FORM_ID, FP_LEVEL_FLAG, FP_UPPER_LEFT_CORNER_IMAGE, FP_UPPER_RIGHT_CORNER_IMAGE, LEVEL_ALL, LEVEL_APPLY, LEVEL_APPLY_TO, LEVEL_FORM, LEVEL_LOAD_DEFAULTS, LEVEL_PREFERENCES, levelFlag, upperLeftCornerImage, upperRightCornerImage
-
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 PreferencesGenericTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
checkPreferenceValue(java.lang.String preferenceEnumName, java.lang.String prefValue, java.lang.String prefLevel)
This method checks if the value of a particular preference at a particular level is equal to a value which the user wants to check against.protected java.util.List
getAllowableValues(java.lang.String preferenceEnumName)
void
renderAllowSaveFlash(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID)
render a select box for allow save over flash dashboard in HTML5.void
renderAsCheckBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID)
Renders the particular preference as a check box along with the descriptor text next to the preference.void
renderAsChecklist(MarkupOutput out, java.lang.String preferenceName, java.lang.String onclick)
Render the list of allowable values as CheckBox listvoid
renderAsComboBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID)
Renders the particular preference as a set of options within a select box.void
renderAsComboBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID, java.lang.String desc)
void
renderAsComboBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID, java.util.Map<java.lang.String,java.lang.String> attributes)
void
renderAsRadio(MarkupOutput out, java.lang.String preferenceEnumName)
Renders the particular preference as a set of radio buttons.void
renderAsRadio(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String orientation)
Renders the particular preference as a set of radio buttons.void
renderAsRadio(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String prefValue, java.lang.String descriptorID)
Renders the particular preference as a radio button along with the descriptor text next to the preference.void
renderAsTextBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String size, java.lang.String maxLength, java.lang.String descriptorID)
Renders the particular preference as a text box along with the descriptor text next to the preference.void
renderCheckBox(MarkupOutput out, java.lang.String preferenceEnumName)
Renders the particular preference as a check box.void
renderCheckBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String onclick)
Renders the particular preference as a check box.void
renderComboBox(MarkupOutput out, java.lang.String preferenceEnumName)
Renders the particular preference as a set of options within a select box.void
renderDefaultDashboard(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID)
render a select box for default dashboard execution mode.void
renderLabel(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID)
Renders the descriptor text for a particular preference.void
renderLabel2(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String text)
void
renderPreference(MarkupOutput out, java.lang.String preferenceName)
void
renderPreference(java.lang.String preferenceName, MarkupOutput out)
Deprecated.void
renderRadio(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String prefValue)
Renders the particular preference as a radio button.void
renderShortcutListAsComboBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String listName)
Renders the particular preference as a set of options within a select box.void
renderTextBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String size, java.lang.String maxLength)
Renders the particular preference as a text box.protected void
transformBody(MarkupOutput out)
Abstract method that must be override by the concrete class.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
getDescription, getFormID, getLoadDefaultsEvent, getPreference, getPreference, getPreferencesBean, getPropertyValue, getSupportedBeanType, getTitle, getUpdateEvent, initializeImages, initializeTransform, isAdminLevel, renderApplyChanges, renderApplyChangesButton, renderApplyChangesCombobox, renderFormEnd, renderFormStart, renderImage, renderInvalidMessage, renderJavascript, renderLoadDefaults, renderNoteInformation, renderPreferenceBodyNote, renderPreferenceBodyNote, renderPreferenceBodyText, renderPreferenceBodyText, renderPreferenceBodyText, renderPreferenceBodyText, renderPreferenceHeader, renderPreferenceHeader, renderSaveMessage, renderSaveMessageText, renderTitle, renderUpdateConfirmation, transformFooter, transformForRequestSuccessful, transformForRequestWaitingForUserInput, transformHeader
-
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
-
ORIENTATION_HORIZONTAL
public static final java.lang.String ORIENTATION_HORIZONTAL
A constant to specify if you want to render each of the value of a preference in a horizontal fashion next to each other.- See Also:
- Constant Field Values
-
ORIENTATION_VERTICAL
public static final java.lang.String ORIENTATION_VERTICAL
A constant to specify if you want to render each of the value of a preference in a vertical fashion below each other.- See Also:
- Constant Field Values
-
-
Method Detail
-
renderLabel
public void renderLabel(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID)
Renders the descriptor text for a particular preference. The value of the argument preferenceEnumName could be the name of a preference or could be from the enumerationEnumWebPreferences
. This method internally calls the methodAbstractPreferencesTransform.renderPreferenceBodyText(MarkupOutput, String, String)
after resolving the text for the descriptorID.It is advisable to use this method as it renders the text next to the preference in a pre defined well formatted CSS style. It also renders the text in a special marked CSS style if there is an error in saving the particular preference.
This is how the output of this method will look like for rendering the descriptor text for the preference named
maxRow
and the descriptorIDmstrWeb.243
which is the descriptor ID for the textMaximum rows in grid:
<span class="mstrStandardHighlighted" id="maxRow_label"><nobr>Maximum rows in grid:</nobr></span>
If users do not have a descriptor for the text that they want to render they can directly call the method
AbstractPreferencesTransform.renderPreferenceBodyText(MarkupOutput, String, String)
with the right string instead of the descriptorID.The same string would be rendered in the following way if there was any error which saving the preference.
<span class="prefs-content-text" id="maxRow_label"><nobr>Maximum rows in grid:
- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference for which we are rendering the descriptor text.descriptorID
- The DescriptorID for the descriptor text to be rendered.
-
renderLabel2
public void renderLabel2(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String text)
-
renderCheckBox
public void renderCheckBox(MarkupOutput out, java.lang.String preferenceEnumName)
Renders the particular preference as a check box. The value of the argument preferenceEnumName could be the name of a preference or could be from the enumerationEnumWebPreferences
.This method will render the check box as cheked if the value of the preference which it is trying to render is
EnumWebPreferences.PREFERENCE_ON
.This is how the output of this method will look like for rendering a check box for the preference named
sSrt
assuming that the current value of the preference isEnumWebPreferences.PREFERENCE_ON
.<input value="1" type="checkbox" checked="1" name="sSrt" id="sSrt"/><input value="0" type="hidden" name="sSrt" id="sSrt"/>
- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.
-
renderCheckBox
public void renderCheckBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String onclick)
Renders the particular preference as a check box. The value of the argument preferenceEnumName could be the name of a preference or could be from the enumerationEnumWebPreferences
.This method will render the check box as cheked if the value of the preference which it is trying to render is
EnumWebPreferences.PREFERENCE_ON
.This is how the output of this method will look like for rendering a check box for the preference named
sSrt
assuming that the current value of the preference isEnumWebPreferences.PREFERENCE_ON
.<input value="1" type="checkbox" checked="1" name="sSrt" id="sSrt"/><input value="0" type="hidden" name="sSrt" id="sSrt"/>
- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.onclick
- Javascript code as onclick handler
-
renderAsCheckBox
public void renderAsCheckBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID)
Renders the particular preference as a check box along with the descriptor text next to the preference. This method internally callsrenderCheckBox(MarkupOutput, String)
and thenrenderLabel(MarkupOutput, String, String)
in that orderExample code for this method:
renderCheckBox(out, preferenceEnumName); out.append(" "); renderLabel(out, preferenceEnumName, descriptorID);
- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.descriptorID
- The DescriptorID for the descriptor text to be rendered.
-
renderRadio
public void renderRadio(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String prefValue)
Renders the particular preference as a radio button. The value of the argument preferenceEnumName could be the name of a preference or could be from the enumerationEnumWebPreferences
.This method will render the radio button as cheked if the value of the preference which it is trying to render is equal to the value of the argument prefValue.
This is how the output of this method will look like for rendering a radio button for the preference named
graphSize
assuming that the value of the argument prefValue is equal to that of the preference.<input value="1" type="radio" checked="1" name="graphSize" id="graphSize"/>
- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.prefValue
- The value of the radio button which if equal to that of the preference will render the radio button as selected.
-
renderAsRadio
public void renderAsRadio(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String prefValue, java.lang.String descriptorID)
Renders the particular preference as a radio button along with the descriptor text next to the preference. This method internally callsrenderRadio(MarkupOutput, String, String)
and thenrenderLabel(MarkupOutput, String, String)
in that orderExample code for this method:
renderRadio(out, preferenceEnumName, prefValue); out.append(" "); renderLabel(out, preferenceEnumName, descriptorID);
- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.prefValue
- The value of the radio button which if equal to that of the preference will render the radio button as selected.descriptorID
- The DescriptorID for the descriptor text to be rendered.
-
renderAsRadio
public void renderAsRadio(MarkupOutput out, java.lang.String preferenceEnumName)
Renders the particular preference as a set of radio buttons.This method internally calls the method
renderAsRadio(MarkupOutput, String, String)
withORIENTATION_HORIZONTAL
orientation.- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.
-
renderAsRadio
public void renderAsRadio(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String orientation)
Renders the particular preference as a set of radio buttons. The value of the argument preferenceEnumName could be the name of a preference or could be from the enumerationEnumWebPreferences
.This method will render the particular preference as a set of radio buttons. It will read the list of allowable values for this preference from the preference definition itself. The preference definition is specified in the file sys_definitions.xml. the list of allowable values will specified along with the preference definition in the nodes "allowableValues" and "allowableValue"
Internally for each allowable value this method will call the method
renderRadio(MarkupOutput, String, String)
and the methodAbstractPreferencesTransform.renderPreferenceBodyText(MarkupOutput, String, String)
in that orderIf no allowable values are specified for the preference in the preference definition file, this method will not render anything. The list of radio buttons will be either rendered vertically one below the other or horizontally one next to the other. This depends on the value of the argument orientation which could be either
ORIENTATION_HORIZONTAL
orORIENTATION_VERTICAL
.This is how the output of this method will look like for rendering a text box for the preference named
drillRetainThresholds
assuming that the value of the preference is 1.<input value="1" type="radio" checked="1" name="drillRetainThresholds" id="drillRetainThresholds"/> <span class="prefs-content-text" id="maxRow_label"><nobr>Yes:</nobr></span>
<input value="2" type="radio" name="drillRetainThresholds" id="drillRetainThresholds"/> <span class="prefs-content-text" id="maxRow_label"><nobr>No:</nobr></span>
This is how the list of allowable values will be specified in the file sys_definitions.xml.
<pr des="Drill retain threshold" n="drillRetainThresholds" scp="user_project" v="3">
<allowableValues>
<allowableValue des="Yes" des-id="mstrWeb.219" v="com.microstrategy.web.app.transforms.DRILL_OPTION_RETAIN_THRESHOLD_YES" />
<allowableValue des="No" des-id="mstrWeb.218" v="com.microstrategy.web.app.transforms.DRILL_OPTION_RETAIN_THRESHOLD_NO" />
</allowableValues>
</pr>- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.orientation
- Specifies if the radio buttons get rendered vertically one below the other or horizontally one next to the other.
-
renderAsChecklist
public void renderAsChecklist(MarkupOutput out, java.lang.String preferenceName, java.lang.String onclick)
Render the list of allowable values as CheckBox list- Parameters:
out
-preferenceName
-
-
renderTextBox
public void renderTextBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String size, java.lang.String maxLength)
Renders the particular preference as a text box. The value of the argument preferenceEnumName could be the name of a preference or could be from the enumerationEnumWebPreferences
.The value of the text box will be that of the preference that it is trying to render.
This is how the output of this method will look like for rendering a text box for the preference named
graphWidth
assuming that the value of the preference is 150.<input value="150" maxlength="4" type="text" class="standard-text" size="4" name="graphWidth" id="graphWidth"/>
- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.size
- The size of the text box to be rendered.maxLength
- The max length of the text box to be rendered.
-
renderAsTextBox
public void renderAsTextBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String size, java.lang.String maxLength, java.lang.String descriptorID)
Renders the particular preference as a text box along with the descriptor text next to the preference. This method internally callsrenderLabel(MarkupOutput, String, String)
and thenrenderTextBox(MarkupOutput, String, String, String)
in that orderExample code for this method:
renderLabel(out, preferenceEnumName, descriptorID); out.append(" "); renderTextBox(out, preferenceEnumName, size, maxLength);
- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.size
- The size of the text box to be rendered.maxLength
- The max length of the text box to be rendered.descriptorID
- The DescriptorID for the descriptor text to be rendered.
-
renderComboBox
public void renderComboBox(MarkupOutput out, java.lang.String preferenceEnumName)
Renders the particular preference as a set of options within a select box. The value of the argument preferenceEnumName could be the name of a preference or could be from the enumerationEnumWebPreferences
.This method will render the particular preference as a select box. It will read the list of allowable values for this preference from the preference definition itself. The preference definition is specified in the file sys_definitions.xml. the list of allowable values will specified along with the preference definition in the nodes "allowableValues" and "allowableValue"
Internally for each allowable value this method will create an option tag and add it as a child of the seclect box.
If no allowable values are specified for the preference in the preference definition file, this method will not render anything.
This is how the output of this method will look like for rendering a text box for the preference named
drillRetainThresholds
assuming that the value of the preference is 3.<SELECT ID="drillRetainThresholds" NAME="drillRetainThresholds" SIZE="1" > <OPTION VALUE="1" >Yes</OPTION> <OPTION VALUE="2" >No</OPTION> <OPTION VALUE="3" SELECTED="1" >Use the settings stored in the report definition</OPTION> </SELECT>
This is how the list of allowable values will be specified in the file sys_definitions.xml.
<pr des="Drill retain threshold" n="drillRetainThresholds" scp="user_project" v="3">
<allowableValues>
<allowableValue des="Yes" des-id="mstrWeb.219" v="com.microstrategy.web.app.transforms.DRILL_OPTION_RETAIN_THRESHOLD_YES" />
<allowableValue des="No" des-id="mstrWeb.218" v="com.microstrategy.web.app.transforms.DRILL_OPTION_RETAIN_THRESHOLD_NO" />
<allowableValue des="Use the settings stored in the report definition" des-id="mstrWeb.270" v="com.microstrategy.web.app.transforms.DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION" />
</allowableValues>
</pr>- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.
-
renderAsComboBox
public void renderAsComboBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID)
Renders the particular preference as a set of options within a select box. This method internally callsrenderLabel(MarkupOutput, String, String)
and thenrenderComboBox(MarkupOutput, String)
in that orderExample code for this method:
renderLabel(out, preferenceEnumName, descriptorID); out.append(" "); renderComboBox(out, preferenceEnumName);
- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.descriptorID
- The DescriptorID for the descriptor text to be rendered.
-
renderAsComboBox
public void renderAsComboBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID, java.util.Map<java.lang.String,java.lang.String> attributes)
-
renderAsComboBox
public void renderAsComboBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID, java.lang.String desc)
-
renderDefaultDashboard
public void renderDefaultDashboard(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID)
render a select box for default dashboard execution mode. Add a toggleDependentSelectsStatus function to make it disable other dependent elements when selecting some options.- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.descriptorID
- The DescriptorID for the descriptor text to be rendered.
-
renderAllowSaveFlash
public void renderAllowSaveFlash(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String descriptorID)
render a select box for allow save over flash dashboard in HTML5. Disable it when the dashboard execution mode is Flash.- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.descriptorID
- The DescriptorID for the descriptor text to be rendered.
-
renderShortcutListAsComboBox
public void renderShortcutListAsComboBox(MarkupOutput out, java.lang.String preferenceEnumName, java.lang.String listName)
Renders the particular preference as a set of options within a select box. The value of the argument preferenceEnumName could be the name of a preference or could be from the enumerationEnumWebPreferences
.This method will render the particular preference as a select box. It will read the list of allowable values as specified by the
ShortcutList
specified by the argument listName. These lists are specified in thepageConfig
file under the node named<system-pickers>
Internally for each allowable value this method will create an option tag and add it as a child of the seclect box.
- Parameters:
out
- Where the output gets rendered.preferenceEnumName
- The name of the preference which we are rendering as a check box.listName
- The name of the shortcut list which we want to render as a select option.
-
checkPreferenceValue
public boolean checkPreferenceValue(java.lang.String preferenceEnumName, java.lang.String prefValue, java.lang.String prefLevel)
This method checks if the value of a particular preference at a particular level is equal to a value which the user wants to check against. The value of the argument preferenceEnumName could be the name of a preference or could be from the enumerationEnumWebPreferences
.The value of the level can be "default", "system", "server", "project", "user" or "user_project" and the preference will be evaluated at that level. If the user does not specify a level argument and leaves it blank we will evaluate the preference value at the lowest level at which the preference has a value.
- Parameters:
preferenceEnumName
- The name of the preference whose value we are checking.prefValue
- The value which we are comparing against the preference value.prefLevel
- The level at which we want to evaluate the prefernece value.- Returns:
- true if the preference value at the indicated level is equal to the value which we are comparing against.
-
getAllowableValues
protected java.util.List getAllowableValues(java.lang.String preferenceEnumName)
-
transformBody
protected void transformBody(MarkupOutput out)
Description copied from class:AbstractPreferencesTransform
Abstract method that must be override by the concrete class. This is called to generate the main body of the Preference dialog- Specified by:
transformBody
in classAbstractPreferencesTransform
- Parameters:
out
- where to create the output- See Also:
AbstractPreferencesTransform.transformBody(com.microstrategy.web.beans.MarkupOutput)
-
renderPreference
public void renderPreference(java.lang.String preferenceName, MarkupOutput out)
Deprecated.Description copied from class:AbstractPreferencesTransform
Render individual preferences based on the name provided- Specified by:
renderPreference
in classAbstractPreferencesTransform
- Parameters:
preferenceName
- name id of the preference- See Also:
AbstractPreferencesTransform.renderPreference(java.lang.String, com.microstrategy.web.beans.MarkupOutput)
-
renderPreference
public void renderPreference(MarkupOutput out, java.lang.String preferenceName)
-
-