Class ReportDesignHandle

  • All Implemented Interfaces:
    IModuleModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IInternalReportDesignModel, org.eclipse.birt.report.model.elements.interfaces.IReportDesignModel

    public class ReportDesignHandle
    extends ModuleHandle
    implements org.eclipse.birt.report.model.elements.interfaces.IReportDesignModel
    Represents the overall report design. The report design defines a set of properties that describe the design as a whole like author, base and comments etc.

    Besides properties, it also contains a variety of elements that make up the report. These include:

    Content Item Description
    Code Modules Global scripts that apply to the report as a whole.
    Parameters A list of Parameter elements that describe the data that the user can enter when running the report.
    Data Sources The connections used by the report.
    Data Sets Data sets defined in the design.
    Color Palette A set of custom color names as part of the design.
    Styles User-defined styles used to format elements in the report. Each style must have a unique name within the set of styles for this report.
    Page Setup The layout of the master pages within the report.
    Components Reusable report items defined in this design. Report items can extend these items. Defines a "private library" for this design.
    Body A list of the visual report content. Content is made up of one or more sections. A section is a report item that fills the width of the page. It can contain Text, Grid, List, Table, etc. elements
    Scratch Pad Temporary place to move report items while restructuring a report.
    Translations The list of externalized messages specifically for this report.
    Images A list of images embedded in this report.

    Module allow to use the components defined in Library.

    • User can call ModuleHandleImpl.includeLibrary(String, String)to include one library.
    • User can create one report item based on the one in library, and add it into design file.
    • User can use style, data source, and data set, which are defined in library, in design file.
                          // Include one library
    
                          ReportDesignHandle designHandle = ...;
                          designHandle.includeLibrary( "libA.rptlibrary", "LibA" );
                          LibraryHandle libraryHandle = designHandle.getLibrary("LibA");
    
                          // Create one label based on the one in library
    
                          LabelHandle labelHandle = (LabelHandle) libraryHandle.findElement("companyNameLabel");
                          LabelHandle myLabelHandle = (LabelHandle) designHandle.getElementFactory().newElementFrom( labelHandle, "myLabel" );
    
                          // Add the new label into design file
    
                          designHandle.getBody().add(myLabelHandle);
    
     
    See Also:
    ReportDesign
    • Constructor Detail

      • ReportDesignHandle

        public ReportDesignHandle​(org.eclipse.birt.report.model.elements.ReportDesign design)
        Constructs a handle with the given design. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.
        Parameters:
        design - the report design
    • Method Detail

      • getAfterFactory

        public java.lang.String getAfterFactory()
        Returns the script called at the end of the Factory after closing the report document (if any). This is the last method called in the Factory.
        Returns:
        the script
      • getAfterRender

        public java.lang.String getAfterRender()
        Returns the script called after starting a presentation time action.
        Returns:
        the script
      • getBase

        public java.lang.String getBase()
        Returns the base directory to use when computing relative links from this report. Especially used for searching images, library and so.
        Returns:
        the base directory
      • getBeforeFactory

        public java.lang.String getBeforeFactory()
        Returns the script called at the start of the Factory after the initialize( ) method and before opening the report document (if any).
        Returns:
        the script
      • getBeforeRender

        public java.lang.String getBeforeRender()
        Returns the script called before starting a presentation time action.
        Returns:
        the script
      • getBody

        public SlotHandle getBody()
        Returns a slot handle to work with the sections in the report's Body slot. The order of sections within the slot determines the order in which the sections print.
        Returns:
        A handle for working with the report sections.
      • getRefreshRate

        public int getRefreshRate()
        Returns the refresh rate when viewing the report.
        Returns:
        the refresh rate
      • getScratchPad

        public SlotHandle getScratchPad()
        Returns a slot handle to work with the scratched elements within the report, which are no longer needed or are in the process of rearranged.
        Returns:
        A handle for working with the scratched elements.
      • includeLibraryScriptsIterator

        public java.util.Iterator includeLibraryScriptsIterator()
        Returns the list of all the included script file of the libraries. Each one is the instance of IncludeScriptHandle
        Returns:
        the iterator of included scripts.
      • setAfterFactory

        public void setAfterFactory​(java.lang.String value)
        Sets the script called at the end of the Factory after closing the report document (if any). This is the last method called in the Factory.
        Parameters:
        value - the script to set.
      • setAfterRender

        public void setAfterRender​(java.lang.String value)
        Sets the script called after starting a presentation time action.
        Parameters:
        value - the script to set.
      • setBase

        public void setBase​(java.lang.String base)
        Sets the base directory to use when computing relative links from this report. Especially used for searching images, library and so.
        Parameters:
        base - the base directory to set
      • setBeforeFactory

        public void setBeforeFactory​(java.lang.String value)
        Sets the script called at the start of the Factory after the initialize( ) method and before opening the report document (if any).
        Parameters:
        value - the script to set.
      • setBeforeRender

        public void setBeforeRender​(java.lang.String value)
        Sets the script called before starting a presentation time action.
        Parameters:
        value - the script to set.
      • setRefreshRate

        public void setRefreshRate​(int rate)
        Sets the refresh rate when viewing the report.
        Parameters:
        rate - the refresh rate
      • getStyles

        public SlotHandle getStyles()
        Returns a slot handle to work with the styles within the report. Note that the order of the styles within the slot is unimportant.
        Returns:
        A handle for working with the styles.
      • getAllCssStyleSheets

        public java.util.List getAllCssStyleSheets()
        Gets all css styles sheet
        Returns:
        each item is CssStyleSheetHandle
      • setDisplayNameKey

        public void setDisplayNameKey​(java.lang.String displayNameKey)
                               throws SemanticException
        Sets the resource key of the display name.
        Parameters:
        displayNameKey - the resource key of the display name
        Throws:
        SemanticException - if the display name resource-key property is locked or not defined on this design.
      • getDisplayNameKey

        public java.lang.String getDisplayNameKey()
        Gets the resource key of the display name.
        Returns:
        the resource key of the display name
      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
                            throws SemanticException
        Sets the display name.
        Parameters:
        displayName - the display name
        Throws:
        SemanticException - if the display name property is locked or not defined on this design.
      • getDisplayName

        public java.lang.String getDisplayName()
        Gets the display name.
        Returns:
        the display name
      • setIconFile

        public void setIconFile​(java.lang.String iconFile)
                         throws SemanticException
        Sets the design icon/thumbnail file path.
        Parameters:
        iconFile - the design icon/thumbnail file path to set
        Throws:
        SemanticException - if the property is locked or not defined on this design.
      • getIconFile

        public java.lang.String getIconFile()
        Gets the design icon/thumbnail file path.
        Returns:
        the design icon/thumbnail file path
      • setCheatSheet

        public void setCheatSheet​(java.lang.String cheatSheet)
                           throws SemanticException
        Sets the design cheat sheet file path.
        Parameters:
        cheatSheet - the design cheat sheet file path to set
        Throws:
        SemanticException - if the property is locked or not defined on this design.
      • getCheatSheet

        public java.lang.String getCheatSheet()
        Gets the design cheat sheet file path.
        Returns:
        the design cheat sheet file path
      • setThumbnail

        public void setThumbnail​(byte[] data)
                          throws SemanticException
        Sets the thumbnail image encoded in ISO-8859-1.
        Parameters:
        data - the thumbnail image to set
        Throws:
        SemanticException - if the property is locked or not defined on this design.
      • getThumbnail

        public byte[] getThumbnail()
        Gets the thumbnail image encoded in ISO-8859-1.
        Returns:
        the thumbnail image
      • deleteThumbnail

        public void deleteThumbnail()
                             throws SemanticException
        Deletes the thumbnail image in the design.
        Throws:
        SemanticException - if the property is locked or not defined on this design.
      • getAllBookmarks

        public java.util.List getAllBookmarks()
        Gets all bookmarks defined in this module.
        Returns:
        All bookmarks defined in this module.
      • getAllTocs

        public java.util.List getAllTocs()
        Gets all TOCs defined in this module.
        Returns:
        All TOCs defined in this module.
      • getReportItemsBasedonTempalates

        public java.util.List getReportItemsBasedonTempalates()
        Gets report items which holds a template definition, that is, report item in body slot and page slot. Notice, nested template items is excluded.
        Returns:
        report items which holds a template definition, nested template items is excluded.
      • getLayoutPreference

        public java.lang.String getLayoutPreference()
        Gets the layout preference of this report design. It can be one of the following:
        • DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_FIXED_LAYOUT
        • DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_AUTO_LAYOUT
        Returns:
        layout preference of report design
      • setLayoutPreference

        public void setLayoutPreference​(java.lang.String layout)
                                 throws SemanticException
        Sets the layout preference of this report design. The input layout can be one of the following:
        • DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_FIXED_LAYOUT
        • DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_AUTO_LAYOUT
        Parameters:
        layout - the layout to set
        Throws:
        SemanticException - if value is invalid
      • includeCssesIterator

        public java.util.Iterator includeCssesIterator()
        Returns the iterator over all included css style sheets. Each one is the instance of IncludedCssStyleSheetHandle
        Returns:
        the iterator over all included css style sheets.
      • findIncludedCssStyleSheetHandleByFileName

        @Deprecated
        public IncludedCssStyleSheetHandle findIncludedCssStyleSheetHandleByFileName​(java.lang.String fileName)
        Deprecated.
        Gets IncludedCssStyleSheetHandle by file name.
        Parameters:
        fileName - the file name
        Returns:
        the includedCssStyleSheet handle.
      • findIncludedCssStyleSheetHandleByProperties

        public IncludedCssStyleSheetHandle findIncludedCssStyleSheetHandleByProperties​(java.lang.String fileName,
                                                                                       java.lang.String externalCssURI,
                                                                                       boolean useExternalCss)
        Gets IncludedCssStyleSheetHandle by properties.
        Parameters:
        fileName -
        externalCssURI -
        useExternalCss -
        Returns:
        the includedCssStyleSheet handle.
      • findCssStyleSheetHandleByFileName

        @Deprecated
        public CssStyleSheetHandle findCssStyleSheetHandleByFileName​(java.lang.String fileName)
        Deprecated.
        Gets CssStyleSheetHandle by file name.
        Parameters:
        fileName - the file name.
        Returns:
        the cssStyleSheet handle.
      • findCssStyleSheetHandleByProperties

        public CssStyleSheetHandle findCssStyleSheetHandleByProperties​(java.lang.String fileName,
                                                                       java.lang.String externalCssURI,
                                                                       boolean useExternalCss)
        Gets CssStyleSheetHandle by file name.
        Parameters:
        fileName -
        externalCssURI -
        useExternalCss -
        Returns:
        the cssStyleSheet handle.
      • addCss

        public void addCss​(CssStyleSheetHandle sheetHandle)
                    throws SemanticException
        Includes one css with the given css file name. The new css will be appended to the css list.
        Parameters:
        sheetHandle - css style sheet handle
        Throws:
        SemanticException - if error is encountered when handling CssStyleSheet structure list.
      • addCss

        @Deprecated
        public void addCss​(java.lang.String fileName)
                    throws SemanticException
        Deprecated.
        Includes one css with the given css file name. The new css will be appended to the css list.
        Parameters:
        fileName - css file name
        Throws:
        SemanticException - if error is encountered when handling CssStyleSheet structure list.
      • addCssByProperties

        public void addCssByProperties​(java.lang.String fileName,
                                       java.lang.String externalCssURI,
                                       boolean useExternalCss)
                                throws SemanticException
        Includes one css with the given css file name. The new css will be appended to the css list.
        Parameters:
        fileName - css file name
        Throws:
        SemanticException - if error is encountered when handling CssStyleSheet structure list.
      • addCss

        public void addCss​(IncludedCssStyleSheet cssStruct)
                    throws SemanticException
        Includes one CSS structure with the given IncludedCssStyleSheet. The new css will be appended to the CSS list.
        Parameters:
        cssStruct - the CSS structure
        Throws:
        SemanticException - if error is encountered when handling CssStyleSheet structure list.
      • renameCss

        @Deprecated
        public void renameCss​(IncludedCssStyleSheetHandle handle,
                              java.lang.String newFileName)
                       throws SemanticException
        Deprecated.
        Renames both IncludedCssStyleSheet and CSSStyleSheet to newFileName.
        Parameters:
        handle - the includedCssStyleSheetHandle
        newFileName - the new file name
        Throws:
        SemanticException
      • renameCssByProperties

        public void renameCssByProperties​(IncludedCssStyleSheetHandle handle,
                                          java.lang.String fileName,
                                          java.lang.String externalCssURI,
                                          boolean useExternalCss)
                                   throws SemanticException
        Renames both IncludedCssStyleSheet and CSSStyleSheet to newFileName.
        Parameters:
        handle - the includedCssStyleSheetHandle
        newFileName - the new file name
        Throws:
        SemanticException
      • canRenameCss

        @Deprecated
        public boolean canRenameCss​(IncludedCssStyleSheetHandle handle,
                                    java.lang.String newFileName)
                             throws SemanticException
        Deprecated.
        Checks css can be renamed or not.
        Parameters:
        handle - the included css style sheet handle.
        newFileName - the new file name.
        Returns:
        true can be renamed.else return false
        Throws:
        SemanticException
      • canRenameCssByProperties

        public boolean canRenameCssByProperties​(IncludedCssStyleSheetHandle handle,
                                                java.lang.String fileName,
                                                java.lang.String externalCssURI,
                                                boolean useExternalCss)
                                         throws SemanticException
        Checks css can be renamed or not.
        Parameters:
        handle - the included css style sheet handle.
        newFileName - the new file name.
        Returns:
        true can be renamed.else return false
        Throws:
        SemanticException
      • dropCss

        public void dropCss​(CssStyleSheetHandle sheetHandle)
                     throws SemanticException
        Drops the given css style sheet of this design file.
        Parameters:
        sheetHandle - the css to drop
        Throws:
        SemanticException - if error is encountered when handling CssStyleSheet structure list. Or it maybe because that the given css is not found in the design. Or that the css has descedents in the current module
      • canDropCssStyleSheet

        public boolean canDropCssStyleSheet​(CssStyleSheetHandle sheetHandle)
        Check style sheet can be droped or not.
        Parameters:
        sheetHandle -
        Returns:
        true can be dropped.else return false
      • canAddCssStyleSheet

        public boolean canAddCssStyleSheet​(CssStyleSheetHandle sheetHandle)
        Check style sheet can be added or not.
        Parameters:
        sheetHandle -
        Returns:
        true can be added.else return false
      • canAddCssStyleSheet

        @Deprecated
        public boolean canAddCssStyleSheet​(java.lang.String fileName)
        Deprecated.
        Check style sheet can be added or not.
        Parameters:
        fileName -
        Returns:
        true can be added.else return false
      • canAddCssStyleSheetByProperties

        public boolean canAddCssStyleSheetByProperties​(java.lang.String fileName,
                                                       java.lang.String externalCssURI,
                                                       boolean useExternalCss)
        Check style sheet can be added or not.
        Parameters:
        fileName -
        externalCssURI -
        useExternalCss -
        Returns:
        true can be added.else return false
      • reloadCss

        public void reloadCss​(CssStyleSheetHandle sheetHandle)
                       throws SemanticException
        Reloads the css with the given css file path. If the css already is included directly, reload it. If the css is not included, exception will be thrown.
        Parameters:
        sheetHandle - css style sheet handle.
        Throws:
        SemanticException - if error is encountered when handling CssStyleSheet structure list. Or it maybe because that the given css is not found in the design. Or that the css has descedents in the current module
      • getBidiOrientation

        public java.lang.String getBidiOrientation()
        Gets Bidi orientation value. The return value is defined in DesignChoiceConstants and can be one of:
        • BIDI_DIRECTION_LTR
        • BIDI_DIRECTION_RTL
        Returns:
        the Bidi orientation value
      • setBidiOrientation

        public void setBidiOrientation​(java.lang.String bidiOrientation)
                                throws SemanticException
        Sets Bidi orientation value. The input value is defined in DesignChoiceConstants and can be one of:
        • BIDI_DIRECTION_LTR
        • BIDI_DIRECTION_RTL
        Parameters:
        bidiOrientation - orientation value to be set
        Throws:
        SemanticException
      • isDirectionRTL

        public boolean isDirectionRTL()
        Description copied from class: DesignElementHandle
        Examines whether the resolved direction of this design element is Right to Left or not.
        Overrides:
        isDirectionRTL in class DesignElementHandle
        Returns:
        true if the direction is RTL, false otherwise
      • isEnableACL

        public boolean isEnableACL()
        Returns true if the ACL feature is enable; otherwise false. By default, it is false.
        Returns:
        the flag to control whether to enable ACL
      • setEnableACL

        public void setEnableACL​(boolean enableACL)
                          throws SemanticException
        Sets the flag to control whether to enable ACL.
        Parameters:
        enableACL - true if to enable ACL, otherwise false
        Throws:
        SemanticException - if the property is locked by masks
      • getACLExpression

        public java.lang.String getACLExpression()
        Returns the ACL expression associated with the design instance.
        Returns:
        the expression in string
      • setACLExpression

        public void setACLExpression​(java.lang.String expr)
                              throws SemanticException
        Sets the ACL expression associated with the design instance.
        Parameters:
        expr - the expression in string
        Throws:
        SemanticException - if the property is locked by masks
      • cascadeACL

        public boolean cascadeACL()
        Returns true (the default), the design's ACL is automatically propagated to all its directly contained child elements and are added to their ACLs. Otherwise false.
        Returns:
        the flag to control whether to cascade ACL
      • setCascadeACL

        public void setCascadeACL​(boolean cascadeACL)
                           throws SemanticException
        Sets the flag to control whether to cascade ACL
        Parameters:
        cascadeACL - true (the default), a design's ACL is automatically propagated to all its directly contained child elements and are added to their ACLs. Otherwise false.
        Throws:
        SemanticException - if the property is locked by masks
      • getImageDPI

        public int getImageDPI()
        Gets the image DPI of the report design. This property can ensure image in report design may be displayed as same size at design time as at run time.
        Returns:
        the value of image DPI.
      • setImageDPI

        public void setImageDPI​(int imageDPI)
                         throws SemanticException
        Sets the image DPI of the report design. This property can ensure image in report design may be displayed as same size at design time as at run time.
        Parameters:
        imageDPI - the value of image DPI.
        Throws:
        SemanticException - if the property is locked by masks
      • getOnPageStart

        public java.lang.String getOnPageStart()
        Gets the script of onPageStart method.
        Returns:
        the script of onPageStart method.
      • setOnPageStart

        public void setOnPageStart​(java.lang.String onPageStart)
                            throws SemanticException
        Sets the script of onPageStart method.
        Parameters:
        onPageStart - the script of onPageStart method.
        Throws:
        SemanticException - if the property is locked by masks.
      • getOnPageEnd

        public java.lang.String getOnPageEnd()
        Gets the script of onPageEnd method.
        Returns:
        the script of onPageEnd method.
      • setOnPageEnd

        public void setOnPageEnd​(java.lang.String onPageEnd)
                          throws SemanticException
        Sets the script of onPageEnd method.
        Parameters:
        onPageEnd - the script of onPageEnd method.
        Throws:
        SemanticException - if the property is locked by masks.
      • getPageVariables

        public java.util.List<VariableElementHandle> getPageVariables()
        Gets the pageVariables list value which contains VariableElementHandle.
        Returns:
        the page variables list value.
      • getPageVariable

        public VariableElementHandle getPageVariable​(java.lang.String pageVariableName)
        Gets the according to the input page variable name.
        Parameters:
        pageVariableName - the page variable name.
        Returns:
        the according to the input page variable name
      • setPageVariable

        public void setPageVariable​(java.lang.String pageVariableName,
                                    Expression value)
                             throws SemanticException
        Sets the page variable value.
        Parameters:
        pageVariableName - the page variable name.
        value - the page variable value.
        Throws:
        SemanticException
      • getAllVariables

        public java.util.List<VariableElementHandle> getAllVariables()
        Gets all variable.
        Returns:
        the list of variable. Each item is an instance of VariableElementHandle.
      • getLocale

        public com.ibm.icu.util.ULocale getLocale()
        Gets the locale of the report design.
        Returns:
        the locale of the report design.
        See Also:
        setLocale(ULocale)
      • setLocale

        public void setLocale​(com.ibm.icu.util.ULocale locale)
                       throws SemanticException
        Sets the locale of the report design.
        Parameters:
        locale - the locale of the report design.
        Throws:
        SemanticException
        See Also:
        getLocale()
      • getAllExternalIncludedCsses

        public java.util.List<IncludedCssStyleSheetHandle> getAllExternalIncludedCsses()
        Gets the list of the included css style sheets that set the external URI. The css style might be included by the design handle itself and the theme which the design refers. Each item in the list is instance of IncludedCssStyleSheetHandle.
        Returns:
        list of all the included css style sheet that set the external URI
      • cacheValues

        public void cacheValues()
        Caches values for all elements, styles, etc. The caller must guarantee this method runs in single thread and have no synchronization issue. Whenever the user changes element values, should recall this method.
      • getFlattenElement

        public DesignElementHandle getFlattenElement​(DesignElementHandle elementHandle,
                                                     java.lang.String originalName)
        Gets the flatten element by the original name.
        Parameters:
        elementHandle - the handle of a flatten element once in the same namespace
        originalName - the original name of the element
        Returns:
        the flatten element handle, or null if not found
      • getOnPrepare

        public java.lang.String getOnPrepare()
        Gets the on-prepare script of the report design. Startup phase. No data binding yet. The design of an element can be changed here.
        Returns:
        the on-prepare script of the report design
      • setOnPrepare

        public void setOnPrepare​(java.lang.String script)
                          throws SemanticException
        Sets the on-prepare script of the report design.
        Parameters:
        script - the script to set
        Throws:
        SemanticException - if the method is locked.
        See Also:
        getOnPrepare()
      • getClientInitialize

        public java.lang.String getClientInitialize()
        Gets the client-initialize script of the report design. The design can load java script libraries by the property.
        Returns:
        the client-initialize script of the report design
      • setClientInitialize

        public void setClientInitialize​(java.lang.String script)
                                 throws SemanticException
        Sets the client-initialize script of the report design.
        Parameters:
        script - the script to set
        Throws:
        SemanticException - if the method is locked.
        See Also:
        getClientInitialize()
      • getLanguage

        public java.lang.String getLanguage()
        Gets the language of the report design.
        Returns:
        the language of the report design
      • setLanguage

        public void setLanguage​(java.lang.String language)
                         throws SemanticException
        Sets the language of the report design.
        Parameters:
        language - the language to set
        Throws:
        SemanticException - if the method is locked.
      • addTranslation

        public void addTranslation​(java.lang.String resourceKey,
                                   java.lang.String locale,
                                   java.lang.String text)
                            throws CustomMsgException
        Description copied from class: ModuleHandleImpl
        Adds a new translation to the design.
        Overrides:
        addTranslation in class ModuleHandleImpl
        Parameters:
        resourceKey - resource key for the message
        locale - the string value of a locale for the translation. Locale should be in java-defined format( en, en-US, zh_CN, etc.)
        text - translated text for the locale
        Throws:
        CustomMsgException - if the resource key is duplicate or missing, or locale is not a valid format.
        See Also:
        ModuleHandleImpl.getTranslation(String, String)
      • dropImage

        public void dropImage​(java.util.List images)
                       throws SemanticException
        Description copied from class: ModuleHandleImpl
        Drops an embedded image handle list from the design. Each one in the list is the instance of EmbeddedImageHandle.
        Overrides:
        dropImage in class ModuleHandleImpl
        Parameters:
        images - the image handle list to remove
        Throws:
        SemanticException - if any image in the list is not found.
      • getComponents

        public SlotHandle getComponents()
        Description copied from class: ModuleHandleImpl
        Returns a slot handle to work with the top-level components within the report.
        Overrides:
        getComponents in class ModuleHandleImpl
        Returns:
        A handle for working with the components.
      • getDataSets

        public SlotHandle getDataSets()
        Description copied from class: ModuleHandleImpl
        Returns a slot handle to work with the data sets within the report. Note that the order of the data sets within the slot is unimportant.
        Overrides:
        getDataSets in class ModuleHandleImpl
        Returns:
        A handle for working with the data sets.
      • getDataSources

        public SlotHandle getDataSources()
        Description copied from class: ModuleHandleImpl
        Returns a slot handle to work with the data sources within the report. Note that the order of the data sources within the slot is unimportant.
        Overrides:
        getDataSources in class ModuleHandleImpl
        Returns:
        A handle for working with the data sources.
      • getFlattenParameters

        public java.util.List getFlattenParameters()
        Description copied from class: ModuleHandleImpl
        Returns the flatten Parameters/ParameterGroups of the design. This method put all Parameters and ParameterGroups into a list then return it. The return list is sorted by on the display name of the parameters.
        Overrides:
        getFlattenParameters in class ModuleHandleImpl
        Returns:
        the sorted, flatten parameters and parameter groups.
      • getMasterPages

        public SlotHandle getMasterPages()
        Description copied from class: ModuleHandleImpl
        Returns a slot handle to work with the master pages within the report. Note that the order of the master pages within the slot is unimportant.
        Overrides:
        getMasterPages in class ModuleHandleImpl
        Returns:
        A handle for working with the master pages.
      • getParameters

        public SlotHandle getParameters()
        Description copied from class: ModuleHandleImpl
        Returns a slot handle to work with the top-level parameters and parameter groups within the report. The order that the items appear within the slot determines the order in which they appear in the "requester" UI.
        Overrides:
        getParameters in class ModuleHandleImpl
        Returns:
        A handle for working with the parameters and parameter groups.
      • imagesIterator

        public java.util.Iterator imagesIterator()
        Description copied from class: ModuleHandleImpl
        Returns the iterator over all embedded images of this module instance. Each one is the instance of EmbeddedImageHandle
        Overrides:
        imagesIterator in class ModuleHandleImpl
        Returns:
        the iterator over all embedded images.
        See Also:
        EmbeddedImageHandle
      • getAllStyles

        public java.util.List getAllStyles()
        Description copied from class: ModuleHandleImpl
        Returns all style element handles that this modules and the included modules contain.
        Overrides:
        getAllStyles in class ModuleHandleImpl
        Returns:
        all style element handles that this modules and the included modules contain.
      • getVisibleThemes

        public java.util.List getVisibleThemes​(int level)
        Description copied from class: ModuleHandleImpl
        Returns theme handles according the input level.
        Overrides:
        getVisibleThemes in class ModuleHandleImpl
        Parameters:
        level - an int value, which should be the one defined in IVisibleLevelControl.
        Returns:
        theme handles according the input level
      • getVisibleReportItemThemes

        public java.util.List<ReportItemThemeHandle> getVisibleReportItemThemes​(int level,
                                                                                java.lang.String type)
        Description copied from class: ModuleHandleImpl
        Returns report item theme handles according the input level.
        Overrides:
        getVisibleReportItemThemes in class ModuleHandleImpl
        Parameters:
        level - an int value, which should be the one defined in IVisibleLevelControl.
        Returns:
        theme handles according the input level
      • getParametersAndParameterGroups

        public java.util.List getParametersAndParameterGroups()
        Description copied from class: ModuleHandleImpl
        Returns parameters and parameter groups on the module. Those parameters included in the parameter groups are not included in the return list.
        Overrides:
        getParametersAndParameterGroups in class ModuleHandleImpl
        Returns:
        parameters and parameter groups
      • getAllPages

        public java.util.List getAllPages()
        Description copied from class: ModuleHandleImpl
        Returns all page handles that this modules and the included modules contain.
        Overrides:
        getAllPages in class ModuleHandleImpl
        Returns:
        all page handles that this modules and the included modules contain.
      • shiftLibrary

        public void shiftLibrary​(LibraryHandle library,
                                 int toPosn)
                          throws SemanticException
        Description copied from class: ModuleHandleImpl
        Shifts the library to new position. This method might affect the style reference, because the library order is changed.
        Overrides:
        shiftLibrary in class ModuleHandleImpl
        Parameters:
        library - the library to shift
        toPosn - the new position
        Throws:
        SemanticException - if error is encountered when shifting
      • includeLibrary

        public void includeLibrary​(java.lang.String libraryFileName,
                                   java.lang.String namespace)
                            throws DesignFileException,
                                   SemanticException
        Description copied from class: ModuleHandleImpl
        Includes one library with the given library file name. The new library will be appended to the library list.
        Overrides:
        includeLibrary in class ModuleHandleImpl
        Parameters:
        libraryFileName - library file name
        namespace - library namespace
        Throws:
        DesignFileException - if the library file is not found, or has fatal error.
        SemanticException - if error is encountered when handling IncludeLibrary structure list.
      • dropLibrary

        public void dropLibrary​(LibraryHandle library)
                         throws SemanticException
        Description copied from class: ModuleHandleImpl
        Drops the given library from the included libraries of this design file.
        Overrides:
        dropLibrary in class ModuleHandleImpl
        Parameters:
        library - the library to drop
        Throws:
        SemanticException - if error is encountered when handling IncludeLibrary structure list. Or it maybe because that the given library is not found in the design. Or that the library has descedents in the current module
      • reloadLibrary

        public void reloadLibrary​(LibraryHandle libraryToReload)
                           throws SemanticException,
                                  DesignFileException
        Description copied from class: ModuleHandleImpl
        Reloads the library with the given library file path. If the library already is included directly, reload it. If the library is not included, exception will be thrown.

        Call this method cautiously ONLY on the condition that the library file is REALLY changed outside. After reload successfully, the command stack is cleared.

        Overrides:
        reloadLibrary in class ModuleHandleImpl
        Parameters:
        libraryToReload - the library instance
        Throws:
        SemanticException - if error is encountered when handling IncludeLibrary structure list. Or it maybe because that the given library is not found in the design. Or that the library has descedents in the current module
        DesignFileException - if the library file is not found, or has fatal error.
      • reloadLibrary

        public void reloadLibrary​(java.lang.String reloadPath)
                           throws SemanticException,
                                  DesignFileException
        Description copied from class: ModuleHandleImpl
        Reloads the library with the given library file path. If the library already is included directly or indirectly(that is, the reload path could be the path of grandson of this module), reload it. If the library is not included, exception will be thrown.

        Call this method cautiously ONLY on the condition that the library file is REALLY changed outside. After reload successfully, the command stack is cleared.

        Overrides:
        reloadLibrary in class ModuleHandleImpl
        Parameters:
        reloadPath - this is supposed to be an absolute path, not in url form.
        Throws:
        SemanticException - if error is encountered when handling IncludeLibrary structure list. Or it maybe because that the given library is not found in the design. Or that the library has descedents in the current module
        DesignFileException - if the library file is not found, or has fatal error.
      • dropLibraryAndBreakExtends

        public void dropLibraryAndBreakExtends​(LibraryHandle library)
                                        throws SemanticException
        Description copied from class: ModuleHandleImpl
        Drops the given library from the design and break all the parent/child relationships. All child element will be localized in the module.
        Overrides:
        dropLibraryAndBreakExtends in class ModuleHandleImpl
        Parameters:
        library - the given library to drop
        Throws:
        SemanticException - if errors occured when drop the library.It may be because that the library is not found in the design or that some elements can not be localized properly.
      • openCssStyleSheet

        public CssStyleSheetHandle openCssStyleSheet​(java.lang.String fileName)
                                              throws StyleSheetException
        Description copied from class: ModuleHandleImpl
        Gets the result style sheet with given file name of an external CSS2 resource.
        Overrides:
        openCssStyleSheet in class ModuleHandleImpl
        Parameters:
        fileName - the file name of the external CSS resource
        Returns:
        the CssStyleSheetHandle if the external resource is successfully loaded
        Throws:
        StyleSheetException - thrown if the resource is not found, or there are syntax errors in the resource
      • openCssStyleSheet

        public CssStyleSheetHandle openCssStyleSheet​(java.io.InputStream is)
                                              throws StyleSheetException
        Description copied from class: ModuleHandleImpl
        Gets the result style sheet with given file name of an external CSS2 resource.
        Overrides:
        openCssStyleSheet in class ModuleHandleImpl
        Parameters:
        is - the input stream of the resource
        Returns:
        the CssStyleSheetHandle if the external resource is successfully loaded
        Throws:
        StyleSheetException - thrown if the resource is not found, or there are syntax errors in the resource