Extension SDK

oracle.ide.navigator
Interface NodeOverlayClient


public interface NodeOverlayClient

Interface to the client controller of explorer node overlays. Register a client with the node overlay manager to specify navigator overlay behaviour for controlled elements.

If using the default overlay manager, ensure that the registered client's controlled nodes implement the Subject interface. This is required since UpdateMessages are used to observe node state changes for overlay updates and repainting.

See Also:
NavigatorManager, NodeOverlayManager

Method Summary
 javax.swing.Icon getOverlayIcon(Element e)
          Gets the overlay icon for the given client element.
 boolean isControlled(Element e)
          Asks whether overlays for the given node are controlled by this client.
 

Method Detail

isControlled

public boolean isControlled(Element e)
Asks whether overlays for the given node are controlled by this client.
Parameters:
e - the element in question.
Returns:
a verdict on client control of the node.

getOverlayIcon

public javax.swing.Icon getOverlayIcon(Element e)
Gets the overlay icon for the given client element.
Parameters:
e - the element.
Returns:
the node overlay icon representing the state.

Extension SDK