IDesignViewDriver Interface

com.bea.ide.control
IDesignViewDriver Interface

public interface IDesignViewDriver

All Known Implementing Classes
DefaultDesignViewDriver

Field Summary

public static final int
CLIENT_JAVA
int
public static final int
CLIENT_NONE
int
public static final int
CLIENT_WEBSERVICE
int
public static final Object
SEPARATOR
Object
public static final Object
STANDARD_MENU
Object
 

Method Summary

public boolean
canContainControl()
Specify whether this designview should show controls and allow them to be added to the document.
public IDocument
getCallbackDocument()
The document which contains callbacks for the current document.
public int
getClientType()
Specify what type of client representation to show on this designview.
public String
getControlInterfaceName()
Specifies the control interface for the ControlDescription that contains the attributes for this document.
public String
getEditorLabel()
The type of file being edited.
public Object[]
getPopupActions(IElement element)
Popup actions for a given element.

Field Detail

CLIENT_JAVA

public static final int CLIENT_JAVA


CLIENT_NONE

public static final int CLIENT_NONE


CLIENT_WEBSERVICE

public static final int CLIENT_WEBSERVICE


SEPARATOR

public static final Object SEPARATOR


STANDARD_MENU

public static final Object STANDARD_MENU

 

Method Detail

canContainControl() Method

public boolean canContainControl()
Specify whether this designview should show controls and allow them to be added to the document.

Returns

true if this document can have controls added to it.

getCallbackDocument() Method

public IDocument getCallbackDocument()
The document which contains callbacks for the current document. In most cases, this is the current document.


getClientType() Method

public int getClientType()
Specify what type of client representation to show on this designview.

Returns

one of the CLIENT_* constants.

getControlInterfaceName() Method

public String getControlInterfaceName()
Specifies the control interface for the ControlDescription that contains the attributes for this document. May not be null, but may be the empty string, in which case the superclasses of the document will be checked for matching types.

Returns

The interface name of the control which defines properties for this control.

getEditorLabel() Method

public String getEditorLabel()
The type of file being edited.

Returns

A label to display as part of the editor title.

getPopupActions(IElement) Method

public Object[] getPopupActions(IElement element)
Popup actions for a given element. Objects in the returned array may be: - An IActionProxy to show on the menu. - The marker object STANDARD_MENU, which will put standard menu items into the array at that point (with seperators before and after if appropriate). - The marker object SEPARATOR to indicate a separator in the menu.

Parameters

element
The element for which the menu should be shown.

Returns

An array of IActionProxy, STANDARD_MENU, and/or SEPARATOR objects for the popup menu to show. If this is zero-length, no menu will be shown. Returning null is equivalent to returning an array containing only STANDARD_MENU.