Uses of Class
org.eclipse.birt.report.model.api.DesignElementHandle

Packages that use DesignElementHandle
org.eclipse.birt.report.model.api Tool-writer's interface for the BIRT design model (also known as the "Design Engine.")  
org.eclipse.birt.report.model.api.core Represents the fundamental data structures of the user-defined property and the interface of UI listener.  
org.eclipse.birt.report.model.api.extension Defines the fundamental interfaces for those extensions from the reportitem extension point.  
org.eclipse.birt.report.model.api.util Utility classes.  
org.eclipse.birt.report.model.api.validators Provides the validation classes for semantic check on multiple properties.  
 

Uses of DesignElementHandle in org.eclipse.birt.report.model.api
 

Subclasses of DesignElementHandle in org.eclipse.birt.report.model.api
 class AutoTextHandle
          Represents a autotext report item.
 class CascadingParameterGroupHandle
          Represents the group of cascading parameters.
 class CellHandle
          Represents a cell within a table or grid.
 class ColumnHandle
          Represents a column within a table.
 class DataItemHandle
          Represents a data item element.
 class DataSetHandle
          Abstract handle for data set elements.
 class DataSourceHandle
          This abstract class represents a data source element: a connection to an external data provider such as an SQL database.
 class ExtendedItemHandle
          Represents an extended element.
 class FreeFormHandle
          Represents a free-form element.
 class GraphicMasterPageHandle
          Represents a graphic master page in the design.
 class GridHandle
          Represents a grid item in the design.
 class GroupHandle
          Represents both list and table groups in the design.
 class ImageHandle
          Represents an image report item.
 class JointDataSetHandle
          Provides API to operate a joint data set.
 class LabelHandle
          Represents a label report item.
 class LibraryHandle
          Represents the handle of library element.
 class LineHandle
          Represents the line item.
 class ListGroupHandle
          Represents a group in a list.
 class ListHandle
          Represents a list report item.
 class ListingHandle
          Represents slots and common properties in the two list-oriented elements: table and list.
 class MasterPageHandle
          Represents a master page.
 class ModuleHandle
          Abstract module handle which provides the common functionalities of report design and library.
 class MultiLineDataHandle
          Deprecated. by TextDataHandle
 class OdaDataSetHandle
          Represents an extended data set.
 class OdaDataSourceHandle
          Represents a extended data source.
 class ParameterGroupHandle
          Represents a group of parameters.
 class ParameterHandle
          Represents the various parameter types.
 class PrivateStyleHandle
          Represents the "private style" for an element.
 class RectangleHandle
          Represents a rectangle element.
 class ReportDesignHandle
          Represents the overall report design.
 class ReportElementHandle
          Abstract base class for working with all elements except the report design.
 class ReportItemHandle
          Represents a report item: any element that can appear within a section of the report.
 class RowHandle
          Represents one row in a Grid or Table.
 class ScalarParameterHandle
          Represents a scalar (single-value) report parameter.
 class ScriptDataSetHandle
          Represents a script data set item.
 class ScriptDataSourceHandle
          Represents a script data source.
 class SharedStyleHandle
          Represents a named, shared style.
 class SimpleMasterPageHandle
          Represents a simple master page.
 class StyleHandle
          Represents the style properties for either a shared style or an element with a style.
 class TableGroupHandle
          Represent a handle to a table group.
 class TableHandle
          Represents a table element.
 class TemplateDataSetHandle
          Handle for template data sets.
 class TemplateElementHandle
          Abstract handle for template elements.
 class TemplateParameterDefinitionHandle
          Represents a template parameter definition element.
 class TemplateReportItemHandle
          Handle for template report items.
 class TextDataHandle
          Represents a multi-line data item element.
 class TextItemHandle
          Represents a text data item.
 class ThemeHandle
          Represents a theme in the library.
 

Fields in org.eclipse.birt.report.model.api declared as DesignElementHandle
protected  DesignElementHandle ElementDetailHandle.elementHandle
          The handle to the report element.
 

Methods in org.eclipse.birt.report.model.api that return DesignElementHandle
 DesignElementHandle TemplateParameterDefinitionHandle.getDefaultElement()
          Gets the default element of this template parameter definition.
 DesignElementHandle TemplateElementHandle.getDefaultElement()
          Gets the default element of this template element.
 DesignElementHandle SlotHandle.get(int posn)
          Returns a handle to the content element at the given position.
 DesignElementHandle PrivateStyleHandle.getElementHandle()
          Returns a handle to the element that owns this private style.
 DesignElementHandle PrivateStyleHandle.getExtends()
          This method is not defined for private styles.
 DesignElementHandle ModuleHandle.findElement(java.lang.String name)
          Finds a named element in the name space in this module and the included moduled.
 DesignElementHandle ModuleHandle.getElementByID(long id)
          Finds the handle to an element by a given element ID.
 DesignElementHandle ElementFactory.newElement(java.lang.String elementTypeName, java.lang.String name)
          Creates a design element specified by the element type name.
 DesignElementHandle ElementFactory.newElementFrom(DesignElementHandle baseElement, java.lang.String name)
          Creates one new element based on the given element.
 DesignElementHandle ElementDetailHandle.getElementHandle()
          Returns a handle to the design element.
 DesignElementHandle DesignElementHandle.getElementProperty(java.lang.String propName)
          Returns the value of an element reference property.
 DesignElementHandle DesignElementHandle.getExtends()
          Returns a handle to the element that this element extends.
 DesignElementHandle DesignElementHandle.getContainer()
          Returns a handle to the element that contains this element.
 

