|
||||||||||
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.ReportElementHandle
org.eclipse.birt.report.model.api.ReportItemHandle
public abstract class ReportItemHandle
Represents a report item: any element that can appear within a section of the
report. Report items have a size and position that are used in some
containers. Report items also have a style. Report items can references to
the data set to use for itself. Many report items can be the target of
hyperlinks. The bookmark property identifies the item location. It also has a
set of visibility rules that say when a report item should be hidden. The
bindings allow a report item to pass data into its data source. Call
DesignElementHandle.getPrivateStyle()
( ) to get a handle with
getter/setter methods for the style properties.
ReportItem
Field Summary | |
---|---|
static int |
DATABINDING_TYPE_DATA
Data binding type "data", means the report item is binding to a data set or cube. |
static int |
DATABINDING_TYPE_NONE
Data binding type "none". |
static int |
DATABINDING_TYPE_REPORT_ITEM_REF
Data binding type "reportItemRef", means the report item is binding to another report item. |
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IReportItemModel |
---|
ACL_EXPRESSION_PROP, ALLOW_EXPORT_PROP, BOOKMARK_PROP, BOUND_DATA_COLUMNS_PROP, CASCADE_ACL_PROP, CUBE_PROP, DATA_BINDING_REF_PROP, DATA_SET_PROP, HEIGHT_PROP, MULTI_VIEWS_PROP, ON_CREATE_METHOD, ON_PAGE_BREAK_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, PARAM_BINDINGS_PROP, TOC_PROP, VISIBILITY_PROP, WIDTH_PROP, X_PROP, Y_PROP, Z_INDEX_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel |
---|
STYLE_PROP |
Fields inherited from interface org.eclipse.birt.report.model.api.elements.IReportItemMethodContext |
---|
ON_CREATE_CONTEXT, ON_PREPARE_CONTEXT, ON_RENDER_CONTEXT |
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 | |
---|---|
ReportItemHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs the handle for a report item with the given design and element. |
Method Summary | |
---|---|
ComputedColumnHandle |
addColumnBinding(ComputedColumn addColumn,
boolean inForce)
Adds a bound column to the list. |
TOCHandle |
addTOC(java.lang.String expression)
Adds toc structure. |
TOCHandle |
addTOC(TOC toc)
Adds toc structure. |
void |
addView(DesignElementHandle viewElement)
Adds a new element as the view. |
boolean |
allowExport()
Gets the allowExport property of the report item. |
boolean |
canCascadeACL()
Determines whether this report item can cascade ACL or not. |
boolean |
cascadeACL()
Returns true (the default), a report element's ACL is
automatically propagated to all its directly contained child elements and
are added to their ACLs. |
java.util.Iterator |
columnBindingsIterator()
Returns the bound columns that binds the data set columns. |
void |
dropView(DesignElementHandle viewElement)
Deletes the given view. |
ComputedColumnHandle |
findColumnBinding(java.lang.String name)
Finds a column binding with the given name. |
java.lang.String |
getACLExpression()
Returns the ACL expression associated with the report element instance. |
java.util.Iterator |
getAvailableBindings()
Returns all the bindings which are available for this element. |
java.util.List |
getAvailableCubeBindingReferenceList()
Returns report items that can be referred by other report items by data binding reference property. |
java.util.List |
getAvailableDataBindingReferenceList()
Returns report items that can be referred by other report items by data binding reference property. |
java.util.List |
getAvailableDataSetBindingReferenceList()
Returns report items that can be referred by other report items by data binding reference property. |
java.lang.String |
getBookmark()
Returns the bookmark of the report item. |
PropertyHandle |
getColumnBindings()
Get a handle to deal with the bound column. |
CubeHandle |
getCube()
Returns the cube of the report item. |
DesignElementHandle |
getCurrentView()
Returns the view that is being used. |
ReportItemHandle |
getDataBindingReference()
Returns the report item of which data binding are referred by. |
java.lang.String |
getDataBindingReferenceName()
Returns the name of the report item of which data binding are referred by. |
int |
getDataBindingType()
Returns the data binding type of this report item. |
DataSetHandle |
getDataSet()
Returns the data set of the report item. |
DimensionHandle |
getHeight()
Gets a handle to deal with the item's height. |
java.util.List |
getMethods(java.lang.String methodName)
Returns functions that can be called in the given method. |
java.util.List |
getNamedCubeBindingReferenceList()
Returns report items that can be referred by other report items by data binding reference property. |
java.util.List |
getNamedDataBindingReferenceList()
Returns report items that can be referred by other report items by data binding reference property. |
java.util.List |
getNamedDataSetBindingReferenceList()
Returns report items that can be referred by other report items by data binding reference property. |
java.lang.String |
getOnCreate()
Returns the script executed when the element is created in the Factory. |
java.lang.String |
getOnPageBreak()
Gets the on-pageBreak script of the report item. |
java.lang.String |
getOnPrepare()
Gets the on-prepare script of the group. |
java.lang.String |
getOnRender()
Returns the script executed when the element is prepared for rendering in the Presentation engine. |
TOCHandle |
getTOC()
Gets TOC handle. |
java.lang.String |
getTocExpression()
Deprecated. |
ReportItemHandle |
getViewHost()
Gets the host element of this view. |
java.util.List |
getViews()
Returns a list containing view elements. |
DimensionHandle |
getWidth()
Gets a handle to deal with the item's width. |
DimensionHandle |
getX()
Gets a handle to deal with the item's x (horizontal) position. |
DimensionHandle |
getY()
Gets a handle to deal with the item's y (vertical) position. |
int |
getZIndex()
Gets the item's z position as an integer. |
java.util.Iterator |
paramBindingsIterator()
Returns the iterator for parameter binding list defined on this report item. |
void |
removedColumnBinding(java.lang.String bindingName)
Removes bound column from the element. |
void |
removedColumnBindings(java.util.List bindingNameList)
Removes bound columns from the element. |
void |
removedUnusedColumnBindings()
Removes unused bound columns from the element. |
void |
setACLExpression(java.lang.String expr)
Sets the ACL expression associated with the report element instance. |
void |
setAllowExport(boolean allowExport)
Sets the allowExport property of the report item. |
void |
setBookmark(java.lang.String value)
Sets the bookmark of the report item. |
void |
setCascadeACL(boolean cascadeACL)
Sets the flag to control whether to cascade ACL |
void |
setCube(CubeHandle handle)
Sets the cube of the report item. |
void |
setCurrentView(DesignElementHandle viewElement)
Sets the view to be used. |
void |
setDataBindingReference(ReportItemHandle item)
Sets the report item of which data binding are referred by. |
void |
setDataSet(DataSetHandle handle)
Sets the data set of the report item. |
void |
setHeight(double dimension)
Sets the item's height to a value in default units. |
void |
setHeight(java.lang.String dimension)
Sets the item's height using a dimension string with optional unit suffix such as "10" or "10pt". |
void |
setOnCreate(java.lang.String value)
Sets the script executed when the element is created in the Factory. |
void |
setOnPageBreak(java.lang.String script)
Sets the on-pageBreak script of the report item. |
void |
setOnPrepare(java.lang.String script)
Sets the on-prepare script of the group element. |
void |
setOnRender(java.lang.String value)
Sets the script executed when the element is prepared for rendering in the Presentation engine. |
void |
setTocExpression(java.lang.String expression)
Deprecated. |
void |
setWidth(double dimension)
Sets the item's width to a value in default units. |
void |
setWidth(java.lang.String dimension)
Sets the item's width using a dimension string with optional unit suffix such as "10" or "10pt". |
void |
setX(double dimension)
Sets the item's x position to a value in default units. |
void |
setX(java.lang.String dimension)
Sets the item's x position using a dimension string with optional unit suffix such as "10" or "10pt". |
void |
setY(double dimension)
Sets the item's y position to a value in default units. |
void |
setY(java.lang.String dimension)
Sets the item's y position using a dimension string with optional unit suffix such as "10" or "10pt". |
void |
setZIndex(int zIndex)
Sets the item's z position to an integer. |
java.util.Iterator |
visibilityRulesIterator()
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, setPropertyMask |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DATABINDING_TYPE_NONE
public static final int DATABINDING_TYPE_DATA
public static final int DATABINDING_TYPE_REPORT_ITEM_REF
Constructor Detail |
---|
public ReportItemHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
---|
public DataSetHandle getDataSet()
public void setDataSet(DataSetHandle handle) throws SemanticException
handle
- the handle of the data set
SemanticException
- if the property is locked.public CubeHandle getCube()
public void setCube(CubeHandle handle) throws SemanticException
handle
- the handle of the cube
SemanticException
- if the property is locked.public DimensionHandle getX()
public DimensionHandle getY()
public void setX(java.lang.String dimension) throws SemanticException
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validpublic void setX(double dimension) throws SemanticException
dimension
- the new value in application units.
SemanticException
- if the property is locked.public void setY(java.lang.String dimension) throws SemanticException
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validpublic void setY(double dimension) throws SemanticException
dimension
- the new value in application units.
SemanticException
- if the property is locked.public void setHeight(java.lang.String dimension) throws SemanticException
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validpublic void setHeight(double dimension) throws SemanticException
dimension
- the new value in application units.
SemanticException
- if the property is locked.public void setWidth(java.lang.String dimension) throws SemanticException
dimension
- dimension string with optional unit suffix.
SemanticException
- if the string is not validpublic void setWidth(double dimension) throws SemanticException
dimension
- the new value in application units.
SemanticException
- if the property is locked.public DimensionHandle getWidth()
public DimensionHandle getHeight()
public java.lang.String getBookmark()
public void setBookmark(java.lang.String value) throws SemanticException
value
- the property value to be set.
SemanticException
- if the property is locked.public java.util.Iterator visibilityRulesIterator()
StructureHandle
that deal with
a Hide
in the list.
HideRule
public java.lang.String getOnCreate()
public void setOnCreate(java.lang.String value) throws SemanticException
value
- the script to set
SemanticException
- if the property is locked.public java.lang.String getOnRender()
public void setOnRender(java.lang.String value) throws SemanticException
value
- the script to set
SemanticException
- if the property is locked.public java.util.Iterator paramBindingsIterator()
StructureHandle
that deal with a ParamBinding
in the list.
ParamBinding
public void setTocExpression(java.lang.String expression) throws SemanticException
expression
- the expression that returns a string
SemanticException
- if the TOC property is locked by the property mask.getTocExpression()
public java.lang.String getTocExpression()
setTocExpression(String)
public java.lang.String getOnPrepare()
public void setOnPrepare(java.lang.String script) throws SemanticException
script
- the script to set
SemanticException
- if the method is locked.getOnPrepare()
public java.lang.String getOnPageBreak()
public void setOnPageBreak(java.lang.String script) throws SemanticException
script
- the script to set
SemanticException
- if the method is locked.getOnPageBreak()
public java.util.Iterator columnBindingsIterator()
ComputedColumnHandle
.
public PropertyHandle getColumnBindings()
public java.util.Iterator getAvailableBindings()
ComputedColumnHandle
instance.public ComputedColumnHandle addColumnBinding(ComputedColumn addColumn, boolean inForce) throws SemanticException
addColumn
- the bound column to addinForce
- true
the column is added to the list regardless
of duplicate expression. false
do not add the
column if the expression already existcolumn
- the bound column
ComputedColumnHandle
or the
existed ComputedColumnHandle
in the list
SemanticException
- if expression is not duplicate but the name duplicates the
exsiting bound column. Or, if the both name/expression are
duplicate, but inForce
is true
.public ComputedColumnHandle findColumnBinding(java.lang.String name)
name
- name of the binding to find
public void removedUnusedColumnBindings() throws SemanticException
SemanticException
- if bound column property is locked.public TOCHandle getTOC()
public TOCHandle addTOC(java.lang.String expression) throws SemanticException
expression
- toc expression
SemanticException
public TOCHandle addTOC(TOC toc) throws SemanticException
toc
- toc structure
SemanticException
public int getZIndex()
public void setZIndex(int zIndex) throws SemanticException
zIndex
- the z depth. Start from 0
SemanticException
- if the property is locked.public java.util.List getMethods(java.lang.String methodName)
methodName
- the method name in string
IMethodInfo
for functionspublic void setDataBindingReference(ReportItemHandle item) throws SemanticException
item
- the report item
SemanticException
- if the element reference makes a circlepublic java.lang.String getDataBindingReferenceName()
public ReportItemHandle getDataBindingReference()
public int getDataBindingType()
public java.util.List getAvailableDataBindingReferenceList()
Two kinds of report items can be referred:
ReportItemHandle
type.
public java.util.List getNamedDataBindingReferenceList()
non-null
names.
Two kinds of report items can be referred:
ReportItemHandle
type.
public java.util.List getAvailableDataSetBindingReferenceList()
Two kinds of report items can be referred:
ReportItemHandle
type.
public java.util.List getNamedDataSetBindingReferenceList()
non-null
names.
Two kinds of report items can be referred:
ReportItemHandle
type.
public java.util.List getAvailableCubeBindingReferenceList()
Two kinds of report items can be referred:
ReportItemHandle
type.
public java.util.List getNamedCubeBindingReferenceList()
non-null
names.
Two kinds of report items can be referred:
ReportItemHandle
type.
public void removedColumnBindings(java.util.List bindingNameList) throws SemanticException
bindingNameList
- the binding name list to be removed, each entry should be
instance of java.lang.String
.
SemanticException
- if bound column property is locked.public void removedColumnBinding(java.lang.String bindingName) throws SemanticException
bindingName
- the binding name to be removed
SemanticException
- if bound column property is locked.public DesignElementHandle getCurrentView()
public void addView(DesignElementHandle viewElement) throws SemanticException
viewElement
- the element
SemanticException
public void dropView(DesignElementHandle viewElement) throws SemanticException
viewElement
- the element
SemanticException
public void setCurrentView(DesignElementHandle viewElement) throws SemanticException
viewElement
- the view element, must not be this
. Can be
null
.
SemanticException
- if the given element resides in the other elements.public java.util.List getViews()
DesignElementHandle
.public 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), a report element'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 report element'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 boolean canCascadeACL()
IReportItemModel.CASCADE_ACL_PROP
property and it is a
container.
IReportItemModel.CASCADE_ACL_PROP
property and it is
a container, otherwise falsepublic boolean allowExport()
public void setAllowExport(boolean allowExport) throws SemanticException
allowExport
- indicates whether can be exported or not.
SemanticException
public ReportItemHandle getViewHost()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |