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

Packages that use DesignElementHandle
Package
Description
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.css
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.impl
org.eclipse.birt.report.model.api.olap
org.eclipse.birt.report.model.api.simpleapi
Report element representations in the BIRT simple API environment.
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
Modifier and Type
Class
Description
`class`
`AbstractScalarParameterHandle`
Represents the abstract scalar parameter types.
`class`
`AbstractScalarParameterHandleImpl`
Represents the abstract scalar parameter types.
`class`
`AbstractThemeHandle`
Represents a abstract theme in the library.
`class`
`AccessControlHandle`
Deprecated.
`class`
`AutoTextHandle`
Represents a autotext report item.
`class`
`CascadingParameterGroupHandle`
Represents the group of cascading parameters.
`class`
`CascadingParameterGroupHandleImpl`
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`
`ContentElementHandle`
`class`
`CssSharedStyleHandle`
Css shared style handle.
`class`
`DataGroupHandle`
`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`
`DerivedDataSetHandle`
Provides API to operate a derived data set.
`class`
`DynamicFilterParameterHandle`
Represents the dynamic filter parameter types.
`class`
`ExtendedItemHandle`
Represents an extended element.
`class`
`FilterConditionElementHandle`
`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`
`LibraryHandleImpl`
`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`
`MemberValueHandle`
CrosstabMemberValueHandle
`class`
`ModuleHandle`
Abstract module handle which provides the common functionalities of report design and library.
`class`
`ModuleHandleImpl`
Abstract module handle which provides the common functionalities of report design and library.
`class`
`MultiLineDataHandle`
Deprecated.
by `TextDataHandle`
`class`
`MultiViewsHandle`
Represents a multiple view element.
`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`
`ReportItemHandleImpl`
Abstract implementation class for the report item handle
`class`
`ReportItemThemeHandle`
Represents a report item theme in the library.
`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`
`SortElementHandle`
`class`
`StyleHandle`
Represents the style properties for either a shared style or an element with a IStyleModel.
`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.
`class`
`ValueAccessControlHandle`
Deprecated.
`class`
`VariableElementHandle`
Represents a variable.
Fields in org.eclipse.birt.report.model.api declared as DesignElementHandle
Modifier and Type
Field
Description
`protected final DesignElementHandle`
ElementDetailHandle.`elementHandle`
The handle to the report element.
Methods in org.eclipse.birt.report.model.api that return DesignElementHandle
Modifier and Type
Method
Description
`final DesignElementHandle`
ModuleHandleImpl.`findElement(String name)`
Finds a named element in the name space in this module and the included moduled.
`DesignElementHandle`
SlotHandle.`get(int posn)`
Returns a handle to the content element at the given position.
`DesignElementHandle`
DesignElementHandle.`getContainer()`
Returns a handle to the element that contains this element.
`DesignElementHandle`
DesignElementHandle.`getContent(String propName, int index)`
Gets a handle to the content element at the given position.
`DesignElementHandle`
PropertyHandleImpl.`getContent(int posn)`
Gets the content at the given position.
`DesignElementHandle`
MultiViewsHandle.`getCurrentView()`
Returns the view that is being used.
`DesignElementHandle`
ReportItemHandleImpl.`getCurrentView()`
Returns the view that is being used.
`DesignElementHandle`
TemplateElementHandle.`getDefaultElement()`
Gets the default element of this template element.
`DesignElementHandle`
TemplateParameterDefinitionHandle.`getDefaultElement()`
Gets the default element of this template parameter definition.
`final DesignElementHandle`
ModuleHandleImpl.`getElementByID(long id)`
Finds the handle to an element by a given element ID.
`DesignElementHandle`
ElementDetailHandle.`getElementHandle()`
Returns a handle to the design element.
`DesignElementHandle`
PrivateStyleHandle.`getElementHandle()`
Returns a handle to the element that owns this private style.
`DesignElementHandle`
DesignElementHandle.`getElementProperty(String propName)`
Returns the value of an element reference property.
`DesignElementHandle`
ContentElementHandle.`getExtends()`
`DesignElementHandle`
DesignElementHandle.`getExtends()`
Returns a handle to the element that this element extends.
`DesignElementHandle`
PrivateStyleHandle.`getExtends()`
This method is not defined for private styles.
`DesignElementHandle`
DesignElementHandle.`getHostViewHandle()`
Return the direct host element handle for this view element.
`DesignElementHandle`
SlotIterator.`next()`
Returns a handle to the next content element.
Methods in org.eclipse.birt.report.model.api that return types with arguments of type DesignElementHandle
Modifier and Type
Method
Description
`final List<DesignElementHandle>`
AbstractThemeHandle.`getAllStyles()`
Gets all styles in theme,include css file.
`List<DesignElementHandle>`
SlotHandle.`getContents()`
Returns the a list with slot contents.Items are handles to the contents and in order by position.
`static List<DesignElementHandle>`
ModuleUtil.`getElementsByType(ModuleHandle moduleHandle, String elementType)`
Gets all the elements that is kind of the specified type.
`Iterator<DesignElementHandle>`
SlotHandle.`iterator()`
Gets an iterator over the items in the slot.
Methods in org.eclipse.birt.report.model.api with parameters of type DesignElementHandle
Modifier and Type
Method
Description
`void`
DesignElementHandle.`add(String propName, DesignElementHandle content)`
Adds a report item to the property with the given element handle.
`void`
DesignElementHandle.`add(String propName, DesignElementHandle content, int newPos)`
Adds a report item to this property at the given position.
`void`
PropertyHandleImpl.`add(DesignElementHandle content)`
Adds a report item to the property with the given element handle.
`void`
PropertyHandleImpl.`add(DesignElementHandle content, int newPos)`
Adds a report item to this property at the given position.
`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.
`void`
DesignElementHandle.`addElement(DesignElementHandle child, int slotId)`
Adds a report item to the end of the given slot.
`void`
DesignElementHandle.`addElement(DesignElementHandle child, int slotId, int pos)`
Adds a report item to the given slot at the given position.
`void`
MultiViewsHandle.`addView(DesignElementHandle viewElement)`
Adds a new element as the view.
`void`
ReportItemHandleImpl.`addView(DesignElementHandle viewElement)`
Adds a new element as the view.
`boolean`
DesignElementHandle.`canContain(int slotId, DesignElementHandle content)`
Determines if the given slot can contain the `content`.
`boolean`
DesignElementHandle.`canContain(String propName, DesignElementHandle content)`
Determines if the given slot can contain the `content`.
`boolean`
PropertyHandleImpl.`canContain(DesignElementHandle content)`
Determines if the given slot can contain the `content`.
`boolean`
SlotHandle.`canContain(DesignElementHandle content)`
Determines if the given slot can contain the `content`.
`void`
DesignElementHandle.`copyPropertyTo(String propName, DesignElementHandle targetHandle)`
Copies all properties to the target element.
`static ActionHandle`
ModuleUtil.`deserializeAction(InputStream streamData, DesignElementHandle element)`
Deserialize an input stream into an Action.
`static ActionHandle`
ModuleUtil.`deserializeAction(String strData, DesignElementHandle element)`
Deserialize a string into an ActionHandle, notice that the handle is faked, the action is not in the design tree, the operation to the handle is not able to be undoned.
`void`
DesignElementHandle.`drop(String propName, DesignElementHandle content)`
Drops a content element from the container, and unresolve any reference property which refers the element to drop.
`void`
PropertyHandleImpl.`drop(DesignElementHandle content)`
Drops a content element from the slot, and unresolve 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.
`void`
DesignElementHandle.`dropAndClear(String propName, DesignElementHandle content)`
Drops a content element from the container, and clear any reference property which refers the element to drop.
`void`
PropertyHandleImpl.`dropAndClear(DesignElementHandle content)`
Drops a content element from the slot, and clear any reference property which refers the element to drop.
`void`
SlotHandle.`dropAndClear(DesignElementHandle content)`
Drops a content element from the slot, and clear any reference property which refers the element to drop.
`void`
MultiViewsHandle.`dropView(DesignElementHandle viewElement)`
Deletes the given view.
`void`
ReportItemHandleImpl.`dropView(DesignElementHandle viewElement)`
Deletes the given view.
`int`
DesignElementHandle.`findContentSlot(DesignElementHandle content)`
Finds the slot within this element that contains the given element.
`int`
PrivateStyleHandle.`findContentSlot(DesignElementHandle content)`
This method is not defined for private styles.
`int`
SlotHandle.`findPosn(DesignElementHandle content)`
Returns the position of the given content in this slot.
`static long`
ModuleUtil.`gerSerializedID(DesignElementHandle element)`
Returns the serialized id for the given element.
`static String`
ModuleUtil.`getExternalizedValue(DesignElementHandle element, String key, String value, com.ibm.icu.util.ULocale locale)`
Returns externalized message for the given locale.
`protected boolean`
GroupElementHandle.`hasLocalPropertiesIncludeSubElement(DesignElementHandle elementHandle)`
return true if the Element or subElement has local properties
`protected boolean`
EmptyGroupElementHandle.`isInGroup(DesignElementHandle element)`
`protected abstract boolean`
GroupElementHandle.`isInGroup(DesignElementHandle element)`
Checks whether the `element` is a member of `GroupElementHandle`.
`protected boolean`
SimpleGroupElementHandle.`isInGroup(DesignElementHandle element)`
`static boolean`
ModuleUtil.`isValidElementName(DesignElementHandle elementHandle)`
checks is the name value is valid for the design element.
`static boolean`
ModuleUtil.`isValidElementName(DesignElementHandle elementHandle, String propName, String nameValue)`
checks if the name of the element is valid.
`static void`
StructureFactory.`makeUniqueNameComputedColumn(DesignElementHandle element, ComputedColumn newColumn)`
Makes a unique name for computed column.
`void`
DesignElementHandle.`move(String fromPropName, DesignElementHandle content, DesignElementHandle newContainer, String toPropName)`
Moves a content element from this element into a property in another container element.
`void`
DesignElementHandle.`move(String fromPropName, DesignElementHandle content, DesignElementHandle newContainer, String toPropName, int newPos)`
Moves a content element into a property in another container element at the specified position.
`void`
PropertyHandleImpl.`move(DesignElementHandle content, DesignElementHandle newContainer, String propName)`
Moves a content element into a slot in another container element.
`void`
PropertyHandleImpl.`move(DesignElementHandle content, DesignElementHandle newContainer, String propName, int newPos)`
Moves a content element into a slot in another container element at the specified position.
`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`
DesignElementHandle.`moveTo(DesignElementHandle newContainer, int toSlot)`
Moves this element to a new location within the design.
`void`
DesignElementHandle.`moveTo(DesignElementHandle newContainer, String toPropName)`
Moves this element to a property in another container element.
`void`
DesignElementHandle.`moveTo(DesignElementHandle newContainer, String toPropName, int newPos)`
Moves this element to a property in another container element at the specified position.
`void`
PrivateStyleHandle.`moveTo(DesignElementHandle newContainer, int toSlot)`
This method is not defined for private styles.
`static ComputedColumn`
StructureFactory.`newComputedColumn(DesignElementHandle element, String newName)`
Creates a bound data column name with the unique column name.
`List<ErrorDetail>`
DesignElementHandle.`paste(String propName, DesignElementHandle content)`
Pastes a report item to this property.
`List<ErrorDetail>`
DesignElementHandle.`paste(String propName, DesignElementHandle content, int newPos)`
Pastes a report item to the slot.
`List`
PropertyHandleImpl.`paste(DesignElementHandle content)`
Pastes a report item to this property.
`List`
PropertyHandleImpl.`paste(DesignElementHandle content, int newPos)`
Pastes a report item to the slot.
`List`
SlotHandle.`paste(DesignElementHandle content)`
Pastes a report item to the slot.
`List`
SlotHandle.`paste(DesignElementHandle content, int newPos)`
Pastes a report item to the slot.
`final void`
ModuleHandleImpl.`rename(DesignElementHandle elementHandle)`
Checks the element name in name space of this report.
`void`
ModuleHandleImpl.`rename(DesignElementHandle containerHandle, DesignElementHandle elementHandle)`
Checks element name is unique in container.
`void`
ReportItemHandleImpl.`setCurrentView(DesignElementHandle viewElement)`
Sets the view to be used.
`final void`
ContentElementHandle.`setExtends(DesignElementHandle parent)`
`void`
DesignElementHandle.`setExtends(DesignElementHandle parent)`
Sets this element to extend the given element.
`void`
PrivateStyleHandle.`setExtends(DesignElementHandle parent)`
This method is not defined for private styles.
`void`
DesignElementHandle.`shift(String propName, DesignElementHandle content, int toPosn)`
Moves the position of a content element within this container.
`void`
PropertyHandleImpl.`shift(DesignElementHandle content, int toPosn)`
Moves the position of a content element within the slot.
`void`
SlotHandle.`shift(DesignElementHandle content, int toPosn)`
Moves the position of a content element within the slot.
Method parameters in org.eclipse.birt.report.model.api with type arguments of type DesignElementHandle
Modifier and Type
Method
Description
`static void`
DesignElementHandle.`doSort(List<DesignElementHandle> list)`
Sorts a list of elements by localized display name.
Constructors in org.eclipse.birt.report.model.api with parameters of type DesignElementHandle
Modifier
Constructor
Description
``
`ActionHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)`
Deprecated.
``
`ActionHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
Construct an handle to deal with the action structure.
``
`CachedMetaDataHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)`
Deprecated.
``
`CachedMetaDataHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext ref)`
Constructors a handle given an element handle that defines the property and a member context to the metadata property.
``
`ColorHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef context)`
Deprecated.
``
`ColorHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
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.
``
`ComplexValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef theMemberRef)`
Deprecated.
``
`ComplexValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext theMemberContext)`
Constructs a handle given an element handle and member reference.
``
`ComplexValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn thePropDefn)`
Constructs a handle given an element handle and definition of a property.
``
`DimensionHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef context)`
Deprecated.
``
`DimensionHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
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.
``
`ElementDetailHandle(DesignElementHandle element)`
Constructs a detail handle given a handle to a report element.
``
`ExpressionHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef memberRef)`
Deprecated.
``
`ExpressionHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
Constructs an expression handle for the structure member.
``
`ExpressionHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn thePropDefn)`
Constructs an expression handle for an element property.
`protected`
`ExpressionListHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)`
Deprecated.
`protected`
`ExpressionListHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
Constructs an expression list handle for the structure member.
`protected`
`ExpressionListHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn thePropDefn)`
Constructs an expression list handle for an element property.
``
`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.
``
`FontHandle(DesignElementHandle handle)`
Constructs a font family handle for an element property.
``
`FontHandle(DesignElementHandle handle, org.eclipse.birt.report.model.core.MemberRef context)`
Deprecated.
``
`FontHandle(DesignElementHandle handle, org.eclipse.birt.report.model.core.StructureContext context)`
Constructs a font family handle for a structure member.
``
`FormatValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef context)`
Deprecated.
``
`FormatValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
Construct an handle to deal with the action structure.
``
`OdaDesignerStateHandle(DesignElementHandle elementHandle, org.eclipse.birt.report.model.core.MemberRef context)`
Deprecated.
``
`OdaDesignerStateHandle(DesignElementHandle elementHandle, org.eclipse.birt.report.model.core.StructureContext context)`
Constructs the handle of Oda Designer state.
``
`PropertyHandle(DesignElementHandle element, 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.
``
`PropertyHandleImpl(DesignElementHandle element, String propName)`
Constructs the handle for a top-level property with the given element handle and property name.
``
`PropertyHandleImpl(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.
``
`ResultSetColumnHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
``
`RuleHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef context)`
Deprecated.
``
`RuleHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
Construct an handle to deal with the action structure.
``
`SimpleValueHandle(DesignElementHandle element)`
Constructs a handle with the given handle to an design element.
``
`SlotHandle(DesignElementHandle element, int slotID)`
Constructs a handle for the slot with the given design element handle and the id of the slot.
``
`StructureHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)`
Deprecated.
``
`StructureHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
Constructs a handle for a structure within a list property of a given element.
``
`TimeIntervalHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
Constructs the handle of time interval.
``
`TOCHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef context)`
Deprecated.
``
`TOCHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)`
Construct an handle to deal with the toc structure.
``
`UserPropertyDefnHandle(DesignElementHandle element, String propName)`
Constructs a handle for the user-defined property with the given element handle and the name of the user-defined property.
``
`UserPropertyDefnHandle(DesignElementHandle element, UserPropertyDefn prop)`
Constructs a handle for the user-defined property with the given element handle and the user-defined property.
``
`ValueHandle(DesignElementHandle element)`
Constructs a value handle with the given element handle.

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

