Class LibraryHandle

All Implemented Interfaces:
IModuleModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IInternalLibraryModel, org.eclipse.birt.report.model.elements.interfaces.ILibraryModel

public class LibraryHandle extends LibraryHandleImpl implements org.eclipse.birt.report.model.elements.interfaces.ILibraryModel
Represents the handle of library element. The library contains the resuable element components.
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.
Translations The list of externalized messages specifically for this report.
Images A list of images embedded in this report.

There are two cases that this library handle represents:

  • the library file that user opens directly
    In this case, user can take operations as same as design file.
  • the library file that is included in one design file
    User can not take operations, because the included library file is read-only. Any operation on the library file of this type will throw runtime exception.
  • Constructor Details

    • LibraryHandle

      public LibraryHandle(org.eclipse.birt.report.model.elements.Library library)
      Constructs one library handle with the given library element.
      Parameters:
      library - library element
  • Method Details