public class ReportDesignHandle extends ModuleHandle implements org.eclipse.birt.report.model.elements.interfaces.IReportDesignModel
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.
includeLibrary(String, String)to include one
library.
// 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);
ReportDesignisInitializedmoduleACL_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_PROPAUTHOR_PROP, BASE_PROP, COLOR_PALETTE_PROP, COMPONENT_SLOT, CONFIG_VARS_PROP, CREATED_BY_PROP, DATA_SET_SLOT, DATA_SOURCE_SLOT, DESCRIPTION_ID_PROP, DESCRIPTION_PROP, HELP_GUIDE_PROP, IMAGES_PROP, INCLUDE_RESOURCE_PROP, INCLUDE_SCRIPTS_PROP, INITIALIZE_METHOD, LIBRARIES_PROP, PAGE_SLOT, PARAMETER_SLOT, PROPERTY_BINDINGS_PROP, SCRIPTLIBS_PROP, SUBJECT_PROP, THEME_PROP, TITLE_ID_PROP, TITLE_PROP, UNITS_PROPCOMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP| 构造器和说明 |
|---|
ReportDesignHandle(org.eclipse.birt.report.model.elements.ReportDesign design)
Constructs a handle with the given design.
|
| 限定符和类型 | 方法和说明 |
|---|---|
void |
addConfigVariable(ConfigVariable configVar)
Adds a new config variable.
|
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 |
addCss(java.lang.String fileName)
已过时。
|
void |
addCssByProperties(java.lang.String fileName,
java.lang.String externalCssURI,
boolean useExternalCss)
Includes one css with the given css file name.
|
void |
addImage(EmbeddedImage image)
Adds a new embedded image.
|
void |
addTranslation(java.lang.String resourceKey,
java.lang.String locale,
java.lang.String text)
Adds a new translation to the design.
|
void |
addVariable(VariableElementHandle variable)
Adds data variable that user defined on the report design.
|
void |
cacheValues()
Caches values for all elements, styles, etc.
|
boolean |
canAddCssStyleSheet(CssStyleSheetHandle sheetHandle)
Check style sheet can be added or not.
|
boolean |
canAddCssStyleSheet(java.lang.String fileName)
已过时。
|
boolean |
canAddCssStyleSheetByProperties(java.lang.String fileName,
java.lang.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,
java.lang.String newFileName)
已过时。
|
boolean |
canRenameCssByProperties(IncludedCssStyleSheetHandle handle,
java.lang.String fileName,
java.lang.String externalCssURI,
boolean useExternalCss)
Checks css can be renamed or not.
|
boolean |
cascadeACL()
Returns
true (the default), the design's ACL is
automatically propagated to all its directly contained child elements and
are added to their ACLs. |
void |
deleteThumbnail()
Deletes the thumbnail image in the design.
|
void |
dropConfigVariable(java.lang.String name)
Drops a config variable.
|
void |
dropCss(CssStyleSheetHandle sheetHandle)
Drops the given css style sheet of this design file.
|
void |
dropImage(java.util.List images)
Drops an embedded image handle list from the design.
|
void |
dropImage(java.lang.String name)
Drops an embedded image from the design.
|
void |
dropLibrary(LibraryHandle library)
Drops the given library from the included libraries of this design file.
|
void |
dropLibraryAndBreakExtends(LibraryHandle library)
Drops the given library from the design and break all the parent/child
relationships.
|
void |
dropTranslation(java.lang.String resourceKey,
java.lang.String locale)
Drops a translation from the design.
|
void |
dropVariable(VariableElementHandle variable)
Removes the given data variable.
|
CssStyleSheetHandle |
findCssStyleSheetHandleByFileName(java.lang.String fileName)
已过时。
|
CssStyleSheetHandle |
findCssStyleSheetHandleByProperties(java.lang.String fileName,
java.lang.String externalCssURI,
boolean useExternalCss)
Gets
CssStyleSheetHandle by file name. |
IncludedCssStyleSheetHandle |
findIncludedCssStyleSheetHandleByFileName(java.lang.String fileName)
已过时。
|
IncludedCssStyleSheetHandle |
findIncludedCssStyleSheetHandleByProperties(java.lang.String fileName,
java.lang.String externalCssURI,
boolean useExternalCss)
Gets
IncludedCssStyleSheetHandle by properties. |
java.lang.String |
getACLExpression()
Returns the ACL expression associated with the design instance.
|
java.lang.String |
getAfterFactory()
Returns the script called at the end of the Factory after closing the
report document (if any).
|
java.lang.String |
getAfterRender()
Returns the script called after starting a presentation time action.
|
java.util.List |
getAllBookmarks()
Gets all bookmarks defined in this module.
|
java.util.List |
getAllCssStyleSheets()
Gets all css styles sheet
|
java.util.List<IncludedCssStyleSheetHandle> |
getAllExternalIncludedCsses()
Gets the list of the included css style sheets that set the external URI.
|
java.util.List |
getAllPages()
Returns all page handles that this modules and the included modules
contain.
|
java.util.List |
getAllStyles()
Returns all style element handles that this modules and the included
modules contain.
|
java.util.List |
getAllTocs()
Gets all TOCs defined in this module.
|
java.util.List<VariableElementHandle> |
getAllVariables()
Gets all variable.
|
java.lang.String |
getBase()
Returns the base directory to use when computing relative links from this
report.
|
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).
|
java.lang.String |
getBeforeRender()
Returns the script called before starting a presentation time action.
|
java.lang.String |
getBidiOrientation()
Gets Bidi orientation value.
|
SlotHandle |
getBody()
Returns a slot handle to work with the sections in the report's Body
slot.
|
java.lang.String |
getCheatSheet()
Gets the design cheat sheet file path.
|
java.lang.String |
getClientInitialize()
Gets the client-initialize script of the report design.
|
SlotHandle |
getComponents()
Returns a slot handle to work with the top-level components within the
report.
|
SlotHandle |
getCubes()
Gets the slot handle to work with all cube elements within the report.
|
SlotHandle |
getDataSets()
Returns a slot handle to work with the data sets within the report.
|
SlotHandle |
getDataSources()
Returns a slot handle to work with the data sources within the report.
|
java.lang.String |
getDisplayName()
Gets the display name.
|
java.lang.String |
getDisplayNameKey()
Gets the resource key of the display name.
|
DesignElementHandle |
getFlattenElement(DesignElementHandle elementHandle,
java.lang.String originalName)
Gets the flatten element by the original name.
|
java.util.List |
getFlattenParameters()
Returns the flatten Parameters/ParameterGroups of the design.
|
java.lang.String |
getIconFile()
Gets the design icon/thumbnail file path.
|
int |
getImageDPI()
Gets the image DPI of the report design.
|
java.lang.String |
getLanguage()
Gets the language of the report design.
|
java.lang.String |
getLayoutPreference()
Gets the layout preference of this report design.
|
com.ibm.icu.util.ULocale |
getLocale()
Gets the locale of the report design.
|
SlotHandle |
getMasterPages()
Returns a slot handle to work with the master pages within the report.
|
java.lang.String |
getOnPageEnd()
Gets the script of onPageEnd method.
|
java.lang.String |
getOnPageStart()
Gets the script of onPageStart method.
|
java.lang.String |
getOnPrepare()
Gets the on-prepare script of the report design.
|
VariableElementHandle |
getPageVariable(java.lang.String pageVariableName)
Gets the
|
java.util.List<VariableElementHandle> |
getPageVariables()
Gets the pageVariables list value which contains
VariableElementHandle. |
SlotHandle |
getParameters()
Returns a slot handle to work with the top-level parameters and parameter
groups within the report.
|
java.util.List |
getParametersAndParameterGroups()
Returns parameters and parameter groups on the module.
|
int |
getRefreshRate()
Returns the refresh rate when viewing the report.
|
java.util.List |
getReportItemsBasedonTempalates()
Gets report items which holds a template definition, that is, report item
in body slot and page slot.
|
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.
|
SlotHandle |
getStyles()
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.List |
getVisibleThemes(int level)
Returns theme handles according the input level.
|
java.util.Iterator |
imagesIterator()
Returns the iterator over all embedded images of this module instance.
|
void |
importCssStyles(CssStyleSheetHandle stylesheet,
java.util.List selectedStyles)
(non-Javadoc)
|
java.util.Iterator |
includeCssesIterator()
Returns the iterator over all included css style sheets.
|
java.util.Iterator |
includeLibrariesIterator()
Returns the iterator over all included libraries.
|
void |
includeLibrary(java.lang.String libraryFileName,
java.lang.String namespace)
Includes one library with the given library file name.
|
java.util.Iterator |
includeLibraryScriptsIterator()
Returns the list of all the included script file of the libraries.
|
boolean |
isDirectionRTL()
Examines whether the resolved direction of this design element is Right
to Left or not.
|
boolean |
isEnableACL()
Returns
true if the ACL feature is enable; otherwise false. |
CssStyleSheetHandle |
openCssStyleSheet(java.io.InputStream is)
Gets the result style sheet with given file name of an external CSS2
resource.
|
CssStyleSheetHandle |
openCssStyleSheet(java.lang.String fileName)
Gets the result style sheet with given file name of an external CSS2
resource.
|
void |
reloadCss(CssStyleSheetHandle sheetHandle)
Reloads the css with the given css file path.
|
void |
reloadLibraries()
Reloads all libraries this module included.
|
void |
reloadLibrary(LibraryHandle libraryToReload)
Reloads the library with the given library file path.
|
void |
reloadLibrary(java.lang.String reloadPath)
Reloads the library with the given library file path.
|
void |
renameCss(IncludedCssStyleSheetHandle handle,
java.lang.String newFileName)
已过时。
|
void |
renameCssByProperties(IncludedCssStyleSheetHandle handle,
java.lang.String fileName,
java.lang.String externalCssURI,
boolean useExternalCss)
Renames both
IncludedCssStyleSheet and
CSSStyleSheet |
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(java.lang.String expr)
Sets the ACL expression associated with the design instance.
|
void |
setAfterFactory(java.lang.String value)
Sets the script called at the end of the Factory after closing the report
document (if any).
|
void |
setAfterRender(java.lang.String value)
Sets the script called after starting a presentation time action.
|
void |
setBase(java.lang.String base)
Sets the base directory to use when computing relative links from this
report.
|
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).
|
void |
setBeforeRender(java.lang.String value)
Sets the script called before starting a presentation time action.
|
void |
setBidiOrientation(java.lang.String bidiOrientation)
Sets Bidi orientation value.
|
void |
setCascadeACL(boolean cascadeACL)
Sets the flag to control whether to cascade ACL
|
void |
setCheatSheet(java.lang.String cheatSheet)
Sets the design cheat sheet file path.
|
void |
setClientInitialize(java.lang.String script)
Sets the client-initialize script of the report design.
|
void |
setDisplayName(java.lang.String displayName)
Sets the display name.
|
void |
setDisplayNameKey(java.lang.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(java.lang.String iconFile)
Sets the design icon/thumbnail file path.
|
void |
setImageDPI(int imageDPI)
Sets the image DPI of the report design.
|
void |
setLanguage(java.lang.String language)
Sets the language of the report design.
|
void |
setLayoutPreference(java.lang.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(java.lang.String onPageEnd)
Sets the script of onPageEnd method.
|
void |
setOnPageStart(java.lang.String onPageStart)
Sets the script of onPageStart method.
|
void |
setOnPrepare(java.lang.String script)
Sets the on-prepare script of the report design.
|
void |
setPageVariable(java.lang.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(java.lang.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.
|
addAttributeListener, addDisposeListener, addIncludeScript, addResourceChangeListener, addScriptLib, addValidationListener, checkReport, checkReportIfNecessary, close, configVariablesIterator, copy, customColorsIterator, drop, dropAllScriptLibs, dropAndClear, dropIncludeScript, dropScriptLib, dropScriptLib, findCascadingParameterGroup, findColor, findConfigVariable, findCube, findDataSet, findDataSource, findDimension, findElement, findImage, findJointDataSet, findLevel, findLibrary, findMasterPage, findNativeStyle, findParameter, findReportItemTheme, findResource, findResource, findScriptLib, findStyle, findTemplateDataSet, findTheme, generateHandleList, getAllCubes, getAllDataSets, getAllDataSources, getAllImages, getAllIncludeScripts, getAllLibraries, getAllParameters, getAllScriptLibs, getAllSharedDimensions, getAuthor, getCommandStack, getComments, getCreatedBy, getDefaultUnits, getDescription, getDescriptionKey, getDisplayDescription, getElement, getElementByID, getErrorList, getFileEncoding, getFileName, getHelpGuide, getIncludeResource, getIncludeResources, getInitialize, getLibraries, getLibraries, getLibrary, getLineNo, getLineNoByID, getMessage, getMessage, getMessage, getMessageKeys, getNativeStructureList, getOptions, getResourceFolder, getSubject, getSymbolicName, getSystemId, getTheme, getTitle, getTitleKey, getTranslation, getTranslationKeys, getTranslations, getVersion, getVisibleCubes, getVisibleDataSets, getVisibleDataSources, getVisibleImages, getVisibleModules, getWarningList, includeScriptsIterator, initializeModule, isInclude, isReadOnly, needsSave, onSave, removeAttributeListener, removeDisposeListener, removeResourceChangeListener, removeValidationListener, rename, rename, rename, save, saveAs, scriptLibsIterator, serialize, setAuthor, setComments, setCreatedBy, setDefaultUnits, setDescription, setDescriptionKey, setFileName, setHelpGuide, setIncludeResource, setIncludeResources, setInitialize, setOptions, setResourceFolder, setSubject, setSymbolicName, setTitle, setTitleKey, shifIncludeScripts, shiftScriptLibs, sortVisibleElementsadd, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, drop, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExpressionProperty, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isInTemplateParameter, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setBooleanProperty, setEncryption, setEventHandlerClass, setExpressionProperty, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setProperty, setPropertyBinding, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError, slotsIteratorpublic ReportDesignHandle(org.eclipse.birt.report.model.elements.ReportDesign design)
design - the report designpublic java.lang.String getAfterFactory()
public java.lang.String getAfterRender()
public java.lang.String getBase()
public java.lang.String getBeforeFactory()
public java.lang.String getBeforeRender()
public SlotHandle getBody()
public int getRefreshRate()
public SlotHandle getScratchPad()
public java.util.Iterator includeLibraryScriptsIterator()
IncludeScriptHandlepublic void setAfterFactory(java.lang.String value)
value - the script to set.public void setAfterRender(java.lang.String value)
value - the script to set.public void setBase(java.lang.String base)
base - the base directory to setpublic void setBeforeFactory(java.lang.String value)
value - the script to set.public void setBeforeRender(java.lang.String value)
value - the script to set.public void setRefreshRate(int rate)
rate - the refresh ratepublic SlotHandle getStyles()
public java.util.List getAllCssStyleSheets()
CssStyleSheetHandlepublic void importCssStyles(CssStyleSheetHandle stylesheet, java.util.List selectedStyles)
importCssStyles 在类中 ModuleHandleImplstylesheet - the style sheet handle that contains all the selected stylesselectedStyles - the selected style listorg.eclipse.birt.report.model.api.ModuleHandle#importCssStyles(org.
eclipse.birt.report.model.api.css.CssStyleSheetHandle,
java.util.List)public void setDisplayNameKey(java.lang.String displayNameKey)
throws SemanticException
displayNameKey - the resource key of the display nameSemanticException - if the display name resource-key property is locked or not
defined on this design.public java.lang.String getDisplayNameKey()
public void setDisplayName(java.lang.String displayName)
throws SemanticException
displayName - the display nameSemanticException - if the display name property is locked or not defined on this
design.public java.lang.String getDisplayName()
public void setIconFile(java.lang.String iconFile)
throws SemanticException
iconFile - the design icon/thumbnail file path to setSemanticException - if the property is locked or not defined on this design.public java.lang.String getIconFile()
public void setCheatSheet(java.lang.String cheatSheet)
throws SemanticException
cheatSheet - the design cheat sheet file path to setSemanticException - if the property is locked or not defined on this design.public java.lang.String getCheatSheet()
public void setThumbnail(byte[] data)
throws SemanticException
data - the thumbnail image to setSemanticException - if the property is locked or not defined on this design.public byte[] getThumbnail()
public void deleteThumbnail()
throws SemanticException
SemanticException - if the property is locked or not defined on this design.public java.util.List getAllBookmarks()
public java.util.List getAllTocs()
public java.util.List getReportItemsBasedonTempalates()
public SlotHandle getCubes()
ModuleHandleImplgetCubes 在类中 ModuleHandleImplpublic java.lang.String getLayoutPreference()
DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_FIXED_LAYOUT
DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_AUTO_LAYOUT
public void setLayoutPreference(java.lang.String layout)
throws SemanticException
DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_FIXED_LAYOUT
DesignChoiceConstants.REPORT_LAYOUT_PREFERENCE_AUTO_LAYOUT
layout - the layout to setSemanticException - if value is invalidpublic java.util.Iterator includeCssesIterator()
IncludedCssStyleSheetHandlepublic IncludedCssStyleSheetHandle findIncludedCssStyleSheetHandleByFileName(java.lang.String fileName)
IncludedCssStyleSheetHandle by file name.fileName - the file namepublic IncludedCssStyleSheetHandle findIncludedCssStyleSheetHandleByProperties(java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss)
IncludedCssStyleSheetHandle by properties.fileName - externalCssURI - useExternalCss - public CssStyleSheetHandle findCssStyleSheetHandleByFileName(java.lang.String fileName)
CssStyleSheetHandle by file name.fileName - the file name.public CssStyleSheetHandle findCssStyleSheetHandleByProperties(java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss)
CssStyleSheetHandle by file name.fileName - externalCssURI - useExternalCss - public void addCss(CssStyleSheetHandle sheetHandle) throws SemanticException
sheetHandle - css style sheet handleSemanticException - if error is encountered when handling
CssStyleSheet structure list.public void addCss(java.lang.String fileName)
throws SemanticException
fileName - css file nameSemanticException - if error is encountered when handling
CssStyleSheet structure list.public void addCssByProperties(java.lang.String fileName,
java.lang.String externalCssURI,
boolean useExternalCss)
throws SemanticException
fileName - css file nameSemanticException - if error is encountered when handling
CssStyleSheet structure list.public void addCss(IncludedCssStyleSheet cssStruct) throws SemanticException
cssStruct - the CSS structureSemanticException - if error is encountered when handling
CssStyleSheet structure list.public void renameCss(IncludedCssStyleSheetHandle handle, java.lang.String newFileName) throws SemanticException
IncludedCssStyleSheet and
CSSStyleSheet to newFileName.handle - the includedCssStyleSheetHandlenewFileName - the new file nameSemanticExceptionpublic void renameCssByProperties(IncludedCssStyleSheetHandle handle, java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss) throws SemanticException
IncludedCssStyleSheet and
CSSStyleSheet to newFileName.handle - the includedCssStyleSheetHandlenewFileName - the new file nameSemanticExceptionpublic boolean canRenameCss(IncludedCssStyleSheetHandle handle, java.lang.String newFileName) throws SemanticException
handle - the included css style sheet handle.newFileName - the new file name.true can be renamed.else return falseSemanticExceptionpublic boolean canRenameCssByProperties(IncludedCssStyleSheetHandle handle, java.lang.String fileName, java.lang.String externalCssURI, boolean useExternalCss) throws SemanticException
handle - the included css style sheet handle.newFileName - the new file name.true can be renamed.else return falseSemanticExceptionpublic void dropCss(CssStyleSheetHandle sheetHandle) throws SemanticException
sheetHandle - the css to dropSemanticException - if error is encountered when handling CssStyleSheet
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 modulepublic boolean canDropCssStyleSheet(CssStyleSheetHandle sheetHandle)
sheetHandle - true can be dropped.else return falsepublic boolean canAddCssStyleSheet(CssStyleSheetHandle sheetHandle)
sheetHandle - true can be added.else return falsepublic boolean canAddCssStyleSheet(java.lang.String fileName)
fileName - true can be added.else return falsepublic boolean canAddCssStyleSheetByProperties(java.lang.String fileName,
java.lang.String externalCssURI,
boolean useExternalCss)
fileName - externalCssURI - useExternalCss - true can be added.else return falsepublic void reloadCss(CssStyleSheetHandle sheetHandle) throws SemanticException
sheetHandle - css style sheet handle.SemanticException - if error is encountered when handling
CssStyleSheet 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 modulepublic java.lang.String getBidiOrientation()
DesignChoiceConstants and can be one of:
BIDI_DIRECTION_LTR
BIDI_DIRECTION_RTL
public void setBidiOrientation(java.lang.String bidiOrientation)
throws SemanticException
DesignChoiceConstants and can be one of:
BIDI_DIRECTION_LTR
BIDI_DIRECTION_RTL
bidiOrientation - orientation value to be setSemanticExceptionpublic boolean isDirectionRTL()
DesignElementHandleisDirectionRTL 在类中 DesignElementHandlepublic boolean isEnableACL()
true if the ACL feature is enable; otherwise false.
By default, it is false.public void setEnableACL(boolean enableACL)
throws SemanticException
enableACL - true if to enable ACL, otherwise falseSemanticException - if the property is locked by maskspublic java.lang.String getACLExpression()
public void setACLExpression(java.lang.String expr)
throws SemanticException
expr - the expression in stringSemanticException - if the property is locked by maskspublic boolean cascadeACL()
true (the default), the design's ACL is
automatically propagated to all its directly contained child elements and
are added to their ACLs. Otherwise false.public void setCascadeACL(boolean cascadeACL)
throws SemanticException
cascadeACL - true (the default), a design's ACL is
automatically propagated to all its directly contained child
elements and are added to their ACLs. Otherwise
false.SemanticException - if the property is locked by maskspublic int getImageDPI()
public void setImageDPI(int imageDPI)
throws SemanticException
imageDPI - the value of image DPI.SemanticException - if the property is locked by maskspublic java.lang.String getOnPageStart()
public void setOnPageStart(java.lang.String onPageStart)
throws SemanticException
onPageStart - the script of onPageStart method.SemanticException - if the property is locked by masks.public java.lang.String getOnPageEnd()
public void setOnPageEnd(java.lang.String onPageEnd)
throws SemanticException
onPageEnd - the script of onPageEnd method.SemanticException - if the property is locked by masks.public java.util.List<VariableElementHandle> getPageVariables()
VariableElementHandle.public VariableElementHandle getPageVariable(java.lang.String pageVariableName)
pageVariableName - the page variable name.public void setPageVariable(java.lang.String pageVariableName,
Expression value)
throws SemanticException
pageVariableName - the page variable name.value - the page variable value.SemanticExceptionpublic void addVariable(VariableElementHandle variable) throws SemanticException
variable - the variableSemanticExceptionpublic void dropVariable(VariableElementHandle variable) throws SemanticException
variable - the variableSemanticExceptionpublic java.util.List<VariableElementHandle> getAllVariables()
VariableElementHandle.public com.ibm.icu.util.ULocale getLocale()
setLocale(ULocale)public void setLocale(com.ibm.icu.util.ULocale locale)
throws SemanticException
locale - the locale of the report design.SemanticExceptiongetLocale()public java.util.List<IncludedCssStyleSheetHandle> getAllExternalIncludedCsses()
IncludedCssStyleSheetHandle.public void cacheValues()
public DesignElementHandle getFlattenElement(DesignElementHandle elementHandle, java.lang.String originalName)
elementHandle - the handle of a flatten element once in the same namespaceoriginalName - the original name of the elementpublic java.lang.String getOnPrepare()
public void setOnPrepare(java.lang.String script)
throws SemanticException
script - the script to setSemanticException - if the method is locked.getOnPrepare()public java.lang.String getClientInitialize()
public void setClientInitialize(java.lang.String script)
throws SemanticException
script - the script to setSemanticException - if the method is locked.getClientInitialize()public java.lang.String getLanguage()
public void setLanguage(java.lang.String language)
throws SemanticException
language - the language to setSemanticException - if the method is locked.public void addConfigVariable(ConfigVariable configVar) throws SemanticException
ModuleHandleImpladdConfigVariable 在类中 ModuleHandleImplconfigVar - the config variableSemanticException - if the name is empty or the same name exists.public void addImage(EmbeddedImage image) throws SemanticException
ModuleHandleImpladdImage 在类中 ModuleHandleImplimage - the image to addSemanticException - if the name is empty, type is invalid, or the same name
exists.public void addTranslation(java.lang.String resourceKey,
java.lang.String locale,
java.lang.String text)
throws CustomMsgException
ModuleHandleImpladdTranslation 在类中 ModuleHandleImplresourceKey - resource key for the messagelocale - the string value of a locale for the translation. Locale
should be in java-defined format( en, en-US, zh_CN, etc.)text - translated text for the localeCustomMsgException - if the resource key is duplicate or missing, or locale is not
a valid format.ModuleHandleImpl.getTranslation(String, String)public void dropConfigVariable(java.lang.String name)
throws SemanticException
ModuleHandleImpldropConfigVariable 在类中 ModuleHandleImplname - config variable nameSemanticException - if no config variable is found.public void dropImage(java.util.List images)
throws SemanticException
ModuleHandleImplEmbeddedImageHandle.dropImage 在类中 ModuleHandleImplimages - the image handle list to removeSemanticException - if any image in the list is not found.public void dropImage(java.lang.String name)
throws SemanticException
ModuleHandleImpldropImage 在类中 ModuleHandleImplname - the image nameSemanticException - if the image is not found.public void dropTranslation(java.lang.String resourceKey,
java.lang.String locale)
throws CustomMsgException
ModuleHandleImpldropTranslation 在类中 ModuleHandleImplresourceKey - resource key of the message in which this translation saves.locale - the string value of the locale for a translation. Locale
should be in java-defined format( en, en-US, zh_CN, etc.)CustomMsgException - if resourceKey is null.ModuleHandleImpl.getTranslation(String, String)public SlotHandle getComponents()
ModuleHandleImplgetComponents 在类中 ModuleHandleImplpublic SlotHandle getDataSets()
ModuleHandleImplgetDataSets 在类中 ModuleHandleImplpublic SlotHandle getDataSources()
ModuleHandleImplgetDataSources 在类中 ModuleHandleImplpublic java.util.List getFlattenParameters()
ModuleHandleImplgetFlattenParameters 在类中 ModuleHandleImplpublic SlotHandle getMasterPages()
ModuleHandleImplgetMasterPages 在类中 ModuleHandleImplpublic SlotHandle getParameters()
ModuleHandleImplgetParameters 在类中 ModuleHandleImplpublic java.util.Iterator imagesIterator()
ModuleHandleImplEmbeddedImageHandleimagesIterator 在类中 ModuleHandleImplEmbeddedImageHandlepublic void replaceConfigVariable(ConfigVariable oldVar, ConfigVariable newVar) throws SemanticException
ModuleHandleImplreplaceConfigVariable 在类中 ModuleHandleImploldVar - the old config variablenewVar - the new config variableSemanticException - if the old config variable is not found or the name of new
one is empty.public void replaceImage(EmbeddedImage oldVar, EmbeddedImage newVar) throws SemanticException
ModuleHandleImplreplaceImage 在类中 ModuleHandleImploldVar - the old embedded imagenewVar - the new embedded imageSemanticException - if the old image is not found or the name of new one is
empty.public java.util.List getAllStyles()
ModuleHandleImplgetAllStyles 在类中 ModuleHandleImplpublic java.util.List getVisibleThemes(int level)
ModuleHandleImplgetVisibleThemes 在类中 ModuleHandleImpllevel - an int value, which should be the one defined in
IVisibleLevelControl.public java.util.List<ReportItemThemeHandle> getVisibleReportItemThemes(int level, java.lang.String type)
ModuleHandleImplgetVisibleReportItemThemes 在类中 ModuleHandleImpllevel - an int value, which should be the one defined in
IVisibleLevelControl.public java.util.List getParametersAndParameterGroups()
ModuleHandleImplgetParametersAndParameterGroups 在类中 ModuleHandleImplpublic java.util.List getAllPages()
ModuleHandleImplgetAllPages 在类中 ModuleHandleImplpublic void shiftLibrary(LibraryHandle library, int toPosn) throws SemanticException
ModuleHandleImplshiftLibrary 在类中 ModuleHandleImpllibrary - the library to shifttoPosn - the new positionSemanticException - if error is encountered when shiftingpublic java.util.Iterator includeLibrariesIterator()
ModuleHandleImplIncludeLibraryHandleincludeLibrariesIterator 在类中 ModuleHandleImplIncludedLibraryHandlepublic void includeLibrary(java.lang.String libraryFileName,
java.lang.String namespace)
throws DesignFileException,
SemanticException
ModuleHandleImplincludeLibrary 在类中 ModuleHandleImpllibraryFileName - library file namenamespace - library namespaceDesignFileException - if the library file is not found, or has fatal error.SemanticException - if error is encountered when handling IncludeLibrary
structure list.public void dropLibrary(LibraryHandle library) throws SemanticException
ModuleHandleImpldropLibrary 在类中 ModuleHandleImpllibrary - the library to dropSemanticException - if error is encountered when handling IncludeLibrary
structure list. Or it maybe because that the given
library is not found in the design. Or that the library has
descedents in the current modulepublic void reloadLibrary(LibraryHandle libraryToReload) throws SemanticException, DesignFileException
ModuleHandleImplCall this method cautiously ONLY on the condition that the library file is REALLY changed outside. After reload successfully, the command stack is cleared.
reloadLibrary 在类中 ModuleHandleImpllibraryToReload - the library instanceSemanticException - if error is encountered when handling IncludeLibrary
structure list. Or it maybe because that the given
library is not found in the design. Or that the library has
descedents in the current moduleDesignFileException - if the library file is not found, or has fatal error.public void reloadLibraries()
throws SemanticException,
DesignFileException
ModuleHandleImpl
Call this method cautiously ONLY on the condition that the library file
is REALLY changed outside. After reload successfully, the command stack
is cleared.
ModuleHandleImpl.reloadLibrary(LibraryHandle)
public void reloadLibrary(java.lang.String reloadPath)
throws SemanticException,
DesignFileException
ModuleHandleImplCall this method cautiously ONLY on the condition that the library file is REALLY changed outside. After reload successfully, the command stack is cleared.
reloadLibrary 在类中 ModuleHandleImplreloadPath - this is supposed to be an absolute path, not in url form.SemanticException - if error is encountered when handling IncludeLibrary
structure list. Or it maybe because that the given
library is not found in the design. Or that the library has
descedents in the current moduleDesignFileException - if the library file is not found, or has fatal error.public void dropLibraryAndBreakExtends(LibraryHandle library) throws SemanticException
ModuleHandleImpldropLibraryAndBreakExtends 在类中 ModuleHandleImpllibrary - the given library to dropSemanticException - if errors occured when drop the library.It may be because
that the library is not found in the design or that some
elements can not be localized properly.public CssStyleSheetHandle openCssStyleSheet(java.lang.String fileName) throws StyleSheetException
ModuleHandleImplopenCssStyleSheet 在类中 ModuleHandleImplfileName - the file name of the external CSS resourceCssStyleSheetHandle if the external resource is
successfully loadedStyleSheetException - thrown if the resource is not found, or there are syntax
errors in the resourcepublic CssStyleSheetHandle openCssStyleSheet(java.io.InputStream is) throws StyleSheetException
ModuleHandleImplopenCssStyleSheet 在类中 ModuleHandleImplis - the input stream of the resourceCssStyleSheetHandle if the external resource is
successfully loadedStyleSheetException - thrown if the resource is not found, or there are syntax
errors in the resourcepublic void setThemeName(java.lang.String themeName)
throws SemanticException
ModuleHandleImplsetThemeName 在类中 ModuleHandleImplthemeName - the name of the themeSemanticExceptionpublic void setTheme(ThemeHandle theme) throws SemanticException
ModuleHandleImplsetTheme 在类中 ModuleHandleImpltheme - the theme instanceSemanticExceptionCopyright © 2008 Actuate Corp. All rights reserved.