Methods in org.eclipse.birt.report.model.api with parameters of type DesignElementHandle
static ComputedColumn StructureFactory.newComputedColumn(DesignElementHandle element, java.lang.String newName)
          Creates a bound data column name with the unique column name.
 void SlotHandle.add(DesignElementHandle content)
          Adds a report item to the slot with the given element handle.
 void SlotHandle.add(DesignElementHandle content, int newPos)
          Adds a report item to the slot at the given position.
 java.util.List SlotHandle.paste(DesignElementHandle content)
          Pastes a report item to the slot.
 java.util.List SlotHandle.paste(DesignElementHandle content, int newPos)
          Pastes a report item to the slot.
 void SlotHandle.shift(DesignElementHandle content, int toPosn)
          Moves the position of a content element within the slot.
 void SlotHandle.move(DesignElementHandle content, DesignElementHandle newContainer, int toSlot)
          Moves a content element into a slot in another container element.
 void SlotHandle.move(DesignElementHandle content, DesignElementHandle newContainer, int toSlot, int newPos)
          Moves a content element into a slot in another container element at the specified position.
 void SlotHandle.dropAndClear(DesignElementHandle content)
          Drops a content element from the slot, and clear any reference property which refers the element to drop.
 void SlotHandle.drop(DesignElementHandle content)
          Drops a content element from the slot, and unresolve any reference property which refers the element to drop.
 int SlotHandle.findPosn(DesignElementHandle content)
          Returns the position of the given content in this slot.
 boolean SlotHandle.canContain(DesignElementHandle content)
          Determines if the given slot can contain the content.
protected  boolean SimpleGroupElementHandle.isInGroup(DesignElementHandle element)
           
 int PrivateStyleHandle.findContentSlot(DesignElementHandle content)
          This method is not defined for private styles.
 void PrivateStyleHandle.moveTo(DesignElementHandle newContainer, int toSlot)
          This method is not defined for private styles.
 void PrivateStyleHandle.setExtends(DesignElementHandle parent)
          This method is not defined for private styles.
static java.lang.String ModuleUtil.getExternalizedValue(DesignElementHandle element, java.lang.String key, java.lang.String value, com.ibm.icu.util.ULocale locale)
          Returns externalized message for the given locale.
 void ModuleHandle.rename(DesignElementHandle elementHandle)
          Checks the element name in name space of this report.
protected abstract  boolean GroupElementHandle.isInGroup(DesignElementHandle element)
          Checks whether the element is a member of GroupElementHandle.
protected  boolean EmptyGroupElementHandle.isInGroup(DesignElementHandle element)
           
 DesignElementHandle ElementFactory.newElementFrom(DesignElementHandle baseElement, java.lang.String name)
          Creates one new element based on the given element.
 void DesignVisitor.apply(DesignElementHandle handle)
          Applies this visitor to the given element.
protected  void DesignVisitor.visitDesignElement(DesignElementHandle obj)
          Visits the design element.
 void DesignElementHandle.addElement(DesignElementHandle child, int slotId, int pos)
          Adds a report item to the given slot at the given position.
 void DesignElementHandle.addElement(DesignElementHandle child, int slotId)
          Adds a report item to the end of the given slot.
 void DesignElementHandle.setExtends(DesignElementHandle parent)
          Sets this element to extend the given element.
 void DesignElementHandle.moveTo(DesignElementHandle newContainer, int toSlot)
          Moves this element to a new location within the design.
 int DesignElementHandle.findContentSlot(DesignElementHandle content)
          Finds the slot within this element that contains the given element.
 void DesignElementHandle.copyPropertyTo(java.lang.String propName, DesignElementHandle targetHandle)
          Copies all properties to the target element.
 boolean DesignElementHandle.canContain(int slotId, DesignElementHandle content)
          Determines if the given slot can contain the content.
 

Constructors in org.eclipse.birt.report.model.api with parameters of type DesignElementHandle
ValueHandle(DesignElementHandle element)
          Constructs a value handle with the given element handle.
UserPropertyDefnHandle(DesignElementHandle element, UserPropertyDefn prop)
          Constructs a handle for the user-defined property with the given element handle and the user-defined property.
UserPropertyDefnHandle(DesignElementHandle element, java.lang.String propName)
          Constructs a handle for the user-defined property with the given element handle and the name of the user-defined property.
StructureHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)
          Constructs a handle for a structure within a list property of a given element.
SlotHandle(DesignElementHandle element, int slotID)
          Constructs a handle for the slot with the given design element handle and the id of the slot.
SimpleValueHandle(DesignElementHandle element)
          Constructs a handle with the given handle to an design element.
