org.eclipse.birt.report.model.api
Class DataItemHandle

java.lang.Object
  extended by org.eclipse.birt.report.model.api.DesignElementHandle
      extended by org.eclipse.birt.report.model.api.ReportElementHandle
          extended by org.eclipse.birt.report.model.api.ReportItemHandle
              extended by org.eclipse.birt.report.model.api.DataItemHandle
All Implemented Interfaces:
IReportItemMethodContext, org.eclipse.birt.report.model.elements.interfaces.IDataItemModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IReportItemModel, org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel

public class DataItemHandle
extends ReportItemHandle
implements org.eclipse.birt.report.model.elements.interfaces.IDataItemModel

Represents a data item element. A data item has an action, value expression and help text.

See Also:
DataItem

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.IDataItemModel
ACTION_PROP, HELP_TEXT_KEY_PROP, HELP_TEXT_PROP, RESULT_SET_COLUMN_PROP, VALUE_EXPR_PROP
 
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.api.elements.IReportItemMethodContext
ON_CREATE_CONTEXT, ON_PREPARE_CONTEXT, ON_RENDER_CONTEXT
 
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
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.
 
Method Summary
 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)
 
Methods inherited from class org.eclipse.birt.report.model.api.ReportItemHandle
addColumnBinding, addTOC, addTOC, addView, allowExport, canCascadeACL, cascadeACL, columnBindingsIterator, dropView, findColumnBinding, getACLExpression, getAvailableBindings, getAvailableCubeBindingReferenceList, getAvailableDataBindingReferenceList, getAvailableDataSetBindingReferenceList, getBookmark, getColumnBindings, getCube, getCurrentView, getDataBindingReference, getDataBindingReferenceName, getDataBindingType, getDataSet, getHeight, getMethods, getNamedCubeBindingReferenceList, getNamedDataBindingReferenceList, getNamedDataSetBindingReferenceList, getOnCreate, getOnPageBreak, getOnPrepare, getOnRender, getTOC, getTocExpression, getViewHost, getViews, getWidth, getX, getY, getZIndex, paramBindingsIterator, removedColumnBinding, removedColumnBindings, removedUnusedColumnBindings, setACLExpression, setAllowExport, setBookmark, setCascadeACL, setCube, setCurrentView, setDataBindingReference, setDataSet, setHeight, setHeight, setOnCreate, setOnPageBreak, setOnPrepare, setOnRender, setTocExpression, setWidth, setWidth, setX, setX, setY, setY, setZIndex, visibilityRulesIterator
 
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 org.eclipse.birt.report.model.api.DesignElementHandle
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, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, 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, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setEncryption, setEventHandlerClass, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNumberProperty, setProperties, setProperty, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataItemHandle

public 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. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.

Parameters:
module - the module
element - the model representation of the element
Method Detail

getActionHandle

public ActionHandle getActionHandle()
Returns a handle to work with the action property, action is a structure that defines a hyperlink.

Returns:
a handle to the action property, return null if the action has not been set on the data item.
See Also:
ActionHandle

setAction

public ActionHandle setAction(Action action)
                       throws SemanticException
Set an action on the image.

Parameters:
action - new action to be set on the image, it represents a bookmark link, hyperlink, and drill through etc.
Returns:
a handle to the action property, return null if the action has not been set on the image.
Throws:
SemanticException - if member of the action is not valid.

getDistinct

public java.lang.String getDistinct()
Deprecated. by the drop function of Cell element.

Returns the value of the distinct property.

Returns:
the distinct value as a string

setDistinct

public void setDistinct(java.lang.String distinct)
                 throws SemanticException
Deprecated. by the drop function of Cell element.

Sets the value of the distinct property. The input value is defined in DesignChoiceConstants and is one of these:

Parameters:
distinct - the distinct value as a string
Throws:
SemanticException - If the property is locked or the value is not one of the above.

getDistinctReset

public java.lang.String getDistinctReset()
Deprecated. by the drop function of Cell element.

Returns the value of the distinct-reset property.

Returns:
the distinct-set value as a string

setDistinctReset

public void setDistinctReset(java.lang.String value)
                      throws SemanticException
Deprecated. by the drop function of Cell element.

Returns the value of the distinct-reset property.

Parameters:
value - the distinct-set value as a string
Throws:
SemanticException - If the property is locked.

getValueExpr

public java.lang.String getValueExpr()
Deprecated. As of BIRT version 2.1.0, replaced by getResultSetColumn( )

Returns the expression that gives the value that the data item displays.

Returns:
the value expression
See Also:
#getResultSetExpression()} for the shortcut function to get the value expression

setValueExpr

public void setValueExpr(java.lang.String expr)
                  throws SemanticException
Deprecated. As of BIRT version 2.1.0, replaced by setResultSetColumn(String columnName)

Sets the expression for the value that the data item is to display. This method still can be used. However, if the user uses both this method and setResultSetColumn(String columnName), the result is unexpectable. It is strongly recommended to use ONLY one of two methods.

Parameters:
expr - the expression to set
Throws:
SemanticException - If the property is locked.
SemanticException

getHelpText

public java.lang.String getHelpText()
Returns the help text of this data item.

Returns:
the help text

setHelpText

public void setHelpText(java.lang.String value)
                 throws SemanticException
Sets the help text of this data item.

Parameters:
value - the help text
Throws:
SemanticException - if the property is locked.

getHelpTextKey

public java.lang.String getHelpTextKey()
Returns the help text resource key of this data item.

Returns:
the help text key

setHelpTextKey

public void setHelpTextKey(java.lang.String value)
                    throws SemanticException
Sets the resource key of the help text of this data item.

Parameters:
value - the resource key of the help text
Throws:
SemanticException - if the property is locked.

getResultSetExpression

public java.lang.String getResultSetExpression()
Looks the column name from the data binding element that is nearest to this data item. Iterate the column name expression list to see if there is a column name is equals with the value of the DataItemHandle.DATA_COLUMN_NAME_PROP on this data item. If yes, return the expression value.

Returns:
the expression value.
Throws:
SemanticException

getResultSetColumn

public java.lang.String getResultSetColumn()
Gets the value of the result set column name property on this data item.

Returns:
the value of the property.

setResultSetColumn

public void setResultSetColumn(java.lang.String columnName)
                        throws SemanticException
Sets the value of the column name property.

Parameters:
columnName - the value to set.
Throws:
SemanticException


Copyright © 2008 Actuate Corp. All rights reserved.