IStructureViewDriver Interface

com.bea.ide.ui.structureview
IStructureViewDriver Interface

public interface IStructureViewDriver

Provides the interface to show information in the structure view.

All Known Implementing Classes
JavaStructureViewDriver, XmlStructureViewDriver

Method Summary
public int
compareName(IElement el1, IElement el2)
Compares two nodes for alphabetical sorting.
public int
compareType(IElement el1, IElement el2)
Compares two nodes for group-by-type sorting.
public IElement
getDocumentElement(IElement el)
Returns the element in the structure tree that should be selected when the IDocumentView's SelectedElement property is set to the given element
public Icon
getIcon(IElement el)
Returns the icon for the given displayed element or null if the element has no icon.
public Object
getPopupMenu(IElement el)
Returns the popup menu to display for this element or null if there is no popup.
public IElement
getSelectionElement(IElement el)
Returns the element that should be set as the selected element when the given element is selected in the structure view
public String
getTooltip(IElement el)
Returns the tooltip for this element or null if there is no tooltip.
public boolean
isDisplayed(IElement el)
Determines whether the given element should be displayed at all.
public boolean
isFollowed(ILinkedElement el)
Determines whether the data pointed to by this linked element should be followed.
public boolean
isLeaf(IElement el)
Determines whether the given element should be a leaf (i.e. it's children should not be explored)
public void
performDoubleClickAction(IElement el)
Perform the action that occurs on a double-click of this element

Method Detail

compareName(IElement, IElement) Method

public int compareName(IElement el1, 
                       IElement el2)
Compares two nodes for alphabetical sorting.

compareType(IElement, IElement) Method

public int compareType(IElement el1, 
                       IElement el2)
Compares two nodes for group-by-type sorting.

getDocumentElement(IElement) Method

public IElement getDocumentElement(IElement el)
Returns the element in the structure tree that should be selected when the IDocumentView's SelectedElement property is set to the given element

getIcon(IElement) Method

public Icon getIcon(IElement el)
Returns the icon for the given displayed element or null if the element has no icon.

getPopupMenu(IElement) Method

public Object getPopupMenu(IElement el)
Returns the popup menu to display for this element or null if there is no popup. This method may return a String in which case it is taken to be the name of a popup menu declared in the ActionSvc and will be shown accordingly. Or it may retrun a javax.swing.JPopupMenu directly.

getSelectionElement(IElement) Method

public IElement getSelectionElement(IElement el)
Returns the element that should be set as the selected element when the given element is selected in the structure view

getTooltip(IElement) Method

public String getTooltip(IElement el)
Returns the tooltip for this element or null if there is no tooltip.

isDisplayed(IElement) Method

public boolean isDisplayed(IElement el)
Determines whether the given element should be displayed at all.

isFollowed(ILinkedElement) Method

public boolean isFollowed(ILinkedElement el)
Determines whether the data pointed to by this linked element should be followed.

isLeaf(IElement) Method

public boolean isLeaf(IElement el)
Determines whether the given element should be a leaf (i.e. it's children should not be explored)

performDoubleClickAction(IElement) Method

public void performDoubleClickAction(IElement el)
Perform the action that occurs on a double-click of this element