PropertyHandle(DesignElementHandle element, java.lang.String propName)
          Constructs the handle for a top-level property with the given element handle and property name.
PropertyHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn prop)
          Constructs the handle for a top-level property with the given element handle and the definition of the property.
OdaDesignerStateHandle(DesignElementHandle elementHandle, org.eclipse.birt.report.model.core.MemberRef memberRef)
          Constructs the handle of Oda Designer state.
MemberHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)
          Constructs a member handle with the given element handle and the member reference.
FormatValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)
          Construct an handle to deal with the action structure.
FontHandle(DesignElementHandle handle)
          Constructs a font family handle for an element property.
FontHandle(DesignElementHandle handle, org.eclipse.birt.report.model.core.MemberRef memberRef)
          Constructs a font family handle for a structure member.
FactoryPropertyHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn prop)
          Constructs a factory property handle with the given DesignElementHandle and the definition of the property.
ElementDetailHandle(DesignElementHandle element)
          Constructs a detail handle given a handle to a report element.
DimensionHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef memberRef)
          Constructs a dimension handle for a member of a structure.
DimensionHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn thePropDefn)
          Constructs a dimension handle for a element property.
ComplexValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn thePropDefn)
          Constructs a handle given an element handle and definition of a property.
ComplexValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef theMemberRef)
          Constructs a handle given an element handle and member reference.
ColorHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef memberRef)
          Constructs a color handle for a member in a structure.
ColorHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn thePropDefn)
          Constructs a color handle for a element property.
CachedMetaDataHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)
          Constructors a handle given an element handle that defines the property and a member reference to the metadata property.
ActionHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)
          Construct an handle to deal with the action structure.
 

Uses of DesignElementHandle in org.eclipse.birt.report.model.api.core
 

Methods in org.eclipse.birt.report.model.api.core that return DesignElementHandle
 DesignElementHandle IDesignElement.getHandle(org.eclipse.birt.report.model.core.Module module)
          Returns an API handle for this element.
 

Methods in org.eclipse.birt.report.model.api.core with parameters of type DesignElementHandle
 void Listener.elementChanged(DesignElementHandle focus, NotificationEvent ev)
          Notifies the listener about a Design Engine event.
 

Uses of DesignElementHandle in org.eclipse.birt.report.model.api.extension
 

Methods in org.eclipse.birt.report.model.api.extension that return DesignElementHandle
 DesignElementHandle IElementCommand.getElementHandle()
          Gets the extendedItem handle from the extension user.
 

Methods in org.eclipse.birt.report.model.api.extension with parameters of type DesignElementHandle
abstract  IReportItem ReportItemFactory.newReportItem(DesignElementHandle extendedItemHandle)
           
 IReportItem IReportItemFactory.newReportItem(DesignElementHandle extendedItemHandle)
          Creates a new instance of the extended element given a handle to the BIRT report element that represents the extended element.
 

Uses of DesignElementHandle in org.eclipse.birt.report.model.api.util
 

Methods in org.eclipse.birt.report.model.api.util with parameters of type DesignElementHandle
static java.lang.Object PropertyValueValidationUtil.validateProperty(DesignElementHandle element, java.lang.String propName, java.lang.Object propValue)
          Validates a value to be stored for the given property.
static void ElementExportUtil.exportElement(DesignElementHandle elementToExport, java.lang.String libraryFileName, boolean canOverride)
          Exports the given element into one library file.
static void ElementExportUtil.exportElement(DesignElementHandle elementToExport, LibraryHandle targetLibraryHandle, boolean canOverride)
          Exports the given element into one library.
 

Uses of DesignElementHandle in org.eclipse.birt.report.model.api.validators
 

Methods in org.eclipse.birt.report.model.api.validators with parameters of type DesignElementHandle
 java.util.List StructureListValidator.validateForAdding(DesignElementHandle element, IPropertyDefn propDefn, java.util.List list, IStructure toAdd)
          Validates whether a new structure can be added to structure list.
 java.util.List StructureListValidator.validateForRenaming(DesignElementHandle element, IPropertyDefn propDefn, java.util.List list, IStructure toRenamed, IPropertyDefn memberDefn, java.lang.String newName)
          Validates whether a structure can be renamed to the given name.
 java.util.List SimpleListValidator.validateForAdding(DesignElementHandle element, IPropertyDefn propDefn, java.util.List list, java.lang.Object toAdd)
          Validates whether a new item can be added to the simple value list.
 void IValidationListener.elementValidated(DesignElementHandle targetElement, ValidationEvent ev)
          Notifies the element is validated.
 java.util.List ColumnBindingNameValidator.validateForAdding(DesignElementHandle element, IPropertyDefn propDefn, IStructure toAdd)
          Validates whether name of structure is valid or not.
 java.util.List ColumnBindingNameValidator.validateForReplacing(DesignElementHandle element, IPropertyDefn propDefn, IStructure toAdd, java.lang.String columnName)
          Validates whether name of structure is valid or not.
 



Copyright © 2005 Actuate Corp. All rights reserved.