# com.bea.ide.ui.palette
IDataPaletteViewDriver Interface

public interface IDataPaletteViewDriver

This interface is an action generator for the IDE's data palette view. It would be used to dynamically populate the data palette with palette actions.

Related Topics

``IGenerator``

All Known Implementing Classes
  `DataPaletteTagDriver`, `DefaultDataPaletteDriver`

## Nested Class Summary

`public static interface` | `IDataPaletteViewDriver.IDataPaletteViewContext` Interface to provide access to the view context of the data palette.

## Method Summary

`public boolean` | `canDelete`(`IAction` element) Determines whether the specified action can be deleted from the data palette.
`public void` | `delete`(`IAction` element) Deletes the specified action and document elements associated with it.
`public `JPopupMenu`` | `getPopupMenu`(`IAction` el) Requests the menu to display for this action on a right click event (or any other).
`public `List`` | `getPropertyInfo`(`IAction` element) Returns a list of IPropertyNodes.
`public boolean` | `populate`(`IActionContainer` palette) Adds actions to the given container.
`public void` | `setContext`(`IDataPaletteViewDriver.IDataPaletteViewContext` context) Sets the view context for this driver.

## Method Detail

### canDelete(IAction) Method

    public boolean canDelete(IAction element)

Determines whether the specified action can be deleted from the data palette.

#### Parameters

element
  the object that is being deleted.

#### Returns

true if the object can be deleted.

### delete(IAction) Method

    public void delete(IAction element)

Deletes the specified action and document elements associated with it.

#### Parameters

element
  the object that is being deleted.

### getPopupMenu(IAction) Method

    public JPopupMenu getPopupMenu(IAction el)

Requests the menu to display for this action on a right click event (or any other).

#### Parameters

el
  the object that the menu is being requsted for.

#### Returns

JPopupMenu to display for the specified action, null if none is available.

### getPropertyInfo(IAction) Method

    public List getPropertyInfo(IAction element)

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

element
  the object that properties are being requested on.

#### Returns

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

### populate(IActionContainer) Method

    public boolean populate(IActionContainer palette)

Adds actions to the given container.

#### Parameters

palette
  The IActioncontainer that needs to be populated

#### Returns

true if items were added to the menu, false if there were no items added

### setContext(IDataPaletteViewDriver.IDataPaletteViewContext) Method

    public void setContext(IDataPaletteViewDriver.IDataPaletteViewContext context)

Sets the view context for this driver. Can be used to request information or actions from the view.

Related Topics

``IDataPaletteViewDriver.IDataPaletteViewContext``