Package com.microstrategy.web.app.beans
Interface DrillEditorBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,FrameElement
,Persistable
,ReportFrameElement
,RequestPersistable
,Transformable
,WebComponent
- All Known Implementing Classes:
DrillEditorBeanImpl
public interface DrillEditorBean extends ReportFrameElement
This is the editor which enables the end user to drill on a particular report. The advanced drill editor can also be opened from this editor for more advanced drilling functionality.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
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 boolean
getAdvancedDrillEditor()
Gets the drill editor display flag to show the Advanced Drill Editor.int
getAdvancedDrillTitleAxis()
Gets the Axis type of the Title that is shown in the Advanced Drill Editorint
getAdvancedDrillTitlePosition()
Gets the Position of the Title to be shown in the Advanced Drill Editor.java.lang.String
getDrillRetainParent()
Gets the value for retaining parent on drilling.java.lang.String
getDrillRetainThresholds()
Gets the value for retaining thresholds on drilling.boolean
getPreselectDrillOptions()
Gets the value for the property of the editor that determines whether the options in the drill editor will be pre-selected with the drill path of high importance.java.lang.String
getSelectedDrillDimension()
Gets the Dimension in the Advanced Drill Editorvoid
setAdvancedDrillEditor(boolean flag)
Sets the drill editor display flag to show the Advanced Drill Editor.void
setAdvancedDrillTitleAxis(int axis)
Set the Axis type of the Title to be shown in the Advanced Drill Editorvoid
setAdvancedDrillTitlePosition(int position)
Set the Position of the Title to be shown in the Advanced Drill Editor.void
setDrillRetainParent(java.lang.String value)
Sets the value for retaining parent on drilling.void
setDrillRetainThresholds(java.lang.String value)
Sets the value for retaining thresholds on drilling.void
setPreselectDrillOptions(boolean preselectDrillOptions)
Sets the value for the property of the editor that determines whether the options in the drill editor will be pre-selected with the drill path of high importance.void
setSelectedDrillDimension(java.lang.String drillDimension)
Sets the Dimension to be shown in the in the Advanced Drill Editorvoid
setShowUniqueDrillPaths(boolean showUniqueDrillPaths)
Sets the value for the property of the editor that determines whether the unique drill paths be shown in the drill editor.-
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.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
-
setAdvancedDrillEditor
void setAdvancedDrillEditor(boolean flag)
Sets the drill editor display flag to show the Advanced Drill Editor.- Parameters:
flag
- set to true for advanced drill
-
getAdvancedDrillEditor
boolean getAdvancedDrillEditor()
Gets the drill editor display flag to show the Advanced Drill Editor.- Returns:
- true if the advanced drill editor is on
-
setAdvancedDrillTitleAxis
void setAdvancedDrillTitleAxis(int axis)
Set the Axis type of the Title to be shown in the Advanced Drill Editor- Parameters:
axis
- The axis type of the title for which the Advanced Drill Editor is to be shown.
-
getAdvancedDrillTitleAxis
int getAdvancedDrillTitleAxis()
Gets the Axis type of the Title that is shown in the Advanced Drill Editor- Returns:
- The integer value of the axis type of the title for which the Advanced Drill Editor is shown.
-
setAdvancedDrillTitlePosition
void setAdvancedDrillTitlePosition(int position)
Set the Position of the Title to be shown in the Advanced Drill Editor. This is the position of the title with respect to the position of other titles on the same axis.- Parameters:
position
- The position of the Title for the Advanced Drill Editor.
-
getAdvancedDrillTitlePosition
int getAdvancedDrillTitlePosition()
Gets the Position of the Title to be shown in the Advanced Drill Editor. This is the position of the title with respect to the position of other titles on the same axis.- Returns:
- The position of the Title for the Advanced Drill Editor.
-
setSelectedDrillDimension
void setSelectedDrillDimension(java.lang.String drillDimension)
Sets the Dimension to be shown in the in the Advanced Drill Editor- Parameters:
drillDimension
- The value of the dimension to be shown in the Advanced Drill Editor
-
getSelectedDrillDimension
java.lang.String getSelectedDrillDimension()
Gets the Dimension in the Advanced Drill Editor- Returns:
- The dimension to be shown in the Advanced Drill Editor
-
setDrillRetainThresholds
void setDrillRetainThresholds(java.lang.String value)
Sets the value for retaining thresholds on drilling. This could be one of the values fromReportTransformHelper.DRILL_RETAIN_THRESHOLDS_NO
orReportTransformHelper.DRILL_RETAIN_THRESHOLDS_YES
orReportTransformHelper.DRILL_RETAIN_THRESHOLDS_USE_DRILL_PATH
- Parameters:
value
- The value for retaining the thresholds for drilling.
-
getDrillRetainThresholds
java.lang.String getDrillRetainThresholds()
Gets the value for retaining thresholds on drilling.- Returns:
- The value set for retaining the thresholds on drilling.
-
setDrillRetainParent
void setDrillRetainParent(java.lang.String value)
Sets the value for retaining parent on drilling.- Parameters:
value
- The value for retaining the parent for drilling.
-
getDrillRetainParent
java.lang.String getDrillRetainParent()
Gets the value for retaining parent on drilling.- Returns:
- The value set for retaining the parent on drilling.
-
setPreselectDrillOptions
void setPreselectDrillOptions(boolean preselectDrillOptions)
Sets the value for the property of the editor that determines whether the options in the drill editor will be pre-selected with the drill path of high importance. The default behavior will not preselect any option in the editor. To change this, add an init-property to the drill editor bean in the pageConfig.xml- Parameters:
preselectDrillOptions
- boolean- Since:
- MicroStrategy Web 8.0.0
-
getPreselectDrillOptions
boolean getPreselectDrillOptions()
Gets the value for the property of the editor that determines whether the options in the drill editor will be pre-selected with the drill path of high importance. The default behavior will not preselect any option in the editor. To change this, add an init-property to the drill editor bean in the pageConfig.xml- Returns:
boolean
value indicating if the options should be preselected or not.- Since:
- MicroStrategy Web 8.0.0
-
setShowUniqueDrillPaths
void setShowUniqueDrillPaths(boolean showUniqueDrillPaths)
Sets the value for the property of the editor that determines whether the unique drill paths be shown in the drill editor. The default behavior will retain duplicate drill paths in the editor. To change this, change/add an init-property "showUniqueDrillPaths" to the drill editor bean in the pageConfig.xml- Parameters:
showUniqueDrillPaths
- boolean- Since:
- MicroStrategy Web 8.1.2
-
-