|
||||||||||
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
public class 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, SUBJECT_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, NEW_HANDLER_ON_EACH_EVENT_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 | |
---|---|
void |
addConfigVariable(ConfigVariable configVar)
Adds a new config variable. |
void |
addImage(EmbeddedImage image)
Adds a new embedded image. |
void |
addTranslation(java.lang.String resourceKey,
java.lang.String locale,
java.lang.String text)
Adds a new translation to the design. |
void |
dropConfigVariable(java.lang.String name)
Drops a config variable. |
void |
dropImage(java.util.List images)
Drops an embedded image handle list from the design. |
void |
dropImage(java.lang.String name)
Drops an embedded image from the design. |
void |
dropLibrary(LibraryHandle library)
Drops the given library from the included libraries of this design file. |
void |
dropLibraryAndBreakExtends(LibraryHandle library)
Drops the given library from the design and break all the parent/child relationships. |
void |
dropTranslation(java.lang.String resourceKey,
java.lang.String locale)
Drops a translation from the design. |
java.util.List |
getAllPages()
Returns all page handles that this modules and the included modules contain. |
java.util.List |
getAllStyles()
Returns all style element handles that this modules and the included modules contain. |
SlotHandle |
getComponents()
Returns a slot handle to work with the top-level components within the report. |
SlotHandle |
getCubes()
Gets the slot handle to work with all cube elements within the report. |
SlotHandle |
getDataSets()
Returns a slot handle to work with the data sets within the report. |
SlotHandle |
getDataSources()
Returns a slot handle to work with the data sources within the report. |
java.util.List |
getFlattenParameters()
Returns the flatten Parameters/ParameterGroups of the design. |
ModuleHandle |
getHostHandle()
Returns the host handle which includes the library. |
SlotHandle |
getMasterPages()
Returns a slot handle to work with the master pages within the report. |
java.lang.String |
getNamespace()
Returns the library namespace, which identifies one library unqiuely in one design file. |
SlotHandle |
getParameters()
Returns a slot handle to work with the top-level parameters and parameter groups within the report. |
java.util.List |
getParametersAndParameterGroups()
Returns parameters and parameter groups on the module. |
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. |
java.util.List<ReportItemThemeHandle> |
getVisibleReportItemThemes(int level,
java.lang.String type)
Returns report item theme handles according the input level. |
java.util.List |
getVisibleThemes(int level)
Returns theme handles according the input level. |
java.util.Iterator |
imagesIterator()
Returns the iterator over all embedded images of this module instance. |
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. |
java.util.Iterator |
includeLibrariesIterator()
Returns the iterator over all included libraries. |
void |
includeLibrary(java.lang.String libraryFileName,
java.lang.String namespace)
Includes one library with the given library file name. |
boolean |
isDirectionRTL()
Examines whether the resolved direction of this design element is Right to Left or not. |
CssStyleSheetHandle |
openCssStyleSheet(java.io.InputStream is)
Gets the result style sheet with given file name of an external CSS2 resource. |
CssStyleSheetHandle |
openCssStyleSheet(java.lang.String fileName)
Gets the result style sheet with given file name of an external CSS2 resource. |
void |
reloadLibraries()
Reloads all libraries this module included. |
void |
reloadLibrary(LibraryHandle libraryToReload)
Reloads the library with the given library file path. |
void |
reloadLibrary(java.lang.String reloadPath)
Reloads the library with the given library file path. |
void |
replaceConfigVariable(ConfigVariable oldVar,
ConfigVariable newVar)
Replaces the old config variable with the new one. |
void |
replaceImage(EmbeddedImage oldVar,
EmbeddedImage newVar)
Replaces the old embedded image with the new one. |
void |
setTheme(ThemeHandle theme)
Sets the theme to a report. |
void |
setThemeName(java.lang.String themeName)
Sets the theme to a report. |
void |
shiftLibrary(LibraryHandle library,
int toPosn)
Shifts the library to new position. |
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 java.lang.String getNamespace()
public SlotHandle getThemes()
public SlotHandle getStyles()
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()
public boolean isDirectionRTL()
DesignElementHandle
isDirectionRTL
in class DesignElementHandle
public void addConfigVariable(ConfigVariable configVar) throws SemanticException
ModuleHandle
addConfigVariable
in class ModuleHandle
configVar
- the config variable
SemanticException
- if the name is empty or the same name exists.public void addImage(EmbeddedImage image) throws SemanticException
ModuleHandle
addImage
in class ModuleHandle
image
- the image to add
SemanticException
- if the name is empty, type is invalid, or the same name
exists.public void addTranslation(java.lang.String resourceKey, java.lang.String locale, java.lang.String text) throws CustomMsgException
ModuleHandle
addTranslation
in class ModuleHandle
resourceKey
- resource key for the messagelocale
- 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
CustomMsgException
- if the resource key is duplicate or missing, or locale is not
a valid format.ModuleHandle.getTranslation(String, String)
public void dropConfigVariable(java.lang.String name) throws SemanticException
ModuleHandle
dropConfigVariable
in class ModuleHandle
name
- config variable name
SemanticException
- if no config variable is found.public void dropImage(java.util.List images) throws SemanticException
ModuleHandle
EmbeddedImageHandle
.
dropImage
in class ModuleHandle
images
- the image handle list to remove
SemanticException
- if any image in the list is not found.public void dropImage(java.lang.String name) throws SemanticException
ModuleHandle
dropImage
in class ModuleHandle
name
- the image name
SemanticException
- if the image is not found.public void dropTranslation(java.lang.String resourceKey, java.lang.String locale) throws CustomMsgException
ModuleHandle
dropTranslation
in class ModuleHandle
resourceKey
- resource key of the message in which this translation saves.locale
- the string value of the locale for a translation. Locale
should be in java-defined format( en, en-US, zh_CN, etc.)
CustomMsgException
- if resourceKey
is null
.ModuleHandle.getTranslation(String, String)
public SlotHandle getComponents()
ModuleHandle
getComponents
in class ModuleHandle
public SlotHandle getDataSets()
ModuleHandle
getDataSets
in class ModuleHandle
public SlotHandle getDataSources()
ModuleHandle
getDataSources
in class ModuleHandle
public java.util.List getFlattenParameters()
ModuleHandle
getFlattenParameters
in class ModuleHandle
public SlotHandle getMasterPages()
ModuleHandle
getMasterPages
in class ModuleHandle
public SlotHandle getParameters()
ModuleHandle
getParameters
in class ModuleHandle
public java.util.Iterator imagesIterator()
ModuleHandle
EmbeddedImageHandle
imagesIterator
in class ModuleHandle
EmbeddedImageHandle
public void replaceConfigVariable(ConfigVariable oldVar, ConfigVariable newVar) throws SemanticException
ModuleHandle
replaceConfigVariable
in class ModuleHandle
oldVar
- the old config variablenewVar
- the new config variable
SemanticException
- if the old config variable is not found or the name of new
one is empty.public void replaceImage(EmbeddedImage oldVar, EmbeddedImage newVar) throws SemanticException
ModuleHandle
replaceImage
in class ModuleHandle
oldVar
- the old embedded imagenewVar
- the new embedded image
SemanticException
- if the old image is not found or the name of new one is
empty.public java.util.List getAllStyles()
ModuleHandle
getAllStyles
in class ModuleHandle
public java.util.List getVisibleThemes(int level)
ModuleHandle
getVisibleThemes
in class ModuleHandle
level
- an int
value, which should be the one defined in
IVisibleLevelControl
.
public java.util.List<ReportItemThemeHandle> getVisibleReportItemThemes(int level, java.lang.String type)
ModuleHandle
getVisibleReportItemThemes
in class ModuleHandle
level
- an int
value, which should be the one defined in
IVisibleLevelControl
.
public java.util.List getParametersAndParameterGroups()
ModuleHandle
getParametersAndParameterGroups
in class ModuleHandle
public java.util.List getAllPages()
ModuleHandle
getAllPages
in class ModuleHandle
public void shiftLibrary(LibraryHandle library, int toPosn) throws SemanticException
ModuleHandle
shiftLibrary
in class ModuleHandle
library
- the library to shifttoPosn
- the new position
SemanticException
- if error is encountered when shiftingpublic java.util.Iterator includeLibrariesIterator()
ModuleHandle
IncludeLibraryHandle
includeLibrariesIterator
in class ModuleHandle
IncludedLibraryHandle
public void includeLibrary(java.lang.String libraryFileName, java.lang.String namespace) throws DesignFileException, SemanticException
ModuleHandle
includeLibrary
in class ModuleHandle
libraryFileName
- library file namenamespace
- library namespace
DesignFileException
- if the library file is not found, or has fatal error.
SemanticException
- if error is encountered when handling IncludeLibrary
structure list.public void dropLibrary(LibraryHandle library) throws SemanticException
ModuleHandle
dropLibrary
in class ModuleHandle
library
- the library to drop
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 modulepublic void reloadLibrary(LibraryHandle libraryToReload) throws SemanticException, DesignFileException
ModuleHandle
Call this method cautiously ONLY on the condition that the library file is REALLY changed outside. After reload successfully, the command stack is cleared.
reloadLibrary
in class ModuleHandle
libraryToReload
- the library instance
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.public void reloadLibraries() throws SemanticException, DesignFileException
ModuleHandle
Call this method cautiously ONLY on the condition that the library file
is REALLY changed outside. After reload successfully, the command stack
is cleared.
ModuleHandle.reloadLibrary(LibraryHandle)
reloadLibraries
in class ModuleHandle
SemanticException
DesignFileException
public void reloadLibrary(java.lang.String reloadPath) throws SemanticException, DesignFileException
ModuleHandle
Call this method cautiously ONLY on the condition that the library file is REALLY changed outside. After reload successfully, the command stack is cleared.
reloadLibrary
in class ModuleHandle
reloadPath
- this is supposed to be an absolute path, not in url form.
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.public void dropLibraryAndBreakExtends(LibraryHandle library) throws SemanticException
ModuleHandle
dropLibraryAndBreakExtends
in class ModuleHandle
library
- the given library to drop
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.public CssStyleSheetHandle openCssStyleSheet(java.lang.String fileName) throws StyleSheetException
ModuleHandle
openCssStyleSheet
in class ModuleHandle
fileName
- the file name of the external CSS resource
CssStyleSheetHandle
if the external resource is
successfully loaded
StyleSheetException
- thrown if the resource is not found, or there are syntax
errors in the resourcepublic CssStyleSheetHandle openCssStyleSheet(java.io.InputStream is) throws StyleSheetException
ModuleHandle
openCssStyleSheet
in class ModuleHandle
is
- the input stream of the resource
CssStyleSheetHandle
if the external resource is
successfully loaded
StyleSheetException
- thrown if the resource is not found, or there are syntax
errors in the resourcepublic void setThemeName(java.lang.String themeName) throws SemanticException
ModuleHandle
setThemeName
in class ModuleHandle
themeName
- the name of the theme
SemanticException
public void setTheme(ThemeHandle theme) throws SemanticException
ModuleHandle
setTheme
in class ModuleHandle
theme
- the theme instance
SemanticException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |