public class

DrillEditorBeanImpl

extends AbstractFrameEditorBean
implements DrillEditorBean

java.lang.Object
↳	com.microstrategy.utils.serialization.AbstractPersistable
	↳	com.microstrategy.web.beans.AbstractTransformable
		↳	com.microstrategy.web.beans.AbstractWebComponent
			↳	com.microstrategy.web.app.beans.AbstractAppComponent
				↳	com.microstrategy.web.app.beans.AbstractPersistableAppComponent
					↳	com.microstrategy.web.app.beans.AbstractPersistableFrameElement
						↳	com.microstrategy.web.app.beans.AbstractFrameEditorBean
							↳	com.microstrategy.web.app.beans.DrillEditorBeanImpl

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

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

[Expand]

Inherited Fields

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

Public Constructors
	DrillEditorBeanImpl() Default constructor

Public Methods
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 Editor
int	getAdvancedDrillTitlePosition() Gets the Position of the Title to be shown in the Advanced Drill Editor.
int	getCountOptionsForSimpleDrill() Returns the count for the number of drill paths in the simple drill editor.
String	getDrillRetainParent() Gets the value for retaining parent on drilling.
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.
String	getSelectedDrillDimension() Gets the Dimension in the Advanced Drill Editor
boolean	getShowUniqueDrillPaths()
String	getTitle() Returns the title of the editor "DRILL" or "DRILL - Advanced, depending on the mode"
void	initEditor(Editor editor) Extends initEditor by settings flags to display only Close and Help.
boolean	isEnabled() Checks if a bean is enabled
boolean	isGridDataNecessary() This method indicates the report frame that the element requires the grid for information.
void	renderEditorContent(MarkupOutput out) Renders the content of an editor.
void	setAdvancedDrillEditor(boolean flag) Sets the drill editor display flag to show the advanced drill editor.
void	setAdvancedDrillTitleAxis(int axis) Set the Axis of the Title to be shown in the Advanced Drill Editor
void	setAdvancedDrillTitlePosition(int position) Set the Position of the Title to be shown in the Advanced Drill Editor
void	setDrillRetainParent(String value) Sets the value for retaining parent
void	setDrillRetainThresholds(String value) Sets the value for retaining thresholds
void	setPreselectDrillOptions(boolean value) Sets the value for retaining parent
void	setSelectedDrillDimension(String drillDimension) Sets the SelectedDrillDimension in the Advanced Drill Editor
void	setShowUniqueDrillPaths(boolean value) Sets the value for the property of the editor that determines whether the unique drill paths be shown in the drill editor.

Protected Methods
void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer) Proceses the save/restore state opperation of the AppComponent
boolean	getIsDHTML()
String	getOnClickJS()
TagsFactory	getTagsFactory()
WebEventHandler	newDefaultEventHandler()
void	populateAttributeList(ReportBean rb, MarkupOutput out, WebTitle wt, String dimensionName) Populates the list of drill paths for the selected drill dimension in the advanced drill editor.
void	renderCell(ReportBean rb, WebTitle title, MarkupOutput out) Renders one cell for the current WebTitle for the simple drill editor.
void	setHelpEventInformation(Editor editor) This method is deprecated. No replacement.
void	showAdvancedDrillEditor(ReportBean rb, MarkupOutput out) Renders the contents of the advanced drill editor.
void	showAdvancedDrillEditorTable(ReportBean rb, String sTitleName, WebEvent changeDimEvent, StringBuffer sScript, StringBuffer sScriptValues, MarkupOutput out) Renders the visible contents of the advanced drill editor.
void	showSimpledDrillEditor(ReportBean rb, MarkupOutput out) Renders the contents of the simple drill editor.
void	showSimpledDrillEditorHiddenInput(MarkupOutput out) Renders the hidden contents of the simple drill editor.
void	showSimpledDrillEditorTable(ReportBean rb, MarkupOutput out) Renders the visible contents of the simple drill editor.
boolean	sortSetNamesAndDrillPaths() Determines if we need to sort set names and drill paths based on a preference.

[Expand]

Inherited Methods

From class com.microstrategy.web.app.beans.AbstractFrameEditorBean

From class com.microstrategy.web.app.beans.AbstractPersistableFrameElement