Methods in org.eclipse.birt.report.model.api.core that return DesignElementHandle
Modifier and Type
Method
Description
`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
Modifier and Type
Method
Description
`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.css

Methods in org.eclipse.birt.report.model.api.css that return DesignElementHandle
Modifier and Type
Method
Description
`DesignElementHandle`
CssStyleSheetHandle.`getContainerHandle()`
Gets container handle.

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

Methods in org.eclipse.birt.report.model.api.extension that return DesignElementHandle
Modifier and Type
Method
Description
`DesignElementHandle`
IllegalContentInfo.`getContent()`
Gets the child of the `UndefinedChildInfo`.
`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
Modifier and Type
Method
Description
`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.
`abstract IReportItem`
ReportItemFactory.`newReportItem(DesignElementHandle extendedItemHandle)`

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

Methods in org.eclipse.birt.report.model.api.impl with parameters of type DesignElementHandle
Modifier and Type
Method
Description
`IDesignElement`
SimpleElementFactory.`getElement(DesignElementHandle handle)`

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

Subclasses of DesignElementHandle in org.eclipse.birt.report.model.api.olap
Modifier and Type
Class
Description
`class`
`CubeHandle`
Represents a cube.
`class`
`DimensionHandle`
Represents a dimension element in the cube element.
`class`
`HierarchyHandle`
Represents a Hierarchy.
`class`
`LevelHandle`
Represents a level element.
`class`
`MeasureGroupHandle`
Handle class for MeasureGroup.
`class`
`MeasureHandle`
This class represents a measure element.
`class`
`OdaCubeHandle`
Represents a cube.
`class`
`OdaDimensionHandle`
Represents a dimension element in the cube element.
`class`
`OdaHierarchyHandle`
Represents a Hierarchy.
`class`
`OdaLevelHandle`
Represents a level element.
`class`
`OdaMeasureGroupHandle`
Handle class for MeasureGroup.
`class`
`OdaMeasureHandle`
This class represents a measure element.
`class`
`TabularCubeHandle`
Represents a cube.
`class`
`TabularDimensionHandle`
Represents a dimension element in the cube element.
`class`
`TabularHierarchyHandle`
Represents a Hierarchy.
`class`
`TabularLevelHandle`
Represents a level element.
`class`
`TabularMeasureGroupHandle`
Handle class for MeasureGroup.
`class`
`TabularMeasureHandle`
This class represents a measure element.

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

