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

java.lang.Object
  extended by org.eclipse.birt.report.model.api.ElementDetailHandle
      extended by org.eclipse.birt.report.model.api.ValueHandle
Direct Known Subclasses:
ComplexValueHandle, SimpleValueHandle, StructureHandle

public abstract class ValueHandle
extends ElementDetailHandle

Abstract base class for value-based handles.


Field Summary
 
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
 
Constructor Summary
ValueHandle(DesignElementHandle element)
          Constructs a value handle with the given element handle.
 
Method Summary
abstract  IElementPropertyDefn getPropertyDefn()
          Gets the property definition.
abstract  org.eclipse.birt.report.model.core.MemberRef getReference()
          Returns a reference to the value.
 
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValueHandle

public ValueHandle(DesignElementHandle element)
Constructs a value handle with the given element handle.

Parameters:
element - a handle to a report element
Method Detail

getPropertyDefn

public abstract IElementPropertyDefn getPropertyDefn()
Gets the property definition. This is the definition of the property that contains the specific value. If the value is a structure or member, then this is the definition of the property that contains the list that contains the structure that contains the member.

Returns:
the property definition

getReference

public abstract org.eclipse.birt.report.model.core.MemberRef getReference()
Returns a reference to the value. The reference is used to identify a list entry or member.

Returns:
a reference to the value


Copyright © 2008 Actuate Corp. All rights reserved.