void	doCollectData() Extends collectData by setting the Persistable mode to Default (do not persist) if the bean is a FrameElement and it's not editable.
DocumentFrameBean	getDocumentFrameBean() Returns the `DocumentFrameBean` associated with this report frame element.
WebFeatures	getFeaturesManager() Overrides getFeaturesManager by providing a new Features implementation for FrameElements.
FrameBean	getFrameBean() Utility method for returning the `FrameBean` associated with this instance
RWFrameBean	getRWFrameBean() Returns the `RWFrameBean` associated with this report frame element.
ReportFrameBean	getReportFrameBean() Returns the `ReportFrameBean` associated with this report frame element.
boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
boolean	isEditor() Indicates whether a ReportFrameElement most be considered editor.
boolean	isGridDataNecessary() This method indicates the report frame that the element requires the grid for information.
boolean	isIFrameEnabled()
boolean	isOpen() Overrides isOpen by making sure FrameElements use the FrameBean to control their open-close status.
void	setIsOpen(boolean value) Overrides setIsOpen by making sure FrameElements use the FrameBean to control their open-close status.
void	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From class com.microstrategy.web.app.beans.AbstractAppComponent

void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
void	collectMinimalData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
boolean	compareChildsTargetWithCurrent() The implementing class should implement this method to return true if it wants to always call the current object's targetBean#hasChanged method in #hasTargetBeanChanged method.
TransformInstance	createTransformInstance(Transform transform)
void	doCollectData() Call the required methods so the data is collected for this instance
void	doCollectMinimalData() By default this method simply invokes `doCollectData()`, i.e.
MarkupOutput	generateOutput() Generates the output of a bean.
AppContext	getAppContext() This method returns the application context object associated with this component.
String	getContactInfo() This method is deprecated. Use Preferences.getValue(EnumWebPreferences.WebPreferenceAdminInfo) instead.
ContainerServices	getContainerServices() Convenience method to retrieve the connected Container Services object.
String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
String	getDescriptor(String key) Retrieve the descriptor when the key is a string
EventManager	getEventManager() This method returns the application EventManager used to generates events.
String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
WebObjectSource	getObjectSource()
int	getResultFilterMode()
WebIServerSession	getSession()
WebComponent	getTargetBean() Get the target bean associated with this instance
int	getTop() Get the top position where the bean should be displayed by the transform if applicable
int	getType() Returns the transformable type as in `EnumWebTransformableType`.
static WebObjectsFactory	getWebObjectsFactory(WebBean wb) Utility method for obtaining a `WebObjectsFactory` instance
WebObjectsFactory	getWebObjectsFactory()
int	getXMLStatus() Returns the `EnumRequestStatus` status of the component.
boolean	hasChanged() Verifies the state of the component has changed
boolean	hasTargetBeanChanged() When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false.
boolean	haveChildrenChanged()
WebComponent	initComponent(WebComponent bean, String suffix) Initialize a WebComponent as child of this FrameBean.
void	internalCollectData() This method is called internally by the transform() method to ensure collectData has been triggered and the bean is ready to transform.
boolean	isDialog() Returns true if this bean should be treated as a dialog
boolean	isForcedChildrenStateSaving() Return wheter the bean's children will be save their states or not despite it's open or closed state.
boolean	isIFrameRequest() Utility method that determines if it's an IFrame type of request.
boolean	isModal() The property is used to determine wheter the component will be displayed as a floating (popup) dialog with modal property.
boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
boolean	isOpen() Returns a boolean value indicating if the instance is marked as opened or closed.
BeanContext	newDefaultBeanContext() This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.
ParameterBuilder	newHiddenInputBuilder() Convenience method to retrieve a new instance of a Hidden Input Builder from the connected Container Services object.
NamespaceEncoder	newNamespaceEncoder() Convenience method to retrieve a new instance of a Namespace Encoder from the connected Container Services object.
StyleRequestContext	newStyleRequestContext()
ParameterBuilder	newURIBuilder() Convenience method to retrieve a new instance of a URI Builder from the connected Container Services object.
void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
void	setForcedChildrenStateSaving(boolean value) Forces the bean to propagate its children to save state despite it's open or closed state.
void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
void	setIsDialog(boolean value) Set method for defining if the instance is to be defined as a Dialog or not.
void	setIsModal(boolean value) Set method for defining if the instance is to be defined as a Modal interface or not.
void	setIsOpen(boolean value) Set the current instance as opened.
void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` for the current WebComponent.
void	setTop(int y) Set the top osition where the bean should be displayed by the transform if applicable.

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)
void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)
AbstractHandler	getStateHandler()
boolean	isXMLStateZipped()
boolean	restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs) Restores a component from an embedded XML during a SAX parsing.
boolean	restoreState(String state) Restores a component based on its saved state.
void	restoreXMLState(String state)
String	saveState() Returns a `java.lang.String` representation of a component.
void	saveState(StringBuffer buf, int howMuchState, int stateFlag) Saves and stores a component's state into a `StringBuffer`.
void	saveState(StringBuffer buf, int howMuchState) Saves and stores a component's state into a `StringBuffer`.
String	saveState(int howMuchState) Returns a `java.lang.String` representation of a component.
void	saveXMLState(StringBuffer buf, int howMuchState, int stateFlag)
void	saveXMLState(StringBuffer buf, int howMuchState)

From class java.lang.Object

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.DrillEditorBean

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.

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 Constructors

public DrillEditorBeanImpl ()

Default constructor

Public Methods

public boolean getAdvancedDrillEditor ()

Gets the drill editor display flag to show the advanced drill editor.

Returns

true if the advanced drill editor is on

public int getAdvancedDrillTitleAxis ()

Gets the Axis type of the Title that is shown in the Advanced Drill Editor

Returns

the Axis of the Title to be shown in the Advanced Drill Editor

public 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 to be shown in the Advanced Drill Editor

public int getCountOptionsForSimpleDrill ()

Returns the count for the number of drill paths in the simple drill editor. This is used in the unit test for validation purposes.

Returns

The count for the number of drill paths in the simple drill editor.

public String getDrillRetainParent ()

Gets the value for retaining parent on drilling.

Returns

the value for retaining parent

public String getDrillRetainThresholds ()

Gets the value for retaining thresholds on drilling.

Returns

the value for retaining thresholds

public 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

the value for retaining parent

public String getSelectedDrillDimension ()

Gets the Dimension in the Advanced Drill Editor

Returns

the SelectedDrillDimension in the Advanced Drill Editor

public boolean getShowUniqueDrillPaths ()

public String getTitle ()

Returns the title of the editor "DRILL" or "DRILL - Advanced, depending on the mode"

Returns

the title of the editor

public void initEditor (Editor editor)

Extends initEditor by settings flags to display only Close and Help.

Parameters

editor	the `Editor` instance used to render.

public boolean isEnabled ()

Checks if a bean is enabled

Returns

True if the bean is enabled.

public boolean isGridDataNecessary ()

This method indicates the report frame that the element requires the grid for information. Editors that requires to grid data for their input should override this method, since by default it returns false. This method is implemented for the ReportFrameElement interface.

Returns

True since this editor requires the grid data.

public void renderEditorContent (MarkupOutput out)

Renders the content of an editor.

Parameters

out	`MarkupOutput` instance where to save the HTML content to output for this instance.

public 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 void setAdvancedDrillTitleAxis (int axis)

Set the Axis of the Title to be shown in the Advanced Drill Editor

Parameters

axis	the axis to be shown in the editor

public void setAdvancedDrillTitlePosition (int position)

Set the Position of the Title to be shown in the Advanced Drill Editor

Parameters

position	the position ob the title to be shown

public void setDrillRetainParent (String value)

Sets the value for retaining parent

Parameters

value	the retaining parent value

public void setDrillRetainThresholds (String value)

Sets the value for retaining thresholds

Parameters

value	the retaining thresholds value

public void setPreselectDrillOptions (boolean value)

Sets the value for retaining parent

Parameters

value	the retaining parent value

public void setSelectedDrillDimension (String drillDimension)

Sets the SelectedDrillDimension in the Advanced Drill Editor

Parameters

drillDimension	the dimention selected

public void setShowUniqueDrillPaths (boolean value)

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

value	boolean

Protected Methods

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

Proceses the save/restore state opperation of the AppComponent

Parameters

serializer	an instance of the `FlatStateSerializer` object to use
howMuchState	defines how much information needs to be saved
tokenizer	an instance of the `FlatStateTokenizer` object to use

protected boolean getIsDHTML ()

protected String getOnClickJS ()

protected TagsFactory getTagsFactory ()

protected WebEventHandler newDefaultEventHandler ()

protected void populateAttributeList (ReportBean rb, MarkupOutput out, WebTitle wt, String dimensionName)

Populates the list of drill paths for the selected drill dimension in the advanced drill editor.

Parameters

rb	The report bean for which we are rendering the drill information.
out	`MarkupOutput` instance where to save the HTML content to output for this instance.
wt	The WebTitle for which the cell is rendering drill paths for.
dimensionName	The name of the dimension for which we are rendering the drill paths.

protected void renderCell (ReportBean rb, WebTitle title, MarkupOutput out)

Renders one cell for the current WebTitle for the simple drill editor. Thsi will render all the drill paths which a user can drill from the current WebTitle.

Parameters

rb	The report bean for which we are rendering the drill information.
title	The WebTitle for which the cell is rendering drill paths for
out	`MarkupOutput` instance where to save the HTML content to output for this instance.

protected void setHelpEventInformation (Editor editor)

This method is deprecated.
No replacement.

protected void showAdvancedDrillEditor (ReportBean rb, MarkupOutput out)

Renders the contents of the advanced drill editor.

Parameters

rb	The report bean for which we are rendering the drill information
out	`MarkupOutput` instance where to save the HTML content to output for this instance.

protected void showAdvancedDrillEditorTable (ReportBean rb, String sTitleName, WebEvent changeDimEvent, StringBuffer sScript, StringBuffer sScriptValues, MarkupOutput out)

Renders the visible contents of the advanced drill editor.

Parameters

rb	The report bean for which we are rendering the drill information
out	`MarkupOutput` instance where to save the HTML content to output for this instance.

Throws

WebBeanException

protected void showSimpledDrillEditor (ReportBean rb, MarkupOutput out)

Renders the contents of the simple drill editor.

Parameters

rb	The report bean for which we are rendering the drill information
out	`MarkupOutput` instance where to save the HTML content to output for this instance.

protected void showSimpledDrillEditorHiddenInput (MarkupOutput out)

Renders the hidden contents of the simple drill editor.

Parameters

out	`MarkupOutput` instance where to save the HTML content to output for this instance.

protected void showSimpledDrillEditorTable (ReportBean rb, MarkupOutput out)

Renders the visible contents of the simple drill editor.

Parameters

rb	The report bean for which we are rendering the drill information
out	`MarkupOutput` instance where to save the HTML content to output for this instance.

Throws

	WebBeanException
WebObjectsException
WebBeanException

protected boolean sortSetNamesAndDrillPaths ()

Determines if we need to sort set names and drill paths based on a preference.

Returns

true if we need to sort set names and drill paths based on a preference.

Interfaces

Classes

Exceptions

DrillEditorBeanImpl

Summary

Public Constructors

public DrillEditorBeanImpl ()

Public Methods

public boolean getAdvancedDrillEditor ()

Returns

public int getAdvancedDrillTitleAxis ()

Returns

public int getAdvancedDrillTitlePosition ()

Returns

public int getCountOptionsForSimpleDrill ()

Returns

public String getDrillRetainParent ()

Returns

public String getDrillRetainThresholds ()

Returns

public boolean getPreselectDrillOptions ()

Returns

public String getSelectedDrillDimension ()

Returns

public boolean getShowUniqueDrillPaths ()

public String getTitle ()

Returns

public void initEditor (Editor editor)

Parameters

public boolean isEnabled ()

Returns

public boolean isGridDataNecessary ()

Returns

public void renderEditorContent (MarkupOutput out)

Parameters

public void setAdvancedDrillEditor (boolean flag)

Parameters

public void setAdvancedDrillTitleAxis (int axis)

Parameters

public void setAdvancedDrillTitlePosition (int position)

Parameters

public void setDrillRetainParent (String value)

Parameters

public void setDrillRetainThresholds (String value)

Parameters

public void setPreselectDrillOptions (boolean value)

Parameters

public void setSelectedDrillDimension (String drillDimension)

Parameters

public void setShowUniqueDrillPaths (boolean value)

Parameters

Protected Methods

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

Parameters

See Also

protected boolean getIsDHTML ()

protected String getOnClickJS ()

protected TagsFactory getTagsFactory ()

protected WebEventHandler newDefaultEventHandler ()

protected void populateAttributeList (ReportBean rb, MarkupOutput out, WebTitle wt, String dimensionName)

Parameters

protected void renderCell (ReportBean rb, WebTitle title, MarkupOutput out)

Parameters

protected void setHelpEventInformation (Editor editor)

See Also

protected void showAdvancedDrillEditor (ReportBean rb, MarkupOutput out)

Parameters

protected void showAdvancedDrillEditorTable (ReportBean rb, String sTitleName, WebEvent changeDimEvent, StringBuffer sScript, StringBuffer sScriptValues, MarkupOutput out)

Parameters

Throws

protected void showSimpledDrillEditor (ReportBean rb, MarkupOutput out)

Parameters

protected void showSimpledDrillEditorHiddenInput (MarkupOutput out)

Parameters

protected void showSimpledDrillEditorTable (ReportBean rb, MarkupOutput out)

Parameters

Throws

protected boolean sortSetNamesAndDrillPaths ()

Returns