Class ReportItemHandleImpl
java.lang.Object
org.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.ReportItemHandleImpl
- All Implemented Interfaces:
IReportItemMethodContext,org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel,org.eclipse.birt.report.model.elements.interfaces.IInternalReportItemModel,org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel
- Direct Known Subclasses:
ReportItemHandle
public abstract class ReportItemHandleImpl
extends ReportElementHandle
implements org.eclipse.birt.report.model.elements.interfaces.IInternalReportItemModel, org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel, IReportItemMethodContext
Abstract implementation class for the report item handle
- Since:
- 3.3
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intData binding type "data", means the report item is binding to a data set or cube.static final intData binding type "none".static final intData binding type "reportItemRef", means the report item is binding to another report item.Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
elementFields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
moduleFields 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_PROPFields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IInternalReportItemModel
ACL_EXPRESSION_PROP, ALLOW_EXPORT_PROP, ALTTEXT_KEY_PROP, ALTTEXT_PROP, BOOKMARK_DISPLAY_NAME_PROP, BOOKMARK_PROP, BOUND_DATA_COLUMNS_PROP, CASCADE_ACL_PROP, CUBE_PROP, DATA_BINDING_REF_PROP, DATA_SET_PROP, HEIGHT_PROP, LANGUAGE_PROP, MULTI_VIEWS_PROP, ON_CREATE_METHOD, ON_PAGE_BREAK_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, ORDER_PROP, PARAM_BINDINGS_PROP, PUSH_DOWN_PROP, TAG_TYPE_PROP, THEME_PROP, TOC_PROP, URL_PROP, VISIBILITY_PROP, WIDTH_PROP, X_PROP, Y_PROP, Z_INDEX_PROPFields inherited from interface org.eclipse.birt.report.model.api.elements.IReportItemMethodContext
ON_CREATE_CONTEXT, ON_PREPARE_CONTEXT, ON_RENDER_CONTEXTFields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel
STYLE_PROP -
Constructor Summary
ConstructorsConstructorDescriptionReportItemHandleImpl(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddColumnBinding(ComputedColumn addColumn, boolean inForce) Adds a bound column to the list.Adds toc structure.Adds toc structure.voidaddView(DesignElementHandle viewElement) Adds a new element as the view.booleanGets the allowExport property of the report item.booleancanAddView(String extensionType) Determines whether this report item can add a view with the specified extension type or not.booleanDetermines whether this report item can cascade ACL or not.booleanReturnstrue(the default), a report element's ACL is automatically propagated to all its directly contained child elements and are added to their ACLs.Returns the bound columns that binds the data set columns.voiddropView(DesignElementHandle viewElement) Deletes the given view.findColumnBinding(String name) Finds a column binding with the given name.Returns the ACL expression associated with the report element instance.Returns the alternate text of this label item.Returns the resource key of the alternate text of this image.Returns all the bindings which are available for this element.Returns report items that can be referred by other report items by data binding reference property.Returns report items that can be referred by other report items by data binding reference property.protected List<ReportItemHandle>getAvailableDataBindingReferenceList(String propName) Returns all available data binding referred report items, regardless of namelessness.Returns report items that can be referred by other report items by data binding reference property.Returns the bookmark of the report item.Gets the display name of the bookmark.Get a handle to deal with the bound column.getCube()Returns the cube of the report item.Returns the view that is being used.Returns the report item of which data binding are referred by.Returns the name of the report item of which data binding are referred by.intReturns the data binding type of this report item.Returns the data set of the report item.Gets a handle to deal with the item's height.Returns the language of this label item.getMethods(String methodName) Returns functions that can be called in the given method.Returns report items that can be referred by other report items by data binding reference property.Returns report items that can be referred by other report items by data binding reference property.Returns report items that can be referred by other report items by data binding reference property.Returns the script executed when the element is created in the Factory.Gets the on-pageBreak script of the report item.Gets the on-prepare script of the group.Returns the script executed when the element is prepared for rendering in the Presentation engine.intgetOrder()Returns the order of this label item.getProperty(String propName) Returns the value of a property as a generic object.Returns the tag type of this label item.final ReportItemThemeHandlegetTheme()Returns the refresh rate when viewing the report.getTOC()Gets TOC handle.Deprecated.getURL()Returns the url of this label item.Gets the host element of this view.getViews()Returns a list containing view elements.getWidth()Gets a handle to deal with the item's width.getX()Gets a handle to deal with the item's x (horizontal) position.getY()Gets a handle to deal with the item's y (vertical) position.intGets the item's z position as an integer.Returns the iterator for parameter binding list defined on this report item.booleanpushDown()Indicate if the query will be pushed down to the database.voidremovedColumnBinding(String bindingName) Removes bound column from the element.voidremovedColumnBindings(List<String> bindingNameList) Removes bound columns from the element.voidRemoves unused bound columns from the element.voidsetACLExpression(String expr) Sets the ACL expression associated with the report element instance.voidsetAllowExport(boolean allowExport) Sets the allowExport property of the report item.voidsetAltTextExpression(Expression altText) Sets the alternate text of this label item.voidsetAltTextKey(String altTextKey) Sets the resource key of the alternate text of this image.voidsetBookmark(String value) Sets the bookmark of the report item.voidsetBookmarkDisplayName(String bookmarkDisplayName) Sets the display name of the bookmark.voidsetCascadeACL(boolean cascadeACL) Sets the flag to control whether to cascade ACLvoidsetCube(CubeHandle handle) Sets the cube of the report item.voidsetCurrentView(DesignElementHandle viewElement) Sets the view to be used.voidSets the report item of which data binding are referred by.voidsetDataSet(DataSetHandle handle) Sets the data set of the report item.voidsetHeight(double dimension) Sets the item's height to a value in default units.voidSets the item's height using a dimension string with optional unit suffix such as "10" or "10pt".voidsetLanguage(String language) Sets the language of this label item.voidsetOnCreate(String value) Sets the script executed when the element is created in the Factory.voidsetOnPageBreak(String script) Sets the on-pageBreak script of the report item.voidsetOnPrepare(String script) Sets the on-prepare script of the group element.voidsetOnRender(String value) Sets the script executed when the element is prepared for rendering in the Presentation engine.voidsetOrder(int order) Sets the order of this label item.voidsetPushDown(boolean pushDown) Sets the pushdown property value of the report item.voidsetTagType(String tagType) Sets the tag type of this label item.voidsetTheme(ReportItemThemeHandle theme) Set the themevoidsetThemeName(String themeName) Set the theme namevoidsetTocExpression(String expression) Deprecated.voidSets the url of this label item.voidsetWidth(double dimension) Sets the item's width to a value in default units.voidSets the item's width using a dimension string with optional unit suffix such as "10" or "10pt".voidsetX(double dimension) Sets the item's x position to a value in default units.voidSets the item's x position using a dimension string with optional unit suffix such as "10" or "10pt".voidsetY(double dimension) Sets the item's y position to a value in default units.voidSets the item's y position using a dimension string with optional unit suffix such as "10" or "10pt".voidsetZIndex(int zIndex) Sets the item's z position to an integer.Returns visibility rules defined on the report item.Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMaskMethods 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, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, drop, drop, dropAndClear, 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, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, 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
-
Field Details
-
DATABINDING_TYPE_NONE
public static final int DATABINDING_TYPE_NONEData binding type "none".- See Also:
-
DATABINDING_TYPE_DATA
public static final int DATABINDING_TYPE_DATAData binding type "data", means the report item is binding to a data set or cube.- See Also:
-
DATABINDING_TYPE_REPORT_ITEM_REF
public static final int DATABINDING_TYPE_REPORT_ITEM_REFData binding type "reportItemRef", means the report item is binding to another report item.- See Also:
-
-
Constructor Details
-
ReportItemHandleImpl
public ReportItemHandleImpl(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Constructor- Parameters:
module- module of the report itemelement- element of the report item
-
-
Method Details
-
getDataSet
Returns the data set of the report item.- Returns:
- the handle to the data set
-
setDataSet
Sets the data set of the report item.- Parameters:
handle- the handle of the data set- Throws:
SemanticException- if the property is locked.
-
getCube
Returns the cube of the report item.- Returns:
- the handle to the cube
-
setCube
Sets the cube of the report item.- Parameters:
handle- the handle of the cube- Throws:
SemanticException- if the property is locked.
-
getX
Gets a handle to deal with the item's x (horizontal) position.- Returns:
- a DimensionHandle for the item's x position.
-
getY
Gets a handle to deal with the item's y (vertical) position.- Returns:
- a DimensionHandle for the item's y position.
-
setX
Sets the item's x position using a dimension string with optional unit suffix such as "10" or "10pt". If no suffix is provided, then the units are assumed to be in the design's default units. Call this method to set a string typed in by the user.- Parameters:
dimension- dimension string with optional unit suffix.- Throws:
SemanticException- if the string is not valid
-
setX
Sets the item's x position to a value in default units. The default unit may be defined by the property in BIRT or the application unit defined in the design session.- Parameters:
dimension- the new value in application units.- Throws:
SemanticException- if the property is locked.
-
setY
Sets the item's y position using a dimension string with optional unit suffix such as "10" or "10pt". If no suffix is provided, then the units are assumed to be in the design's default units. Call this method to set a string typed in by the user.- Parameters:
dimension- dimension string with optional unit suffix.- Throws:
SemanticException- if the string is not valid
-
setY
Sets the item's y position to a value in default units. The default unit may be defined by the property in BIRT or the application unit defined in the design session.- Parameters:
dimension- the new value in application units.- Throws:
SemanticException- if the property is locked.
-
setHeight
Sets the item's height using a dimension string with optional unit suffix such as "10" or "10pt". If no suffix is provided, then the units are assumed to be in the design's default units. Call this method to set a string typed in by the user.- Parameters:
dimension- dimension string with optional unit suffix.- Throws:
SemanticException- if the string is not valid
-
setHeight
Sets the item's height to a value in default units. The default unit may be defined by the property in BIRT or the application unit defined in the design session.- Parameters:
dimension- the new value in application units.- Throws:
SemanticException- if the property is locked.
-
setWidth
Sets the item's width using a dimension string with optional unit suffix such as "10" or "10pt". If no suffix is provided, then the units are assumed to be in the design's default units. Call this method to set a string typed in by the user.- Parameters:
dimension- dimension string with optional unit suffix.- Throws:
SemanticException- if the string is not valid
-
setWidth
Sets the item's width to a value in default units. The default unit may be defined by the property in BIRT or the application unit defined in the design session.- Parameters:
dimension- the new value in application units.- Throws:
SemanticException- if the property is locked.
-
getWidth
Gets a handle to deal with the item's width.- Returns:
- a DimensionHandle for the item's width.
-
getHeight
Gets a handle to deal with the item's height.- Returns:
- a DimensionHandle for the item's height.
-
getBookmark
Returns the bookmark of the report item.- Returns:
- the book mark as a string
-
setBookmark
Sets the bookmark of the report item.- Parameters:
value- the property value to be set.- Throws:
SemanticException- if the property is locked.
-
visibilityRulesIterator
Returns visibility rules defined on the report item. The element in the iterator is the correspondingStructureHandlethat deal with aHidein the list.- Returns:
- the iterator for visibility rules defined on this report item.
- See Also:
-
getOnCreate
Returns the script executed when the element is created in the Factory. Called after the item is created, but before the item is saved to the report document file.- Returns:
- the script that executes
-
setOnCreate
Sets the script executed when the element is created in the Factory. Called after the item is created, but before the item is saved to the report document file.- Parameters:
value- the script to set- Throws:
SemanticException- if the property is locked.
-
getOnRender
Returns the script executed when the element is prepared for rendering in the Presentation engine.- Returns:
- the script that executes
-
setOnRender
Sets the script executed when the element is prepared for rendering in the Presentation engine.- Parameters:
value- the script to set- Throws:
SemanticException- if the property is locked.
-
paramBindingsIterator
Returns the iterator for parameter binding list defined on this report item. The element in the iterator is the correspondingStructureHandlethat deal with aParamBindingin the list.- Returns:
- the iterator for parameter binding handle list defined on this data set.
- See Also:
-
org.eclipse.birt.report.model.api.elements.structures.ParamBindingHandle
-
setTocExpression
Deprecated.Sets a table of contents entry for this item. The TOC property defines an expression that returns a string that is to appear in the Table of Contents for this item or its container.- Parameters:
expression- the expression that returns a string- Throws:
SemanticException- if the TOC property is locked by the property mask.- See Also:
-
getTocExpression
Deprecated.Returns the expression evalueated as a table of contents entry for this item.- Returns:
- the expression evaluated as a table of contents entry for this item
- See Also:
-
getOnPrepare
Gets the on-prepare script of the group. Startup phase. No data binding yet. The design of an element can be changed here.- Returns:
- the on-prepare script of the group
-
setOnPrepare
Sets the on-prepare script of the group element.- Parameters:
script- the script to set- Throws:
SemanticException- if the method is locked.- See Also:
-
getOnPageBreak
Gets the on-pageBreak script of the report item. Presentation phase. It is for a script executed when the element is prepared for page breaking in the Presentation engine.- Returns:
- the on-pageBreak script of the report item
-
setOnPageBreak
Sets the on-pageBreak script of the report item.- Parameters:
script- the script to set- Throws:
SemanticException- if the method is locked.- See Also:
-
columnBindingsIterator
Returns the bound columns that binds the data set columns. The item in the iterator is the correspondingComputedColumnHandle.- Returns:
- a list containing the bound columns.
-
getColumnBindings
Get a handle to deal with the bound column.- Returns:
- a handle to deal with the bound data column.
-
getAvailableBindings
Returns all the bindings which are available for this element. If the report item has no local data set, the bindings come from its container.- Returns:
- each item is a
ComputedColumnHandleinstance.
-
addColumnBinding
public ComputedColumnHandle addColumnBinding(ComputedColumn addColumn, boolean inForce) throws SemanticException Adds a bound column to the list.- Parameters:
addColumn- the bound column to addinForce-truethe column is added to the list regardless of duplicate expression.falsedo not add the column if the expression already exist- Returns:
- the newly created
ComputedColumnHandleor the existedComputedColumnHandlein the list - Throws:
SemanticException- if expression is not duplicate but the name duplicates the exsiting bound column. Or, if the both name/expression are duplicate, butinForceistrue.
-
findColumnBinding
Finds a column binding with the given name.- Parameters:
name- name of the binding to find- Returns:
- column binding with the given name if found, otherwise null
-
removedUnusedColumnBindings
Removes unused bound columns from the element. Bound columns of nested elements will not be removed. For example, if calls this method for a list thaat contains a text-data, unused bound columns on list are removed. While, unused columns on text-data still are kept.- Throws:
SemanticException- if bound column property is locked.
-
getTOC
Gets TOC handle.- Returns:
- toc handle
-
addTOC
Adds toc structure.- Parameters:
expression- toc expression- Returns:
- toc handle
- Throws:
SemanticException
-
addTOC
Adds toc structure.- Parameters:
toc- toc structure- Returns:
- toc handle
- Throws:
SemanticException
-
getZIndex
public int getZIndex()Gets the item's z position as an integer.- Returns:
- the z depth. Start from 0
-
setZIndex
Sets the item's z position to an integer.- Parameters:
zIndex- the z depth. Start from 0- Throws:
SemanticException- if the property is locked.
-
getMethods
Returns functions that can be called in the given method.- Parameters:
methodName- the method name in string- Returns:
- a list containing
IMethodInfofor functions
-
setDataBindingReference
Sets the report item of which data binding are referred by.- Parameters:
item- the report item- Throws:
SemanticException- if the element reference makes a circle
-
getDataBindingReferenceName
Returns the name of the report item of which data binding are referred by.- Returns:
- the report item name
-
getDataBindingReference
Returns the report item of which data binding are referred by.- Returns:
- the report item
-
getDataBindingType
public int getDataBindingType()Returns the data binding type of this report item. The return value should be one of following:- DATABINDING_TYPE_NONE, no data binding.
- DATABINDING_TYPE_DATA, data binding to data set or cube.
- DATABINDING_TYPE_REPORT_ITEM_REF, data binding to another report item.
- Returns:
- the data binding type of this report item
-
getAvailableDataBindingReferenceList
Returns report items that can be referred by other report items by data binding reference property.Two kinds of report items can be referred:
- The report item has dataset or cube property defined. That is, data set or cube property is set locally and databinding ref property is null.
- The report item has data binding reference to other report items.
ReportItemHandletype.- Returns:
- returns report items that has dataset or cube property defined
-
getNamedDataBindingReferenceList
Returns report items that can be referred by other report items by data binding reference property. Report items in the return list havenon-nullnames.Two kinds of report items can be referred:
- The report item has dataset or cube property defined. That is, data set or cube property is set locally and databinding ref property is null.
- The report item has data binding reference to other report items.
ReportItemHandletype.- Returns:
- returns report items that has dataset or cube property defined
-
getAvailableDataSetBindingReferenceList
Returns report items that can be referred by other report items by data binding reference property.Two kinds of report items can be referred:
- The report item has dataset property defined. That is, data set property is set locally and databinding ref property is null.
- The report item has data binding reference to other report items.
ReportItemHandletype.- Returns:
- returns report items that has dataset property defined
-
getNamedDataSetBindingReferenceList
Returns report items that can be referred by other report items by data binding reference property. Report items in the return list havenon-nullnames.Two kinds of report items can be referred:
- The report item has dataset property defined. That is, data set property is set locally and databinding ref property is null.
- The report item has data binding reference to other report items.
ReportItemHandletype.- Returns:
- returns report items that has dataset property defined
-
getAvailableCubeBindingReferenceList
Returns report items that can be referred by other report items by data binding reference property.Two kinds of report items can be referred:
- The report item has cube property defined. That is, cube property is set locally and databinding ref property is null.
- The report item has data binding reference to other report items.
ReportItemHandletype.- Returns:
- returns report items that has cube property defined
-
getNamedCubeBindingReferenceList
Returns report items that can be referred by other report items by data binding reference property. Report items in the return list havenon-nullnames.Two kinds of report items can be referred:
- The report item has cube property defined. That is, cube property is set locally and databinding ref property is null.
- The report item has data binding reference to other report items.
ReportItemHandletype.- Returns:
- returns report items that has cube property defined
-
getAvailableDataBindingReferenceList
Returns all available data binding referred report items, regardless of namelessness.- Parameters:
propName- the property name. Can be resultSet, cube ornull.- Returns:
- a list containing report item
-
removedColumnBindings
Removes bound columns from the element.- Parameters:
bindingNameList- the binding name list to be removed, each entry should be instance ofjava.lang.String.- Throws:
SemanticException- if bound column property is locked.
-
removedColumnBinding
Removes bound column from the element.- Parameters:
bindingName- the binding name to be removed- Throws:
SemanticException- if bound column property is locked.
-
getCurrentView
Returns the view that is being used.- Returns:
- the view that is being used
-
addView
Adds a new element as the view.- Parameters:
viewElement- the element- Throws:
SemanticException
-
dropView
Deletes the given view.- Parameters:
viewElement- the element- Throws:
SemanticException
-
setCurrentView
Sets the view to be used. If the given element is not in the multiple view, it will be added and set as the active view.- Parameters:
viewElement- the view element, must not bethis. Can benull.- Throws:
SemanticException- if the given element resides in the other elements.
-
getViews
Returns a list containing view elements.- Returns:
- a list. Each item is
DesignElementHandle.
-
canAddView
Determines whether this report item can add a view with the specified extension type or not.- Parameters:
extensionType- extension type- Returns:
- Return the verified option to add the view
-
getACLExpression
Returns the ACL expression associated with the report element instance.- Returns:
- the expression in string
-
setACLExpression
Sets the ACL expression associated with the report element instance.- Parameters:
expr- the expression in string- Throws:
SemanticException- if the property is locked by masks
-
cascadeACL
public boolean cascadeACL()Returnstrue(the default), a report element'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 report element'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
-
canCascadeACL
public boolean canCascadeACL()Determines whether this report item can cascade ACL or not. True if and only if this item has defineIInternalReportItemModel.CASCADE_ACL_PROPproperty and it is a container.- Returns:
- true if this item has define
IInternalReportItemModel.CASCADE_ACL_PROPproperty and it is a container, otherwise false
-
allowExport
public boolean allowExport()Gets the allowExport property of the report item.- Returns:
- a boolean value which indicates if can be exported or not.
-
setAllowExport
Sets the allowExport property of the report item.- Parameters:
allowExport- indicates whether can be exported or not.- Throws:
SemanticException
-
getViewHost
Gets the host element of this view.- Returns:
- the host element of this view
-
getBookmarkDisplayName
Gets the display name of the bookmark.- Returns:
- the display name of the bookmark.
-
setBookmarkDisplayName
Sets the display name of the bookmark.- Parameters:
bookmarkDisplayName- the display name of the bookmark to set- Throws:
SemanticException
-
pushDown
public boolean pushDown()Indicate if the query will be pushed down to the database. Default value is false.- Returns:
if the query will be pushed down to the database, otherwise return .
-
setPushDown
Sets the pushdown property value of the report item. Property pushDown indicates if the query will be pushed down to the database.- Parameters:
pushDown- true if the query will be pushed down to the database, otherwise false.- Throws:
SemanticException
-
getProperty
Description copied from class:DesignElementHandleReturns the value of a property as a generic object. The value is the internal property value, it is not localized. For a property with the element reference type, the reference element name is returned.- Overrides:
getPropertyin classDesignElementHandle- Parameters:
propName- the name of the property of interest- Returns:
- the value of the property. The type of the returned object depends on the property type.
- See Also:
-
setThemeName
Set the theme name- Parameters:
themeName- theme name- Throws:
SemanticException- throw semantic exception
-
setTheme
Set the theme- Parameters:
theme- theme object- Throws:
SemanticException- throw semantic exception
-
getTheme
Returns the refresh rate when viewing the report.- Returns:
- the refresh rate
-
getTagType
Returns the tag type of this label item.- Returns:
- the tag type value
-
setTagType
Sets the tag type of this label item.- Parameters:
tagType- the tag type- Throws:
SemanticException- if the property is locked.
-
getLanguage
Returns the language of this label item.- Returns:
- the language
-
setLanguage
Sets the language of this label item.- Parameters:
language- the language- Throws:
SemanticException- if the property is locked.
-
getAltTextExpression
Returns the alternate text of this label item.- Returns:
- the alternate text expression.
-
setAltTextExpression
Sets the alternate text of this label item.- Parameters:
altText- the alternate text expression.- Throws:
SemanticException- if the property is locked.
-
getOrder
public int getOrder()Returns the order of this label item.- Returns:
- the order
-
setOrder
Sets the order of this label item.- Parameters:
order- order number- Throws:
SemanticException- if the property is locked.
-
getURL
Returns the url of this label item.- Returns:
- the url
-
setURL
Sets the url of this label item.- Parameters:
url- the url- Throws:
SemanticException- if the property is locked.
-
getAltTextKey
Returns the resource key of the alternate text of this image.- Returns:
- the resource key of the alternate text
-
setAltTextKey
Sets the resource key of the alternate text of this image.- Parameters:
altTextKey- the alternate text key- Throws:
SemanticException
-