Package com.microstrategy.web.app.beans
Interface ExportOptionsEditorBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,FrameElement
,Persistable
,ReportFrameElement
,RequestPersistable
,Transformable
,ViewBeanParserBean
,WebComponent
public interface ExportOptionsEditorBean extends ReportFrameElement, ViewBeanParserBean
- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getExecutionMode()
Returns the execution mode.int
getExportMode()
Returns the export mode.int
getExportRange()
Returns the export range.RWBean
getRWBean()
Returns theRWBean
boolean
isPDF()
void
setExecutionMode(int executionMode)
Sets the execution mode A value fromEnumRWExecutionModes
void
setIsPDF(boolean value)
Define if the export options editor was initialized from the PDF button or menu option (false if Print).-
Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop
-
Methods inherited from interface com.microstrategy.web.app.beans.FrameElement
getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement
getReportFrameBean, isGridDataNecessary
-
Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest
-
Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform
-
Methods inherited from interface com.microstrategy.web.app.beans.ViewBeanParserBean
getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey
-
Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setWebEventHandler
-
-
-
-
Method Detail
-
getExportMode
int getExportMode()
Returns the export mode. A value fromEnumRWExportModes
.
The value for this property will be read fromRWExportSettings.getMode()
object. If the value of this property isEnumRWExportModes.RW_EXPORT_DEFAULT
, we initialize it from the Default Page-by Export Mode property of the document (RWDocumentProperties > DefaultPageByExportMode).- Returns:
- the export mode.
-
getExecutionMode
int getExecutionMode()
Returns the execution mode. A value fromEnumRWExecutionModes
- Returns:
- int the execution mode
-
setExecutionMode
void setExecutionMode(int executionMode)
Sets the execution mode A value fromEnumRWExecutionModes
- Parameters:
executionMode
- int the execution mode
-
setIsPDF
void setIsPDF(boolean value)
Define if the export options editor was initialized from the PDF button or menu option (false if Print).
Used to determine whether to use the word 'Export' on the editor and not 'Print'.- Parameters:
value
- boolean indicating if it's a PDF export or not
-
isPDF
boolean isPDF()
- Returns:
- boolean value indicating if the export options editor was initialized from the PDF button or menu option (false if Print).
-
getExportRange
int getExportRange()
Returns the export range. A value fromEnumRWExportRanges
.- Returns:
- the export range.
- Since:
- MicroStrategy Web 9.0.0
-
-