public class ExtendedItemHandle extends ReportItemHandle implements org.eclipse.birt.report.model.elements.interfaces.IExtendedItemModel, IReportItemMethodContext
An extended element has a plug-in property that is a name of a Java class that implements the behavior for the element.
ExtendedItem
DATABINDING_TYPE_DATA, DATABINDING_TYPE_NONE, DATABINDING_TYPE_REPORT_ITEM_REF
element
module
ALT_TEXT_KEY_PROP, ALT_TEXT_PROP, EXTENSION_NAME_PROP, EXTENSION_VERSION_PROP, FILTER_PROP
ON_CREATE_CONTEXT, ON_PREPARE_CONTEXT, ON_RENDER_CONTEXT
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_PROP
STYLE_PROP
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_PROP
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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<java.lang.String,java.util.List<IllegalContentInfo>> |
getIllegalContents()
Gets all the illegal contents.
|
java.util.List |
getMethods()
Returns the methods defined on the extension element definition and the
methods defined within the extension model property inside.
|
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<java.lang.String,UndefinedPropertyInfo> |
getUndefinedProperties()
Gets the map of all name/value pair.
|
void |
loadExtendedElement()
Loads the instance of extended element.
|
void |
makeUniqueName(java.lang.String namePrefix)
Makes a unique name for this element with the given name prefix.
|
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.
|
addColumnBinding, addTOC, addTOC, addView, allowExport, canAddView, canCascadeACL, cascadeACL, columnBindingsIterator, dropView, findColumnBinding, getACLExpression, getAltTextExpression, getAvailableBindings, getAvailableCubeBindingReferenceList, getAvailableDataBindingReferenceList, getAvailableDataBindingReferenceList, getAvailableDataSetBindingReferenceList, getBookmark, getBookmarkDisplayName, getColumnBindings, getCube, getCurrentView, getDataBindingReference, getDataBindingReferenceName, getDataBindingType, getDataSet, getHeight, getLanguage, getNamedCubeBindingReferenceList, getNamedDataBindingReferenceList, getNamedDataSetBindingReferenceList, getOnCreate, getOnPageBreak, getOnPrepare, getOnRender, getOrder, getProperty, getTagType, getTheme, getTOC, getTocExpression, getURL, getViewHost, getViews, getWidth, getX, getY, getZIndex, paramBindingsIterator, pushDown, removedColumnBinding, removedColumnBindings, removedUnusedColumnBindings, setACLExpression, setAllowExport, setAltTextExpression, setBookmark, setBookmarkDisplayName, setCascadeACL, setCube, setCurrentView, setDataBindingReference, setDataSet, setHeight, setHeight, setLanguage, setOnCreate, setOnPageBreak, setOnPrepare, setOnRender, setOrder, setPushDown, setTagType, setTheme, setThemeName, setTocExpression, setURL, setWidth, setWidth, setX, setX, setY, setY, setZIndex, visibilityRulesIterator
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask
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, 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
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 elementpublic 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 extensionExtendedElementException
- if the serialized model is invalidpublic java.util.List getExtensionPropertyDefinitionList()
public java.util.List getMethods()
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 setSemanticException
- if fail to set the scriptspublic java.lang.String getAltText()
public java.lang.String getAltTextKey()
getAltTextKey
in class ReportItemHandleImpl
public void setAltText(java.lang.String altText) throws SemanticException
altText
- the alt textSemanticException
- if the property is locked.public void setAltTextKey(java.lang.String altTextKey) throws SemanticException
setAltTextKey
in class ReportItemHandleImpl
altTextKey
- the alt text idSemanticException
- if the property is locked.public java.util.List getMethods(java.lang.String context)
getMethods
in class ReportItemHandleImpl
context
- the method name in stringIMethodInfo
for functionspublic java.util.Map<java.lang.String,UndefinedPropertyInfo> getUndefinedProperties()
UndefinedPropertyInfo
.public java.util.Map<java.lang.String,java.util.List<IllegalContentInfo>> getIllegalContents()
IllegalContentInfo
.public java.lang.String getExtensionVersion()
public void setExtensionVersion(java.lang.String extensionVersion) throws SemanticException
extensionVersion
- SemanticException
public void makeUniqueName(java.lang.String namePrefix) throws NameException
namePrefix
- the name prefixNameException
Copyright © 2008 Actuate Corp. All rights reserved.