Interface SubreportProperties

All Known Implementing Classes:
Subreport

public interface SubreportProperties
Interface for elements that supports onDemand like subreports.

This class is part of the RDC.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a FormulaField whose return value specifies the text that is shown instead of the element content when on demand is enabled.
    Returns a FormulaField whose return value specifies the name of the tab which is showing the activated element if on demand is enabled.
    boolean
    Returns true if on demand is enabled else false.
    boolean
    Returns true if "suppress if blank" is enabled else false.
    void
    setOnDemand(boolean onDemand)
    Specifies whether on demand is enabled or not.
    void
    If on demand is enabled, the element is shown in the report as a line of text.
    void
    If on demand is enabled, the element is shown in the report as a line of text.
    void
    If on demand is enabled and the element is activated, it is shown in an extra tab or window.
    void
    If on demand is enabled and the element is activated, it is shown in an extra tab or window.
    void
    setSuppressIfBlank(boolean suppress)
    Specifies whether "suppress if blank" is enabled or not.
  • Method Details

    • setOnDemand

      void setOnDemand(boolean onDemand)
      Specifies whether on demand is enabled or not.
      Parameters:
      onDemand - when true on demand is enabled
      Since:
      6.0
    • isOnDemand

      boolean isOnDemand()
      Returns true if on demand is enabled else false.
      Returns:
      whether on demand is enabled
      Since:
      7.0
    • setOnDemandLinkLabel

      void setOnDemandLinkLabel(String lab)
      If on demand is enabled, the element is shown in the report as a line of text. Specify this text with this method.
      Parameters:
      lab - - the text as String
      Since:
      6.0
    • setOnDemandLinkLabel

      void setOnDemandLinkLabel(FormulaField lab)
      If on demand is enabled, the element is shown in the report as a line of text. Specify this text with this method.
      Parameters:
      lab - - a FormulaField whose return value specifies the text.
      Since:
      6.0
    • getOnDemandLinkLabel

      FormulaField getOnDemandLinkLabel()
      Returns a FormulaField whose return value specifies the text that is shown instead of the element content when on demand is enabled.
      Returns:
      FormulaField
      Since:
      6.0
    • setOnDemandTabLabel

      void setOnDemandTabLabel(String lab)
      If on demand is enabled and the element is activated, it is shown in an extra tab or window. Specify the name of this tab with this method.
      Parameters:
      lab - - the name as String
      Since:
      6.0
    • setOnDemandTabLabel

      void setOnDemandTabLabel(FormulaField lab)
      If on demand is enabled and the element is activated, it is shown in an extra tab or window. Specify the name of this tab with this method.
      Parameters:
      lab - - a FormulaField whose return value specifies the name.
      Since:
      6.0
    • getOnDemandTabLabel

      FormulaField getOnDemandTabLabel()
      Returns a FormulaField whose return value specifies the name of the tab which is showing the activated element if on demand is enabled.
      Returns:
      FormulaField
      Since:
      6.0
    • isSuppressIfBlank

      boolean isSuppressIfBlank()
      Returns true if "suppress if blank" is enabled else false. A subreport is blank if all sections are suppressed or have no height. If the subreport is suppressed, the border and background will not be printed.
      Returns:
      whether "suppress if blank" is enabled
      Since:
      11.1
      See Also:
    • setSuppressIfBlank

      void setSuppressIfBlank(boolean suppress)
      Specifies whether "suppress if blank" is enabled or not. A subreport is blank if all sections are suppressed or have no height. If the subreport is suppressed, the border and background will not be printed.
      Parameters:
      suppress - whether to suppress the display of this subreport if it is blank
      Since:
      11.1
      See Also: