|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ModuleHandle
org.eclipse.birt.report.model.api.ReportDesignHandle
public class ReportDesignHandle
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
.
ModuleHandle.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);
ReportDesign
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ModuleHandle |
---|
isInitialized |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IReportDesignModel |
---|
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, CSSES_PROP, CUBE_SLOT, ENABLE_ACL_PROP, ICON_FILE_PROP, LAYOUT_PREFERENCE_PROP, REFRESH_RATE_PROP, SCRATCH_PAD_SLOT, SLOT_COUNT, STYLE_SLOT, TEMPLATE_PARAMETER_DEFINITION_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 |
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, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
ReportDesignHandle(org.eclipse.birt.report.model.elements.ReportDesign design)
Constructs a handle with the given design. |
Method Summary | |
---|---|
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)
Includes one css with the given css file name. |
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)
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)
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 |
dropCss(CssStyleSheetHandle sheetHandle)
Drops the given css style sheet of this design file. |
CssStyleSheetHandle |
findCssStyleSheetHandleByFileName(java.lang.String fileName)
Gets CssStyleSheetHandle by file name. |
IncludedCssStyleSheetHandle |
findIncludedCssStyleSheetHandleByFileName(java.lang.String fileName)
Gets IncludedCssStyleSheetHandle by file name. |
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 |
getAllTocs()
Gets all TOCs defined in this module. |
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. |
SlotHandle |
getCubes()
Gets the slot handle to work with all cube elements within the report. |
java.lang.String |
getDisplayName()
Gets the display name. |
java.lang.String |
getDisplayNameKey()
Gets the resource key of the display name. |
java.lang.String |
getIconFile()
Gets the design icon/thumbnail file path. |
java.lang.String |
getLayoutPreference()
Gets the layout preference of this report design. |
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. |
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 |
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. |
void |
reloadCss(CssStyleSheetHandle sheetHandle)
Reloads the css with the given css file path. |
void |
renameCss(IncludedCssStyleSheetHandle handle,
java.lang.String newFileName)
Renames both IncludedCssStyleSheet and
CSSStyleSheet |
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 |
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 |
setLayoutPreference(java.lang.String layout)
Sets the layout preference of this report design. |
void |
setRefreshRate(int rate)
Sets the refresh rate when viewing the report. |
void |
setThumbnail(byte[] data)
Sets the thumbnail image encoded in ISO-8859-1. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReportDesignHandle(org.eclipse.birt.report.model.elements.ReportDesign design)
design
- the report designMethod Detail |
---|
public 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()
IncludeScriptHandle
public 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()
getStyles
in class ModuleHandle
public java.util.List getAllCssStyleSheets()
CssStyleSheetHandle
public void importCssStyles(CssStyleSheetHandle stylesheet, java.util.List selectedStyles)
importCssStyles
in class ModuleHandle
stylesheet
- the style sheet handle that contains all the selected stylesselectedStyles
- the selected style 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 name
SemanticException
- 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 name
SemanticException
- 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 set
SemanticException
- 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 set
SemanticException
- 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 set
SemanticException
- 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()
ModuleHandle
getCubes
in class ModuleHandle
public 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 set
SemanticException
- if value is invalidpublic java.util.Iterator includeCssesIterator()
IncludedCssStyleSheetHandle
public IncludedCssStyleSheetHandle findIncludedCssStyleSheetHandleByFileName(java.lang.String fileName)
IncludedCssStyleSheetHandle
by file name.
fileName
- the file name
public CssStyleSheetHandle findCssStyleSheetHandleByFileName(java.lang.String fileName)
CssStyleSheetHandle
by file name.
fileName
- the file name.
public void addCss(CssStyleSheetHandle sheetHandle) throws SemanticException
sheetHandle
- css style sheet handle
SemanticException
- if error is encountered when handling
CssStyleSheet
structure list.public void addCss(java.lang.String fileName) throws SemanticException
fileName
- css file name
SemanticException
- if error is encountered when handling
CssStyleSheet
structure list.public void addCss(IncludedCssStyleSheet cssStruct) throws SemanticException
cssStruct
- the CSS structure
SemanticException
- 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.
- Parameters:
handle
- the includedCssStyleSheetHandlenewFileName
- the new file name
- Throws:
SemanticException
public 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 false
SemanticException
public void dropCss(CssStyleSheetHandle sheetHandle) throws SemanticException
sheetHandle
- the css to drop
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 boolean canDropCssStyleSheet(CssStyleSheetHandle sheetHandle)
sheetHandle
-
true
can be dropped.else return false
public boolean canAddCssStyleSheet(CssStyleSheetHandle sheetHandle)
sheetHandle
-
true
can be added.else return false
public boolean canAddCssStyleSheet(java.lang.String fileName)
fileName
-
true
can be added.else return false
public 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 set
SemanticException
public boolean isDirectionRTL()
DesignElementHandle
isDirectionRTL
in class DesignElementHandle
public 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 false
SemanticException
- if the property is locked by maskspublic java.lang.String getACLExpression()
public void setACLExpression(java.lang.String expr) throws SemanticException
expr
- the expression in string
SemanticException
- 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 java.util.List<IncludedCssStyleSheetHandle> getAllExternalIncludedCsses()
IncludedCssStyleSheetHandle
.
public void cacheValues()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |