public abstract class LibraryHandleImpl extends ModuleHandle implements org.eclipse.birt.report.model.elements.interfaces.ILibraryModel
isInitializedmoduleCUBE_SLOT, SLOT_COUNT, THEMES_SLOTAUTHOR_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_PROPCOMMENTS_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| 构造器和说明 |
|---|
LibraryHandleImpl(org.eclipse.birt.report.model.core.Module module) |
| 限定符和类型 | 方法和说明 |
|---|---|
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()
已过时。
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.
|
addAttributeListener, addDisposeListener, addIncludeScript, addResourceChangeListener, addScriptLib, addValidationListener, checkReport, checkReportIfNecessary, close, configVariablesIterator, copy, customColorsIterator, drop, dropAllScriptLibs, dropAndClear, dropIncludeScript, dropScriptLib, dropScriptLib, findCascadingParameterGroup, findColor, findConfigVariable, findCube, findDataSet, findDataSource, findDimension, findElement, findImage, findJointDataSet, findLevel, findLibrary, findMasterPage, findNativeStyle, findParameter, findReportItemTheme, findResource, findResource, findScriptLib, findStyle, findTemplateDataSet, findTheme, generateHandleList, getAllCubes, getAllDataSets, getAllDataSources, getAllImages, getAllIncludeScripts, getAllLibraries, getAllParameters, getAllScriptLibs, getAllSharedDimensions, getAuthor, getCommandStack, getComments, getCreatedBy, getDefaultUnits, getDescription, getDescriptionKey, getDisplayDescription, getElement, getElementByID, getErrorList, getFileEncoding, getFileName, getHelpGuide, getIncludeResource, getIncludeResources, getInitialize, getLibraries, getLibraries, getLibrary, getLineNo, getLineNoByID, getMessage, getMessage, getMessage, getMessageKeys, getNativeStructureList, getOptions, getResourceFolder, getSubject, getSymbolicName, getSystemId, getTheme, getTitle, getTitleKey, getTranslation, getTranslationKeys, getTranslations, getVersion, getVisibleCubes, getVisibleDataSets, getVisibleDataSources, getVisibleImages, getVisibleModules, getWarningList, includeScriptsIterator, initializeModule, isInclude, isReadOnly, needsSave, onSave, removeAttributeListener, removeDisposeListener, removeResourceChangeListener, removeValidationListener, rename, rename, rename, save, saveAs, scriptLibsIterator, serialize, setAuthor, setComments, setCreatedBy, setDefaultUnits, setDescription, setDescriptionKey, setFileName, setHelpGuide, setIncludeResource, setIncludeResources, setInitialize, setOptions, setResourceFolder, setSubject, setSymbolicName, setTitle, setTitleKey, shifIncludeScripts, shiftScriptLibs, sortVisibleElementsadd, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, drop, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExpressionProperty, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isInTemplateParameter, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setBooleanProperty, setEncryption, setEventHandlerClass, setExpressionProperty, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setProperty, setPropertyBinding, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError, slotsIteratorpublic LibraryHandleImpl(org.eclipse.birt.report.model.core.Module module)
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 在类中 ModuleHandleImplstylesheet - 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()
ModuleHandleImplgetCubes 在类中 ModuleHandleImplpublic java.lang.String getRelativeFileName()
public boolean isDirectionRTL()
DesignElementHandleisDirectionRTL 在类中 DesignElementHandlepublic void addConfigVariable(ConfigVariable configVar) throws SemanticException
ModuleHandleImpladdConfigVariable 在类中 ModuleHandleImplconfigVar - the config variableSemanticException - if the name is empty or the same name exists.public void addImage(EmbeddedImage image) throws SemanticException
ModuleHandleImpladdImage 在类中 ModuleHandleImplimage - the image to addSemanticException - 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
ModuleHandleImpladdTranslation 在类中 ModuleHandleImplresourceKey - 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 localeCustomMsgException - if the resource key is duplicate or missing, or locale is not
a valid format.ModuleHandleImpl.getTranslation(String, String)public void dropConfigVariable(java.lang.String name)
throws SemanticException
ModuleHandleImpldropConfigVariable 在类中 ModuleHandleImplname - config variable nameSemanticException - if no config variable is found.public void dropImage(java.util.List images)
throws SemanticException
ModuleHandleImplEmbeddedImageHandle.dropImage 在类中 ModuleHandleImplimages - the image handle list to removeSemanticException - if any image in the list is not found.public void dropImage(java.lang.String name)
throws SemanticException
ModuleHandleImpldropImage 在类中 ModuleHandleImplname - the image nameSemanticException - if the image is not found.public void dropTranslation(java.lang.String resourceKey,
java.lang.String locale)
throws CustomMsgException
ModuleHandleImpldropTranslation 在类中 ModuleHandleImplresourceKey - 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.ModuleHandleImpl.getTranslation(String, String)public SlotHandle getComponents()
ModuleHandleImplgetComponents 在类中 ModuleHandleImplpublic SlotHandle getDataSets()
ModuleHandleImplgetDataSets 在类中 ModuleHandleImplpublic SlotHandle getDataSources()
ModuleHandleImplgetDataSources 在类中 ModuleHandleImplpublic java.util.List getFlattenParameters()
ModuleHandleImplgetFlattenParameters 在类中 ModuleHandleImplpublic SlotHandle getMasterPages()
ModuleHandleImplgetMasterPages 在类中 ModuleHandleImplpublic SlotHandle getParameters()
ModuleHandleImplgetParameters 在类中 ModuleHandleImplpublic java.util.Iterator imagesIterator()
ModuleHandleImplEmbeddedImageHandleimagesIterator 在类中 ModuleHandleImplEmbeddedImageHandlepublic void replaceConfigVariable(ConfigVariable oldVar, ConfigVariable newVar) throws SemanticException
ModuleHandleImplreplaceConfigVariable 在类中 ModuleHandleImploldVar - the old config variablenewVar - the new config variableSemanticException - 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
ModuleHandleImplreplaceImage 在类中 ModuleHandleImploldVar - the old embedded imagenewVar - the new embedded imageSemanticException - if the old image is not found or the name of new one is
empty.public java.util.List getAllStyles()
ModuleHandleImplgetAllStyles 在类中 ModuleHandleImplpublic java.util.List getVisibleThemes(int level)
ModuleHandleImplgetVisibleThemes 在类中 ModuleHandleImpllevel - an int value, which should be the one defined in
IVisibleLevelControl.public java.util.List<ReportItemThemeHandle> getVisibleReportItemThemes(int level, java.lang.String type)
ModuleHandleImplgetVisibleReportItemThemes 在类中 ModuleHandleImpllevel - an int value, which should be the one defined in
IVisibleLevelControl.public java.util.List getParametersAndParameterGroups()
ModuleHandleImplgetParametersAndParameterGroups 在类中 ModuleHandleImplpublic java.util.List getAllPages()
ModuleHandleImplgetAllPages 在类中 ModuleHandleImplpublic void shiftLibrary(LibraryHandle library, int toPosn) throws SemanticException
ModuleHandleImplshiftLibrary 在类中 ModuleHandleImpllibrary - the library to shifttoPosn - the new positionSemanticException - if error is encountered when shiftingpublic java.util.Iterator includeLibrariesIterator()
ModuleHandleImplIncludeLibraryHandleincludeLibrariesIterator 在类中 ModuleHandleImplIncludedLibraryHandlepublic void includeLibrary(java.lang.String libraryFileName,
java.lang.String namespace)
throws DesignFileException,
SemanticException
ModuleHandleImplincludeLibrary 在类中 ModuleHandleImpllibraryFileName - library file namenamespace - library namespaceDesignFileException - 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
ModuleHandleImpldropLibrary 在类中 ModuleHandleImpllibrary - the library to dropSemanticException - 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
ModuleHandleImplCall this method cautiously ONLY on the condition that the library file is REALLY changed outside. After reload successfully, the command stack is cleared.
reloadLibrary 在类中 ModuleHandleImpllibraryToReload - the library instanceSemanticException - 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 moduleDesignFileException - if the library file is not found, or has fatal error.public void reloadLibraries()
throws SemanticException,
DesignFileException
ModuleHandleImpl
Call this method cautiously ONLY on the condition that the library file
is REALLY changed outside. After reload successfully, the command stack
is cleared.
ModuleHandleImpl.reloadLibrary(LibraryHandle)
public void reloadLibrary(java.lang.String reloadPath)
throws SemanticException,
DesignFileException
ModuleHandleImplCall this method cautiously ONLY on the condition that the library file is REALLY changed outside. After reload successfully, the command stack is cleared.
reloadLibrary 在类中 ModuleHandleImplreloadPath - 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 moduleDesignFileException - if the library file is not found, or has fatal error.public void dropLibraryAndBreakExtends(LibraryHandle library) throws SemanticException
ModuleHandleImpldropLibraryAndBreakExtends 在类中 ModuleHandleImpllibrary - the given library to dropSemanticException - 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
ModuleHandleImplopenCssStyleSheet 在类中 ModuleHandleImplfileName - the file name of the external CSS resourceCssStyleSheetHandle if the external resource is
successfully loadedStyleSheetException - thrown if the resource is not found, or there are syntax
errors in the resourcepublic CssStyleSheetHandle openCssStyleSheet(java.io.InputStream is) throws StyleSheetException
ModuleHandleImplopenCssStyleSheet 在类中 ModuleHandleImplis - the input stream of the resourceCssStyleSheetHandle if the external resource is
successfully loadedStyleSheetException - thrown if the resource is not found, or there are syntax
errors in the resourcepublic void setThemeName(java.lang.String themeName)
throws SemanticException
ModuleHandleImplsetThemeName 在类中 ModuleHandleImplthemeName - the name of the themeSemanticExceptionpublic void setTheme(ThemeHandle theme) throws SemanticException
ModuleHandleImplsetTheme 在类中 ModuleHandleImpltheme - the theme instanceSemanticExceptionCopyright © 2008 Actuate Corp. All rights reserved.