Class ExportOptionsEditorTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractEditorTransform
-
- com.microstrategy.web.app.transforms.ExportOptionsEditorTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class ExportOptionsEditorTransform extends AbstractEditorTransform
- Since:
- MicroStrategy Web 8.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 protected static java.lang.String
EXPORT_TARGET_WINDOW_NAME
static java.lang.String
PROPERTY_DEFAULT_PAGEBY_EXPORT_MODE
static java.lang.String
PROPERTY_EXPORT_RANGE_ALL
static java.lang.String
PROPERTY_EXPORT_RANGE_CURRENT
static java.lang.String
PROPERTY_NAME_EMBED_FONTS
static java.lang.String
PROPERTY_NAME_EMBED_IMAGES
static java.lang.String
PROPERTY_NAME_INCLUDE_BOOKMARKS
static java.lang.String
PROPERTY_NAME_SHOW_BOOKMARKS
static java.lang.String
PROPERTY_PROMPT_USER_FOR_PAGEBY_EXPORT
static java.lang.String
PROPERTY_USE_BITMAPS_GRAPH
static java.lang.String
PROPERTY_USE_DRAFT_QUALITY_GRAPH
static java.lang.String
PROPERTYSET_NAME_FORMATTING_PAGE
static java.lang.String
PROPERTYSET_RWDOCUMENT_PROPERTIES
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_INCLUDE_DYNAMIC_SCRIPT, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID
-
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 ExportOptionsEditorTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getBeanPath()
Returns the path within the application of the WebBean being transformed.java.lang.String
getDescription()
Returns the textual description of the transformprotected java.lang.String
getScriptClass()
Returns the name of the javaScript class (if any) to be associated with the component.java.lang.Class
getSupportedBeanType()
Returns the supported bean type.protected void
initHelp(Editor editor)
void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.void
renderEditorContents(MarkupOutput out)
Generates the output for the Export Options Editor Beanprotected void
renderExportHiddenInput(MarkupOutput out)
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, renderEditor, renderEditorElement, renderJavascript, setFocusFieldId, transformForRequestInError, transformForRequestSuccessful
-
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, 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, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, 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, 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, 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
-
EXPORT_TARGET_WINDOW_NAME
protected static final java.lang.String EXPORT_TARGET_WINDOW_NAME
- See Also:
- Constant Field Values
-
PROPERTYSET_RWDOCUMENT_PROPERTIES
public static final java.lang.String PROPERTYSET_RWDOCUMENT_PROPERTIES
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROPERTY_DEFAULT_PAGEBY_EXPORT_MODE
public static final java.lang.String PROPERTY_DEFAULT_PAGEBY_EXPORT_MODE
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROPERTY_PROMPT_USER_FOR_PAGEBY_EXPORT
public static final java.lang.String PROPERTY_PROMPT_USER_FOR_PAGEBY_EXPORT
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROPERTYSET_NAME_FORMATTING_PAGE
public static final java.lang.String PROPERTYSET_NAME_FORMATTING_PAGE
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROPERTY_NAME_INCLUDE_BOOKMARKS
public static final java.lang.String PROPERTY_NAME_INCLUDE_BOOKMARKS
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROPERTY_NAME_SHOW_BOOKMARKS
public static final java.lang.String PROPERTY_NAME_SHOW_BOOKMARKS
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROPERTY_NAME_EMBED_FONTS
public static final java.lang.String PROPERTY_NAME_EMBED_FONTS
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROPERTY_NAME_EMBED_IMAGES
public static final java.lang.String PROPERTY_NAME_EMBED_IMAGES
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROPERTY_USE_BITMAPS_GRAPH
public static final java.lang.String PROPERTY_USE_BITMAPS_GRAPH
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROPERTY_USE_DRAFT_QUALITY_GRAPH
public static final java.lang.String PROPERTY_USE_DRAFT_QUALITY_GRAPH
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROPERTY_EXPORT_RANGE_ALL
public static final java.lang.String PROPERTY_EXPORT_RANGE_ALL
- Since:
- MicroStrategy Web 9.0.0
-
PROPERTY_EXPORT_RANGE_CURRENT
public static final java.lang.String PROPERTY_EXPORT_RANGE_CURRENT
- Since:
- MicroStrategy Web 9.0.0
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractEditorTransform
- Parameters:
data
- bean that will be transformed
-
renderEditorContents
public void renderEditorContents(MarkupOutput out)
Generates the output for the Export Options Editor Bean- Specified by:
renderEditorContents
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
renderExportHiddenInput
protected void renderExportHiddenInput(MarkupOutput out)
-
initHelp
protected void initHelp(Editor editor)
- Overrides:
initHelp
in classAbstractEditorTransform
- Since:
- MicroStrategy Web 9.0.0
-
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.
-
getDescription
public java.lang.String getDescription()
Returns the textual description of the transform- Returns:
- the description of the transform
-
getBeanPath
protected java.lang.String getBeanPath()
Description copied from class:AbstractAppTransform
Returns the path within the application of the WebBean being transformed.
When submitting anWebEvent
, this path allows Microstrategy Web to uniquely identify the location of the bean that needs to handle the event.
This method is used by therenderRegisterBone
method to inform the javascript bone the bean to whom it should send its server-side requests.- Overrides:
getBeanPath
in classAbstractAppTransform
- Returns:
- String
- Since:
- MicroStrategy Web 8.1.0
- See Also:
WebComponent.getPath()
,AbstractAppTransform.renderRegisterBone(com.microstrategy.web.beans.MarkupOutput)
-
getScriptClass
protected java.lang.String getScriptClass()
Description copied from class:AbstractAppTransform
Returns the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component.
A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.- Overrides:
getScriptClass
in classAbstractAppTransform
- Returns:
String
representing the name of a javaScript class
-
-