public class

PreferencesDrillTransform

extends PreferencesGenericTransform
implements EnumWebPreferences
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractPreferencesTransform
           ↳ com.microstrategy.web.app.transforms.PreferencesGenericTransform
             ↳ com.microstrategy.web.app.transforms.PreferencesDrillTransform

Class Overview

This is the transform that render the Drill Preferences. Most of the methods of this transform are deprecated except the one which renders the drilloptions for reports.

Summary

Constants
String ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT
String ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU
String DRILL_OPTION_DRILL_ANYWHERE
String DRILL_OPTION_DRILL_HYPERLINKS
String DRILL_OPTION_HYPERLINK_DRILL_DISABLED
String DRILL_OPTION_NO_DRILL
String DRILL_OPTION_REPORT_DEFINITION
String DRILL_OPTION_RETAIN_PARENT_NO
String DRILL_OPTION_RETAIN_PARENT_REPORT_DEFINITION
String DRILL_OPTION_RETAIN_PARENT_YES
String DRILL_OPTION_RETAIN_THRESHOLD_NO
String DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION
String DRILL_OPTION_RETAIN_THRESHOLD_YES
String DRILL_OPTION_SIMPLE_DRILL
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.PreferencesGenericTransform
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From interface com.microstrategy.web.objects.EnumWebPreferences
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From interface com.microstrategy.web.objects.EnumWebPreferences
Public Constructors
PreferencesDrillTransform()
Public Methods
boolean canDisplayDrillMetricValues()
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
boolean canDisplayDrillMetricValuesLink()
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
boolean canDisplayDrillMetricValuesRMC()
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void renderAdvancedDrillingMenuDisplay(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void renderDrillDisableHyperLinkDrill(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void renderDrillEnableContextMenuDrill(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void renderDrillKeepParent(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void renderDrillMode(MarkupOutput out)
void renderDrillOpenInNewWindow(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void renderDrillRetainThresholds(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void renderDrillShowMetricValueLink(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void renderDrillShowMetricValueRMC(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void renderGroupContextMenuDrillPathsByType(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void renderPreference(String preferenceName, MarkupOutput out)
This method is deprecated. Call the corresponding renderXXX method directly.
void renderSortSetNamesAndDrillPaths(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
void transformBody(MarkupOutput out)
This method is deprecated. This method has been deprecated. Instead use the preferences generic transform
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.PreferencesGenericTransform
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT

Constant Value: "1"

public static final String ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU

Constant Value: "2"

public static final String DRILL_OPTION_DRILL_ANYWHERE

Constant Value: "1"

public static final String DRILL_OPTION_DRILL_HYPERLINKS

Constant Value: "2"

public static final String DRILL_OPTION_HYPERLINK_DRILL_DISABLED

Constant Value: "1"

public static final String DRILL_OPTION_NO_DRILL

Constant Value: "4"

public static final String DRILL_OPTION_REPORT_DEFINITION

Constant Value: "5"

public static final String DRILL_OPTION_RETAIN_PARENT_NO

Constant Value: "2"

public static final String DRILL_OPTION_RETAIN_PARENT_REPORT_DEFINITION

Constant Value: "3"

public static final String DRILL_OPTION_RETAIN_PARENT_YES

Constant Value: "1"

public static final String DRILL_OPTION_RETAIN_THRESHOLD_NO

Constant Value: "2"

public static final String DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION

Constant Value: "3"

public static final String DRILL_OPTION_RETAIN_THRESHOLD_YES

Constant Value: "1"

public static final String DRILL_OPTION_SIMPLE_DRILL

Constant Value: "3"

Public Constructors

public PreferencesDrillTransform ()

Public Methods

public boolean canDisplayDrillMetricValues ()

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Returns true if drill metric values preferences (either link or RMC) can be displayed.

public boolean canDisplayDrillMetricValuesLink ()

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Returns true if the preferences to show drill metric values for links is enabled.

Returns
  • boolean

public boolean canDisplayDrillMetricValuesRMC ()

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

public void renderAdvancedDrillingMenuDisplay (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Renders the advanced drill menu display ;

Parameters
out MarkupOutput instance where the HTML to render will be saved

public void renderDrillDisableHyperLinkDrill (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Parameters
out MarkupOutput instance where the HTML to render will be saved

public void renderDrillEnableContextMenuDrill (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Parameters
out MarkupOutput instance where the HTML to render will be saved

public void renderDrillKeepParent (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Parameters
out MarkupOutput instance where the HTML to render will be saved

public void renderDrillMode (MarkupOutput out)

Parameters
out MarkupOutput instance where the HTML to render will be saved

public void renderDrillOpenInNewWindow (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

public void renderDrillRetainThresholds (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Parameters
out MarkupOutput instance where the HTML to render will be saved

public void renderDrillShowMetricValueLink (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Parameters
out MarkupOutput instance where the HTML to render will be saved

public void renderDrillShowMetricValueRMC (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Parameters
out MarkupOutput instance where the HTML to render will be saved

public void renderGroupContextMenuDrillPathsByType (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Renders the drill paths sorting property;

Parameters
out MarkupOutput instance where the HTML to render will be saved

public void renderPreference (String preferenceName, MarkupOutput out)

This method is deprecated.
Call the corresponding renderXXX method directly.

Render individual preferences based on the name provided

Parameters
preferenceName name id of the preference
out MarkupOutput instance where the HTML to render will be saved

public void renderSortSetNamesAndDrillPaths (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Renders the drill paths sorting property;

Parameters
out MarkupOutput instance where the HTML to render will be saved.

public void transformBody (MarkupOutput out)

This method is deprecated.
This method has been deprecated. Instead use the preferences generic transform

Generates the content for the Drill Preference's dialog.

Parameters
out the body content