Class ReportItemThemeHandle

  • All Implemented Interfaces:
    org.eclipse.birt.report.model.elements.interfaces.IAbstractThemeModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IReportItemThemeModel

    public class ReportItemThemeHandle
    extends AbstractThemeHandle
    implements org.eclipse.birt.report.model.elements.interfaces.IReportItemThemeModel
    Represents a report item theme in the library. Each theme contains some number of styles.
    See Also:
    ReportItemTheme
    • Constructor Detail

      • ReportItemThemeHandle

        public ReportItemThemeHandle​(org.eclipse.birt.report.model.core.Module module,
                                     org.eclipse.birt.report.model.core.DesignElement element)
        Constructs the handle for a theme with the given design and element. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.
        Parameters:
        module - the module
        element - the model representation of the element
    • Method Detail

      • getType

        public java.lang.String getType()
        Gets the type for this report item theme. The type for this theme is required. If it is not set, no style can be inserted to this theme. The type can be the predefined choices as one of the following:
        • REPORT_ITEM_THEME_TYPE_TABLE
        • REPORT_ITEM_THEME_TYPE_LIST
        • REPORT_ITEM_THEME_TYPE_GRID
        At the another side, the type can be extension name for the extended item, such as crosstab and chart and others. Generally, the type is the name of the element definitionIObjectDefn.getName() .
        Returns:
      • setType

        public void setType​(java.lang.String type)
                     throws SemanticException
        Sets the type for this report item theme. The type for this theme is required. If it is not set, no style can be inserted to this theme. The type can be the predefined choices as one of the following:
        • REPORT_ITEM_THEME_TYPE_TABLE
        • REPORT_ITEM_THEME_TYPE_LIST
        • REPORT_ITEM_THEME_TYPE_GRID
        At the another side, the type can be extension name for the extended item, such as crosstab and chart and others. Generally, the type is the name of the element definitionIObjectDefn.getName() .
        Parameters:
        type - the type to set for this report item theme
        Throws:
        SemanticException
      • importCssStyles

        public void importCssStyles​(CssStyleSheetHandle stylesheet,
                                    java.util.List<SharedStyleHandle> selectedStyles)
                             throws SemanticException
        Imports the selected styles in a CssStyleSheetHandle to the given theme of the library. Each in the list is instance of SharedStyleHandle .If any style selected has a duplicate name with that of one style already existing in the report design, this method will rename it and then add it to the design.
        Parameters:
        stylesheet - the style sheet handle that contains all the selected styles
        selectedStyles - the selected style list
        themeName - the name of the theme to put styles
        Throws:
        SemanticException
      • getCustomValues

        public java.lang.String getCustomValues()
        Returns: