IDocumentViewInfo Interface

com.bea.ide.document
IDocumentViewInfo Interface

public interface IDocumentViewInfo

Document view info is a minor information class used to display user interface in the IDE without necessarily instantiating a potentially expensive view object. The view info should be very lightweight in implementation and may be reusable (multiple calls to IDocument.getViewInfo() may return the same instances repeatedly). By contrast it is important that the createView() method return a new instance each time it is invoked.


All Known Implementing Classes
DefaultDocumentViewInfo

Method Summary

public IDocumentView
createView()
Create an instance of this view.
public String
getDescription()
A description of this view.
public Icon
getIcon()
An icon representing this view.
public String
getName()
The name of this view.

Method Detail

createView() Method

public IDocumentView createView()
Create an instance of this view.

Returns

a new instance of the IDocumentView represented by this object.

getDescription() Method

public String getDescription()
A description of this view.


getIcon() Method

public Icon getIcon()
An icon representing this view.


getName() Method

public String getName()
The name of this view. This may be used to navigate to the view using the DocumentSvc.I.displayDocument(IDocument, String) method. It will also be displayed in the tab for the document view (if multiple views are available).