|
||||||||||
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
org.eclipse.birt.report.model.api.ExtendedItemHandle
public class ExtendedItemHandle
Represents an extended element. An extended item represents a custom element added by the application. Extended items can use user-defined properties, can use scripts, or a combination of the two. Extended items often require user-defined properties.
An extended element has a plug-in property that is a name of a Java class that implements the behavior for the element.
ExtendedItem
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ReportItemHandle |
---|
DATABINDING_TYPE_DATA, DATABINDING_TYPE_NONE, DATABINDING_TYPE_REPORT_ITEM_REF |
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.IExtendedItemModel |
---|
ALT_TEXT_KEY_PROP, ALT_TEXT_PROP, EXTENSION_NAME_PROP, EXTENSION_VERSION_PROP, FILTER_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.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.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 | |
---|---|
ExtendedItemHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs the handle with the report design and the element it holds. |
Method Summary | |
---|---|
java.util.Iterator |
filtersIterator()
Returns an iterator over filter. |
java.lang.String |
getAltText()
Returns the alternate text of this extended item. |
java.lang.String |
getAltTextKey()
Returns the resource key of the alternate text of this extended item. |
java.lang.String |
getExtensionName()
Returns the extension name defined by the extended item. |
java.util.List |
getExtensionPropertyDefinitionList()
Returns the list of extension property definition. |
java.lang.String |
getExtensionVersion()
Gets the extension version of this element. |
java.lang.String |
getExternalScript()
Returns the external script defined in the extended element model. |
java.util.Map |
getIllegalContents()
Gets all the illegal contents. |
java.util.List |
getMethods()
Deprecated. by getMethods(String) |
java.util.List |
getMethods(java.lang.String context)
Returns functions that can be called in the given method. |
IReportItem |
getReportItem()
Returns the interface IReportItem for extension. |
java.util.Map |
getUndefinedProperties()
Gets the map of all name/value pair. |
void |
loadExtendedElement()
Loads the instance of extended element. |
void |
setAltText(java.lang.String altText)
Sets the alt text of this extended item. |
void |
setAltTextKey(java.lang.String altTextKey)
Sets the alt text id of this extended item. |
void |
setExtensionVersion(java.lang.String extensionVersion)
Sets the extension version of this element. |
void |
setExternalScript(java.lang.String theScript)
Sets the scripts in the extension element model. |
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 |
Constructor Detail |
---|
public ExtendedItemHandle(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 java.lang.String getExtensionName()
public void loadExtendedElement() throws ExtendedElementException
ExtendedElementException
- if the serialized model is invalidpublic IReportItem getReportItem() throws ExtendedElementException
IReportItem
for extension.
IReportItem
for extension
ExtendedElementException
- if the serialized model is invalidpublic java.util.List getExtensionPropertyDefinitionList()
public java.util.List getMethods()
getMethods(String)
getMethods
in class DesignElementHandle
public java.util.Iterator filtersIterator()
FilterConditionHandle
that represents filter condition
object.
FilterCondition
public java.lang.String getExternalScript()
public void setExternalScript(java.lang.String theScript) throws SemanticException
theScript
- the script to be set
SemanticException
- if fail to set the scriptspublic java.lang.String getAltText()
public java.lang.String getAltTextKey()
public void setAltText(java.lang.String altText) throws SemanticException
altText
- the alt text
SemanticException
- if the property is locked.public void setAltTextKey(java.lang.String altTextKey) throws SemanticException
altTextKey
- the alt text id
SemanticException
- if the property is locked.public java.util.List getMethods(java.lang.String context)
getMethods
in class ReportItemHandle
context
- the method name in string
IMethodInfo
for functionspublic java.util.Map getUndefinedProperties()
UndefinedPropertyInfo
.
public java.util.Map getIllegalContents()
IllegalContentInfo
.
public java.lang.String getExtensionVersion()
public void setExtensionVersion(java.lang.String extensionVersion) throws SemanticException
extensionVersion
-
SemanticException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |