|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ModuleHandle
org.eclipse.birt.report.model.api.LibraryHandle
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:
Field Summary |
Fields inherited from class org.eclipse.birt.report.model.api.ModuleHandle |
isInitialized |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.ILibraryModel |
CUBE_SLOT, SLOT_COUNT, THEMES_SLOT |
Fields inherited from interface org.eclipse.birt.report.model.api.core.IModuleModel |
AUTHOR_PROP, BASE_PROP, COLOR_PALETTE_PROP, COMPONENT_SLOT, CONFIG_VARS_PROP, CREATED_BY_PROP, DATA_SET_SLOT, DATA_SOURCE_SLOT, DESCRIPTION_ID_PROP, DESCRIPTION_PROP, HELP_GUIDE_PROP, IMAGES_PROP, INCLUDE_RESOURCE_PROP, INCLUDE_SCRIPTS_PROP, INITIALIZE_METHOD, LIBRARIES_PROP, PAGE_SLOT, PARAMETER_SLOT, PROPERTY_BINDINGS_PROP, SCRIPTLIBS_PROP, THEME_PROP, TITLE_ID_PROP, TITLE_PROP, UNITS_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel |
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
LibraryHandle(org.eclipse.birt.report.model.elements.Library library)
Constructs one library handle with the given library element. |
Method Summary | |
SlotHandle |
getCubes()
Gets the slot handle to work with all cube elements within the report. |
org.eclipse.birt.report.model.core.DesignElement |
getElement()
Returns the element to which this handle is attached. |
ModuleHandle |
getHostHandle()
Returns the host handle which includes the library. |
java.lang.String |
getNamespace()
Returns the library namespace, which identifies one library unqiuely in one design file. |
java.lang.String |
getRelativeFileName()
If this library is included by a module, return the relative file name that is defined in the host's xml file. |
SlotHandle |
getStyles()
Deprecated. uses the theme instead |
SlotHandle |
getThemes()
Returns a slot handle to work with the themes within the library. |
void |
importCssStyles(CssStyleSheetHandle stylesheet,
java.util.List selectedStyles)
Import css file to theme. |
void |
importCssStyles(CssStyleSheetHandle stylesheet,
java.util.List selectedStyles,
java.lang.String themeName)
Imports the selected styles in a CssStyleSheetHandle to
the given theme of the library. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public LibraryHandle(org.eclipse.birt.report.model.elements.Library library)
library
- library elementMethod Detail |
public ModuleHandle getHostHandle()
public org.eclipse.birt.report.model.core.DesignElement getElement()
DesignElementHandle
getElement
in class ModuleHandle
public java.lang.String getNamespace()
public SlotHandle getThemes()
public SlotHandle getStyles()
getStyles
in class ModuleHandle
null
if
the library has no values for the theme propertypublic void importCssStyles(CssStyleSheetHandle stylesheet, java.util.List selectedStyles)
importCssStyles
in class ModuleHandle
stylesheet
- the style sheet handle that contains all the selected stylesselectedStyles
- the selected style listpublic void importCssStyles(CssStyleSheetHandle stylesheet, java.util.List selectedStyles, java.lang.String themeName)
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.
stylesheet
- the style sheet handle that contains all the selected stylesselectedStyles
- the selected style listthemeName
- the name of the theme to put stylespublic SlotHandle getCubes()
ModuleHandle
getCubes
in class ModuleHandle
public java.lang.String getRelativeFileName()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |