public class DataItemHandle extends ReportItemHandle implements org.eclipse.birt.report.model.elements.interfaces.IDataItemModel
DataItem
DATABINDING_TYPE_DATA, DATABINDING_TYPE_NONE, DATABINDING_TYPE_REPORT_ITEM_REF
element
module
ACTION_PROP, HELP_TEXT_KEY_PROP, HELP_TEXT_PROP, RESULT_SET_COLUMN_PROP, VALUE_EXPR_PROP
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
ON_CREATE_CONTEXT, ON_PREPARE_CONTEXT, ON_RENDER_CONTEXT
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 |
---|
DataItemHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a handle of the data item with the given design and a data
item.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<ActionHandle> |
actionsIterator()
Returns the iterator for action defined on this data item.
|
ActionHandle |
getActionHandle()
Returns a handle to work with the action property, action is a structure
that defines a hyperlink.
|
java.lang.String |
getDistinct()
Deprecated.
by the drop function of Cell element.
|
java.lang.String |
getDistinctReset()
Deprecated.
by the drop function of Cell element.
|
java.lang.String |
getHelpText()
Returns the help text of this data item.
|
java.lang.String |
getHelpTextKey()
Returns the help text resource key of this data item.
|
java.lang.String |
getResultSetColumn()
Gets the value of the result set column name property on this data item.
|
java.lang.String |
getResultSetExpression()
Looks the column name from the data binding element that is nearest to
this data item.
|
java.lang.String |
getValueExpr()
Deprecated.
As of BIRT version 2.1.0, replaced by getResultSetColumn( )
|
ActionHandle |
setAction(Action action)
Set an action on the image.
|
void |
setDistinct(java.lang.String distinct)
Deprecated.
by the drop function of Cell element.
|
void |
setDistinctReset(java.lang.String value)
Deprecated.
by the drop function of Cell element.
|
void |
setHelpText(java.lang.String value)
Sets the help text of this data item.
|
void |
setHelpTextKey(java.lang.String value)
Sets the resource key of the help text of this data item.
|
void |
setResultSetColumn(java.lang.String columnName)
Sets the value of the column name property.
|
void |
setValueExpr(java.lang.String expr)
Deprecated.
As of BIRT version 2.1.0, replaced by
setResultSetColumn(String columnName)
|
addColumnBinding, addTOC, addTOC, addView, allowExport, canAddView, canCascadeACL, cascadeACL, columnBindingsIterator, dropView, findColumnBinding, getACLExpression, getAltTextExpression, getAltTextKey, getAvailableBindings, getAvailableCubeBindingReferenceList, getAvailableDataBindingReferenceList, getAvailableDataBindingReferenceList, getAvailableDataSetBindingReferenceList, getBookmark, getBookmarkDisplayName, getColumnBindings, getCube, getCurrentView, getDataBindingReference, getDataBindingReferenceName, getDataBindingType, getDataSet, getHeight, getLanguage, getMethods, 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, setAltTextKey, 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, getMethods, 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 DataItemHandle(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 ActionHandle getActionHandle()
null
if the
action has not been set on the data item.ActionHandle
public ActionHandle setAction(Action action) throws SemanticException
action
- new action to be set on the image, it represents a bookmark
link, hyperlink, and drill through etc.null
if the
action has not been set on the image.SemanticException
- if member of the action is not valid.public java.util.Iterator<ActionHandle> actionsIterator()
Action
structure list defined on
this data itempublic java.lang.String getDistinct()
public void setDistinct(java.lang.String distinct) throws SemanticException
DesignChoiceConstants
and is one of these:
distinct
- the distinct value as a stringSemanticException
- If the property is locked or the value is not one of the
above.public java.lang.String getDistinctReset()
public void setDistinctReset(java.lang.String value) throws SemanticException
value
- the distinct-set value as a stringSemanticException
- If the property is locked.public java.lang.String getValueExpr()
#getResultSetExpression()} for the shortcut function to get
the value expression
public void setValueExpr(java.lang.String expr) throws SemanticException
expr
- the expression to setSemanticException
- If the property is locked.SemanticException
public java.lang.String getHelpText()
public void setHelpText(java.lang.String value) throws SemanticException
value
- the help textSemanticException
- if the property is locked.public java.lang.String getHelpTextKey()
public void setHelpTextKey(java.lang.String value) throws SemanticException
value
- the resource key of the help textSemanticException
- if the property is locked.public java.lang.String getResultSetExpression()
SemanticException
public java.lang.String getResultSetColumn()
public void setResultSetColumn(java.lang.String columnName) throws SemanticException
columnName
- the value to set.SemanticException
Copyright © 2008 Actuate Corp. All rights reserved.