# com.bea.ide.ui.propertyeditor
DefaultPropertyViewDriver Class

public abstract class DefaultPropertyViewDriver
extends `Object`
implements `IPropertyViewDriver`

A default implementation of IPropertyViewDriver.

Hierarchy
  `Object`
  `DefaultPropertyViewDriver`

All Implemented Interfaces
  `IPropertyViewDriver`

## Constructor Summary

DefaultPropertyViewDriver()

## Method Summary

`public `IPropertyViewDriver.IPropertyViewContext`` | `getContext`() Gets the view context for this driver.
`public `String`` | `getDescription`(`IElement` el) Description of this type of element.
`public `IElement`` | `getDisplayElement`(`IElement` activeElement) Allows the property view driver to display properties for a different element than that which was selected in the document.
`public `URI`[]` | `getHelpContextList`(`IElement` el) The default behavior when an IElement is selected in PropertyView is to find and invoke the IHelpDriver for the view in which the element was selected.
`public `URI`[]` | `getHelpContextList`(`IPropertyNode` node) Returns an array of URIs containing help context identifiers for context-sensitive help.
`public `String`` | `getLabel`(`IElement` el) Display name identifying this element instance.
`public `List`` | `getProperties`(`IElement` el) Returns a list of IPropertyNodes.
`public `String`` | `getTypeLabel`(`IElement` el) Display name identifying this type of element.
`public void` | `setContext`(`IPropertyViewDriver.IPropertyViewContext` context) Sets the view context for this driver.

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `com.bea.ide.ui.propertyeditor.`IPropertyViewDriver``
``getDescription`, `getDisplayElement`, `getHelpContextList`, `getHelpContextList`, `getLabel`, `getProperties`, `getTypeLabel`, `setContext``

## Constructor Detail

### DefaultPropertyViewDriver

    public DefaultPropertyViewDriver()

## Method Detail

### getContext() Method

    public IPropertyViewDriver.IPropertyViewContext getContext()

Gets the view context for this driver.

#### Returns

the IPropertyViewContext that is set for this driver.

### getDescription(IElement) Method

    public String getDescription(IElement el)

Description copied from `IPropertyViewDriver.getDescription(IElement)`
Description of this type of element.

#### Parameters

el
  IElement.

#### Returns

String type description.

Related Topics

``IPropertyViewDriver.getDescription(IElement)``

### getDisplayElement(IElement) Method

    public IElement getDisplayElement(IElement activeElement)

Description copied from `IPropertyViewDriver.getDisplayElement(IElement)`
Allows the property view driver to display properties for a different element than that which was selected in the document.

#### Parameters

activeElement
  the currently selected document element. el may be null in the case where there is no selected element in the document.

#### Returns

an element whose properties should be displayed rather than the provided element. If no remapping is desired, the element passed in should be returned.

Related Topics

``IPropertyViewDriver.getDisplayElement(IElement)``

### getHelpContextList(IElement) Method

    public URI[] getHelpContextList(IElement el)

The default behavior when an IElement is selected in PropertyView is to find and invoke the IHelpDriver for the view in which the element was selected. This will be a help driver associated with a source or design view, for example.

Related Topics

``IPropertyViewDriver.getHelpContextList(IElement)``

### getHelpContextList(IPropertyNode) Method

    public URI[] getHelpContextList(IPropertyNode node)

Description copied from `IPropertyViewDriver.getHelpContextList(IPropertyNode)`
Returns an array of URIs containing help context identifiers for context-sensitive help. A help context URI is a URN where the namespace identifies the type of thing selected (e.g. javadoc-tag) and the scheme-specific part identifies which item is selected. In the case of the PropertyView, a typical selection would be a "property" that represents a Javadoc tag from a JWS or JCX file. An example of the URN for the @common:operation is urn:javadoc-tag:common/operation.

Related Topics

``IPropertyViewDriver.getHelpContextList(IPropertyNode)``

### getLabel(IElement) Method

    public String getLabel(IElement el)

Description copied from `IPropertyViewDriver.getLabel(IElement)`
Display name identifying this element instance. Note that this label should be different than the string returned by getTypeLabel().

Elements of the same type would have have the same type label, but different instance labels.

#### Parameters

el
  IElement.

#### Returns

String name.

Related Topics

``IPropertyViewDriver.getLabel(IElement)``

### getProperties(IElement) Method

    public List getProperties(IElement el)

Description copied from `IPropertyViewDriver.getProperties(IElement)`
Returns a list of IPropertyNodes. This list is the top level of the property heirarchy displayed in the property view. The property view expects that all top level nodes represent property groups and will not not display values for these nodes. After the top-level, nodes implementing IProperty will display a value.

If this element has no displayable properties, an empty List should be returned. Use of Collections.EMPTY_LIST is recommended.

#### Parameters

el
  IElement.

#### Returns

List of IPropertyNode. May not be null, may be empty.

Related Topics

``IPropertyViewDriver.getProperties(IElement)``

### getTypeLabel(IElement) Method

    public String getTypeLabel(IElement el)

Description copied from `IPropertyViewDriver.getTypeLabel(IElement)`
Display name identifying this type of element.

Elements of the same type would have have the same type label, but different instance labels.

#### Parameters

el
  IElement.

#### Returns

String type name.

Related Topics

``IPropertyViewDriver.getTypeLabel(IElement)``

### setContext(IPropertyViewDriver.IPropertyViewContext) Method

    public void setContext(IPropertyViewDriver.IPropertyViewContext context)

Description copied from `IPropertyViewDriver.setContext(IPropertyViewDriver.IPropertyViewContext)`
Sets the view context for this driver. Usually set by the view but can be used by drivers which wrap or extend other drivers.

Related Topics

``IPropertyViewDriver.setContext(IPropertyViewDriver.IPropertyViewContext)``