Class PreferencesDrillTransform

  • All Implemented Interfaces:
    AppTransform, EnumWebPreferences, LayoutTransform, Transform

    public class PreferencesDrillTransform
    extends PreferencesGenericTransform
    implements EnumWebPreferences
    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.
    Since:
    MicroStrategy Web 7.3.1 or earlier (@link com.microstrategy.web.app.transforms.PreferencesGenericTransform} to render the drill preferences.
    • Field Detail

      • DRILL_OPTION_DRILL_ANYWHERE

        public static final java.lang.String DRILL_OPTION_DRILL_ANYWHERE
        See Also:
        Constant Field Values
      • DRILL_OPTION_DRILL_HYPERLINKS

        public static final java.lang.String DRILL_OPTION_DRILL_HYPERLINKS
        See Also:
        Constant Field Values
      • DRILL_OPTION_SIMPLE_DRILL

        public static final java.lang.String DRILL_OPTION_SIMPLE_DRILL
        See Also:
        Constant Field Values
      • DRILL_OPTION_NO_DRILL

        public static final java.lang.String DRILL_OPTION_NO_DRILL
        See Also:
        Constant Field Values
      • DRILL_OPTION_REPORT_DEFINITION

        public static final java.lang.String DRILL_OPTION_REPORT_DEFINITION
        See Also:
        Constant Field Values
      • DRILL_OPTION_RETAIN_PARENT_YES

        public static final java.lang.String DRILL_OPTION_RETAIN_PARENT_YES
        See Also:
        Constant Field Values
      • DRILL_OPTION_RETAIN_PARENT_NO

        public static final java.lang.String DRILL_OPTION_RETAIN_PARENT_NO
        See Also:
        Constant Field Values
      • DRILL_OPTION_RETAIN_PARENT_REPORT_DEFINITION

        public static final java.lang.String DRILL_OPTION_RETAIN_PARENT_REPORT_DEFINITION
        See Also:
        Constant Field Values
      • DRILL_OPTION_RETAIN_THRESHOLD_YES

        public static final java.lang.String DRILL_OPTION_RETAIN_THRESHOLD_YES
        See Also:
        Constant Field Values
      • DRILL_OPTION_RETAIN_THRESHOLD_NO

        public static final java.lang.String DRILL_OPTION_RETAIN_THRESHOLD_NO
        See Also:
        Constant Field Values
      • DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION

        public static final java.lang.String DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION
        See Also:
        Constant Field Values
      • ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT

        public static final java.lang.String ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU

        public static final java.lang.String ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • DRILL_OPTION_HYPERLINK_DRILL_DISABLED

        public static final java.lang.String DRILL_OPTION_HYPERLINK_DRILL_DISABLED
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
    • Constructor Detail

      • PreferencesDrillTransform

        public PreferencesDrillTransform()
    • Method Detail

      • renderAdvancedDrillingMenuDisplay

        public void renderAdvancedDrillingMenuDisplay​(MarkupOutput out)
        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
        Since:
        MicroStrategy Web 8.0.0
      • renderGroupContextMenuDrillPathsByType

        public void renderGroupContextMenuDrillPathsByType​(MarkupOutput out)
        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
        Since:
        MicroStrategy Web 8.0.0
      • renderSortSetNamesAndDrillPaths

        public void renderSortSetNamesAndDrillPaths​(MarkupOutput out)
        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.
        Since:
        MicroStrategy Web 8.0.0
      • renderDrillMode

        public void renderDrillMode​(MarkupOutput out)
        Parameters:
        out - MarkupOutput instance where the HTML to render will be saved
        Since:
        MicroStrategy Web 7.5.1
      • renderDrillEnableContextMenuDrill

        public void renderDrillEnableContextMenuDrill​(MarkupOutput out)
        Deprecated.
        This method has been deprecated. Instead use the preferences generic transform
        Parameters:
        out - MarkupOutput instance where the HTML to render will be saved
        Since:
        MicroStrategy Web 8.0.0
      • renderDrillDisableHyperLinkDrill

        public void renderDrillDisableHyperLinkDrill​(MarkupOutput out)
        Deprecated.
        This method has been deprecated. Instead use the preferences generic transform
        Parameters:
        out - MarkupOutput instance where the HTML to render will be saved
        Since:
        MicroStrategy Web 8.0.0
      • renderDrillShowMetricValueLink

        public void renderDrillShowMetricValueLink​(MarkupOutput out)
        Deprecated.
        This method has been deprecated. Instead use the preferences generic transform
        Parameters:
        out - MarkupOutput instance where the HTML to render will be saved
        Since:
        MicroStrategy Web 7.5.1
      • canDisplayDrillMetricValues

        public boolean canDisplayDrillMetricValues()
        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.
        Since:
        MicroStrategy Web 8.0.1
      • canDisplayDrillMetricValuesLink

        public boolean canDisplayDrillMetricValuesLink()
        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
        Since:
        MicroStrategy Web 8.0.1
      • renderDrillShowMetricValueRMC

        public void renderDrillShowMetricValueRMC​(MarkupOutput out)
        Deprecated.
        This method has been deprecated. Instead use the preferences generic transform
        Parameters:
        out - MarkupOutput instance where the HTML to render will be saved
        Since:
        MicroStrategy Web 7.5.1
      • canDisplayDrillMetricValuesRMC

        public boolean canDisplayDrillMetricValuesRMC()
        Deprecated.
        This method has been deprecated. Instead use the preferences generic transform
        Since:
        MicroStrategy Web 8.0.1
      • renderDrillKeepParent

        public void renderDrillKeepParent​(MarkupOutput out)
        Deprecated.
        This method has been deprecated. Instead use the preferences generic transform
        Parameters:
        out - MarkupOutput instance where the HTML to render will be saved
        Since:
        MicroStrategy Web 7.5.1
      • renderDrillRetainThresholds

        public void renderDrillRetainThresholds​(MarkupOutput out)
        Deprecated.
        This method has been deprecated. Instead use the preferences generic transform
        Parameters:
        out - MarkupOutput instance where the HTML to render will be saved
        Since:
        MicroStrategy Web 7.5.1
      • renderDrillOpenInNewWindow

        public void renderDrillOpenInNewWindow​(MarkupOutput out)
        Deprecated.
        This method has been deprecated. Instead use the preferences generic transform
        Since:
        MicroStrategy Web 7.5.4