1 /*******************************************************************************
2 * Copyright (c) 2000, 2003 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Common Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/cpl-v10.html
9 * IBM Corporation - initial API and implementation
10 *******************************************************************************/
11 package net.sourceforge.phpdt.ui.text.folding;
13 import org.eclipse.jface.text.source.projection.ProjectionViewer;
14 import org.eclipse.ui.texteditor.ITextEditor;
18 * <code>net.sourceforge.phpdt.ui.foldingStructureProvider</code> extension
19 * point must specify an implementation of this interface which will create and
21 * {@link org.eclipse.jface.text.source.projection.ProjectionAnnotation} objects
23 * {@link org.eclipse.jface.text.source.projection.ProjectionViewer}.
25 * Clients may implement this interface.
30 public interface IJavaFoldingStructureProvider {
33 * Installs this structure provider on the given editor and viewer.
34 * Implementations should observe the projection events generated by
35 * <code>viewer</code> and enable / disable generation of projection
36 * structure accordingly.
39 * the editor that this provider works on
41 * the projection viewer that displays the annotations created by
42 * this structure provider
44 public abstract void install(ITextEditor editor, ProjectionViewer viewer);
47 * Uninstalls this structure provider. Any references to editors or viewers
50 public abstract void uninstall();
53 * (Re-)initializes the structure provided by the receiver.
55 public abstract void initialize();