|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportItem
Represents an instance of a extended report element. There is a one-to-one correspondence between the BIRT-defined report item and this IReportItem.
BIRT Extended Item <--> ExtendedItemIReportItem is responsible for storing model data, and for serializing the model state. They can optionally provide generic property access.
Method Summary | |
---|---|
boolean |
canExport()
Indicates whether the report item can be allowed to export to library. |
void |
checkProperty(java.lang.String propName,
java.lang.Object value)
Checks the value of a property prior to setting it. |
IReportItem |
copy()
Creates deep copy of the IReportItem and return the new element. |
void |
deserialize(java.lang.String propName,
java.io.ByteArrayInputStream data)
Deserializes the model. |
IPropertyDefinition[] |
getMethods()
Deprecated. by getMethods(String) |
IMethodInfo[] |
getMethods(java.lang.String methodName)
Returns the method info list of extension elements. |
java.util.List |
getPredefinedStyles()
Gets list of the predefined styles. |
java.lang.Object |
getProperty(java.lang.String propName)
Returns the value of a public property. |
IPropertyDefinition[] |
getPropertyDefinitions()
Gets the list of all the property definitions that the extended element model has. |
IPropertyDefinition |
getScriptPropertyDefinition()
Gets the script property definition of this report item. |
IReportItem |
getSimpleElement()
Returns the interface for script operations. |
boolean |
refreshPropertyDefinition()
Justifies whether the property list of the extended element is changed. |
java.io.ByteArrayOutputStream |
serialize(java.lang.String propName)
Serializes the model given the property name. |
void |
setHandle(ExtendedItemHandle handle)
Sets the handle of this report item. |
void |
setProperty(java.lang.String propName,
java.lang.Object value)
Sets the value of a property. |
java.util.List |
validate()
Performs a semantic check on the report item. |
Method Detail |
---|
java.io.ByteArrayOutputStream serialize(java.lang.String propName)
XMLPropertyType
. The
serialized data must be Unicode text. XML is preferred, but any text
format is legal. If the model is binary, then one solution is to
serialize the model as Base64 encoded data.
propName
- the model property name to serialize
void deserialize(java.lang.String propName, java.io.ByteArrayInputStream data) throws ExtendedElementException
XMLPropertyType
. The data
provided will be that created by the serialize
method. A
well-written extension will handle two exceptional cases. First, it will
handle all previous versions of this same extension. Second, it will
handle erroneous input, perhaps created when a human editied the saved
state by hand.
propName
- the model property name to deserializedata
- a byte array stream containing the serialized data
ExtendedElementException
- if the serialized model is invalidIPropertyDefinition[] getPropertyDefinitions()
java.lang.Object getProperty(java.lang.String propName)
IReportItemFactory
class defines a
property, then this method must accept that property name.
Property names can be separated with dots and can include array indexes. For example: barColors[1].pattern. This will occur if a property is defined as a list or structure.
If the report element support styles or inheritance, then a return value
of null
means that the value should be inherited. BIRT will
use its normal inheritance mechanisms to locate the value. If the
extended element does not support inheritance or styles, then this method
must return the value of each property, including defaults if the value
has not yet been set.
propName
- the name of the property to get
void checkProperty(java.lang.String propName, java.lang.Object value) throws ExtendedElementException
setProperty
method for details on the process for setting a property value.
propName
- the name of the property to checkvalue
- the new property value as one of the supported BIRT types
ExtendedElementException
- if the property value is invalid or the property name is
invalidgetProperty(java.lang.String)
void setProperty(java.lang.String propName, java.lang.Object value)
checkProperty
method, and
will have created a command to set the property.
If this element supports styles or inheritance, then the value can be
null
, which means to clear the property value so that it
will inherit from the base element or the style.
propName
- the name of the property to setvalue
- the new property value as one of the supported BIRT typesgetProperty(java.lang.String)
,
checkProperty(java.lang.String, java.lang.Object)
java.util.List validate()
IReportItem copy()
boolean refreshPropertyDefinition()
IPropertyDefinition[] getMethods()
getMethods(String)
IElementPropertyDefn
.
IPropertyDefinition getScriptPropertyDefinition()
java.util.List getPredefinedStyles()
String
IStyleDeclaration
IReportItem getSimpleElement()
IMethodInfo[] getMethods(java.lang.String methodName)
IMethodInfo
.
methodName
- the method name
void setHandle(ExtendedItemHandle handle)
handle
- extended item handleboolean canExport()
true
if the report item can be allowed to export to
library; false
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |