Class ReportDesignHandle
- java.lang.Object
-
- org.eclipse.birt.report.model.api.DesignElementHandle
-
- org.eclipse.birt.report.model.api.ModuleHandleImpl
-
- org.eclipse.birt.report.model.api.ModuleHandle
-
- org.eclipse.birt.report.model.api.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
-
-
Field Summary
-
Fields inherited from class org.eclipse.birt.report.model.api.ModuleHandleImpl
isInitialized
-
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
module
-
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
-
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IInternalReportDesignModel
ACL_EXPRESSION_PROP, AFTER_FACTORY_METHOD, AFTER_RENDER_METHOD, BEFORE_FACTORY_METHOD, BEFORE_RENDER_METHOD, BIDI_ORIENTATION_PROP, BODY_SLOT, CASCADE_ACL_PROP, CHARSET, CHEAT_SHEET_PROP, CLIENT_INITIALIZE_METHOD, CSSES_PROP, CUBE_SLOT, DATA_OBJECTS_PROP, ENABLE_ACL_PROP, EXTERNAL_METADATA_PROP, ICON_FILE_PROP, IMAGE_DPI_PROP, LANGUAGE_PROP, LAYOUT_PREFERENCE_PROP, LOCALE_PROP, ON_PAGE_END_METHOD, ON_PAGE_START_METHOD, ON_PREPARE_METHOD, PAGE_VARIABLES_PROP, REFRESH_RATE_PROP, SCRATCH_PAD_SLOT, SLOT_COUNT, STYLE_SLOT, TEMPLATE_PARAMETER_DEFINITION_SLOT, THEMES_SLOT, THUMBNAIL_PROP
-
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
-
-
Constructor Summary
Constructors Constructor Description ReportDesignHandle(org.eclipse.birt.report.model.elements.ReportDesign design)Constructs a handle with the given design.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddConfigVariable(ConfigVariable configVar)Adds a new config variable.voidaddCss(java.lang.String fileName)Deprecated.voidaddCss(CssStyleSheetHandle sheetHandle)Includes one css with the given css file name.voidaddCss(IncludedCssStyleSheet cssStruct)Includes one CSS structure with the given IncludedCssStyleSheet.voidaddCssByProperties(java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss)Includes one css with the given css file name.voidaddImage(EmbeddedImage image)Adds a new embedded image.voidaddTranslation(java.lang.String resourceKey, java.lang.String locale, java.lang.String text)Adds a new translation to the design.voidaddVariable(VariableElementHandle variable)Adds data variable that user defined on the report design.voidcacheValues()Caches values for all elements, styles, etc.booleancanAddCssStyleSheet(java.lang.String fileName)Deprecated.booleancanAddCssStyleSheet(CssStyleSheetHandle sheetHandle)Check style sheet can be added or not.booleancanAddCssStyleSheetByProperties(java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss)Check style sheet can be added or not.booleancanDropCssStyleSheet(CssStyleSheetHandle sheetHandle)Check style sheet can be droped or not.booleancanRenameCss(IncludedCssStyleSheetHandle handle, java.lang.String newFileName)Deprecated.booleancanRenameCssByProperties(IncludedCssStyleSheetHandle handle, java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss)Checks css can be renamed or not.booleancascadeACL()Returnstrue(the default), the design's ACL is automatically propagated to all its directly contained child elements and are added to their ACLs.voiddeleteThumbnail()Deletes the thumbnail image in the design.voiddropConfigVariable(java.lang.String name)Drops a config variable.voiddropCss(CssStyleSheetHandle sheetHandle)Drops the given css style sheet of this design file.voiddropImage(java.lang.String name)Drops an embedded image from the design.voiddropImage(java.util.List images)Drops an embedded image handle list from the design.voiddropLibrary(LibraryHandle library)Drops the given library from the included libraries of this design file.voiddropLibraryAndBreakExtends(LibraryHandle library)Drops the given library from the design and break all the parent/child relationships.voiddropTranslation(java.lang.String resourceKey, java.lang.String locale)Drops a translation from the design.voiddropVariable(VariableElementHandle variable)Removes the given data variable.CssStyleSheetHandlefindCssStyleSheetHandleByFileName(java.lang.String fileName)Deprecated.CssStyleSheetHandlefindCssStyleSheetHandleByProperties(java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss)GetsCssStyleSheetHandleby file name.IncludedCssStyleSheetHandlefindIncludedCssStyleSheetHandleByFileName(java.lang.String fileName)Deprecated.IncludedCssStyleSheetHandlefindIncludedCssStyleSheetHandleByProperties(java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss)GetsIncludedCssStyleSheetHandleby properties.java.lang.StringgetACLExpression()Returns the ACL expression associated with the design instance.java.lang.StringgetAfterFactory()Returns the script called at the end of the Factory after closing the report document (if any).java.lang.StringgetAfterRender()Returns the script called after starting a presentation time action.java.util.ListgetAllBookmarks()Gets all bookmarks defined in this module.java.util.ListgetAllCssStyleSheets()Gets all css styles sheetjava.util.List<IncludedCssStyleSheetHandle>getAllExternalIncludedCsses()Gets the list of the included css style sheets that set the external URI.java.util.ListgetAllPages()Returns all page handles that this modules and the included modules contain.java.util.ListgetAllStyles()Returns all style element handles that this modules and the included modules contain.java.util.ListgetAllTocs()Gets all TOCs defined in this module.java.util.List<VariableElementHandle>getAllVariables()Gets all variable.java.lang.StringgetBase()Returns the base directory to use when computing relative links from this report.java.lang.StringgetBeforeFactory()Returns the script called at the start of the Factory after the initialize( ) method and before opening the report document (if any).java.lang.StringgetBeforeRender()Returns the script called before starting a presentation time action.java.lang.StringgetBidiOrientation()Gets Bidi orientation value.SlotHandlegetBody()Returns a slot handle to work with the sections in the report's Body slot.java.lang.StringgetCheatSheet()Gets the design cheat sheet file path.java.lang.StringgetClientInitialize()Gets the client-initialize script of the report design.SlotHandlegetComponents()Returns a slot handle to work with the top-level components within the report.SlotHandlegetCubes()Gets the slot handle to work with all cube elements within the report.SlotHandlegetDataSets()Returns a slot handle to work with the data sets within the report.SlotHandlegetDataSources()Returns a slot handle to work with the data sources within the report.java.lang.StringgetDisplayName()Gets the display name.java.lang.StringgetDisplayNameKey()Gets the resource key of the display name.DesignElementHandlegetFlattenElement(DesignElementHandle elementHandle, java.lang.String originalName)Gets the flatten element by the original name.java.util.ListgetFlattenParameters()Returns the flatten Parameters/ParameterGroups of the design.java.lang.StringgetIconFile()Gets the design icon/thumbnail file path.intgetImageDPI()Gets the image DPI of the report design.java.lang.StringgetLanguage()Gets the language of the report design.java.lang.StringgetLayoutPreference()Gets the layout preference of this report design.com.ibm.icu.util.ULocalegetLocale()Gets the locale of the report design.SlotHandlegetMasterPages()Returns a slot handle to work with the master pages within the report.java.lang.StringgetOnPageEnd()Gets the script of onPageEnd method.java.lang.StringgetOnPageStart()Gets the script of onPageStart method.java.lang.StringgetOnPrepare()Gets the on-prepare script of the report design.VariableElementHandlegetPageVariable(java.lang.String pageVariableName)Gets theaccording to the input page variable name. java.util.List<VariableElementHandle>getPageVariables()Gets the pageVariables list value which containsVariableElementHandle.SlotHandlegetParameters()Returns a slot handle to work with the top-level parameters and parameter groups within the report.java.util.ListgetParametersAndParameterGroups()Returns parameters and parameter groups on the module.intgetRefreshRate()Returns the refresh rate when viewing the report.java.util.ListgetReportItemsBasedonTempalates()Gets report items which holds a template definition, that is, report item in body slot and page slot.SlotHandlegetScratchPad()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.SlotHandlegetStyles()Returns a slot handle to work with the styles within the report.byte[]getThumbnail()Gets the thumbnail image encoded in ISO-8859-1.java.util.List<ReportItemThemeHandle>getVisibleReportItemThemes(int level, java.lang.String type)Returns report item theme handles according the input level.java.util.ListgetVisibleThemes(int level)Returns theme handles according the input level.java.util.IteratorimagesIterator()Returns the iterator over all embedded images of this module instance.voidimportCssStyles(CssStyleSheetHandle stylesheet, java.util.List selectedStyles)(non-Javadoc)java.util.IteratorincludeCssesIterator()Returns the iterator over all included css style sheets.java.util.IteratorincludeLibrariesIterator()Returns the iterator over all included libraries.voidincludeLibrary(java.lang.String libraryFileName, java.lang.String namespace)Includes one library with the given library file name.java.util.IteratorincludeLibraryScriptsIterator()Returns the list of all the included script file of the libraries.booleanisDirectionRTL()Examines whether the resolved direction of this design element is Right to Left or not.booleanisEnableACL()Returnstrueif the ACL feature is enable; otherwise false.CssStyleSheetHandleopenCssStyleSheet(java.io.InputStream is)Gets the result style sheet with given file name of an external CSS2 resource.CssStyleSheetHandleopenCssStyleSheet(java.lang.String fileName)Gets the result style sheet with given file name of an external CSS2 resource.voidreloadCss(CssStyleSheetHandle sheetHandle)Reloads the css with the given css file path.voidreloadLibraries()Reloads all libraries this module included.voidreloadLibrary(java.lang.String reloadPath)Reloads the library with the given library file path.voidreloadLibrary(LibraryHandle libraryToReload)Reloads the library with the given library file path.voidrenameCss(IncludedCssStyleSheetHandle handle, java.lang.String newFileName)Deprecated.voidrenameCssByProperties(IncludedCssStyleSheetHandle handle, java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss)Renames bothIncludedCssStyleSheetandCSSStyleSheetto newFileName.voidreplaceConfigVariable(ConfigVariable oldVar, ConfigVariable newVar)Replaces the old config variable with the new one.voidreplaceImage(EmbeddedImage oldVar, EmbeddedImage newVar)Replaces the old embedded image with the new one.voidsetACLExpression(java.lang.String expr)Sets the ACL expression associated with the design instance.voidsetAfterFactory(java.lang.String value)Sets the script called at the end of the Factory after closing the report document (if any).voidsetAfterRender(java.lang.String value)Sets the script called after starting a presentation time action.voidsetBase(java.lang.String base)Sets the base directory to use when computing relative links from this report.voidsetBeforeFactory(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).voidsetBeforeRender(java.lang.String value)Sets the script called before starting a presentation time action.voidsetBidiOrientation(java.lang.String bidiOrientation)Sets Bidi orientation value.voidsetCascadeACL(boolean cascadeACL)Sets the flag to control whether to cascade ACLvoidsetCheatSheet(java.lang.String cheatSheet)Sets the design cheat sheet file path.voidsetClientInitialize(java.lang.String script)Sets the client-initialize script of the report design.voidsetDisplayName(java.lang.String displayName)Sets the display name.voidsetDisplayNameKey(java.lang.String displayNameKey)Sets the resource key of the display name.voidsetEnableACL(boolean enableACL)Sets the flag to control whether to enable ACL.voidsetIconFile(java.lang.String iconFile)Sets the design icon/thumbnail file path.voidsetImageDPI(int imageDPI)Sets the image DPI of the report design.voidsetLanguage(java.lang.String language)Sets the language of the report design.voidsetLayoutPreference(java.lang.String layout)Sets the layout preference of this report design.voidsetLocale(com.ibm.icu.util.ULocale locale)Sets the locale of the report design.voidsetOnPageEnd(java.lang.String onPageEnd)Sets the script of onPageEnd method.voidsetOnPageStart(java.lang.String onPageStart)Sets the script of onPageStart method.voidsetOnPrepare(java.lang.String script)Sets the on-prepare script of the report design.voidsetPageVariable(java.lang.String pageVariableName, Expression value)Sets the page variable value.voidsetRefreshRate(int rate)Sets the refresh rate when viewing the report.voidsetTheme(ThemeHandle theme)Sets the theme to a report.voidsetThemeName(java.lang.String themeName)Sets the theme to a report.voidsetThumbnail(byte[] data)Sets the thumbnail image encoded in ISO-8859-1.voidshiftLibrary(LibraryHandle library, int toPosn)Shifts the library to new position.-
Methods inherited from class org.eclipse.birt.report.model.api.ModuleHandleImpl
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, sortVisibleElements
-
Methods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
add, 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, slotsIterator
-
-
-
-
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 ofIncludeScriptHandle- 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
-
importCssStyles
public void importCssStyles(CssStyleSheetHandle stylesheet, java.util.List selectedStyles)
(non-Javadoc)- Overrides:
importCssStylesin classModuleHandleImpl- Parameters:
stylesheet- the style sheet handle that contains all the selected stylesselectedStyles- the selected style list- See Also:
ModuleHandleImpl.importCssStyles(org. eclipse.birt.report.model.api.css.CssStyleSheetHandle, java.util.List)
-
setDisplayNameKey
public void setDisplayNameKey(java.lang.String displayNameKey) throws SemanticExceptionSets 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 SemanticExceptionSets 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 SemanticExceptionSets 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 SemanticExceptionSets 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 SemanticExceptionSets 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 SemanticExceptionDeletes 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.
-
getCubes
public SlotHandle getCubes()
Description copied from class:ModuleHandleImplGets the slot handle to work with all cube elements within the report.- Specified by:
getCubesin classModuleHandleImpl- Returns:
- cube slot handle
-
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_LAYOUTDesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_AUTO_LAYOUT
- Returns:
- layout preference of report design
-
setLayoutPreference
public void setLayoutPreference(java.lang.String layout) throws SemanticExceptionSets the layout preference of this report design. The input layout can be one of the following:DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_FIXED_LAYOUTDesignChoiceConstants.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 ofIncludedCssStyleSheetHandle- Returns:
- the iterator over all included css style sheets.
-
findIncludedCssStyleSheetHandleByFileName
@Deprecated public IncludedCssStyleSheetHandle findIncludedCssStyleSheetHandleByFileName(java.lang.String fileName)
Deprecated.GetsIncludedCssStyleSheetHandleby 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)
GetsIncludedCssStyleSheetHandleby properties.- Parameters:
fileName-externalCssURI-useExternalCss-- Returns:
- the includedCssStyleSheet handle.
-
findCssStyleSheetHandleByFileName
@Deprecated public CssStyleSheetHandle findCssStyleSheetHandleByFileName(java.lang.String fileName)
Deprecated.GetsCssStyleSheetHandleby 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)
GetsCssStyleSheetHandleby 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 handlingCssStyleSheetstructure list.
-
addCss
@Deprecated public void addCss(java.lang.String fileName) throws SemanticExceptionDeprecated.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 handlingCssStyleSheetstructure list.
-
addCssByProperties
public void addCssByProperties(java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss) throws SemanticExceptionIncludes 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 handlingCssStyleSheetstructure 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 handlingCssStyleSheetstructure list.
-
renameCss
@Deprecated public void renameCss(IncludedCssStyleSheetHandle handle, java.lang.String newFileName) throws SemanticException
Deprecated.Renames bothIncludedCssStyleSheetandCSSStyleSheetto newFileName.- Parameters:
handle- the includedCssStyleSheetHandlenewFileName- 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 bothIncludedCssStyleSheetandCSSStyleSheetto newFileName.- Parameters:
handle- the includedCssStyleSheetHandlenewFileName- 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:
truecan be renamed.else returnfalse- 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:
truecan be renamed.else returnfalse- 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 handlingCssStyleSheetstructure 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:
truecan be dropped.else returnfalse
-
canAddCssStyleSheet
public boolean canAddCssStyleSheet(CssStyleSheetHandle sheetHandle)
Check style sheet can be added or not.- Parameters:
sheetHandle-- Returns:
truecan be added.else returnfalse
-
canAddCssStyleSheet
@Deprecated public boolean canAddCssStyleSheet(java.lang.String fileName)
Deprecated.Check style sheet can be added or not.- Parameters:
fileName-- Returns:
truecan be added.else returnfalse
-
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:
truecan be added.else returnfalse
-
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 handlingCssStyleSheetstructure 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 inDesignChoiceConstantsand can be one of:BIDI_DIRECTION_LTRBIDI_DIRECTION_RTL
- Returns:
- the Bidi orientation value
-
setBidiOrientation
public void setBidiOrientation(java.lang.String bidiOrientation) throws SemanticExceptionSets Bidi orientation value. The input value is defined inDesignChoiceConstantsand can be one of:BIDI_DIRECTION_LTRBIDI_DIRECTION_RTL
- Parameters:
bidiOrientation- orientation value to be set- Throws:
SemanticException
-
isDirectionRTL
public boolean isDirectionRTL()
Description copied from class:DesignElementHandleExamines whether the resolved direction of this design element is Right to Left or not.- Overrides:
isDirectionRTLin classDesignElementHandle- Returns:
- true if the direction is RTL, false otherwise
-
isEnableACL
public boolean isEnableACL()
Returnstrueif the ACL feature is enable; otherwise false. By default, it isfalse.- Returns:
- the flag to control whether to enable ACL
-
setEnableACL
public void setEnableACL(boolean enableACL) throws SemanticExceptionSets 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 SemanticExceptionSets 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()
Returnstrue(the default), the design's ACL is automatically propagated to all its directly contained child elements and are added to their ACLs. Otherwisefalse.- Returns:
- the flag to control whether to cascade ACL
-
setCascadeACL
public void setCascadeACL(boolean cascadeACL) throws SemanticExceptionSets 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. Otherwisefalse.- 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 SemanticExceptionSets 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 SemanticExceptionSets 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 SemanticExceptionSets 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 containsVariableElementHandle.- Returns:
- the page variables list value.
-
getPageVariable
public VariableElementHandle getPageVariable(java.lang.String pageVariableName)
Gets theaccording 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 SemanticExceptionSets the page variable value.- Parameters:
pageVariableName- the page variable name.value- the page variable value.- Throws:
SemanticException
-
addVariable
public void addVariable(VariableElementHandle variable) throws SemanticException
Adds data variable that user defined on the report design.- Parameters:
variable- the variable- Throws:
SemanticException
-
dropVariable
public void dropVariable(VariableElementHandle variable) throws SemanticException
Removes the given data variable.- Parameters:
variable- the variable- 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 SemanticExceptionSets 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 ofIncludedCssStyleSheetHandle.- 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 namespaceoriginalName- 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 SemanticExceptionSets 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 SemanticExceptionSets 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 SemanticExceptionSets the language of the report design.- Parameters:
language- the language to set- Throws:
SemanticException- if the method is locked.
-
addConfigVariable
public void addConfigVariable(ConfigVariable configVar) throws SemanticException
Description copied from class:ModuleHandleImplAdds a new config variable.- Overrides:
addConfigVariablein classModuleHandleImpl- Parameters:
configVar- the config variable- Throws:
SemanticException- if the name is empty or the same name exists.
-
addImage
public void addImage(EmbeddedImage image) throws SemanticException
Description copied from class:ModuleHandleImplAdds a new embedded image.- Overrides:
addImagein classModuleHandleImpl- Parameters:
image- the image to add- Throws:
SemanticException- if the name is empty, type is invalid, or the same name exists.
-
addTranslation
public void addTranslation(java.lang.String resourceKey, java.lang.String locale, java.lang.String text) throws CustomMsgExceptionDescription copied from class:ModuleHandleImplAdds a new translation to the design.- Overrides:
addTranslationin classModuleHandleImpl- Parameters:
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- Throws:
CustomMsgException- if the resource key is duplicate or missing, or locale is not a valid format.- See Also:
ModuleHandleImpl.getTranslation(String, String)
-
dropConfigVariable
public void dropConfigVariable(java.lang.String name) throws SemanticExceptionDescription copied from class:ModuleHandleImplDrops a config variable.- Overrides:
dropConfigVariablein classModuleHandleImpl- Parameters:
name- config variable name- Throws:
SemanticException- if no config variable is found.
-
dropImage
public void dropImage(java.util.List images) throws SemanticExceptionDescription copied from class:ModuleHandleImplDrops an embedded image handle list from the design. Each one in the list is the instance ofEmbeddedImageHandle.- Overrides:
dropImagein classModuleHandleImpl- Parameters:
images- the image handle list to remove- Throws:
SemanticException- if any image in the list is not found.
-
dropImage
public void dropImage(java.lang.String name) throws SemanticExceptionDescription copied from class:ModuleHandleImplDrops an embedded image from the design.- Overrides:
dropImagein classModuleHandleImpl- Parameters:
name- the image name- Throws:
SemanticException- if the image is not found.
-
dropTranslation
public void dropTranslation(java.lang.String resourceKey, java.lang.String locale) throws CustomMsgExceptionDescription copied from class:ModuleHandleImplDrops a translation from the design.- Overrides:
dropTranslationin classModuleHandleImpl- Parameters:
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.)- Throws:
CustomMsgException- ifresourceKeyisnull.- See Also:
ModuleHandleImpl.getTranslation(String, String)
-
getComponents
public SlotHandle getComponents()
Description copied from class:ModuleHandleImplReturns a slot handle to work with the top-level components within the report.- Overrides:
getComponentsin classModuleHandleImpl- Returns:
- A handle for working with the components.
-
getDataSets
public SlotHandle getDataSets()
Description copied from class:ModuleHandleImplReturns 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:
getDataSetsin classModuleHandleImpl- Returns:
- A handle for working with the data sets.
-
getDataSources
public SlotHandle getDataSources()
Description copied from class:ModuleHandleImplReturns 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:
getDataSourcesin classModuleHandleImpl- Returns:
- A handle for working with the data sources.
-
getFlattenParameters
public java.util.List getFlattenParameters()
Description copied from class:ModuleHandleImplReturns 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:
getFlattenParametersin classModuleHandleImpl- Returns:
- the sorted, flatten parameters and parameter groups.
-
getMasterPages
public SlotHandle getMasterPages()
Description copied from class:ModuleHandleImplReturns 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:
getMasterPagesin classModuleHandleImpl- Returns:
- A handle for working with the master pages.
-
getParameters
public SlotHandle getParameters()
Description copied from class:ModuleHandleImplReturns 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:
getParametersin classModuleHandleImpl- Returns:
- A handle for working with the parameters and parameter groups.
-
imagesIterator
public java.util.Iterator imagesIterator()
Description copied from class:ModuleHandleImplReturns the iterator over all embedded images of this module instance. Each one is the instance ofEmbeddedImageHandle- Overrides:
imagesIteratorin classModuleHandleImpl- Returns:
- the iterator over all embedded images.
- See Also:
EmbeddedImageHandle
-
replaceConfigVariable
public void replaceConfigVariable(ConfigVariable oldVar, ConfigVariable newVar) throws SemanticException
Description copied from class:ModuleHandleImplReplaces the old config variable with the new one.- Overrides:
replaceConfigVariablein classModuleHandleImpl- Parameters:
oldVar- the old config variablenewVar- the new config variable- Throws:
SemanticException- if the old config variable is not found or the name of new one is empty.
-
replaceImage
public void replaceImage(EmbeddedImage oldVar, EmbeddedImage newVar) throws SemanticException
Description copied from class:ModuleHandleImplReplaces the old embedded image with the new one.- Overrides:
replaceImagein classModuleHandleImpl- Parameters:
oldVar- the old embedded imagenewVar- the new embedded image- Throws:
SemanticException- if the old image is not found or the name of new one is empty.
-
getAllStyles
public java.util.List getAllStyles()
Description copied from class:ModuleHandleImplReturns all style element handles that this modules and the included modules contain.- Overrides:
getAllStylesin classModuleHandleImpl- 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:ModuleHandleImplReturns theme handles according the input level.- Overrides:
getVisibleThemesin classModuleHandleImpl- Parameters:
level- anintvalue, which should be the one defined inIVisibleLevelControl.- Returns:
- theme handles according the input level
-
getVisibleReportItemThemes
public java.util.List<ReportItemThemeHandle> getVisibleReportItemThemes(int level, java.lang.String type)
Description copied from class:ModuleHandleImplReturns report item theme handles according the input level.- Overrides:
getVisibleReportItemThemesin classModuleHandleImpl- Parameters:
level- anintvalue, which should be the one defined inIVisibleLevelControl.- Returns:
- theme handles according the input level
-
getParametersAndParameterGroups
public java.util.List getParametersAndParameterGroups()
Description copied from class:ModuleHandleImplReturns parameters and parameter groups on the module. Those parameters included in the parameter groups are not included in the return list.- Overrides:
getParametersAndParameterGroupsin classModuleHandleImpl- Returns:
- parameters and parameter groups
-
getAllPages
public java.util.List getAllPages()
Description copied from class:ModuleHandleImplReturns all page handles that this modules and the included modules contain.- Overrides:
getAllPagesin classModuleHandleImpl- 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:ModuleHandleImplShifts the library to new position. This method might affect the style reference, because the library order is changed.- Overrides:
shiftLibraryin classModuleHandleImpl- Parameters:
library- the library to shifttoPosn- the new position- Throws:
SemanticException- if error is encountered when shifting
-
includeLibrariesIterator
public java.util.Iterator includeLibrariesIterator()
Description copied from class:ModuleHandleImplReturns the iterator over all included libraries. Each one is the instance ofIncludeLibraryHandle- Overrides:
includeLibrariesIteratorin classModuleHandleImpl- Returns:
- the iterator over all included libraries.
- See Also:
IncludedLibraryHandle
-
includeLibrary
public void includeLibrary(java.lang.String libraryFileName, java.lang.String namespace) throws DesignFileException, SemanticExceptionDescription copied from class:ModuleHandleImplIncludes one library with the given library file name. The new library will be appended to the library list.- Overrides:
includeLibraryin classModuleHandleImpl- Parameters:
libraryFileName- library file namenamespace- library namespace- Throws:
DesignFileException- if the library file is not found, or has fatal error.SemanticException- if error is encountered when handlingIncludeLibrarystructure list.
-
dropLibrary
public void dropLibrary(LibraryHandle library) throws SemanticException
Description copied from class:ModuleHandleImplDrops the given library from the included libraries of this design file.- Overrides:
dropLibraryin classModuleHandleImpl- Parameters:
library- the library to drop- Throws:
SemanticException- if error is encountered when handlingIncludeLibrarystructure 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:ModuleHandleImplReloads 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:
reloadLibraryin classModuleHandleImpl- Parameters:
libraryToReload- the library instance- Throws:
SemanticException- if error is encountered when handlingIncludeLibrarystructure 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.
-
reloadLibraries
public void reloadLibraries() throws SemanticException, DesignFileExceptionDescription copied from class:ModuleHandleImplReloads all libraries this module included.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)- Overrides:
reloadLibrariesin classModuleHandleImpl- Throws:
SemanticExceptionDesignFileException
-
reloadLibrary
public void reloadLibrary(java.lang.String reloadPath) throws SemanticException, DesignFileExceptionDescription copied from class:ModuleHandleImplReloads 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:
reloadLibraryin classModuleHandleImpl- Parameters:
reloadPath- this is supposed to be an absolute path, not in url form.- Throws:
SemanticException- if error is encountered when handlingIncludeLibrarystructure 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.
-
dropLibraryAndBreakExtends
public void dropLibraryAndBreakExtends(LibraryHandle library) throws SemanticException
Description copied from class:ModuleHandleImplDrops the given library from the design and break all the parent/child relationships. All child element will be localized in the module.- Overrides:
dropLibraryAndBreakExtendsin classModuleHandleImpl- 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:ModuleHandleImplGets the result style sheet with given file name of an external CSS2 resource.- Overrides:
openCssStyleSheetin classModuleHandleImpl- Parameters:
fileName- the file name of the external CSS resource- Returns:
- the
CssStyleSheetHandleif 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:ModuleHandleImplGets the result style sheet with given file name of an external CSS2 resource.- Overrides:
openCssStyleSheetin classModuleHandleImpl- Parameters:
is- the input stream of the resource- Returns:
- the
CssStyleSheetHandleif the external resource is successfully loaded - Throws:
StyleSheetException- thrown if the resource is not found, or there are syntax errors in the resource
-
setThemeName
public void setThemeName(java.lang.String themeName) throws SemanticExceptionDescription copied from class:ModuleHandleImplSets the theme to a report.- Overrides:
setThemeNamein classModuleHandleImpl- Parameters:
themeName- the name of the theme- Throws:
SemanticException
-
setTheme
public void setTheme(ThemeHandle theme) throws SemanticException
Description copied from class:ModuleHandleImplSets the theme to a report.- Overrides:
setThemein classModuleHandleImpl- Parameters:
theme- the theme instance- Throws:
SemanticException
-
-