Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

DrillEditorBean

implements ReportFrameElement

com.microstrategy.web.app.beans.DrillEditorBean

Known Indirect Subclasses

DrillEditorBeanImpl

Class Overview

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.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

From interface com.microstrategy.web.app.beans.AppComponent

Public Methods
abstract boolean	getAdvancedDrillEditor() Gets the drill editor display flag to show the Advanced Drill Editor.
abstract int	getAdvancedDrillTitleAxis() Gets the Axis type of the Title that is shown in the Advanced Drill Editor
abstract int	getAdvancedDrillTitlePosition() Gets the Position of the Title to be shown in the Advanced Drill Editor.
abstract String	getDrillRetainParent() Gets the value for retaining parent on drilling.
abstract String	getDrillRetainThresholds() Gets the value for retaining thresholds on drilling.
abstract 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.
abstract String	getSelectedDrillDimension() Gets the Dimension in the Advanced Drill Editor
abstract void	setAdvancedDrillEditor(boolean flag) Sets the drill editor display flag to show the Advanced Drill Editor.
abstract void	setAdvancedDrillTitleAxis(int axis) Set the Axis type of the Title to be shown in the Advanced Drill Editor
abstract void	setAdvancedDrillTitlePosition(int position) Set the Position of the Title to be shown in the Advanced Drill Editor.
abstract void	setDrillRetainParent(String value) Sets the value for retaining parent on drilling.
abstract void	setDrillRetainThresholds(String value) Sets the value for retaining thresholds on drilling.
abstract 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.
abstract void	setSelectedDrillDimension(String drillDimension) Sets the Dimension to be shown in the in the Advanced Drill Editor
abstract 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.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.app.beans.AppComponent

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.app.beans.FrameElement

abstract FrameBean	getFrameBean() Returns the frame bean that is containing this FrameElement.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
abstract boolean	isEditor() Indicates whether a ReportFrameElement most be considered editor.
abstract boolean	isEnabled() Indicates whether a ReportFrameElement is Enabled.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output

From interface com.microstrategy.web.app.beans.ReportFrameElement

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Public Methods

public abstract boolean getAdvancedDrillEditor ()

Gets the drill editor display flag to show the Advanced Drill Editor.

Returns

true if the advanced drill editor is on

public abstract 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.

public abstract 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.

public abstract String getDrillRetainParent ()

Gets the value for retaining parent on drilling.

Returns

The value set for retaining the parent on drilling.

public abstract String getDrillRetainThresholds ()

Gets the value for retaining thresholds on drilling.

Returns

The value set for retaining the thresholds on drilling.

public abstract 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.

public abstract String getSelectedDrillDimension ()

Gets the Dimension in the Advanced Drill Editor

Returns

The dimension to be shown in the Advanced Drill Editor

public abstract void setAdvancedDrillEditor (boolean flag)

Sets the drill editor display flag to show the Advanced Drill Editor.

Parameters

flag	set to true for advanced drill

public abstract 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.

public abstract 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.

public abstract void setDrillRetainParent (String value)

Sets the value for retaining parent on drilling.

Parameters

value	The value for retaining the parent for drilling.

public abstract void setDrillRetainThresholds (String value)

Sets the value for retaining thresholds on drilling. This could be one of the values from DRILL_RETAIN_THRESHOLDS_NO or DRILL_RETAIN_THRESHOLDS_YES or DRILL_RETAIN_THRESHOLDS_USE_DRILL_PATH

Parameters

value	The value for retaining the thresholds for drilling.

public abstract 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

public abstract void setSelectedDrillDimension (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

public abstract 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

Interfaces

Classes

Exceptions

DrillEditorBean

Class Overview

Summary

Public Methods

public abstract boolean getAdvancedDrillEditor ()

Returns

public abstract int getAdvancedDrillTitleAxis ()

Returns

public abstract int getAdvancedDrillTitlePosition ()

Returns

public abstract String getDrillRetainParent ()

Returns

public abstract String getDrillRetainThresholds ()

Returns

public abstract boolean getPreselectDrillOptions ()

Returns

public abstract String getSelectedDrillDimension ()

Returns

public abstract void setAdvancedDrillEditor (boolean flag)

Parameters

public abstract void setAdvancedDrillTitleAxis (int axis)

Parameters

public abstract void setAdvancedDrillTitlePosition (int position)

Parameters

public abstract void setDrillRetainParent (String value)

Parameters

public abstract void setDrillRetainThresholds (String value)

Parameters

public abstract void setPreselectDrillOptions (boolean preselectDrillOptions)

Parameters

public abstract void setSelectedDrillDimension (String drillDimension)

Parameters

public abstract void setShowUniqueDrillPaths (boolean showUniqueDrillPaths)

Parameters