|
|||||||||||
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
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 |
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 |
BOOKMARK_PROP, DATA_SET_PROP, HEIGHT_PROP, ON_CREATE_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, PARAM_BINDINGS_PROP, TOC_PROP, VISIBILITY_PROP, WIDTH_PROP, X_PROP, Y_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel |
STYLE_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 |
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 | |
java.lang.String |
getBookmark()
Returns the bookmark of the 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.lang.String |
getOnCreate()
Returns the script executed when the element is created in the Factory. |
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. |
java.lang.String |
getTocExpression()
Returns the expression evalueated as a table of contents entry for this item. |
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. |
java.util.Iterator |
paramBindingsIterator()
Returns the iterator for parameter binding list defined on this report item. |
void |
setBookmark(java.lang.String value)
Sets the bookmark of the report item. |
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 |
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)
Sets a table of contents entry for this item. |
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". |
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, 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 |
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 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()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |