org.eclipse.xtext.ui.editor.folding
Interface IFoldingStructureProvider

All Known Implementing Classes:
DefaultFoldingStructureProvider, InitiallyCollapsableAwareFoldingStructureProvider

public interface IFoldingStructureProvider

Author:
Michael Clay - Initial contribution and API

Method Summary
 void initialize()
          (Re-)initializes the structure provided by the receiver.
 void install(XtextEditor editor, org.eclipse.jface.text.source.projection.ProjectionViewer viewer)
          Installs this structure provider on the given editor and viewer.
 void uninstall()
          Uninstalls this structure provider.
 

Method Detail

install

void install(XtextEditor editor,
             org.eclipse.jface.text.source.projection.ProjectionViewer viewer)
Installs this structure provider on the given editor and viewer. Implementations should listen to the projection events generated by viewer and enable / disable generation of projection structure accordingly.

Parameters:
editor - the editor that this provider works on
viewer - the projection viewer that displays the annotations created by this structure provider

uninstall

void uninstall()
Uninstalls this structure provider. Any references to editors or viewers should be cleared.


initialize

void initialize()
(Re-)initializes the structure provided by the receiver.