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
ConstructorsConstructorDescriptionReportDesignHandle
(org.eclipse.birt.report.model.elements.ReportDesign design) Constructs a handle with the given design. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addConfigVariable
(ConfigVariable configVar) Adds a new config variable.void
Deprecated.void
addCss
(CssStyleSheetHandle sheetHandle) Includes one css with the given css file name.void
addCss
(IncludedCssStyleSheet cssStruct) Includes one CSS structure with the given IncludedCssStyleSheet.void
addCssByProperties
(String fileName, String externalCssURI, boolean useExternalCss) Includes one css with the given css file name.void
addImage
(EmbeddedImage image) Adds a new embedded image.void
addTranslation
(String resourceKey, String locale, String text) Adds a new translation to the design.void
addVariable
(VariableElementHandle variable) Adds data variable that user defined on the report design.void
Caches values for all elements, styles, etc.boolean
canAddCssStyleSheet
(String fileName) Deprecated.boolean
canAddCssStyleSheet
(CssStyleSheetHandle sheetHandle) Check style sheet can be added or not.boolean
canAddCssStyleSheetByProperties
(String fileName, String externalCssURI, boolean useExternalCss) Check style sheet can be added or not.boolean
canDropCssStyleSheet
(CssStyleSheetHandle sheetHandle) Check style sheet can be droped or not.boolean
canRenameCss
(IncludedCssStyleSheetHandle handle, String newFileName) Deprecated.boolean
canRenameCssByProperties
(IncludedCssStyleSheetHandle handle, String fileName, String externalCssURI, boolean useExternalCss) Checks css can be renamed or not.boolean
Returnstrue
(the default), the design's ACL is automatically propagated to all its directly contained child elements and are added to their ACLs.void
Deletes the thumbnail image in the design.void
dropConfigVariable
(String name) Drops a config variable.void
dropCss
(CssStyleSheetHandle sheetHandle) Drops the given css style sheet of this design file.void
Drops an embedded image from the design.void
Drops an embedded image handle list 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
(String resourceKey, String locale) Drops a translation from the design.void
dropVariable
(VariableElementHandle variable) Removes the given data variable.findCssStyleSheetHandleByFileName
(String fileName) Deprecated.findCssStyleSheetHandleByProperties
(String fileName, String externalCssURI, boolean useExternalCss) GetsCssStyleSheetHandle
by file name.Deprecated.findIncludedCssStyleSheetHandleByProperties
(String fileName, String externalCssURI, boolean useExternalCss) GetsIncludedCssStyleSheetHandle
by properties.Returns the ACL expression associated with the design instance.Returns the script called at the end of the Factory after closing the report document (if any).Returns the script called after starting a presentation time action.Gets all bookmarks defined in this module.Gets all css styles sheetGets the list of the included css style sheets that set the external URI.Returns all page handles that this modules and the included modules contain.Returns all style element handles that this modules and the included modules contain.Gets all TOCs defined in this module.Gets all variable.getBase()
Returns the base directory to use when computing relative links from this report.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 called before starting a presentation time action.Gets Bidi orientation value.getBody()
Returns a slot handle to work with the sections in the report's Body slot.Gets the design cheat sheet file path.Gets the client-initialize script of the report design.Returns a slot handle to work with the top-level components within the report.getCubes()
Gets the slot handle to work with all cube elements within the report.Returns a slot handle to work with the data sets within the report.Returns a slot handle to work with the data sources within the report.Gets the display name.Gets the resource key of the display name.getFlattenElement
(DesignElementHandle elementHandle, String originalName) Gets the flatten element by the original name.Returns the flatten Parameters/ParameterGroups of the design.Gets the design icon/thumbnail file path.int
Gets the image DPI of the report design.Gets the language of the report design.Gets the layout preference of this report design.com.ibm.icu.util.ULocale
Gets the locale of the report design.Returns a slot handle to work with the master pages within the report.Gets the script of onPageEnd method.Gets the script of onPageStart method.Gets the on-prepare script of the report design.getPageVariable
(String pageVariableName) Gets theaccording to the input page variable name. Gets the pageVariables list value which containsVariableElementHandle
.Returns a slot handle to work with the top-level parameters and parameter groups within the report.Returns parameters and parameter groups on the module.int
Returns the refresh rate when viewing the report.Gets report items which holds a template definition, that is, report item in body slot and page slot.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 slot handle to work with the styles within the report.byte[]
Gets the thumbnail image encoded in ISO-8859-1.getVisibleReportItemThemes
(int level, String type) Returns report item theme handles according the input level.getVisibleThemes
(int level) Returns theme handles according the input level.Returns the iterator over all embedded images of this module instance.void
importCssStyles
(CssStyleSheetHandle stylesheet, List selectedStyles) (non-Javadoc)Returns the iterator over all included css style sheets.Returns the iterator over all included libraries.void
includeLibrary
(String libraryFileName, String namespace) Includes one library with the given library file name.Returns the list of all the included script file of the libraries.boolean
Examines whether the resolved direction of this design element is Right to Left or not.boolean
Returnstrue
if the ACL feature is enable; otherwise false.Gets the result style sheet with given file name of an external CSS2 resource.openCssStyleSheet
(String fileName) Gets the result style sheet with given file name of an external CSS2 resource.void
reloadCss
(CssStyleSheetHandle sheetHandle) Reloads the css with the given css file path.void
Reloads all libraries this module included.void
reloadLibrary
(String reloadPath) Reloads the library with the given library file path.void
reloadLibrary
(LibraryHandle libraryToReload) Reloads the library with the given library file path.void
renameCss
(IncludedCssStyleSheetHandle handle, String newFileName) Deprecated.void
renameCssByProperties
(IncludedCssStyleSheetHandle handle, String fileName, String externalCssURI, boolean useExternalCss) Renames bothIncludedCssStyleSheet
andCSSStyleSheet
to newFileName.
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
setACLExpression
(String expr) Sets the ACL expression associated with the design instance.void
setAfterFactory
(String value) Sets the script called at the end of the Factory after closing the report document (if any).void
setAfterRender
(String value) Sets the script called after starting a presentation time action.void
Sets the base directory to use when computing relative links from this report.void
setBeforeFactory
(String value) Sets the script called at the start of the Factory after the initialize( ) method and before opening the report document (if any).void
setBeforeRender
(String value) Sets the script called before starting a presentation time action.void
setBidiOrientation
(String bidiOrientation) Sets Bidi orientation value.void
setCascadeACL
(boolean cascadeACL) Sets the flag to control whether to cascade ACLvoid
setCheatSheet
(String cheatSheet) Sets the design cheat sheet file path.void
setClientInitialize
(String script) Sets the client-initialize script of the report design.void
setDisplayName
(String displayName) Sets the display name.void
setDisplayNameKey
(String displayNameKey) Sets the resource key of the display name.void
setEnableACL
(boolean enableACL) Sets the flag to control whether to enable ACL.void
setIconFile
(String iconFile) Sets the design icon/thumbnail file path.void
setImageDPI
(int imageDPI) Sets the image DPI of the report design.void
setLanguage
(String language) Sets the language of the report design.void
setLayoutPreference
(String layout) Sets the layout preference of this report design.void
setLocale
(com.ibm.icu.util.ULocale locale) Sets the locale of the report design.void
setOnPageEnd
(String onPageEnd) Sets the script of onPageEnd method.void
setOnPageStart
(String onPageStart) Sets the script of onPageStart method.void
setOnPrepare
(String script) Sets the on-prepare script of the report design.void
setPageVariable
(String pageVariableName, Expression value) Sets the page variable value.void
setRefreshRate
(int rate) Sets the refresh rate when viewing the report.void
setTheme
(ThemeHandle theme) Sets the theme to a report.void
setThemeName
(String themeName) Sets the theme to a report.void
setThumbnail
(byte[] data) Sets the thumbnail image encoded in ISO-8859-1.void
shiftLibrary
(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 Details
-
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 Details
-
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
Returns the script called after starting a presentation time action.- Returns:
- the script
-
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
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
Returns the script called before starting a presentation time action.- Returns:
- the script
-
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
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
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
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
Sets the script called after starting a presentation time action.- Parameters:
value
- the script to set.
-
setBase
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
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
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
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
Gets all css styles sheet- Returns:
- each item is
CssStyleSheetHandle
-
importCssStyles
(non-Javadoc)- Overrides:
importCssStyles
in classModuleHandleImpl
- Parameters:
stylesheet
- the style sheet handle that contains all the selected stylesselectedStyles
- the selected style list- See Also:
-
setDisplayNameKey
Sets 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
Gets the resource key of the display name.- Returns:
- the resource key of the display name
-
setDisplayName
Sets the display name.- Parameters:
displayName
- the display name- Throws:
SemanticException
- if the display name property is locked or not defined on this design.
-
getDisplayName
Gets the display name.- Returns:
- the display name
-
setIconFile
Sets 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
Gets the design icon/thumbnail file path.- Returns:
- the design icon/thumbnail file path
-
setCheatSheet
Sets 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
Gets the design cheat sheet file path.- Returns:
- the design cheat sheet file path
-
setThumbnail
Sets 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
Deletes the thumbnail image in the design.- Throws:
SemanticException
- if the property is locked or not defined on this design.
-
getAllBookmarks
Gets all bookmarks defined in this module.- Returns:
- All bookmarks defined in this module.
-
getAllTocs
Gets all TOCs defined in this module.- Returns:
- All TOCs defined in this module.
-
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
Description copied from class:ModuleHandleImpl
Gets the slot handle to work with all cube elements within the report.- Specified by:
getCubes
in classModuleHandleImpl
- Returns:
- cube slot handle
-
getLayoutPreference
Gets the layout preference of this report design. It can be one of the following:DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_FIXED_LAYOUT
DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_AUTO_LAYOUT
- Returns:
- layout preference of report design
-
setLayoutPreference
Sets the layout preference of this report design. The input layout can be one of the following:DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_FIXED_LAYOUT
DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_AUTO_LAYOUT
- Parameters:
layout
- the layout to set- Throws:
SemanticException
- if value is invalid
-
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(String fileName) Deprecated.GetsIncludedCssStyleSheetHandle
by file name.- Parameters:
fileName
- the file name- Returns:
- the includedCssStyleSheet handle.
-
findIncludedCssStyleSheetHandleByProperties
public IncludedCssStyleSheetHandle findIncludedCssStyleSheetHandleByProperties(String fileName, String externalCssURI, boolean useExternalCss) GetsIncludedCssStyleSheetHandle
by properties.- Parameters:
fileName
-externalCssURI
-useExternalCss
-- Returns:
- the includedCssStyleSheet handle.
-
findCssStyleSheetHandleByFileName
Deprecated.GetsCssStyleSheetHandle
by file name.- Parameters:
fileName
- the file name.- Returns:
- the cssStyleSheet handle.
-
findCssStyleSheetHandleByProperties
public CssStyleSheetHandle findCssStyleSheetHandleByProperties(String fileName, String externalCssURI, boolean useExternalCss) GetsCssStyleSheetHandle
by file name.- Parameters:
fileName
-externalCssURI
-useExternalCss
-- Returns:
- the cssStyleSheet handle.
-
addCss
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 handlingCssStyleSheet
structure list.
-
addCss
Deprecated.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 handlingCssStyleSheet
structure list.
-
addCssByProperties
public void addCssByProperties(String fileName, String externalCssURI, boolean useExternalCss) throws SemanticException 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 handlingCssStyleSheet
structure list.
-
addCss
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 handlingCssStyleSheet
structure list.
-
renameCss
@Deprecated public void renameCss(IncludedCssStyleSheetHandle handle, String newFileName) throws SemanticException Deprecated.Renames bothIncludedCssStyleSheet
andCSSStyleSheet
to newFileName.
- Parameters:
handle
- the includedCssStyleSheetHandlenewFileName
- the new file name- Throws:
SemanticException
-
renameCssByProperties
public void renameCssByProperties(IncludedCssStyleSheetHandle handle, String fileName, String externalCssURI, boolean useExternalCss) throws SemanticException Renames bothIncludedCssStyleSheet
andCSSStyleSheet
to newFileName.
- Parameters:
handle
- the includedCssStyleSheetHandlenewFileName
- the new file name- Throws:
SemanticException
-
canRenameCss
@Deprecated public boolean canRenameCss(IncludedCssStyleSheetHandle handle, 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:
true
can be renamed.else returnfalse
- Throws:
SemanticException
-
canRenameCssByProperties
public boolean canRenameCssByProperties(IncludedCssStyleSheetHandle handle, String fileName, 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:
true
can be renamed.else returnfalse
- Throws:
SemanticException
-
dropCss
Drops the given css style sheet of this design file.- Parameters:
sheetHandle
- the css to drop- Throws:
SemanticException
- if error is encountered when handlingCssStyleSheet
structure 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
Check style sheet can be droped or not.- Parameters:
sheetHandle
-- Returns:
true
can be dropped.else returnfalse
-
canAddCssStyleSheet
Check style sheet can be added or not.- Parameters:
sheetHandle
-- Returns:
true
can be added.else returnfalse
-
canAddCssStyleSheet
Deprecated.Check style sheet can be added or not.- Parameters:
fileName
-- Returns:
true
can be added.else returnfalse
-
canAddCssStyleSheetByProperties
public boolean canAddCssStyleSheetByProperties(String fileName, String externalCssURI, boolean useExternalCss) Check style sheet can be added or not.- Parameters:
fileName
-externalCssURI
-useExternalCss
-- Returns:
true
can be added.else returnfalse
-
reloadCss
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 handlingCssStyleSheet
structure 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
Gets Bidi orientation value. The return value is defined inDesignChoiceConstants
and can be one of:BIDI_DIRECTION_LTR
BIDI_DIRECTION_RTL
- Returns:
- the Bidi orientation value
-
setBidiOrientation
Sets Bidi orientation value. The input value is defined inDesignChoiceConstants
and can be one of:BIDI_DIRECTION_LTR
BIDI_DIRECTION_RTL
- Parameters:
bidiOrientation
- orientation value to be set- Throws:
SemanticException
-
isDirectionRTL
public boolean isDirectionRTL()Description copied from class:DesignElementHandle
Examines whether the resolved direction of this design element is Right to Left or not.- Overrides:
isDirectionRTL
in classDesignElementHandle
- Returns:
- true if the direction is RTL, false otherwise
-
isEnableACL
public boolean isEnableACL()Returnstrue
if the ACL feature is enable; otherwise false. By default, it isfalse
.- Returns:
- the flag to control whether to enable ACL
-
setEnableACL
Sets 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
Returns the ACL expression associated with the design instance.- Returns:
- the expression in string
-
setACLExpression
Sets 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
Sets 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
Sets 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
Gets the script of onPageStart method.- Returns:
- the script of onPageStart method.
-
setOnPageStart
Sets the script of onPageStart method.- Parameters:
onPageStart
- the script of onPageStart method.- Throws:
SemanticException
- if the property is locked by masks.
-
getOnPageEnd
Gets the script of onPageEnd method.- Returns:
- the script of onPageEnd method.
-
setOnPageEnd
Sets the script of onPageEnd method.- Parameters:
onPageEnd
- the script of onPageEnd method.- Throws:
SemanticException
- if the property is locked by masks.
-
getPageVariables
Gets the pageVariables list value which containsVariableElementHandle
.- Returns:
- the page variables list value.
-
getPageVariable
Gets theaccording to the input page variable name. - Parameters:
pageVariableName
- the page variable name.- Returns:
- the
according to the input page variable name
-
setPageVariable
Sets the page variable value.- Parameters:
pageVariableName
- the page variable name.value
- the page variable value.- Throws:
SemanticException
-
addVariable
Adds data variable that user defined on the report design.- Parameters:
variable
- the variable- Throws:
SemanticException
-
dropVariable
Removes the given data variable.- Parameters:
variable
- the variable- Throws:
SemanticException
-
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
Sets the locale of the report design.- Parameters:
locale
- the locale of the report design.- Throws:
SemanticException
- See Also:
-
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, 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
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
Sets the on-prepare script of the report design.- Parameters:
script
- the script to set- Throws:
SemanticException
- if the method is locked.- See Also:
-
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
Sets the client-initialize script of the report design.- Parameters:
script
- the script to set- Throws:
SemanticException
- if the method is locked.- See Also:
-
getLanguage
Gets the language of the report design.- Returns:
- the language of the report design
-
setLanguage
Sets the language of the report design.- Parameters:
language
- the language to set- Throws:
SemanticException
- if the method is locked.
-
addConfigVariable
Description copied from class:ModuleHandleImpl
Adds a new config variable.- Overrides:
addConfigVariable
in classModuleHandleImpl
- Parameters:
configVar
- the config variable- Throws:
SemanticException
- if the name is empty or the same name exists.
-
addImage
Description copied from class:ModuleHandleImpl
Adds a new embedded image.- Overrides:
addImage
in 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(String resourceKey, String locale, String text) throws CustomMsgException Description copied from class:ModuleHandleImpl
Adds a new translation to the design.- Overrides:
addTranslation
in 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:
-
dropConfigVariable
Description copied from class:ModuleHandleImpl
Drops a config variable.- Overrides:
dropConfigVariable
in classModuleHandleImpl
- Parameters:
name
- config variable name- Throws:
SemanticException
- if no config variable is found.
-
dropImage
Description copied from class:ModuleHandleImpl
Drops an embedded image handle list from the design. Each one in the list is the instance ofEmbeddedImageHandle
.- Overrides:
dropImage
in classModuleHandleImpl
- Parameters:
images
- the image handle list to remove- Throws:
SemanticException
- if any image in the list is not found.
-
dropImage
Description copied from class:ModuleHandleImpl
Drops an embedded image from the design.- Overrides:
dropImage
in classModuleHandleImpl
- Parameters:
name
- the image name- Throws:
SemanticException
- if the image is not found.
-
dropTranslation
Description copied from class:ModuleHandleImpl
Drops a translation from the design.- Overrides:
dropTranslation
in 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
- ifresourceKey
isnull
.- See Also:
-
getComponents
Description copied from class:ModuleHandleImpl
Returns a slot handle to work with the top-level components within the report.- Overrides:
getComponents
in classModuleHandleImpl
- Returns:
- A handle for working with the components.
-
getDataSets
Description copied from class:ModuleHandleImpl
Returns 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:
getDataSets
in classModuleHandleImpl
- Returns:
- A handle for working with the data sets.
-
getDataSources
Description copied from class:ModuleHandleImpl
Returns 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:
getDataSources
in classModuleHandleImpl
- Returns:
- A handle for working with the data sources.
-
getFlattenParameters
Description copied from class:ModuleHandleImpl
Returns 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:
getFlattenParameters
in classModuleHandleImpl
- Returns:
- the sorted, flatten parameters and parameter groups.
-
getMasterPages
Description copied from class:ModuleHandleImpl
Returns 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:
getMasterPages
in classModuleHandleImpl
- Returns:
- A handle for working with the master pages.
-
getParameters
Description copied from class:ModuleHandleImpl
Returns 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:
getParameters
in classModuleHandleImpl
- Returns:
- A handle for working with the parameters and parameter groups.
-
imagesIterator
Description copied from class:ModuleHandleImpl
Returns the iterator over all embedded images of this module instance. Each one is the instance ofEmbeddedImageHandle
- Overrides:
imagesIterator
in classModuleHandleImpl
- Returns:
- the iterator over all embedded images.
- See Also:
-
replaceConfigVariable
public void replaceConfigVariable(ConfigVariable oldVar, ConfigVariable newVar) throws SemanticException Description copied from class:ModuleHandleImpl
Replaces the old config variable with the new one.- Overrides:
replaceConfigVariable
in 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
Description copied from class:ModuleHandleImpl
Replaces the old embedded image with the new one.- Overrides:
replaceImage
in 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
Description copied from class:ModuleHandleImpl
Returns all style element handles that this modules and the included modules contain.- Overrides:
getAllStyles
in classModuleHandleImpl
- Returns:
- all style element handles that this modules and the included modules contain.
-
getVisibleThemes
Description copied from class:ModuleHandleImpl
Returns theme handles according the input level.- Overrides:
getVisibleThemes
in classModuleHandleImpl
- Parameters:
level
- anint
value, which should be the one defined inIVisibleLevelControl
.- Returns:
- theme handles according the input level
-
getVisibleReportItemThemes
Description copied from class:ModuleHandleImpl
Returns report item theme handles according the input level.- Overrides:
getVisibleReportItemThemes
in classModuleHandleImpl
- Parameters:
level
- anint
value, which should be the one defined inIVisibleLevelControl
.- Returns:
- theme handles according the input level
-
getParametersAndParameterGroups
Description copied from class:ModuleHandleImpl
Returns parameters and parameter groups on the module. Those parameters included in the parameter groups are not included in the return list.- Overrides:
getParametersAndParameterGroups
in classModuleHandleImpl
- Returns:
- parameters and parameter groups
-
getAllPages
Description copied from class:ModuleHandleImpl
Returns all page handles that this modules and the included modules contain.- Overrides:
getAllPages
in classModuleHandleImpl
- Returns:
- all page handles that this modules and the included modules contain.
-
shiftLibrary
Description copied from class:ModuleHandleImpl
Shifts the library to new position. This method might affect the style reference, because the library order is changed.- Overrides:
shiftLibrary
in classModuleHandleImpl
- Parameters:
library
- the library to shifttoPosn
- the new position- Throws:
SemanticException
- if error is encountered when shifting
-
includeLibrariesIterator
Description copied from class:ModuleHandleImpl
Returns the iterator over all included libraries. Each one is the instance ofIncludeLibraryHandle
- Overrides:
includeLibrariesIterator
in classModuleHandleImpl
- Returns:
- the iterator over all included libraries.
- See Also:
-
includeLibrary
public void includeLibrary(String libraryFileName, String namespace) throws DesignFileException, SemanticException Description copied from class:ModuleHandleImpl
Includes one library with the given library file name. The new library will be appended to the library list.- Overrides:
includeLibrary
in 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 handlingIncludeLibrary
structure list.
-
dropLibrary
Description copied from class:ModuleHandleImpl
Drops the given library from the included libraries of this design file.- Overrides:
dropLibrary
in classModuleHandleImpl
- Parameters:
library
- the library to drop- Throws:
SemanticException
- if error is encountered when handlingIncludeLibrary
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
-
reloadLibrary
public void reloadLibrary(LibraryHandle libraryToReload) throws SemanticException, DesignFileException Description copied from class:ModuleHandleImpl
Reloads 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:
reloadLibrary
in classModuleHandleImpl
- Parameters:
libraryToReload
- the library instance- Throws:
SemanticException
- if error is encountered when handlingIncludeLibrary
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.
-
reloadLibraries
Description copied from class:ModuleHandleImpl
Reloads 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:
reloadLibraries
in classModuleHandleImpl
- Throws:
SemanticException
DesignFileException
-
reloadLibrary
Description copied from class:ModuleHandleImpl
Reloads 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:
reloadLibrary
in classModuleHandleImpl
- Parameters:
reloadPath
- this is supposed to be an absolute path, not in url form.- Throws:
SemanticException
- if error is encountered when handlingIncludeLibrary
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.
-
dropLibraryAndBreakExtends
Description copied from class:ModuleHandleImpl
Drops the given library from the design and break all the parent/child relationships. All child element will be localized in the module.- Overrides:
dropLibraryAndBreakExtends
in 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
Description copied from class:ModuleHandleImpl
Gets the result style sheet with given file name of an external CSS2 resource.- Overrides:
openCssStyleSheet
in classModuleHandleImpl
- Parameters:
fileName
- the file name of the external CSS resource- Returns:
- the
CssStyleSheetHandle
if the external resource is successfully loaded - Throws:
StyleSheetException
- thrown if the resource is not found, or there are syntax errors in the resource
-
openCssStyleSheet
Description copied from class:ModuleHandleImpl
Gets the result style sheet with given file name of an external CSS2 resource.- Overrides:
openCssStyleSheet
in classModuleHandleImpl
- Parameters:
is
- the input stream of the resource- Returns:
- the
CssStyleSheetHandle
if the external resource is successfully loaded - Throws:
StyleSheetException
- thrown if the resource is not found, or there are syntax errors in the resource
-
setThemeName
Description copied from class:ModuleHandleImpl
Sets the theme to a report.- Overrides:
setThemeName
in classModuleHandleImpl
- Parameters:
themeName
- the name of the theme- Throws:
SemanticException
-
setTheme
Description copied from class:ModuleHandleImpl
Sets the theme to a report.- Overrides:
setTheme
in classModuleHandleImpl
- Parameters:
theme
- the theme instance- Throws:
SemanticException
-