Methods in org.eclipse.birt.report.model.api.simpleapi with parameters of type DesignElementHandle
Modifier and Type
Method
Description
`IDesignElement`
ISimpleElementFactory.`getElement(DesignElementHandle handle)`
Creates the IDesignElement instance.

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

Methods in org.eclipse.birt.report.model.api.util that return DesignElementHandle
Modifier and Type
Method
Description
`static DesignElementHandle`
StyleUtil.`copyLocalStyles(DesignElementHandle source, DesignElementHandle target)`
Gets the design element handle with all the style properties are copied to the returned value.
`static DesignElementHandle`
StyleUtil.`copyStyles(DesignElementHandle source, DesignElementHandle target)`
Gets the design element handle with all the style properties are copied to the returned value.
`static DesignElementHandle`
StyleUtil.`copyStyles(DesignElementHandle source, DesignElementHandle target, boolean isCascaded)`
Gets the design element handle with all the style properties are copied to the returned value.
`DesignElementHandle`
IElementCopy.`getHandle(ModuleHandle handle)`
Gets the element which keeps the "extends" relationship and unlocalized information, it should be only used to validate copy/paste actions.
Methods in org.eclipse.birt.report.model.api.util with parameters of type DesignElementHandle
Modifier and Type
Method
Description
`static boolean`
ElementExportUtilImpl.`canExport(DesignElementHandle elementToExport)`
Checks whether the given element can be exported into one library.
`static boolean`
ElementExportUtilImpl.`canExport(DesignElementHandle elementToExport, boolean ignoreName)`
Checks whether the given element can be exported into one library.
`static boolean`
ElementExportUtilImpl.`canExport(DesignElementHandle elementToExport, LibraryHandle targetLibraryHandle, boolean canOverride)`
Checks whether the given element can be exported into one library.
`static IPasteStatus`
CopyUtil.`canPaste(IElementCopy copy, DesignElementHandle container, int slotID)`
/** Checks whether the given copy can be pasted into the given slot of the specified element.
`static IPasteStatus`
CopyUtil.`canPaste(IElementCopy copy, DesignElementHandle container, String propName)`
/** Checks whether the given copy can be pasted into the given slot of the specified element.
`protected static final boolean`
ElementExportUtilImpl.`checkExportElementByContext(DesignElementHandle handle, ModuleHandle targetLibraryHandle, boolean canOverride)`
Checks if extendedItem and cube's content element has the same name as the exported element and its content elements.
`static IElementCopy`
CopyUtil.`copy(DesignElementHandle source)`
Returns the copy of the current element.
`static DesignElementHandle`
StyleUtil.`copyLocalStyles(DesignElementHandle source, DesignElementHandle target)`
Gets the design element handle with all the style properties are copied to the returned value.
`static DesignElementHandle`
StyleUtil.`copyStyles(DesignElementHandle source, DesignElementHandle target)`
Gets the design element handle with all the style properties are copied to the returned value.
`static DesignElementHandle`
StyleUtil.`copyStyles(DesignElementHandle source, DesignElementHandle target, boolean isCascaded)`
Gets the design element handle with all the style properties are copied to the returned value.
`static void`
ElementExportUtilImpl.`exportElement(DesignElementHandle elementToExport, String libraryFileName, boolean canOverride)`
Exports the given element into one library file.
`static void`
ElementExportUtilImpl.`exportElement(DesignElementHandle elementToExport, LibraryHandle targetLibraryHandle, boolean canOverride)`
Exports the given element into one library.
`static List`
CopyUtil.`paste(IElementCopy copy, DesignElementHandle container, int slotID)`
Pastes a report item to the slot.
`static List`
CopyUtil.`paste(IElementCopy copy, DesignElementHandle container, int slotID, int newPos)`
Pastes a report item to the slot.
`static List`
CopyUtil.`paste(IElementCopy copy, DesignElementHandle container, String propName)`
Pastes a report item to the slot.
`static List`
CopyUtil.`paste(IElementCopy copy, DesignElementHandle container, String propName, int newPos)`
Pastes a report item to the slot.
`static Object`
PropertyValueValidationUtil.`validateProperty(DesignElementHandle element, String propName, Object propValue)`
Validates a value to be stored for the given property.

## 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
Modifier and Type
Method
Description
`void`
IValidationListener.`elementValidated(DesignElementHandle targetElement, ValidationEvent ev)`
Notifies the element is validated.
`List<SemanticException>`
SimpleListValidator.`validateForAdding(DesignElementHandle element, IPropertyDefn propDefn, List<Object> list, Object toAdd)`
Validates whether a new item can be added to the simple value list.
`List<SemanticException>`
StructureListValidator.`validateForAdding(DesignElementHandle element, IPropertyDefn propDefn, List<Object> list, IStructure toAdd)`
Validates whether a new structure can be added to structure list.
`List<SemanticException>`
StructureListValidator.`validateForRenaming(DesignElementHandle element, IPropertyDefn propDefn, List<Object> list, IStructure toRenamed, IPropertyDefn memberDefn, String newName)`
Validates whether a structure can be renamed to the given name.