Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api
Class MemberHandle

    java.lang.Object
      org.eclipse.birt.report.model.api.ElementDetailHandle
          org.eclipse.birt.report.model.api.ValueHandle
              org.eclipse.birt.report.model.api.SimpleValueHandle
                  org.eclipse.birt.report.model.api.MemberHandle

    public class MemberHandle

extends SimpleValueHandle

A handle to a member of a property structure. A structure list occurs in an element property that contains a list of structures. The class handles a member of one structure in the list.

See Also:
  `StructureHandle`

Field Summary
`protected org.eclipse.birt.report.model.core.CachedMemberRef` | `memberRef` The reference to the member itself.

Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
`elementHandle`

Constructor Summary
`MemberHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)` Constructs a member handle with the given element handle and the member reference.
`MemberHandle(StructureHandle structHandle, org.eclipse.birt.report.model.metadata.StructPropertyDefn member)` Constructs a member handle with the given structure handle and the member property definition.

Method Summary
`void` | `addItem(java.lang.Object item)` Adds an item to the end of a list property.
`IPropertyDefn` | `getDefn()` Gets the generic property definition.
`IElementPropertyDefn` | `getPropertyDefn()` Gets the property definition.
`org.eclipse.birt.report.model.core.MemberRef` | `getReference()` Returns a reference to the value.
`java.lang.Object` | `getValue()` Gets the value of the property as a generic object.
`boolean` | `isReadOnly()` Checks whether a value is read-only in the property sheet.
`boolean` | `isVisible()` Checks whether a value is visible in the property sheet.
`void` | `removeItem(int posn)` Removes an item from a list property or member.
`void` | `setValue(java.lang.Object value)` Sets the value of a property or member to the object given.

Methods inherited from class org.eclipse.birt.report.model.api.SimpleValueHandle
`addItem, clearValue, get, getAt, getChoices, getDefaultUnit, getDisplayValue, getFloatValue, getIntValue, getListValue, getNumberValue, getStringValue, getTypeCode, indexOf, insertItem, isList, iterator, moveItem, removeItem, removeItems, replaceItem, setFloatValue, setIntValue, setNumberValue, setStringValue`

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`

Field Detail

### memberRef

    protected org.eclipse.birt.report.model.core.CachedMemberRef memberRef

  The reference to the member itself.

Constructor Detail

### MemberHandle

    public MemberHandle(DesignElementHandle element,
                        org.eclipse.birt.report.model.core.MemberRef ref)

  Constructs a member handle with the given element handle and the member reference. The application usually does not create a handle directly. Instead, it obtains a handle by calling a method another handle.

  Parameters:
    `element` - handle to the report element that has the property that contains the structure that contains the member the list that contains the structure that contains the member.
    `ref` - The reference to the member.

### MemberHandle

    public MemberHandle(StructureHandle structHandle,
                        org.eclipse.birt.report.model.metadata.StructPropertyDefn member)

  Constructs a member handle with the given structure handle and the member property definition. This form is used by the `StructureIterator` class.

  Parameters:
    `structHandle` - a handle to the structure
    `member` - definition of the member within the structure

Method Detail

### getDefn

    public IPropertyDefn getDefn()

  Description copied from class: `SimpleValueHandle`
  Gets the generic property definition. Its a property definition for an element or a member definition for a structure.

  Specified by:
    `getDefn` in class `SimpleValueHandle`
  Returns:
    the value definition.

### getValue

    public java.lang.Object getValue()

  Description copied from class: `SimpleValueHandle`
  Gets the value of the property as a generic object. Use the specialized methods to get the value as a particular type.

  Specified by:
    `getValue` in class `SimpleValueHandle`
  Returns:
    The value of the property as a generic object.
  See Also:
    `SimpleValueHandle.getStringValue()`, `SimpleValueHandle.getIntValue()`, `SimpleValueHandle.getFloatValue()`, `SimpleValueHandle.getNumberValue()`

### setValue

    public void setValue(java.lang.Object value)
                  throws SemanticException

  Description copied from class: `SimpleValueHandle`
  Sets the value of a property or member to the object given. If the object is `null`, then the value is cleared.

  Specified by:
    `setValue` in class `SimpleValueHandle`
  Parameters:
    `value` - The new value.
  Throws:
    `SemanticException` - If the value is not valid for the property or member.
  See Also:
    `SimpleValueHandle.setIntValue(int)`, `SimpleValueHandle.setStringValue(java.lang.String)`, `SimpleValueHandle.setFloatValue(double)`, `SimpleValueHandle.setNumberValue(java.math.BigDecimal)`, `SimpleValueHandle.clearValue()`

### removeItem

    public void removeItem(int posn)
                    throws PropertyValueException

  Description copied from class: `SimpleValueHandle`
  Removes an item from a list property or member. The handle must be working on a list property or member.

  Specified by:
    `removeItem` in class `SimpleValueHandle`
  Parameters:
    `posn` - The position of the item to remove.
  Throws:
    `PropertyValueException` - If the property is not a list property.

### addItem

    public void addItem(java.lang.Object item)
                 throws SemanticException

  Description copied from class: `SimpleValueHandle`
  Adds an item to the end of a list property. The handle must be working on a list property.

  Specified by:
    `addItem` in class `SimpleValueHandle`
  Parameters:
    `item` - The new item to add.
  Throws:
    `SemanticException` - If the property is not a list property, or if the the value of the item is incorrect.

### getPropertyDefn

    public IElementPropertyDefn getPropertyDefn()

  Description copied from class: `ValueHandle`
  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.

  Specified by:
    `getPropertyDefn` in class `ValueHandle`
  Returns:
    the property definition

### getReference

    public org.eclipse.birt.report.model.core.MemberRef getReference()

  Description copied from class: `ValueHandle`
  Returns a reference to the value. The reference is used to identify a list entry or member.

  Specified by:
    `getReference` in class `ValueHandle`
  Returns:
    a reference to the value

### isReadOnly

    public boolean isReadOnly()

  Description copied from class: `SimpleValueHandle`
  Checks whether a value is read-only in the property sheet.

  Specified by:
    `isReadOnly` in class `SimpleValueHandle`
  Returns:
    `true` if it is read-only. Otherwise `false`.

### isVisible

    public boolean isVisible()

  Description copied from class: `SimpleValueHandle`
  Checks whether a value is visible in the property sheet.

  Specified by:
    `isVisible` in class `SimpleValueHandle`
  Returns:
    `true` if it is visible. Otherwise `false`.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.