Class AbstractOptionsTransform
- 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
-
- com.microstrategy.web.app.transforms.AbstractOptionsTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
AbstractHeaderFooterTransform
,PreferencesExportTransform
,PreferencesPDFTransform
,PreferencesPrintTransform
public abstract class AbstractOptionsTransform extends PreferencesGenericTransform
This abstract class is the base for print/pdf/export options 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 static java.lang.String
ACTION_TYPE_EXPORT
static java.lang.String
ACTION_TYPE_PDF
static java.lang.String
ACTION_TYPE_PRINT
protected ReportPreferencePropertyListMapper
mapper
-
Fields inherited from class com.microstrategy.web.app.transforms.PreferencesGenericTransform
ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL
-
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 AbstractOptionsTransform()
Default empty constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getActionType()
java.lang.String
getDescription()
Returns the textual description of the transformprotected java.lang.String
getExportEventID()
Returns the ID of the export event used when this transform is used for the Options Page (examples are Export, PDF and Print) This will be used to pass as the "eventToForwardTo" on the Save Report Properties page.protected OptionsBean
getOptionsBean()
Returns the current OptionsBeanprotected java.lang.String
getPreference(java.lang.String name)
Overwrites implementation to check for report properties if set.protected WebEvent
getSaveReportPropertiesEvent()
protected int
getSaveReportPropertiesEventID()
java.lang.Class
getSupportedBeanType()
Returns the supported bean type.java.lang.String
getTitle()
WebEvent
getValidatePreferencesEvent()
Returns the event used to validate preferences before exporting.void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform, such as width and height.boolean
isGraphOptions()
Determines if the editor is being used to display grid options.boolean
isGridGraphOptions()
Determines if the editor is being used to display grid/graph options.boolean
isGridOptions()
Determines if the editor is being used to display grid options.boolean
isReportPageByNotEmpty()
Determin whether the page-by in the report is emptyboolean
isShowingOptions()
This method is used to determine whether the transform is being used to display user preferences or report export optionsprotected void
renderCustomHeaderFooterButton(MarkupOutput out, WebEvent evt)
void
renderHeaderAndFooterButton(MarkupOutput out, java.lang.String groupName)
Renders link to edit custom header and footer.protected void
renderOutlineModeHiddenInput(MarkupOutput out)
Render the Hidden Inputs for the Outline Mode to be passed to the PDF.protected void
renderPreferenceBodyText(MarkupOutput out, java.lang.String preferenceName, java.lang.String text, java.lang.String tagID)
Renders the text of a Preference.void
renderSaveMessage(MarkupOutput out)
If a preference was updated and there were no errors, this method shows a success message to the user.void
transformForRequestInError(MarkupOutput out)
Generates the graphical output for the PreferencesBean when the bean is in Error.-
Methods inherited from class com.microstrategy.web.app.transforms.PreferencesGenericTransform
checkPreferenceValue, getAllowableValues, renderAllowSaveFlash, renderAsCheckBox, renderAsChecklist, renderAsComboBox, renderAsComboBox, renderAsComboBox, renderAsRadio, renderAsRadio, renderAsRadio, renderAsTextBox, renderCheckBox, renderCheckBox, renderComboBox, renderDefaultDashboard, renderLabel, renderLabel2, renderPreference, renderPreference, renderRadio, renderShortcutListAsComboBox, renderTextBox, transformBody
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
getFormID, getLoadDefaultsEvent, getPreference, getPreferencesBean, getPropertyValue, getUpdateEvent, initializeImages, isAdminLevel, renderApplyChanges, renderApplyChangesButton, renderApplyChangesCombobox, renderFormEnd, renderFormStart, renderImage, renderInvalidMessage, renderJavascript, renderLoadDefaults, renderNoteInformation, renderPreferenceBodyNote, renderPreferenceBodyNote, renderPreferenceBodyText, renderPreferenceBodyText, renderPreferenceBodyText, renderPreferenceHeader, renderPreferenceHeader, 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, 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
-
ACTION_TYPE_PDF
public static final java.lang.String ACTION_TYPE_PDF
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
ACTION_TYPE_PRINT
public static final java.lang.String ACTION_TYPE_PRINT
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
ACTION_TYPE_EXPORT
public static final java.lang.String ACTION_TYPE_EXPORT
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
mapper
protected ReportPreferencePropertyListMapper mapper
- Since:
- MicroStrategy Web 9.0.0
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Returns the textual description of the transform- Specified by:
getDescription
in interfaceTransform
- Overrides:
getDescription
in classAbstractPreferencesTransform
- Returns:
- the textual description of the transform
-
transformForRequestInError
public void transformForRequestInError(MarkupOutput out)
Generates the graphical output for the PreferencesBean when the bean is in Error. It will call the parent method if it is not invoked from the options page or if has an error object which is not null or if it ha no preference validation errors. If there are preference validation errors from the options page then it will render and error message and make a call totransformForRequestWaitingForUserInput
so the user might change Preferences again and get a chance to correct them.- Overrides:
transformForRequestInError
in classAbstractAppTransform
- Parameters:
out
- where to create the output- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
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 classAbstractPreferencesTransform
- Parameters:
data
- the bean to transform.
-
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.- Overrides:
renderSaveMessage
in classAbstractPreferencesTransform
- Parameters:
out
- where to write the output of the method.
-
renderOutlineModeHiddenInput
protected void renderOutlineModeHiddenInput(MarkupOutput out)
Render the Hidden Inputs for the Outline Mode to be passed to the PDF.- Parameters:
out
- where to write the output of the method.- Since:
- MicroStrategy Web 8.0.1
-
isShowingOptions
public boolean isShowingOptions()
This method is used to determine whether the transform is being used to display user preferences or report export options- Returns:
true
if used to display exporting/printing options.- Since:
- MicroStrategy Web 8.0.1
-
getTitle
public java.lang.String getTitle()
- Overrides:
getTitle
in classAbstractPreferencesTransform
- Returns:
- the Title for the dialog. By default the current group.
-
getOptionsBean
protected OptionsBean getOptionsBean()
Returns the current OptionsBean- Returns:
- this OptionsBean
-
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 classAbstractPreferencesTransform
- Returns:
- a root class/interface supported by this transform.
-
isGridGraphOptions
public boolean isGridGraphOptions()
Determines if the editor is being used to display grid/graph options.- Returns:
true
if the options bean is being used to display grid options- Since:
- MicroStrategy Web 8.0.1
-
isGridOptions
public boolean isGridOptions()
Determines if the editor is being used to display grid options.- Returns:
true
if the options bean is being used to display grid options- Since:
- MicroStrategy Web 8.0.1
-
isGraphOptions
public boolean isGraphOptions()
Determines if the editor is being used to display grid options.- Returns:
true
if the options bean is being used to display grid options- Since:
- MicroStrategy Web 8.0.1
-
isReportPageByNotEmpty
public boolean isReportPageByNotEmpty()
Determin whether the page-by in the report is empty- Returns:
true
if the transform is displaying print options and there are template units in the page-by.- Since:
- MicroStrategy Web 8.0.1
-
getValidatePreferencesEvent
public WebEvent getValidatePreferencesEvent()
Returns the event used to validate preferences before exporting.- Since:
- MicroStrategy Web 8.0.1
-
getSaveReportPropertiesEvent
protected WebEvent getSaveReportPropertiesEvent()
- Returns:
- the save report properties event. Used for the options pages.
- Since:
- MicroStrategy Web 9.0.0
-
getSaveReportPropertiesEventID
protected int getSaveReportPropertiesEventID()
- Since:
- MicroStrategy Web 9.0.0
-
getExportEventID
protected java.lang.String getExportEventID()
Returns the ID of the export event used when this transform is used for the Options Page (examples are Export, PDF and Print) This will be used to pass as the "eventToForwardTo" on the Save Report Properties page.- Returns:
- The ID of the final event used when this transform is used for the Options Page (examples are Export, PDF and Print)
- Since:
- MicroStrategy Web 9.0.0
-
getActionType
protected java.lang.String getActionType()
- Returns:
- the type of action (
ACTION_TYPE_PDF
,ACTION_TYPE_PRINT
orACTION_TYPE_EXPORT
) - Since:
- MicroStrategy Web 9.0.0
-
renderHeaderAndFooterButton
public void renderHeaderAndFooterButton(MarkupOutput out, java.lang.String groupName)
Renders link to edit custom header and footer.- Parameters:
out
- the output object- Since:
- MicroStrategy Web 9.0.0
-
renderCustomHeaderFooterButton
protected void renderCustomHeaderFooterButton(MarkupOutput out, WebEvent evt)
- Since:
- MicroStrategy Web 9.0.0
-
getPreference
protected java.lang.String getPreference(java.lang.String name)
Overwrites implementation to check for report properties if set.- Overrides:
getPreference
in classAbstractPreferencesTransform
- Parameters:
name
- name of the preference- Returns:
- preference.getValue() for the requested level
- Since:
- MicroStrategy Web 9.0.0
-
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.- Overrides:
renderPreferenceBodyText
in classAbstractPreferencesTransform
- 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
-
-