Attachment #75067 for bug #69581

Lines 41-43 Link Here

(-)Ant Editor/org/eclipse/ant/internal/ui/editor/AntEditorMessages.properties (+5 lines)
41	AntAnnotationHover.multipleMarkersAtThisLine=Multiple markers at this line	41	AntAnnotationHover.multipleMarkersAtThisLine=Multiple markers at this line
42		42
43	AntEditor.3=Current text selection does not resolve to an Ant reference	43	AntEditor.3=Current text selection does not resolve to an Ant reference
		44
		45	Editor.Paste.label=&Paste
		46	Editor.Paste.tooltip=Paste
		47	Editor.Paste.image=
		48	Editor.Paste.description=Paste




import org.eclipse.ant.internal.ui.editor.actions.RunToLineAdapter;
import org.eclipse.ant.internal.ui.editor.actions.ToggleLineBreakpointAction;
import org.eclipse.ant.internal.ui.editor.outline.AntEditorContentOutlinePage;
import org.eclipse.ant.internal.ui.editor.templates.AntTemplatesPage;
import org.eclipse.ant.internal.ui.editor.text.AntEditorDocumentProvider;
import org.eclipse.ant.internal.ui.editor.text.AntFoldingStructureProvider;
import org.eclipse.ant.internal.ui.editor.text.IReconcilingParticipant;

import org.eclipse.jface.text.ISelectionValidator;
import org.eclipse.jface.text.ISynchronizable;
import org.eclipse.jface.text.ITextInputListener;
import org.eclipse.jface.text.ITextOperationTarget;
import org.eclipse.jface.text.ITextSelection;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.Position;

import org.eclipse.jface.text.source.projection.IProjectionListener;
import org.eclipse.jface.text.source.projection.ProjectionSupport;
import org.eclipse.jface.text.source.projection.ProjectionViewer;
import org.eclipse.jface.text.templates.Template;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.jface.viewers.IPostSelectionProvider;
import org.eclipse.jface.viewers.ISelection;

import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.dnd.Clipboard;
import org.eclipse.swt.events.ShellAdapter;
import org.eclipse.swt.events.ShellEvent;
import org.eclipse.swt.graphics.Image;

import org.eclipse.ui.texteditor.ContentAssistAction;
import org.eclipse.ui.texteditor.IDocumentProvider;
import org.eclipse.ui.texteditor.IEditorStatusLine;
import org.eclipse.ui.texteditor.ITextEditor;
import org.eclipse.ui.texteditor.ITextEditorActionConstants;
import org.eclipse.ui.texteditor.ITextEditorActionDefinitionIds;
import org.eclipse.ui.texteditor.IWorkbenchActionDefinitionIds;
import org.eclipse.ui.texteditor.TextEditorAction;
import org.eclipse.ui.texteditor.TextOperationAction;
import org.eclipse.ui.texteditor.templates.TemplateTransfer;
import org.eclipse.ui.views.contentoutline.ContentOutline;
import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
import org.eclipse.ui.views.templates.ITemplatesPage;

/**
 * The actual editor implementation for Eclipse's Ant integration.
 */
public class AntEditor extends TextEditor implements IReconcilingParticipant, IProjectionListener {

	class ClipboardPasteOperation extends TextEditorAction {
		private ITextOperationTarget fOperationTarget;
		private int fOperationCode = -1;

		protected ClipboardPasteOperation(ResourceBundle bundle, String prefix, ITextEditor editor,
				int style) {
			super(bundle, prefix, editor, style);
		}

		public void run() {
			ITextEditor editor = getTextEditor();
			Clipboard clipboard = new Clipboard(getSite().getShell().getDisplay());
			Template[] templates = (Template[]) clipboard.getContents(TemplateTransfer
					.getInstance());
			if (templates != null) {
				AntTemplatesPage page = (AntTemplatesPage) editor.getAdapter(ITemplatesPage.class);
				page.insertTemplate(templates[0]);
			} else
				fOperationTarget.doOperation(fOperationCode);
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.ui.texteditor.IUpdate#update()
		 */
		public void update() {
			super.update();
		}

	}


	/**
	 * Updates the Ant outline page selection and this editor's range indicator.
	 * 

     * The page that shows the outline.
     */
    protected AntEditorContentOutlinePage fOutlinePage;
	/**
	 * The templates page
	 */
	protected AntTemplatesPage fTemplatesPage;
	
	private boolean fInitialReconcile= true;
	

		action= new RenameInFileAction(this);
		action.setActionDefinitionId("org.eclipse.ant.ui.renameInFile"); //$NON-NLS-1$
		setAction("renameInFile", action); //$NON-NLS-1$
		
		// Override the TextEditor paste operation to support templates
		action = new ClipboardPasteOperation(bundle,
				"Editor.Paste.", this, ITextOperationTarget.PASTE); //$NON-NLS-1$
		action.setActionDefinitionId(IWorkbenchActionDefinitionIds.PASTE);
		setAction(ITextEditorActionConstants.PASTE, action);
    }

	/*

			return getOutlinePage();
        }
        
		if (key.equals(ITemplatesPage.class)) {
			return getTemplatesPage();
		}

        if (fProjectionSupport != null) { 
        	Object adapter= fProjectionSupport.getAdapter(getSourceViewer(), key); 
        	if (adapter != null) {

		return fOutlinePage;
	}

	private AntTemplatesPage getTemplatesPage() {
		if (fTemplatesPage == null) {
			fTemplatesPage = new AntTemplatesPage(this);
		}
		return fTemplatesPage;
	}

	protected void handleCursorPositionChanged() {
		super.handleCursorPositionChanged();
		if (fTemplatesPage != null)
			fTemplatesPage.cursorPositionChanged();
	}

    private void doSelectionChanged(SelectionChangedEvent selectionChangedEvent) {
        IStructuredSelection selection= (IStructuredSelection)selectionChangedEvent.getSelection();





/*******************************************************************************
 * Copyright (c) 2000, 2005  John-Mason P. Shackelford and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 * 	   John-Mason P. Shackelford - initial API and implementation
 *     IBM Corporation - bug fixes
 *******************************************************************************/
package org.eclipse.ant.internal.ui.editor.templates;

import org.eclipse.ant.internal.ui.AntUIPlugin;
import org.eclipse.ant.internal.ui.editor.AntEditor;
import org.eclipse.ant.internal.ui.editor.formatter.FormattingPreferences;
import org.eclipse.ant.internal.ui.editor.formatter.XmlFormatter;
import org.eclipse.ant.internal.ui.editor.text.AntDocumentSetupParticipant;
import org.eclipse.ant.internal.ui.preferences.AntEditorPreferenceConstants;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.ITextSelection;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.Region;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.jface.text.source.SourceViewer;
import org.eclipse.jface.text.source.SourceViewerConfiguration;
import org.eclipse.jface.text.templates.ContextTypeRegistry;
import org.eclipse.jface.text.templates.Template;
import org.eclipse.jface.text.templates.TemplateContextType;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.texteditor.templates.TemplatesPage;

/**
 * An implementation of TemplatesPage for AntEditor
 * 
 * @see TemplatesPage
 */
public class AntTemplatesPage extends TemplatesPage {

	private static final ContextTypeRegistry CONTEXT_TYPE_REGISTRY = AntTemplateAccess
			.getDefault().getContextTypeRegistry();
	private FormattingPreferences fFormattingPreferences = new FormattingPreferences();
	private final AntEditor fEditor;
	private String fCurrentId;

	/**
	 * Constructor
	 * 
	 * @param editor
	 */
	public AntTemplatesPage(AntEditor editor) {
		fEditor = editor;
		setTemplateStore(AntTemplateAccess.getDefault().getTemplateStore(),
				AntUIPlugin.getDefault().getPreferenceStore());
		setContextTypeRegistry(CONTEXT_TYPE_REGISTRY);
		cursorPositionChanged();
		setupEditorDropTarget(fEditor.getSite(), fEditor.getViewer()
				.getTextWidget());
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.texteditor.templates.TemplatePreferencePage#createViewer(org.eclipse.swt.widgets.Composite)
	 */
	protected SourceViewer createViewer(Composite parent) {
		SourceViewer viewer = new SourceViewer(parent, null, SWT.BORDER
				| SWT.V_SCROLL | SWT.H_SCROLL);

		SourceViewerConfiguration configuration = new AntTemplateViewerConfiguration();
		IDocument document = new Document();
		new AntDocumentSetupParticipant().setup(document);
		viewer.configure(configuration);
		viewer.setDocument(document);
		viewer.setEditable(false);
		Font font = JFaceResources.getFont(JFaceResources.TEXT_FONT);
		viewer.getTextWidget().setFont(font);

		return viewer;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.texteditor.templates.TemplatePreferencePage#getFormatterPreferenceKey()
	 */
	protected String getFormatterPreferenceKey() {
		return AntEditorPreferenceConstants.TEMPLATES_USE_CODEFORMATTER;
	}

	/*
	 * @see org.eclipse.ui.texteditor.templates.TemplatePreferencePage#updateViewerInput()
	 */
	protected void updateViewerInput(Template template) {
		SourceViewer viewer = getViewer();

		if (AntUIPlugin.getDefault().getPreferenceStore().getBoolean(
				getFormatterPreferenceKey())) {
			String formatted = XmlFormatter.format(template.getPattern(),
					fFormattingPreferences);
			viewer.getDocument().set(formatted);
		} else {
			viewer.getDocument().set(template.getPattern());
		}
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.part.Page#setFocus()
	 */
	public void setFocus() {
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.texteditor.templates.TemplatesPage#getPreferencePageId()
	 */
	protected String getPreferencePageId() {
		return "org.eclipse.ant.ui.TemplatesPreferencePage"; //$NON-NLS-1$
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.texteditor.templates.TemplatesPage#insertTemplate(org.eclipse.jface.text.templates.Template)
	 */
	public void insertTemplate(Template template) {
		IRegion region;
		TemplateContextType type = CONTEXT_TYPE_REGISTRY
				.getContextType(template.getContextTypeId());
		if (type == null)
			return;
		ISourceViewer contextViewer = fEditor.getViewer();
		ITextSelection textSelection = (ITextSelection) contextViewer
				.getSelectionProvider().getSelection();
		region = new Region(textSelection.getOffset(), textSelection
				.getLength());
		Point selection = contextViewer.getSelectedRange();
		Position position;
		if (selection.y > 0) {
			position = new Position(selection.x, selection.y);
		} else {
			position = new Position(region.getOffset(), region.getLength());
		}

		IDocument document = contextViewer.getDocument();
		AntContext context = new AntContext(type, document, fEditor
				.getAntModel(), position);
		context.setVariable("selection", textSelection.getText()); //$NON-NLS-1$
		AntTemplateProposal proposal = new AntTemplateProposal(template,
				context, region, null, 100);
		PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage()
				.activate(fEditor);
		proposal.apply(fEditor.getViewer(), ' ', 0, region.getOffset());
	}

	/**
	 * Invoked by the editor whenever the caret position is updated
	 */
	public void cursorPositionChanged() {
		String id;
		if (fEditor.getDocumentProvider().getDocument(fEditor.getEditorInput())
				.getLength() == 0)
			id = BuildFileContextType.BUILDFILE_CONTEXT_TYPE;
		else
			id = TargetContextType.TARGET_CONTEXT_TYPE;
		if (id.equals(fCurrentId))
			return;
		fCurrentId = id;
		if (fCurrentId.equals(BuildFileContextType.BUILDFILE_CONTEXT_TYPE))
			contextTypeChanged(new String[] { BuildFileContextType.BUILDFILE_CONTEXT_TYPE });
		else
			contextTypeChanged(new String[] {
					TargetContextType.TARGET_CONTEXT_TYPE,
					TaskContextType.TASK_CONTEXT_TYPE });
	}
}

Lines 11-17 Link Here

(-)META-INF/MANIFEST.MF (-1 / +2 lines)
11	org.eclipse.ui.internal.views.contentoutline;x-internal:=true,	11	org.eclipse.ui.internal.views.contentoutline;x-internal:=true,
12	org.eclipse.ui.internal.views.properties;x-internal:=true,	12	org.eclipse.ui.internal.views.properties;x-internal:=true,
13	org.eclipse.ui.views.contentoutline,	13	org.eclipse.ui.views.contentoutline,
14	org.eclipse.ui.views.properties	14	org.eclipse.ui.views.properties,
		15	org.eclipse.ui.views.templates
15	Require-Bundle: org.eclipse.core.runtime;bundle-version="[3.2.0,4.0.0)",	16	Require-Bundle: org.eclipse.core.runtime;bundle-version="[3.2.0,4.0.0)",
16	org.eclipse.help;bundle-version="[3.2.0,4.0.0)",	17	org.eclipse.help;bundle-version="[3.2.0,4.0.0)",
17	org.eclipse.ui;bundle-version="[3.2.0,4.0.0)"	18	org.eclipse.ui;bundle-version="[3.2.0,4.0.0)"

Lines 13-16 Link Here

(-)plugin.properties (-1 / +1 lines)
13		13
14	Views.PropertySheet = Properties	14	Views.PropertySheet = Properties
15	Views.ContentOutline = Outline	15	Views.ContentOutline = Outline
16		16	Views.Templates = Templates

Lines 18-23 Link Here

(-)plugin.xml (+7 lines)
18	class="org.eclipse.ui.views.contentoutline.ContentOutline"	18	class="org.eclipse.ui.views.contentoutline.ContentOutline"
19	id="org.eclipse.ui.views.ContentOutline">	19	id="org.eclipse.ui.views.ContentOutline">
20	</view>	20	</view>
		21	<view
		22	name="%Views.Templates"
		23	icon="$nl$/icons/full/eview16/templates.gif"
		24	category="org.eclipse.ui"
		25	class="org.eclipse.ui.views.templates.Templates"
		26	id="org.eclipse.ui.views.Templates">
		27	</view>
21	</extension>	28	</extension>
22		29
23	</plugin>	30	</plugin>

Added Link Here

(-)icons/full/eview16/templates.gif (+2 lines)
1	GIF89aæûwyômqåU_ì`gàNY÷øüö÷ûøùüôöû¬òõûöøüûüþúûýùúüøùû¬ìñú2]¬¬«çîùíòúòõúo¹§ÅÑããìùðôúöøûh·h¶ô÷û\´]³äíøéðùòöûñõúP}°P}¯¥Bv«Cw«øúüüýþûüý+k¤+j£,j¤,k¤,j£,k£6p§7q§+k£¢S1^T¦o¢z·Ç´Ò£¥¨¨«ÞÝÔ¹³µ°¿¶¼´²ÿÿÿÿÿÿÿ!ùP,¡PKKLLI11IJ2"¤JM%3
2	%%%MG¶¶HF!ÁÇE$OÍ#A'"N&=),Ï-.0">DCB@?/(:ûù+;2ÀqG6hðà£Æ ,L!i4;




package org.eclipse.ui.internal.views.templates;

import org.eclipse.osgi.util.NLS;

/**
 * TemplatesMessages is the message class for the messages used in the templates view.
 *
 */
public class TemplatesMessages extends NLS {
	private static final String BUNDLE_NAME = "org.eclipse.ui.internal.views.templates.TemplatesMessages"; //$NON-NLS-1$
	
	// Default message for an empty templates view
	public static String Templates_defaultMessage;
	static {
		// initialize resource bundle
		NLS.initializeMessages(BUNDLE_NAME, TemplatesMessages.class);
	}

	private TemplatesMessages() {
	}
}

Added Link Here

(-)src/org/eclipse/ui/internal/views/templates/TemplatesMessages.properties (+1 lines)
1	Templates_defaultMessage=No templates available for this editor




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.ui.views.templates;

import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.internal.views.ViewsPlugin;
import org.eclipse.ui.internal.views.templates.TemplatesMessages;
import org.eclipse.ui.part.IContributedContentsView;
import org.eclipse.ui.part.IPage;
import org.eclipse.ui.part.MessagePage;
import org.eclipse.ui.part.PageBook;
import org.eclipse.ui.part.PageBookView;

/**
 * Main class for the Templates View.
 * <p>
 * This standard view has id <code>"org.eclipse.ui.views.TemplatesView"</code>.
 * </p>
 * When a <b>templates view</b> notices an editor being activated, it 
 * asks the editor whether it has a <b>template page</b> to include
 * in the templates view. This is done using <code>getAdapter</code>:
 * <pre>
 * IEditorPart editor = ...;
 * ITemplatePage templatePage = (ITemplatePage) editor.getAdapter(ITemplatePage.class);
 * if (templatePage != null) {
 *    // editor wishes to contribute templatePage to templates view
 * }
 * </pre>
 * If the editor supports a templates page, the editor instantiates
 * and configures the page, and returns it. This page is then added to the 
 * templates view (a pagebook which presents one page at a time) and 
 * immediately made the current page (the templates view need not be
 * visible). If the editor does not support a template page, the templates
 * view shows a special default page which makes it clear to the user
 * that the templates view is disengaged. When the templates view notices a
 * different editor being activated, it flips to the editor's corresponding
 * template page. When the templates view notices an editor being
 * closed, it may destroy the editor's corresponding content outline page.
 * </p>
 * <p>
 * The workbench will automatically instantiate this class when a templates
 * view is needed for a workbench window. This class was not intended
 * to be instantiated or subclassed by clients.
 * </p>
 */
public class Templates extends PageBookView {
    /**
     * The plugin prefix.
     */
    public static final String PREFIX = PlatformUI.PLUGIN_ID + "."; //$NON-NLS-1$

    /**
     * Help context id used for the content outline view
     * (value <code>"org.eclipse.ui.content_outline_context"</code>).
     */
    public static final String TEMPLATES_VIEW_HELP_CONTEXT_ID = PREFIX
            + "templates_view_context";//$NON-NLS-1$

    /**
     * Message to show on the default page.
     */
    private String defaultText = TemplatesMessages.Templates_defaultMessage; 

    /**
     * Creates a content outline view with no content outline pages.
     */
    public Templates() {
        super();
    }

    /* (non-Javadoc)
     * Method declared on PageBookView.
     */
    protected IPage createDefaultPage(PageBook book) {
        MessagePage page = new MessagePage();
        initPage(page);
        page.createControl(book);
        page.setMessage(defaultText);
        return page;
    }

    /**
     * The <code>PageBookView</code> implementation of this <code>IWorkbenchPart</code>
     * method creates a <code>PageBook</code> control with its default page showing.
     */
    public void createPartControl(Composite parent) {
        super.createPartControl(parent);
        PlatformUI.getWorkbench().getHelpSystem().setHelp(getPageBook(),
                TEMPLATES_VIEW_HELP_CONTEXT_ID);
    }

    /* (non-Javadoc)
     * Method declared on PageBookView.
     */
    protected PageRec doCreatePage(IWorkbenchPart part) {
        // Try to get template page.
        Object obj = ViewsPlugin.getAdapter(part, ITemplatesPage.class, false);
        if (obj instanceof ITemplatesPage) {
            ITemplatesPage page = (ITemplatesPage) obj;
			initPage(page);
            page.createControl(getPageBook());
            return new PageRec(part, page);
        }
        // There is no template page
        return null;
    }

    /* (non-Javadoc)
     * Method declared on PageBookView.
     */
    protected void doDestroyPage(IWorkbenchPart part, PageRec rec) {
        ITemplatesPage page = (ITemplatesPage) rec.page;
        page.dispose();
        rec.dispose();
    }

    /* (non-Javadoc)
     * Method declared on IAdaptable.
     */
    public Object getAdapter(Class key) {
        if (key == IContributedContentsView.class) {
			return new IContributedContentsView() {
                public IWorkbenchPart getContributingPart() {
                    return getContributingEditor();
                }
            };
		}
        return super.getAdapter(key);
    }

    /* (non-Javadoc)
     * Method declared on PageBookView.
     */
    protected IWorkbenchPart getBootstrapPart() {
        IWorkbenchPage page = getSite().getPage();
        if (page != null) {
			return page.getActiveEditor();
		}

        return null;
    }

    /**
     * Returns the editor which contributed the current 
     * page to this view.
     *
     * @return the editor which contributed the current page
     * or <code>null</code> if no editor contributed the current page
     */
    private IWorkbenchPart getContributingEditor() {
        return getCurrentContributingPart();
    }

    /* (non-Javadoc)
     * Method declared on PageBookView.
     * We only want to track editors.
     */
    protected boolean isImportant(IWorkbenchPart part) {
        //We only care about editors
        return (part instanceof IEditorPart);
    }

    /* (non-Javadoc)
     * Method declared on IViewPart.
     * Treat this the same as part activation.
     */
    public void partBroughtToTop(IWorkbenchPart part) {
        partActivated(part);
    }
}




package org.eclipse.ui.views.templates;

import org.eclipse.ui.part.IPageBookViewPage;

/**
 * Interface for a template page. This interface defines
 * the minimum requirement for pages within the templates view, namely
 * they must be pages (implement <code>IPageBookViewPage</code>).
 *
 * @see TemplatesView
 */
public interface ITemplatesPage extends IPageBookViewPage {
}

Lines 25-31 Link Here

(-)META-INF/MANIFEST.MF (-1 / +2 lines)
25	org.eclipse.core.expressions;bundle-version="[3.2.0,4.0.0)",	25	org.eclipse.core.expressions;bundle-version="[3.2.0,4.0.0)",
26	org.eclipse.jface.text;bundle-version="[3.4.0,4.0.0)",	26	org.eclipse.jface.text;bundle-version="[3.4.0,4.0.0)",
27	org.eclipse.core.filesystem;bundle-version="[1.1.0,2.0.0)",	27	org.eclipse.core.filesystem;bundle-version="[1.1.0,2.0.0)",
28	org.eclipse.ui;bundle-version="[3.3.0,4.0.0)"	28	org.eclipse.ui;bundle-version="[3.3.0,4.0.0)",
		29	org.eclipse.ui.views
29	Eclipse-LazyStart: true	30	Eclipse-LazyStart: true
30	Bundle-RequiredExecutionEnvironment: J2SE-1.4	31	Bundle-RequiredExecutionEnvironment: J2SE-1.4
31	Import-Package: com.ibm.icu.text	32	Import-Package: com.ibm.icu.text




final class TextEditorTemplateMessages extends NLS {

	private static final String BUNDLE_NAME= TextEditorTemplateMessages.class.getName();

	private TextEditorTemplateMessages() {
		// Do not instantiate
	}

	// TemplatesView
	public static String TemplatesPage_collapse_expand;
	public static String TemplatesPage_column_context;
	public static String TemplatesPage_column_description;
	public static String TemplatesPage_column_name;
	public static String TemplatesPage_insert;
	public static String TemplatesPage_edit;
	public static String TemplatesPage_paste_description;
	public static String TemplatesPage_preference_page;
	public static String TemplatesPage_link_to_editor;
	public static String TemplatesPage_new;
	public static String TemplatesPage_preview;
	public static String TemplatesPage_question_create_new_message;
	public static String TemplatesPage_question_create_new_title;
	public static String TemplatesPage_remove;
	public static String TemplatesPage_save_error_message;
	public static String TemplatesPage_snippet;
	public static String TemplatesPage_show_disabled;
	public static String TemplatesPage_show_new_dialog;
	public static String TemplatesPage_context_description;
	public static String TemplatesPage_remove_message;
	public static String TemplatesPage_remove_title;

	// TemplatePreferencePage
	public static String TemplatePreferencePage_error_import;
	public static String TemplatePreferencePage_error_export;
	public static String TemplatePreferencePage_error_read_title;




#     IBM Corporation - initial API and implementation
###############################################################################

# templates page (view)
TemplatesPage_collapse_expand=Collapse or Expand
TemplatesPage_column_context=Context
TemplatesPage_column_description=Description
TemplatesPage_save_error_message=Error Saving the Templates
TemplatesPage_column_name=Name
TemplatesPage_edit=&Edit...
TemplatesPage_insert=&Insert...
TemplatesPage_preference_page=&Preference Page...
TemplatesPage_paste_description=Pasted from editor
TemplatesPage_link_to_editor=Link to Editor
TemplatesPage_new=&New...
TemplatesPage_preview=Previe&w:
TemplatesPage_snippet=snippet
TemplatesPage_question_create_new_message= The name of the template has been changed. Click 'Yes' to create an additional template with the new name or 'No' to rename the existing one.
TemplatesPage_context_description=Context
TemplatesPage_remove_title=Removing Templates
TemplatesPage_remove_message=Are you sure you want to remove the selected templates?
TemplatesPage_question_create_new_title= Edit Template
TemplatesPage_remove=&Remove
TemplatesPage_show_disabled=&Show Disabled
TemplatesPage_show_new_dialog=S&how New Dialog on Drop

# preference page
TemplatePreferencePage_error_import=Failed to import templates.
TemplatePreferencePage_error_export=Failed to export templates.




import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.custom.VerifyKeyListener;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.events.FocusListener;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.events.VerifyEvent;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.FileDialog;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.Widget;

import org.eclipse.core.filesystem.EFS;
import org.eclipse.core.filesystem.IFileInfo;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.Path;

import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.GroupMarker;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.IMenuListener;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.Separator;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.dialogs.StatusDialog;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.preference.PreferencePage;
import org.eclipse.jface.resource.JFaceResources;


import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextListener;
import org.eclipse.jface.text.ITextOperationTarget;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.TextEvent;
import org.eclipse.jface.text.contentassist.ContentAssistant;
import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
import org.eclipse.jface.text.contentassist.IContentAssistant;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.jface.text.source.SourceViewer;
import org.eclipse.jface.text.source.SourceViewerConfiguration;
import org.eclipse.jface.text.templates.ContextTypeRegistry;
import org.eclipse.jface.text.templates.Template;
import org.eclipse.jface.text.templates.TemplateContextType;
import org.eclipse.jface.text.templates.TemplateException;
import org.eclipse.jface.text.templates.persistence.TemplatePersistenceData;
import org.eclipse.jface.text.templates.persistence.TemplateReaderWriter;
import org.eclipse.jface.text.templates.persistence.TemplateStore;

import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
import org.eclipse.ui.internal.texteditor.NLSUtility;
import org.eclipse.ui.internal.texteditor.TextEditorPlugin;
import org.eclipse.ui.texteditor.ITextEditorActionConstants;
import org.eclipse.ui.texteditor.IUpdate;

/**
 * A template preference page allows configuration of the templates for an


	
	/**
	 * Dialog to edit a template. Clients will usually instantiate, but
	 * may also extend.
	 *
	 * @since 3.3
	 */
	protected static class EditTemplateDialog extends StatusDialog {

		private class TextViewerAction extends Action implements IUpdate {

			private int fOperationCode= -1;
			private ITextOperationTarget fOperationTarget;

			/**
			 * Creates a new action.
			 *
			 * @param viewer the viewer
			 * @param operationCode the opcode
			 */
			public TextViewerAction(ITextViewer viewer, int operationCode) {
				fOperationCode= operationCode;
				fOperationTarget= viewer.getTextOperationTarget();
				update();
			}

			/**
			 * Updates the enabled state of the action.
			 * Fires a property change if the enabled state changes.
			 *
			 * @see Action#firePropertyChange(String, Object, Object)
			 */
			public void update() {

				boolean wasEnabled= isEnabled();
				boolean isEnabled= (fOperationTarget != null && fOperationTarget.canDoOperation(fOperationCode));
				setEnabled(isEnabled);

				if (wasEnabled != isEnabled) {
					firePropertyChange(ENABLED, wasEnabled ? Boolean.TRUE : Boolean.FALSE, isEnabled ? Boolean.TRUE : Boolean.FALSE);
				}
			}

			/**
			 * @see Action#run()
			 */
			public void run() {
				if (fOperationCode != -1 && fOperationTarget != null) {
					fOperationTarget.doOperation(fOperationCode);
				}
			}
		}

		private final Template fOriginalTemplate;

		private Text fNameText;
		private Text fDescriptionText;
		private Combo fContextCombo;
		private SourceViewer fPatternEditor;
		private Button fInsertVariableButton;
		private Button fAutoInsertCheckbox;
		private boolean fIsNameModifiable;

		private StatusInfo fValidationStatus;
		private boolean fSuppressError= true; // #4354
		private Map fGlobalActions= new HashMap(10);
		private List fSelectionActions = new ArrayList(3);
		private String[][] fContextTypes;

		private ContextTypeRegistry fContextTypeRegistry;

		private final TemplateVariableProcessor fTemplateProcessor= new TemplateVariableProcessor();

		private Template fNewTemplate;

		/**
		 * Creates a new dialog.
		 *
		 * @param parent the shell parent of the dialog
		 * @param template the template to edit
		 * @param edit whether this is a new template or an existing being edited
		 * @param isNameModifiable whether the name of the template may be modified
		 * @param registry the context type registry to use
		 */
		public EditTemplateDialog(Shell parent, Template template, boolean edit, boolean isNameModifiable, ContextTypeRegistry registry) {
			super(parent);

			setShellStyle(getShellStyle() | SWT.MAX | SWT.RESIZE);

			String title= edit
				? TextEditorTemplateMessages.EditTemplateDialog_title_edit
				: TextEditorTemplateMessages.EditTemplateDialog_title_new;
			setTitle(title);

			fOriginalTemplate= template;
			fIsNameModifiable= isNameModifiable;

			List contexts= new ArrayList();
			for (Iterator it= registry.contextTypes(); it.hasNext();) {
				TemplateContextType type= (TemplateContextType) it.next();
				contexts.add(new String[] { type.getId(), type.getName() });
			}
			fContextTypes= (String[][]) contexts.toArray(new String[contexts.size()][]);

			fValidationStatus= new StatusInfo();

			fContextTypeRegistry= registry;

			TemplateContextType type= fContextTypeRegistry.getContextType(template.getContextTypeId());
			fTemplateProcessor.setContextType(type);
		}

		/*
		 * @see org.eclipse.ui.texteditor.templates.StatusDialog#create()
		 */
		public void create() {
			super.create();
			// update initial OK button to be disabled for new templates
			boolean valid= fNameText == null || fNameText.getText().trim().length() != 0;
			if (!valid) {
				StatusInfo status = new StatusInfo();
				status.setError(TextEditorTemplateMessages.EditTemplateDialog_error_noname);
				updateButtonsEnableState(status);
	 		}
		}

		/*
		 * @see Dialog#createDialogArea(Composite)
		 */
		protected Control createDialogArea(Composite ancestor) {
			Composite parent= new Composite(ancestor, SWT.NONE);
			GridLayout layout= new GridLayout();
			layout.numColumns= 2;
			parent.setLayout(layout);
			parent.setLayoutData(new GridData(GridData.FILL_BOTH));

			ModifyListener listener= new ModifyListener() {
				public void modifyText(ModifyEvent e) {
					doTextWidgetChanged(e.widget);
				}
			};

			if (fIsNameModifiable) {
				createLabel(parent, TextEditorTemplateMessages.EditTemplateDialog_name);

				Composite composite= new Composite(parent, SWT.NONE);
				composite.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
				layout= new GridLayout();
				layout.numColumns= 4;
				layout.marginWidth= 0;
				layout.marginHeight= 0;
				composite.setLayout(layout);

				fNameText= createText(composite);
				fNameText.addModifyListener(listener);
				fNameText.addFocusListener(new FocusListener() {

					public void focusGained(FocusEvent e) {
					}

					public void focusLost(FocusEvent e) {
						if (fSuppressError) {
							fSuppressError= false;
							updateButtons();
						}
					}
				});

				createLabel(composite, TextEditorTemplateMessages.EditTemplateDialog_context);
				fContextCombo= new Combo(composite, SWT.READ_ONLY);

				for (int i= 0; i < fContextTypes.length; i++) {
					fContextCombo.add(fContextTypes[i][1]);
				}

				fContextCombo.addModifyListener(listener);
				
				fAutoInsertCheckbox= createCheckbox(composite, TextEditorTemplateMessages.EditTemplateDialog_autoinsert);
				fAutoInsertCheckbox.setSelection(fOriginalTemplate.isAutoInsertable());
			}

			createLabel(parent, TextEditorTemplateMessages.EditTemplateDialog_description);

			int descFlags= fIsNameModifiable ? SWT.BORDER : SWT.BORDER | SWT.READ_ONLY;
			fDescriptionText= new Text(parent, descFlags );
			fDescriptionText.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

			fDescriptionText.addModifyListener(listener);

			Label patternLabel= createLabel(parent, TextEditorTemplateMessages.EditTemplateDialog_pattern);
			patternLabel.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_BEGINNING));
			fPatternEditor= createEditor(parent, fOriginalTemplate.getPattern());

			Label filler= new Label(parent, SWT.NONE);
			filler.setLayoutData(new GridData());

			Composite composite= new Composite(parent, SWT.NONE);
			layout= new GridLayout();
			layout.marginWidth= 0;
			layout.marginHeight= 0;
			composite.setLayout(layout);
			composite.setLayoutData(new GridData());

			fInsertVariableButton= new Button(composite, SWT.NONE);
			fInsertVariableButton.setLayoutData(getButtonGridData(fInsertVariableButton));
			fInsertVariableButton.setText(TextEditorTemplateMessages.EditTemplateDialog_insert_variable);
			fInsertVariableButton.addSelectionListener(new SelectionListener() {
				public void widgetSelected(SelectionEvent e) {
					fPatternEditor.getTextWidget().setFocus();
					fPatternEditor.doOperation(ISourceViewer.CONTENTASSIST_PROPOSALS);
				}

				public void widgetDefaultSelected(SelectionEvent e) {}
			});

			fDescriptionText.setText(fOriginalTemplate.getDescription());
			if (fIsNameModifiable) {
				fNameText.setText(fOriginalTemplate.getName());
				fNameText.addModifyListener(listener);
				fContextCombo.select(getIndex(fOriginalTemplate.getContextTypeId()));
			} else {
				fPatternEditor.getControl().setFocus();
			}
			initializeActions();

			applyDialogFont(parent);
			return composite;
		}

		private void doTextWidgetChanged(Widget w) {
			if (w == fNameText) {
				fSuppressError= false;
				updateButtons();
			} else if (w == fContextCombo) {
				String contextId= getContextId();
				fTemplateProcessor.setContextType(fContextTypeRegistry.getContextType(contextId));
			} else if (w == fDescriptionText) {
				// oh, nothing
			}
		}

		private String getContextId() {
			if (fContextCombo != null && !fContextCombo.isDisposed()) {
				String name= fContextCombo.getText();
				for (int i= 0; i < fContextTypes.length; i++) {
					if (name.equals(fContextTypes[i][1])) {
						return fContextTypes[i][0];
					}
				}
			}

			return fOriginalTemplate.getContextTypeId();
		}

		private void doSourceChanged(IDocument document) {
			String text= document.get();
			fValidationStatus.setOK();
			TemplateContextType contextType= fContextTypeRegistry.getContextType(getContextId());
			if (contextType != null) {
				try {
					contextType.validate(text);
				} catch (TemplateException e) {
					fValidationStatus.setError(e.getLocalizedMessage());
				}
			}

			updateUndoAction();
			updateButtons();
		}

		private static GridData getButtonGridData(Button button) {
			GridData data= new GridData(GridData.FILL_HORIZONTAL);
			// TODO get some button hints.
//			data.heightHint= SWTUtil.getButtonHeightHint(button);

			return data;
		}

		private static Label createLabel(Composite parent, String name) {
			Label label= new Label(parent, SWT.NULL);
			label.setText(name);
			label.setLayoutData(new GridData());

			return label;
		}

		private static Text createText(Composite parent) {
			Text text= new Text(parent, SWT.BORDER);
			text.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

			return text;
		}

		private static Button createCheckbox(Composite parent, String name) {
			Button button= new Button(parent, SWT.CHECK);
			button.setText(name);
			button.setLayoutData(new GridData());
			
			return button;
		}
		
		private SourceViewer createEditor(Composite parent, String pattern) {
			SourceViewer viewer= createViewer(parent);
			viewer.setEditable(true);
			
			IDocument document= viewer.getDocument();
			if (document != null)
				document.set(pattern);
			else {
				document= new Document(pattern);
				viewer.setDocument(document);
			}

			int nLines= document.getNumberOfLines();
			if (nLines < 5) {
				nLines= 5;
			} else if (nLines > 12) {
				nLines= 12;
			}

			Control control= viewer.getControl();
			GridData data= new GridData(GridData.FILL_BOTH);
			data.widthHint= convertWidthInCharsToPixels(80);
			data.heightHint= convertHeightInCharsToPixels(nLines);
			control.setLayoutData(data);

			viewer.addTextListener(new ITextListener() {
				public void textChanged(TextEvent event) {
					if (event .getDocumentEvent() != null)
						doSourceChanged(event.getDocumentEvent().getDocument());
				}
			});

			viewer.addSelectionChangedListener(new ISelectionChangedListener() {
				public void selectionChanged(SelectionChangedEvent event) {
					updateSelectionDependentActions();
				}
			});

		 	viewer.prependVerifyKeyListener(new VerifyKeyListener() {
				public void verifyKey(VerifyEvent event) {
					handleVerifyKeyPressed(event);
				}
			});

			return viewer;
		}

		/**
		 * Creates the viewer to be used to display the pattern. Subclasses may override.
		 *
		 * @param parent the parent composite of the viewer
		 * @return a configured <code>SourceViewer</code>
		 */
		protected SourceViewer createViewer(Composite parent) {
			SourceViewer viewer= new SourceViewer(parent, null, null, false, SWT.BORDER | SWT.V_SCROLL | SWT.H_SCROLL);
			SourceViewerConfiguration configuration= new SourceViewerConfiguration() {
				public IContentAssistant getContentAssistant(ISourceViewer sourceViewer) {

					ContentAssistant assistant= new ContentAssistant();
					assistant.enableAutoActivation(true);
					assistant.enableAutoInsert(true);
					assistant.setContentAssistProcessor(fTemplateProcessor, IDocument.DEFAULT_CONTENT_TYPE);
					return assistant;
				}
			};
			viewer.configure(configuration);
			return viewer;
		}

		private void handleVerifyKeyPressed(VerifyEvent event) {
			if (!event.doit)
				return;

			if (event.stateMask != SWT.MOD1)
				return;

			switch (event.character) {
				case ' ':
					fPatternEditor.doOperation(ISourceViewer.CONTENTASSIST_PROPOSALS);
					event.doit= false;
					break;

				// CTRL-Z
				case 'z' - 'a' + 1:
					fPatternEditor.doOperation(ITextOperationTarget.UNDO);
					event.doit= false;
					break;
			}
		}

		private void initializeActions() {
			TextViewerAction action= new TextViewerAction(fPatternEditor, ITextOperationTarget.UNDO);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_undo);
			fGlobalActions.put(ITextEditorActionConstants.UNDO, action);

			action= new TextViewerAction(fPatternEditor, ITextOperationTarget.CUT);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_cut);
			fGlobalActions.put(ITextEditorActionConstants.CUT, action);

			action= new TextViewerAction(fPatternEditor, ITextOperationTarget.COPY);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_copy);
			fGlobalActions.put(ITextEditorActionConstants.COPY, action);

			action= new TextViewerAction(fPatternEditor, ITextOperationTarget.PASTE);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_paste);
			fGlobalActions.put(ITextEditorActionConstants.PASTE, action);

			action= new TextViewerAction(fPatternEditor, ITextOperationTarget.SELECT_ALL);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_select_all);
			fGlobalActions.put(ITextEditorActionConstants.SELECT_ALL, action);

			action= new TextViewerAction(fPatternEditor, ISourceViewer.CONTENTASSIST_PROPOSALS);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_content_assist);
			fGlobalActions.put("ContentAssistProposal", action); //$NON-NLS-1$

			fSelectionActions.add(ITextEditorActionConstants.CUT);
			fSelectionActions.add(ITextEditorActionConstants.COPY);
			fSelectionActions.add(ITextEditorActionConstants.PASTE);

			// create context menu
			MenuManager manager= new MenuManager(null, null);
			manager.setRemoveAllWhenShown(true);
			manager.addMenuListener(new IMenuListener() {
				public void menuAboutToShow(IMenuManager mgr) {
					fillContextMenu(mgr);
				}
			});

			StyledText text= fPatternEditor.getTextWidget();
			Menu menu= manager.createContextMenu(text);
			text.setMenu(menu);
		}

		private void fillContextMenu(IMenuManager menu) {
			menu.add(new GroupMarker(ITextEditorActionConstants.GROUP_UNDO));
			menu.appendToGroup(ITextEditorActionConstants.GROUP_UNDO, (IAction) fGlobalActions.get(ITextEditorActionConstants.UNDO));

			menu.add(new Separator(ITextEditorActionConstants.GROUP_EDIT));
			menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.CUT));
			menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.COPY));
			menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.PASTE));
			menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.SELECT_ALL));

			menu.add(new Separator("templates")); //$NON-NLS-1$
			menu.appendToGroup("templates", (IAction) fGlobalActions.get("ContentAssistProposal")); //$NON-NLS-1$ //$NON-NLS-2$
		}

		private void updateSelectionDependentActions() {
			Iterator iterator= fSelectionActions.iterator();
			while (iterator.hasNext())
				updateAction((String)iterator.next());
		}

		private void updateUndoAction() {
			IAction action= (IAction) fGlobalActions.get(ITextEditorActionConstants.UNDO);
			if (action instanceof IUpdate)
				((IUpdate) action).update();
		}

		private void updateAction(String actionId) {
			IAction action= (IAction) fGlobalActions.get(actionId);
			if (action instanceof IUpdate)
				((IUpdate) action).update();
		}

		private int getIndex(String contextid) {

			if (contextid == null)
				return -1;

			for (int i= 0; i < fContextTypes.length; i++) {
				if (contextid.equals(fContextTypes[i][0])) {
					return i;
				}
			}
			return -1;
		}

		private void updateButtons() {
			StatusInfo status;

			boolean valid= fNameText == null || fNameText.getText().trim().length() != 0;
			if (!valid) {
				status = new StatusInfo();
				if (!fSuppressError) {
					status.setError(TextEditorTemplateMessages.EditTemplateDialog_error_noname);
				}
	 		} else {
	 			status= fValidationStatus;
	 		}
			updateStatus(status);
		}

		/*
		 * @since 3.1
		 */
		protected void okPressed() {
			String name= fNameText == null ? fOriginalTemplate.getName() : fNameText.getText();
			boolean isAutoInsertable= fAutoInsertCheckbox != null && fAutoInsertCheckbox.getSelection();
			fNewTemplate= new Template(name, fDescriptionText.getText(), getContextId(), fPatternEditor.getDocument().get(), isAutoInsertable);
			super.okPressed();
		}

		/**
		 * Returns the created template.
		 *
		 * @return the created template
		 * @since 3.1
		 */
		public Template getTemplate() {
			return fNewTemplate;
		}
		
		/**
		 * Returns the content assist processor that
		 * suggests template variables.
		 * 
		 * @return the processor to suggest variables
		 * @since 3.3
		 */
		protected IContentAssistProcessor getTemplateProcessor() {
			return fTemplateProcessor;
		}

		/*
		 * @see org.eclipse.jface.dialogs.Dialog#getDialogBoundsSettings()
		 * @since 3.2
		 */
		protected IDialogSettings getDialogBoundsSettings() {
			String sectionName= getClass().getName() + "_dialogBounds"; //$NON-NLS-1$
			IDialogSettings settings= TextEditorPlugin.getDefault().getDialogSettings();
			IDialogSettings section= settings.getSection(sectionName);
			if (section == null)
				section= settings.addNewSection(sectionName);
			return section;
		}

	}
	
	
	/**
	 * Label provider for templates.
	 */
	private class TemplateLabelProvider extends LabelProvider implements ITableLabelProvider {




/*******************************************************************************
 * Copyright (c) 2000, 2007 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.texteditor.templates;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;

import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.IMenuListener;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.Separator;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.layout.TreeColumnLayout;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.source.SourceViewer;
import org.eclipse.jface.text.source.SourceViewerConfiguration;
import org.eclipse.jface.text.templates.ContextTypeRegistry;
import org.eclipse.jface.text.templates.Template;
import org.eclipse.jface.text.templates.TemplateContextType;
import org.eclipse.jface.text.templates.persistence.TemplatePersistenceData;
import org.eclipse.jface.text.templates.persistence.TemplateStore;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.jface.viewers.ColumnWeightData;
import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.IDoubleClickListener;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.ITableLabelProvider;
import org.eclipse.jface.viewers.ITreeContentProvider;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerComparator;
import org.eclipse.jface.window.Window;
import org.eclipse.swt.SWT;
import org.eclipse.swt.dnd.Clipboard;
import org.eclipse.swt.dnd.DND;
import org.eclipse.swt.dnd.DragSourceAdapter;
import org.eclipse.swt.dnd.DragSourceEvent;
import org.eclipse.swt.dnd.DropTargetAdapter;
import org.eclipse.swt.dnd.DropTargetEvent;
import org.eclipse.swt.dnd.TextTransfer;
import org.eclipse.swt.dnd.Transfer;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.FontMetrics;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeColumn;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.IWorkbenchActionConstants;
import org.eclipse.ui.IWorkbenchPartSite;
import org.eclipse.ui.actions.ActionFactory;
import org.eclipse.ui.dialogs.PreferencesUtil;
import org.eclipse.ui.dnd.IDragAndDropService;
import org.eclipse.ui.internal.texteditor.TextEditorPlugin;
import org.eclipse.ui.part.Page;
import org.eclipse.ui.views.templates.ITemplatesPage;

/**
 * An abstract base class for template pages for use with TextEditor.
 * <p>
 * Clients who are defining an editor may elect to provide a corresponding
 * templates page. This templates page will be presented to the user via the
 * Templates View (the user decides whether their workbench window contains this
 * view) whenever that editor is active. This class should be subclassed.
 * </p>
 * <p>
 * Internally, a TemplatesPage uses the template store to display different
 * categories. A link to editor mode on the templates page allows to filtering
 * of the categories to only that are supported in this context.
 * </p>
 * Since: 3.4
 */
public abstract class TemplatesPage extends Page implements ITemplatesPage {

	/**
	 * Link to editor action setting
	 */
	private static final String LINK_ACTION_PREF_ID = TextEditorPlugin.PLUGIN_ID
			+ ".templates.templatesPage.linkAction"; //$NON-NLS-1$
	/**
	 * Show disabled actions setting
	 */
	private static final String SHOW_DISABLED_ACTION_PREF_ID = TextEditorPlugin.PLUGIN_ID
			+ ".templates.templatesPage.showDisabledAction"; //$NON-NLS-1$
	/**
	 * Show new dialog on drop setting
	 */
	private static final String SHOW_NEW_DIALOG_ACTION_PREF_ID = TextEditorPlugin.PLUGIN_ID
			+ ".templates.templatesPage.showNewDialogAction"; //$NON-NLS-1$;

	/**
	 * The ID for the popup menu for this templates page
	 */
	private static final String POPUP_MENU_ID = "org.eclipse.ui.texteditor.templates.PopupMenu"; //$NON-NLS-1$

	/**
	 * Drop support for the editor linked to this page. When a user drops a
	 * template into the active editor, the template is applied at the drop
	 * position.
	 */
	private final class EditorDropTarget extends DropTargetAdapter {
		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.swt.dnd.DropTargetAdapter#dragEnter(org.eclipse.swt.dnd.DropTargetEvent)
		 */
		public void dragEnter(DropTargetEvent event) {
			super.dragEnter(event);
			if (event.detail == DND.DROP_DEFAULT)
				event.detail = DND.DROP_COPY;
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.swt.dnd.DropTargetAdapter#dragOperationChanged(org.eclipse.swt.dnd.DropTargetEvent)
		 */
		public void dragOperationChanged(DropTargetEvent event) {
			if (event.detail == DND.DROP_DEFAULT)
				event.detail = DND.DROP_COPY;
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.swt.dnd.DropTargetAdapter#dragOver(org.eclipse.swt.dnd.DropTargetEvent)
		 */
		public void dragOver(DropTargetEvent event) {
			event.feedback |= DND.FEEDBACK_SCROLL;
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.swt.dnd.DropTargetAdapter#drop(org.eclipse.swt.dnd.DropTargetEvent)
		 */
		public void drop(DropTargetEvent event) {
			insertTemplate(getSelectedTemplate());
		}
	}

	/**
	 * Comparator for the viewer. Sorts the templates by name and then
	 * description and context types by names.
	 */
	private static final class TemplateViewerComparator extends ViewerComparator {
		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.jface.viewers.ViewerComparator#compare(org.eclipse.jface.viewers.Viewer,
		 *      java.lang.Object, java.lang.Object)
		 */
		public int compare(Viewer viewer, Object object1, Object object2) {
			if ((object1 instanceof TemplatePersistenceData)
					&& (object2 instanceof TemplatePersistenceData)) {
				Template left = ((TemplatePersistenceData) object1).getTemplate();
				Template right = ((TemplatePersistenceData) object2).getTemplate();
				int result = left.getName().compareToIgnoreCase(right.getName());
				if (result != 0)
					return result;
				return left.getDescription().compareToIgnoreCase(right.getDescription());
			}
			if ((object1 instanceof TemplateContextType)
					&& (object2 instanceof TemplateContextType)) {
				return ((TemplateContextType) object1).getName().compareToIgnoreCase(
						((TemplateContextType) object1).getName());
			}
			return super.compare(viewer, object1, object2);
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.jface.viewers.ViewerComparator#isSorterProperty(java.lang.Object,
		 *      java.lang.String)
		 */
		public boolean isSorterProperty(Object element, String property) {
			return true;
		}
	}

	/**
	 * Label provider for templates.
	 */
	private class TemplateLabelProvider extends LabelProvider implements ITableLabelProvider {

		/*
		 * @see org.eclipse.jface.viewers.ITableLabelProvider#getColumnImage(java.lang.Object,
		 *      int)
		 */
		public Image getColumnImage(Object element, int columnIndex) {
			return null;
		}

		/*
		 * @see org.eclipse.jface.viewers.ITableLabelProvider#getColumnText(java.lang.Object,
		 *      int)
		 */
		public String getColumnText(Object element, int columnIndex) {
			if (element instanceof TemplatePersistenceData)
				return getTemplateColumnText(((TemplatePersistenceData) element).getTemplate(),
						columnIndex);
			return getContextColumnText((TemplateContextType) element, columnIndex);
		}

		/**
		 * Return the column text for a template
		 * 
		 * @param template
		 * @param columnIndex
		 * @return the column text
		 */
		private String getTemplateColumnText(Template template, int columnIndex) {
			switch (columnIndex) {
			case 0:
				return template.getName();
			case 1:
				return template.getDescription();
			default:
				return ""; //$NON-NLS-1$
			}
		}

		/**
		 * Return the column text for a context
		 * 
		 * @param contextType
		 * @param columnIndex
		 * @return the column text
		 */
		private String getContextColumnText(TemplateContextType contextType, int columnIndex) {
			switch (columnIndex) {
			case 0:
				return contextType.getName();
			case 1:
				return TextEditorTemplateMessages.TemplatesPage_context_description;
			default:
				return ""; //$NON-NLS-1$
			}
		}

	}

	/**
	 * Content provider for templates. Provides all the templates defined for
	 * this editor and optionally the disabled ones.
	 */
	private class TemplatesContentProvider implements ITreeContentProvider {
		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.jface.viewers.ITreeContentProvider#getChildren(java.lang.Object)
		 */
		public Object[] getChildren(Object parentElement) {
			if (parentElement instanceof TemplatePersistenceData)
				return new Object[0];
			else if (parentElement instanceof TemplateContextType) {
				TemplateContextType contextType = (TemplateContextType) parentElement;
				return getTemplates(contextType.getId());
			}
			return null;
		}

		/**
		 * Get the templates for a given contextId. if ShowDisabled is selected
		 * the disabled templates are also included.
		 * 
		 * @param contextId
		 * @return the templates
		 */
		private TemplatePersistenceData[] getTemplates(String contextId) {
			List templateList = new ArrayList();
			TemplatePersistenceData[] datas = fTemplateStore.getTemplateData(false);
			boolean showDisabled = fShowDisabledAction.isChecked();
			for (int i = 0; i < datas.length; i++) {
				if ((showDisabled || datas[i].isEnabled())
						&& datas[i].getTemplate().getContextTypeId().equals(contextId))
					templateList.add(datas[i]);
			}
			return (TemplatePersistenceData[]) templateList
					.toArray(new TemplatePersistenceData[templateList.size()]);
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.jface.viewers.ITreeContentProvider#getParent(java.lang.Object)
		 */
		public Object getParent(Object element) {
			if (element instanceof TemplatePersistenceData) {
				TemplatePersistenceData templateData = (TemplatePersistenceData) element;
				return fContextTypeRegistry.getContextType(templateData.getTemplate()
						.getContextTypeId());
			}
			return null;
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.jface.viewers.ITreeContentProvider#hasChildren(java.lang.Object)
		 */
		public boolean hasChildren(Object element) {
			if (element instanceof TemplateContextType)
				return true;
			return false;
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.jface.viewers.IStructuredContentProvider#getElements(java.lang.Object)
		 */
		public Object[] getElements(Object inputElement) {
			List contextTypes = new ArrayList();

			for (Iterator iterator = fContextTypeRegistry.contextTypes(); iterator.hasNext();) {
				TemplateContextType contextType = (TemplateContextType) iterator.next();
				if (isActiveContext(contextType) || !fLinkAction.isChecked())
					contextTypes.add(contextType);
			}
			return contextTypes.toArray(new TemplateContextType[contextTypes.size()]);
		}

		/**
		 * Checks whether given context type is active for displaying the
		 * templates
		 * 
		 * @param contextType
		 * @return true if context is active
		 */
		private boolean isActiveContext(TemplateContextType contextType) {
			return fActiveTypes == null || fActiveTypes.contains(contextType.getId());
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.jface.viewers.IContentProvider#dispose()
		 */
		public void dispose() {
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.jface.viewers.IContentProvider#inputChanged(org.eclipse.jface.viewers.Viewer,
		 *      java.lang.Object, java.lang.Object)
		 */
		public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {
		}
	}

	/**
	 * Show/Hide new dialog
	 */
	private static final int SHOW_DIALOG = 0;
	private static final int HIDE_DIALOG = 1;

	/** The viewer displays the pattern of selected template. */
	private SourceViewer fPatternViewer;
	/** The store for our templates. */
	private TemplateStore fTemplateStore;
	/** The context type registry. */
	private ContextTypeRegistry fContextTypeRegistry;

	/** The control for this page book view */
	private Composite fControl;

	/* Actions */
	private Action fInsertAction;
	private Action fAddAction;
	private Action fEditAction;
	private Action fRemoveAction;
	private Action fLinkAction;
	private Action fExpandCollapseAction;
	private Action fPreferencePageAction;
	private Action fShowDisabledAction;
	private Action fShowNewDialogOnDropAction;

	/* Clipboard actions */
	private Action fPasteAction;
	private Action fCopyAction;

	/** Currently selected templates */
	private ArrayList fSelectedTemplateList = new ArrayList();

	/** Current active context types for the editor */
	private List fActiveTypes;

	/* Preference stores */
	/**
	 * Preference store to store the dialog setting for this page
	 */
	private IPreferenceStore fPreferenceStore;
	/**
	 * The template stores preference page. Used to listen to the changes and
	 * update the view. Needed when the user selects Preferences and updates the
	 * templates.
	 */
	private IPreferenceStore fTemplatePreferenceStore;

	/* Controls */
	private Tree fTemplatesTree;
	private TreeViewer fTreeViewer;

	/**
	 * Creates a new template preference page.
	 */
	protected TemplatesPage() {
		super();
		fPreferenceStore = TextEditorPlugin.getDefault().getPreferenceStore();
	}

	/**
	 * Returns the template store.
	 * 
	 * @return the template store
	 */
	public TemplateStore getTemplateStore() {
		return fTemplateStore;
	}

	/**
	 * Returns the context type registry.
	 * 
	 * @return the context type registry
	 */
	public ContextTypeRegistry getContextTypeRegistry() {
		return fContextTypeRegistry;
	}

	/**
	 * Sets the template store.
	 * 
	 * @param store
	 *            the template store
	 * @param templatePreferenceStore
	 *            the preference store used for this template store
	 */
	public void setTemplateStore(TemplateStore store, IPreferenceStore templatePreferenceStore) {
		fTemplateStore = store;
		fTemplatePreferenceStore = templatePreferenceStore;
		if (fTemplatePreferenceStore != null)
			fTemplatePreferenceStore.addPropertyChangeListener(new IPropertyChangeListener() {
				public void propertyChange(PropertyChangeEvent event) {
					refresh();
				}
			});
	}

	/**
	 * Sets the context type registry.
	 * 
	 * @param registry
	 *            the new context type registry
	 */
	public void setContextTypeRegistry(ContextTypeRegistry registry) {
		fContextTypeRegistry = registry;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.part.Page#createControl(org.eclipse.swt.widgets.Composite)
	 */
	public void createControl(Composite ancestor) {
		setupActions();

		fControl = new Composite(ancestor, SWT.NONE);
		GridLayout layout = new GridLayout();
		layout.numColumns = 2;
		layout.marginHeight = 0;
		layout.marginWidth = 0;
		fControl.setLayout(layout);
		Dialog.applyDialogFont(fControl);

		createTemplateTree();
		createPatternViewer(fControl);

		hookContextMenu();
		initializeDND();
		updateButtons();

		fControl.layout(true, true);
	}

	/**
	 * Create the tree control to display template information
	 */
	private void createTemplateTree() {
		Composite treeComposite = new Composite(fControl, SWT.NONE);
		GridData data = new GridData(GridData.FILL_BOTH);
		treeComposite.setLayoutData(data);

		TreeColumnLayout columnLayout = new TreeColumnLayout();
		treeComposite.setLayout(columnLayout);
		fTemplatesTree = new Tree(treeComposite, SWT.H_SCROLL | SWT.V_SCROLL | SWT.MULTI
				| SWT.FULL_SELECTION);
		fTemplatesTree.setHeaderVisible(true);
		fTemplatesTree.setLinesVisible(true);

		GC gc = new GC(getShell());
		gc.setFont(JFaceResources.getDialogFont());

		TreeColumn columnName = new TreeColumn(fTemplatesTree, SWT.NONE);
		columnName.setText(TextEditorTemplateMessages.TemplatesPage_column_name);
		int minWidth = gc.stringExtent(TextEditorTemplateMessages.TemplatesPage_column_name).x + 10;
		columnLayout.setColumnData(columnName, new ColumnWeightData(2, minWidth, true));

		TreeColumn columnDescription = new TreeColumn(fTemplatesTree, SWT.NONE);
		columnDescription.setText(TextEditorTemplateMessages.TemplatesPage_column_description);
		minWidth = gc.stringExtent(TextEditorTemplateMessages.TemplatesPage_column_description).x + 10;
		columnLayout.setColumnData(columnDescription, new ColumnWeightData(3, minWidth, true));

		gc.dispose();

		data = new GridData(GridData.FILL_BOTH);
		data.grabExcessHorizontalSpace = true;
		data.grabExcessVerticalSpace = true;
		/*
		 * these hints should not be zero. the grabExcess will ensure that the
		 * tree is sized appropriately the the pattern viewer is displayed below
		 * it.
		 */
		data.heightHint = 5;
		data.widthHint = 5;
		fTemplatesTree.setLayoutData(data);
		createTreeViewer();
	}

	/**
	 * Create the viewer for the tree control and configure it.
	 */
	private void createTreeViewer() {
		fTreeViewer = new TreeViewer(fTemplatesTree);
		fTreeViewer.setLabelProvider(new TemplateLabelProvider());
		fTreeViewer.setContentProvider(new TemplatesContentProvider());

		fTreeViewer.setComparator(new TemplateViewerComparator());
		fTreeViewer.setInput(fTemplateStore);
		fTreeViewer.addDoubleClickListener(new IDoubleClickListener() {
			public void doubleClick(DoubleClickEvent e) {
				updateSelectedTemplate();
				insertTemplate(getSelectedTemplate());
			}
		});

		fTreeViewer.addSelectionChangedListener(new ISelectionChangedListener() {
			public void selectionChanged(SelectionChangedEvent e) {
				updateSelectedTemplate();
				updateButtons();
			}
		});
		fTreeViewer.expandAll();
		setDisableItemColors();
	}

	/**
	 * Sets all templates in the tree that are disabled to grey.
	 */
	private void setDisableItemColors() {
		TreeItem[] items = fTemplatesTree.getItems();
		Color fgcDisabled = getShell().getDisplay().getSystemColor(SWT.COLOR_GRAY);
		Color fgcEnabled = getShell().getDisplay().getSystemColor(SWT.COLOR_WIDGET_FOREGROUND);
		for (int i = 0; i < items.length; i++) {
			TreeItem[] items2 = items[i].getItems();
			for (int j = 0; j < items2.length; j++) {
				TemplatePersistenceData templateData = (TemplatePersistenceData) items2[j]
						.getData();
				if (!templateData.isEnabled() && items2[j].getForeground() != fgcDisabled)
					items2[j].setForeground(fgcDisabled);
				else if (templateData.isEnabled() && items2[j].getForeground() != fgcEnabled)
					items2[j].setForeground(fgcEnabled);
			}
		}
	}

	/**
	 * Update the selected template list and update the pattern viewer
	 */
	private void updateSelectedTemplate() {
		IStructuredSelection selection = (IStructuredSelection) fTreeViewer.getSelection();

		fSelectedTemplateList.clear();
		for (Iterator iterator = selection.iterator(); iterator.hasNext();) {
			Object item = iterator.next();
			if (item instanceof TemplateContextType) {
				fSelectedTemplateList.clear();
				break;
			}
			fSelectedTemplateList.add(item);

		}
		if (isSingleTemplateSelected())
			updateViewerInput(getSelectedTemplate());
		else
			fPatternViewer.getDocument().set(""); //$NON-NLS-1$
	}

	/**
	 * Checks whether only one template is selected in the tree
	 * 
	 * @return true if only single template is selected
	 */
	private boolean isSingleTemplateSelected() {
		return fSelectedTemplateList.size() == 1;
	}

	/**
	 * Get the selected template. Note: should always precede with a check for
	 * isSingleTemplateSelected
	 * 
	 * @return the template (Not the data)
	 */
	private Template getSelectedTemplate() {
		return ((TemplatePersistenceData) fSelectedTemplateList.get(0)).getTemplate();
	}

	/**
	 * Create a viewer to display the pattern
	 * 
	 * @param parent
	 */
	private void createPatternViewer(Composite parent) {
		Label previewLabel = new Label(parent, SWT.NONE);
		previewLabel.setText(TextEditorTemplateMessages.TemplatesPage_preview);
		GridData data = new GridData();
		data.horizontalSpan = 2;
		previewLabel.setLayoutData(data);

		fPatternViewer = createViewer(parent);
		fPatternViewer.setEditable(false);

		Control control = fPatternViewer.getControl();
		data = new GridData(GridData.FILL_BOTH);
		data.horizontalSpan = 2;

		Dialog.applyDialogFont(control);
		GC gc = new GC(control);
		data.heightHint = convertHeightInCharsToPixels(gc, 5);
		data.grabExcessVerticalSpace = false;
		data.verticalAlignment = SWT.FILL;
		gc.dispose();

		control.setLayoutData(data);
	}

	/**
	 * Setup the actions
	 */
	private void setupActions() {
		IActionBars actionBars = getSite().getActionBars();
		IToolBarManager toolBarManager = actionBars.getToolBarManager();
		IMenuManager menuManager = actionBars.getMenuManager();

		fInsertAction = new Action(TextEditorTemplateMessages.TemplatesPage_insert) {
			public void run() {
				insertTemplate(getSelectedTemplate());
			}
		};

		fAddAction = new Action() {
			public void run() {
				addTemplate();
			}
		};
		fAddAction.setText(TextEditorTemplateMessages.TemplatesPage_new);
		fAddAction.setImageDescriptor(TemplateViewImages
				.getImageDescriptor(ITemplateViewImageConstants.IMG_TEMPLATE_NEW));
		toolBarManager.add(fAddAction);

		fEditAction = new Action() {
			public void run() {
				editTemplate();
			}
		};
		fEditAction.setText(TextEditorTemplateMessages.TemplatesPage_edit);
		fEditAction.setImageDescriptor(TemplateViewImages
				.getImageDescriptor(ITemplateViewImageConstants.IMG_TEMPLATE_EDIT));
		toolBarManager.add(fEditAction);

		fRemoveAction = new Action() {
			public void run() {
				removeTemplate();
			}
		};
		fRemoveAction.setText(TextEditorTemplateMessages.TemplatesPage_remove);
		fRemoveAction.setImageDescriptor(TemplateViewImages
				.getImageDescriptor(ITemplateViewImageConstants.IMG_TEMPLATE_DELETE));
		toolBarManager.add(fRemoveAction);

		toolBarManager.add(new Separator());

		fLinkAction = new Action(TextEditorTemplateMessages.TemplatesPage_link_to_editor,
				IAction.AS_CHECK_BOX) {
			public void run() {
				fPreferenceStore.setValue(LINK_ACTION_PREF_ID, fLinkAction.isChecked());
				refresh();
			}
		};
		fLinkAction.setImageDescriptor(TemplateViewImages
				.getImageDescriptor(ITemplateViewImageConstants.IMG_TEMPLATE_LINK));
		fLinkAction.setChecked(fPreferenceStore.getBoolean(LINK_ACTION_PREF_ID));
		toolBarManager.add(fLinkAction);

		fExpandCollapseAction = new Action(TextEditorTemplateMessages.TemplatesPage_collapse_expand) {
			public void run() {
				Object[] vee = fTreeViewer.getVisibleExpandedElements();
				boolean collapse = vee.length != 0;
				if (collapse)
					fTreeViewer.collapseAll();
				else
					fTreeViewer.expandAll();
			}
		};
		fExpandCollapseAction.setImageDescriptor(TemplateViewImages
				.getImageDescriptor(ITemplateViewImageConstants.IMG_TEMPLATE_COLLAPSE_EXPAND));
		toolBarManager.add(fExpandCollapseAction);

		if (getPreferencePageId() != null) {
			fPreferencePageAction = new Action() {
				public void run() {
					showPreferencePage();
				}
			};
			fPreferencePageAction.setText(TextEditorTemplateMessages.TemplatesPage_preference_page);
			menuManager.add(fPreferencePageAction);
		}
		menuManager.add(new Separator());

		fShowDisabledAction = new Action(TextEditorTemplateMessages.TemplatesPage_show_disabled,
				IAction.AS_CHECK_BOX) {
			public void run() {
				fPreferenceStore.setValue(SHOW_DISABLED_ACTION_PREF_ID, fShowDisabledAction
						.isChecked());
				refresh();
			}
		};
		fPreferenceStore.setDefault(SHOW_DISABLED_ACTION_PREF_ID, false);
		fShowDisabledAction.setChecked(fPreferenceStore.getBoolean(SHOW_DISABLED_ACTION_PREF_ID));
		menuManager.add(fShowDisabledAction);

		fShowNewDialogOnDropAction = new Action(
				TextEditorTemplateMessages.TemplatesPage_show_new_dialog, IAction.AS_CHECK_BOX) {
			public void run() {
				fPreferenceStore.setValue(SHOW_NEW_DIALOG_ACTION_PREF_ID,
						fShowNewDialogOnDropAction.isChecked());
			}
		};
		fPreferenceStore.setDefault(SHOW_NEW_DIALOG_ACTION_PREF_ID, true);
		fShowDisabledAction.setChecked(fPreferenceStore.getBoolean(SHOW_NEW_DIALOG_ACTION_PREF_ID));
		menuManager.add(fShowNewDialogOnDropAction);

		menuManager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS));

		fPasteAction = new Action() {
			public void run() {
				Clipboard clipBoard = new Clipboard(getShell().getDisplay());
				Object contents = clipBoard.getContents(TextTransfer.getInstance());
				if (contents == null)
					return;
				final String text = (String) contents;
				String contextId = getContextId();
				final Template template = new Template(
						TextEditorTemplateMessages.TemplatesPage_snippet,
						TextEditorTemplateMessages.TemplatesPage_paste_description, contextId,
						text, true);
				getShell().getDisplay().asyncExec(new Runnable() {
					public void run() {
						addTemplate(template, HIDE_DIALOG);
					}
				});

			}

			private String getContextId() {
				if (isSingleTemplateSelected())
					return getSelectedTemplate().getContextTypeId();
				IStructuredSelection selection = (IStructuredSelection) fTreeViewer.getSelection();
				if (selection.isEmpty())
					return getFirstContextTypeId();
				Object element = selection.getFirstElement();
				if (element instanceof TemplateContextType)
					return ((TemplateContextType) element).getId();
				return ((TemplatePersistenceData) element).getTemplate().getContextTypeId();
			}
		};
		actionBars.setGlobalActionHandler(ActionFactory.PASTE.getId(), fPasteAction);

		fCopyAction = new Action() {
			public void run() {
				if (!isSingleTemplateSelected())
					return;
				Template[] templates = new Template[] { getSelectedTemplate() };
				Clipboard clipBoard = new Clipboard(getShell().getDisplay());
				clipBoard.setContents(new Object[] { templates }, new Transfer[] { TemplateTransfer
						.getInstance() });
			}
		};
		actionBars.setGlobalActionHandler(ActionFactory.COPY.getId(), fCopyAction);
	}

	/**
	 * Setup the context menu for the viewer.
	 */
	private void hookContextMenu() {
		MenuManager menuMgr = new MenuManager(POPUP_MENU_ID);
		menuMgr.setRemoveAllWhenShown(true);
		menuMgr.addMenuListener(new IMenuListener() {
			public void menuAboutToShow(IMenuManager manager) {
				fillContextMenu(manager);
			}
		});
		Menu menu = menuMgr.createContextMenu(fTreeViewer.getControl());
		fTreeViewer.getControl().setMenu(menu);
		getSite().registerContextMenu(POPUP_MENU_ID, menuMgr, fTreeViewer);
	}

	/**
	 * Fill up the context menu
	 * 
	 * @param manager
	 */
	protected void fillContextMenu(IMenuManager manager) {
		manager.add(fInsertAction);
		manager.add(new Separator());
		manager.add(fAddAction);
		manager.add(fEditAction);
		manager.add(fRemoveAction);
		// Other plug-ins can contribute there actions here
		manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS));
	}

	/**
	 * Show the preference templates preference page
	 */
	private void showPreferencePage() {
		PreferencesUtil.createPreferenceDialogOn(getShell(), getPreferencePageId(), null, null)
				.open();
	}

	/**
	 * Get the preference page ID for the templates for the given editor.
	 * Subclasses should override.
	 * 
	 * @return id of the preference page
	 */
	protected String getPreferencePageId() {
		return null;
	}

	/**
	 * Helper to find the size for pattern viewer
	 * 
	 * @param gc
	 * @param chars
	 * @return the hieght in pixels
	 */
	private int convertHeightInCharsToPixels(GC gc, int chars) {
		FontMetrics fontMetrics = gc.getFontMetrics();
		return fontMetrics.getHeight() * chars;
	}

	/**
	 * Get the shell
	 * 
	 * @return the shell for this view site
	 */
	protected Shell getShell() {
		return getSite().getShell();
	}

	/**
	 * Creates, configures and returns a source viewer to present the template
	 * pattern on the preference page. Clients may override to provide a custom
	 * source viewer featuring e.g. syntax coloring.
	 * 
	 * @param parent
	 *            the parent control
	 * @return a configured source viewer
	 */
	protected SourceViewer createViewer(Composite parent) {
		SourceViewer viewer = new SourceViewer(parent, null, null, false, SWT.BORDER | SWT.V_SCROLL
				| SWT.H_SCROLL);
		SourceViewerConfiguration configuration = new SourceViewerConfiguration();
		viewer.configure(configuration);
		IDocument document = new Document();
		viewer.setDocument(document);
		return viewer;
	}

	/**
	 * Updates the pattern viewer.
	 * 
	 * @param template
	 */
	protected void updateViewerInput(Template template) {
		if (template != null)
			fPatternViewer.getDocument().set(template.getPattern());
		else
			fPatternViewer.getDocument().set(""); //$NON-NLS-1$
	}

	/**
	 * Updates the buttons.
	 */
	private void updateButtons() {
		fCopyAction.setEnabled(isSingleTemplateSelected());
		fInsertAction.setEnabled(isSingleTemplateSelected());
		fEditAction.setEnabled(isSingleTemplateSelected());
		fRemoveAction.setEnabled(fSelectedTemplateList.size() != 0);
	}

	/**
	 * Add a template
	 */
	private void addTemplate() {
		String id = getFirstContextTypeId();
		if (id != null) {
			Template template = new Template("", "", id, "", true); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$

			addTemplate(template, SHOW_DIALOG);
		}
	}

	/**
	 * Get the first context type from the registry.
	 * 
	 * @return id of the context type
	 */
	private String getFirstContextTypeId() {
		Iterator it = fContextTypeRegistry.contextTypes();
		if (it.hasNext())
			return ((TemplateContextType) it.next()).getId();
		return null;
	}

	/**
	 * Add a template
	 * 
	 * Setting ui to SHOW_DIALOG will force a New dialog. Setting it to
	 * MAY_HIDE_DIALOG will respect the show new dialog on drop option.
	 * 
	 * @param template
	 * @param ui
	 */
	private void addTemplate(Template template, int ui) {
		Template newTemplate;
		if (ui == SHOW_DIALOG || fShowNewDialogOnDropAction.isChecked())
			newTemplate = editTemplate(template, false, true);
		else
			newTemplate = template;
		if (newTemplate != null) {
			TemplatePersistenceData data = new TemplatePersistenceData(newTemplate, true);
			fTemplateStore.add(data);
			saveTemplateStore();
			fSelectedTemplateList.clear();
			fSelectedTemplateList.add(data);
			changeSelection();
		}
	}

	/**
	 * Save the template store
	 */
	private void saveTemplateStore() {
		try {
			fTemplateStore.save();
		} catch (IOException e) {
			e.printStackTrace();
			MessageDialog.openError(getShell(),
					TextEditorTemplateMessages.TemplatesPage_save_error_message, e.getMessage());
		}
	}

	/**
	 * Change selection in the viewer. oldData will contain the earlier selected
	 * template and fCurrentTemplateData will hold the current selection. Either
	 * can be null.
	 * 
	 */
	private void changeSelection() {
		fTreeViewer.refresh();
		if (isSingleTemplateSelected())
			fTreeViewer.setSelection(new StructuredSelection(fSelectedTemplateList.get(0)), true);
		else
			fTreeViewer.setSelection(new StructuredSelection());
		updateSelectedTemplate();
	}

	/**
	 * Creates the edit dialog. Subclasses may override this method to provide a
	 * custom dialog.
	 * 
	 * @param template
	 *            the template being edited
	 * @param edit
	 *            whether the dialog should be editable
	 * @param isNameModifiable
	 *            whether the template name may be modified
	 * @return the created or modified template, or <code>null</code> if the
	 *         edition failed
	 * @since 3.1
	 */
	protected Template editTemplate(Template template, boolean edit, boolean isNameModifiable) {
		EditTemplateDialog dialog = new EditTemplateDialog(getShell(), template, edit,
				isNameModifiable, fContextTypeRegistry);
		if (dialog.open() == Window.OK) {
			return dialog.getTemplate();
		}
		return null;
	}

	/**
	 * Edit the current template
	 */
	private void editTemplate() {
		Template oldTemplate = getSelectedTemplate();
		Template newTemplate = editTemplate(new Template(oldTemplate), true, true);
		if (newTemplate != null) {
			if (!newTemplate.getName().equals(oldTemplate.getName())
					&& MessageDialog.openQuestion(getShell(),
							TextEditorTemplateMessages.TemplatesPage_question_create_new_title,
							TextEditorTemplateMessages.TemplatesPage_question_create_new_message)) {
				fSelectedTemplateList.clear();
				TemplatePersistenceData templateData = new TemplatePersistenceData(newTemplate,
						true);
				fSelectedTemplateList.add(templateData);
				fTemplateStore.add(templateData);
			} else {
				((TemplatePersistenceData) fSelectedTemplateList.get(0)).setTemplate(newTemplate);
			}
			changeSelection();
		}
		saveTemplateStore();
	}

	/**
	 * Remove the currently selected templates
	 */
	private void removeTemplate() {
		if (!MessageDialog.openQuestion(getShell(),
				TextEditorTemplateMessages.TemplatesPage_remove_title,
				TextEditorTemplateMessages.TemplatesPage_remove_message))
			return;
		for (Iterator iterator = fSelectedTemplateList.iterator(); iterator.hasNext();) {
			TemplatePersistenceData data = (TemplatePersistenceData) iterator.next();
			fTemplateStore.delete(data);
		}
		saveTemplateStore();
		fSelectedTemplateList.clear();
		changeSelection();
	}

	/**
	 * Get the pattern viewer. Subclass can override
	 * 
	 * @return the viewer
	 */
	protected SourceViewer getViewer() {
		return fPatternViewer;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.part.Page#getControl()
	 */
	public Control getControl() {
		return fControl;
	}

	/**
	 * Subclasses should override and facilitate inserting the template code
	 * into the active editor.
	 * 
	 * @param template
	 */
	public void insertTemplate(Template template) {
	}

	/**
	 * The caret position in the editor has moved into a new context type. It is
	 * the subclasses responsibility to see that this is called only when needed
	 * by keeping track of editor contents (eg. partitions).
	 * 
	 * @param ids
	 */
	protected void contextTypeChanged(String[] ids) {
		fActiveTypes = Arrays.asList(ids);
		if (fLinkAction != null && fLinkAction.isChecked())
			refresh();
	}

	/**
	 * Setup the drop target for the table
	 */
	private void initializeDND() {
		DragSourceAdapter dragListener = new DragSourceAdapter() {
			public void dragSetData(DragSourceEvent event) {
				if (isSingleTemplateSelected()
						&& TemplateTransfer.getInstance().isSupportedType(event.dataType)) {
					event.data = new Template[] { getSelectedTemplate() };
				}
			}
		};
		fTreeViewer.addDragSupport(DND.DROP_COPY,
				new Transfer[] { TemplateTransfer.getInstance() }, dragListener);
		DropTargetAdapter dropListener = new DropTargetAdapter() {
			TextTransfer textTransfer = TextTransfer.getInstance();

			public void dragEnter(DropTargetEvent event) {
				if (event.detail == DND.DROP_DEFAULT)
					event.detail = DND.DROP_COPY;
			}

			public void dragOperationChanged(DropTargetEvent event) {
				if (event.detail == DND.DROP_DEFAULT)
					event.detail = DND.DROP_COPY;
			}

			public void dragOver(DropTargetEvent event) {
				event.detail = DND.DROP_NONE;
				if (event.item == null)
					return;
				int index = 0;
				while (index < event.dataTypes.length) {
					if (textTransfer.isSupportedType(event.dataTypes[index]))
						break;
					index++;
				}
				if (index < event.dataTypes.length) {
					event.currentDataType = event.dataTypes[index];
					event.detail = DND.DROP_COPY;
					return;
				}
			}

			public void drop(DropTargetEvent event) {
				if (event.item == null)
					return;
				Object object = ((TreeItem) event.item).getData();
				String contextId;
				if (object instanceof TemplateContextType)
					contextId = findContextIdByName(((TemplateContextType) object).getId());
				else
					contextId = findContextIdByName(((TemplatePersistenceData) object)
							.getTemplate().getContextTypeId());
				if (textTransfer.isSupportedType(event.currentDataType)) {
					String text = (String) event.data;
					final Template template = new Template(
							TextEditorTemplateMessages.TemplatesPage_snippet,
							TextEditorTemplateMessages.TemplatesPage_paste_description, contextId,
							text, true);
					getShell().getDisplay().asyncExec(new Runnable() {
						public void run() {
							addTemplate(template, HIDE_DIALOG);
						}
					});
				}
			}

			private String findContextIdByName(String contextName) {
				String contextId = null;
				for (Iterator iterator = fContextTypeRegistry.contextTypes(); iterator.hasNext();) {
					TemplateContextType contextType = (TemplateContextType) iterator.next();
					if (contextType.getName().equals(contextName))
						contextId = contextType.getId();
				}
				return contextId;
			}
		};
		fTreeViewer.addDropSupport(DND.DROP_COPY, new Transfer[] { TextTransfer.getInstance() },
				dropListener);
	}

	/**
	 * Setup the editor site as a drop target. Should be invoked by the
	 * subclasses for the D&D to work with the editor.
	 * 
	 * @param site
	 * @param viewer
	 */
	protected void setupEditorDropTarget(IWorkbenchPartSite site, Control viewer) {
		IDragAndDropService dndService = (IDragAndDropService) site
				.getService(IDragAndDropService.class);
		EditorDropTarget editorDropTarget = new EditorDropTarget();
		dndService.addMergedDropTarget(viewer, DND.DROP_COPY, new Transfer[] { TemplateTransfer
				.getInstance() }, editorDropTarget);
	}

	private void refresh() {
		fTreeViewer.refresh();
		setDisableItemColors();
	}
}




package org.eclipse.ui.texteditor.templates;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.GroupMarker;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.IMenuListener;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.Separator;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.dialogs.StatusDialog;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextListener;
import org.eclipse.jface.text.ITextOperationTarget;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.TextEvent;
import org.eclipse.jface.text.contentassist.ContentAssistant;
import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
import org.eclipse.jface.text.contentassist.IContentAssistant;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.jface.text.source.SourceViewer;
import org.eclipse.jface.text.source.SourceViewerConfiguration;
import org.eclipse.jface.text.templates.ContextTypeRegistry;
import org.eclipse.jface.text.templates.Template;
import org.eclipse.jface.text.templates.TemplateContextType;
import org.eclipse.jface.text.templates.TemplateException;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.custom.VerifyKeyListener;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.events.FocusListener;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.events.VerifyEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.ui.internal.texteditor.TextEditorPlugin;
import org.eclipse.ui.texteditor.ITextEditorActionConstants;
import org.eclipse.ui.texteditor.IUpdate;

/**
	 * Dialog to edit a template. Clients will usually instantiate, but
	 * may also extend.
	 *
	 * @since 3.3
	 */
	public class EditTemplateDialog extends StatusDialog {

		private class TextViewerAction extends Action implements IUpdate {

			private int fOperationCode= -1;
			private ITextOperationTarget fOperationTarget;

			/**
			 * Creates a new action.
			 *
			 * @param viewer the viewer
			 * @param operationCode the opcode
			 */
			public TextViewerAction(ITextViewer viewer, int operationCode) {
				fOperationCode= operationCode;
				fOperationTarget= viewer.getTextOperationTarget();
				update();
			}

			/**
			 * Updates the enabled state of the action.
			 * Fires a property change if the enabled state changes.
			 *
			 * @see Action#firePropertyChange(String, Object, Object)
			 */
			public void update() {

				boolean wasEnabled= isEnabled();
				boolean isEnabled= (fOperationTarget != null && fOperationTarget.canDoOperation(fOperationCode));
				setEnabled(isEnabled);

				if (wasEnabled != isEnabled) {
					firePropertyChange(ENABLED, wasEnabled ? Boolean.TRUE : Boolean.FALSE, isEnabled ? Boolean.TRUE : Boolean.FALSE);
				}
			}

			/**
			 * @see Action#run()
			 */
			public void run() {
				if (fOperationCode != -1 && fOperationTarget != null) {
					fOperationTarget.doOperation(fOperationCode);
				}
			}
		}

		private final Template fOriginalTemplate;

		private Text fNameText;
		private Text fDescriptionText;
		private Combo fContextCombo;
		private SourceViewer fPatternEditor;
		private Button fInsertVariableButton;
		private Button fAutoInsertCheckbox;
		private boolean fIsNameModifiable;

		private StatusInfo fValidationStatus;
		private boolean fSuppressError= true; // #4354
		private Map fGlobalActions= new HashMap(10);
		private List fSelectionActions = new ArrayList(3);
		private String[][] fContextTypes;

		private ContextTypeRegistry fContextTypeRegistry;

		private final TemplateVariableProcessor fTemplateProcessor= new TemplateVariableProcessor();

		private Template fNewTemplate;

		/**
		 * Creates a new dialog.
		 *
		 * @param parent the shell parent of the dialog
		 * @param template the template to edit
		 * @param edit whether this is a new template or an existing being edited
		 * @param isNameModifiable whether the name of the template may be modified
		 * @param registry the context type registry to use
		 */
		public EditTemplateDialog(Shell parent, Template template, boolean edit, boolean isNameModifiable, ContextTypeRegistry registry) {
			super(parent);

			setShellStyle(getShellStyle() | SWT.MAX | SWT.RESIZE);

			String title= edit
				? TextEditorTemplateMessages.EditTemplateDialog_title_edit
				: TextEditorTemplateMessages.EditTemplateDialog_title_new;
			setTitle(title);

			fOriginalTemplate= template;
			fIsNameModifiable= isNameModifiable;

			List contexts= new ArrayList();
			for (Iterator it= registry.contextTypes(); it.hasNext();) {
				TemplateContextType type= (TemplateContextType) it.next();
				contexts.add(new String[] { type.getId(), type.getName() });
			}
			fContextTypes= (String[][]) contexts.toArray(new String[contexts.size()][]);

			fValidationStatus= new StatusInfo();

			fContextTypeRegistry= registry;

			TemplateContextType type= fContextTypeRegistry.getContextType(template.getContextTypeId());
			fTemplateProcessor.setContextType(type);
		}

		/*
		 * @see org.eclipse.ui.texteditor.templates.StatusDialog#create()
		 */
		public void create() {
			super.create();
			// update initial OK button to be disabled for new templates
			boolean valid= fNameText == null || fNameText.getText().trim().length() != 0;
			if (!valid) {
				StatusInfo status = new StatusInfo();
				status.setError(TextEditorTemplateMessages.EditTemplateDialog_error_noname);
				updateButtonsEnableState(status);
	 		}
		}

		/*
		 * @see Dialog#createDialogArea(Composite)
		 */
		protected Control createDialogArea(Composite ancestor) {
			Composite parent= new Composite(ancestor, SWT.NONE);
			GridLayout layout= new GridLayout();
			layout.numColumns= 2;
			parent.setLayout(layout);
			parent.setLayoutData(new GridData(GridData.FILL_BOTH));

			ModifyListener listener= new ModifyListener() {
				public void modifyText(ModifyEvent e) {
					doTextWidgetChanged(e.widget);
				}
			};

			if (fIsNameModifiable) {
				createLabel(parent, TextEditorTemplateMessages.EditTemplateDialog_name);

				Composite composite= new Composite(parent, SWT.NONE);
				composite.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
				layout= new GridLayout();
				layout.numColumns= 4;
				layout.marginWidth= 0;
				layout.marginHeight= 0;
				composite.setLayout(layout);

				fNameText= createText(composite);
				fNameText.addModifyListener(listener);
				fNameText.addFocusListener(new FocusListener() {

					public void focusGained(FocusEvent e) {
					}

					public void focusLost(FocusEvent e) {
						if (fSuppressError) {
							fSuppressError= false;
							updateButtons();
						}
					}
				});

				createLabel(composite, TextEditorTemplateMessages.EditTemplateDialog_context);
				fContextCombo= new Combo(composite, SWT.READ_ONLY);

				for (int i= 0; i < fContextTypes.length; i++) {
					fContextCombo.add(fContextTypes[i][1]);
				}

				fContextCombo.addModifyListener(listener);
				
				fAutoInsertCheckbox= createCheckbox(composite, TextEditorTemplateMessages.EditTemplateDialog_autoinsert);
				fAutoInsertCheckbox.setSelection(fOriginalTemplate.isAutoInsertable());
			}

			createLabel(parent, TextEditorTemplateMessages.EditTemplateDialog_description);

			int descFlags= fIsNameModifiable ? SWT.BORDER : SWT.BORDER | SWT.READ_ONLY;
			fDescriptionText= new Text(parent, descFlags );
			fDescriptionText.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

			fDescriptionText.addModifyListener(listener);

			Label patternLabel= createLabel(parent, TextEditorTemplateMessages.EditTemplateDialog_pattern);
			patternLabel.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_BEGINNING));
			fPatternEditor= createEditor(parent, fOriginalTemplate.getPattern());

			Label filler= new Label(parent, SWT.NONE);
			filler.setLayoutData(new GridData());

			Composite composite= new Composite(parent, SWT.NONE);
			layout= new GridLayout();
			layout.marginWidth= 0;
			layout.marginHeight= 0;
			composite.setLayout(layout);
			composite.setLayoutData(new GridData());

			fInsertVariableButton= new Button(composite, SWT.NONE);
			fInsertVariableButton.setLayoutData(getButtonGridData(fInsertVariableButton));
			fInsertVariableButton.setText(TextEditorTemplateMessages.EditTemplateDialog_insert_variable);
			fInsertVariableButton.addSelectionListener(new SelectionListener() {
				public void widgetSelected(SelectionEvent e) {
					fPatternEditor.getTextWidget().setFocus();
					fPatternEditor.doOperation(ISourceViewer.CONTENTASSIST_PROPOSALS);
				}

				public void widgetDefaultSelected(SelectionEvent e) {}
			});

			fDescriptionText.setText(fOriginalTemplate.getDescription());
			if (fIsNameModifiable) {
				fNameText.setText(fOriginalTemplate.getName());
				fNameText.addModifyListener(listener);
				fContextCombo.select(getIndex(fOriginalTemplate.getContextTypeId()));
			} else {
				fPatternEditor.getControl().setFocus();
			}
			initializeActions();

			applyDialogFont(parent);
			return composite;
		}

		private void doTextWidgetChanged(Widget w) {
			if (w == fNameText) {
				fSuppressError= false;
				updateButtons();
			} else if (w == fContextCombo) {
				String contextId= getContextId();
				fTemplateProcessor.setContextType(fContextTypeRegistry.getContextType(contextId));
			} else if (w == fDescriptionText) {
				// oh, nothing
			}
		}

		private String getContextId() {
			if (fContextCombo != null && !fContextCombo.isDisposed()) {
				String name= fContextCombo.getText();
				for (int i= 0; i < fContextTypes.length; i++) {
					if (name.equals(fContextTypes[i][1])) {
						return fContextTypes[i][0];
					}
				}
			}

			return fOriginalTemplate.getContextTypeId();
		}

		private void doSourceChanged(IDocument document) {
			String text= document.get();
			fValidationStatus.setOK();
			TemplateContextType contextType= fContextTypeRegistry.getContextType(getContextId());
			if (contextType != null) {
				try {
					contextType.validate(text);
				} catch (TemplateException e) {
					fValidationStatus.setError(e.getLocalizedMessage());
				}
			}

			updateUndoAction();
			updateButtons();
		}

		private static GridData getButtonGridData(Button button) {
			GridData data= new GridData(GridData.FILL_HORIZONTAL);
			// TODO get some button hints.
//			data.heightHint= SWTUtil.getButtonHeightHint(button);

			return data;
		}

		private static Label createLabel(Composite parent, String name) {
			Label label= new Label(parent, SWT.NULL);
			label.setText(name);
			label.setLayoutData(new GridData());

			return label;
		}

		private static Text createText(Composite parent) {
			Text text= new Text(parent, SWT.BORDER);
			text.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

			return text;
		}

		private static Button createCheckbox(Composite parent, String name) {
			Button button= new Button(parent, SWT.CHECK);
			button.setText(name);
			button.setLayoutData(new GridData());
			
			return button;
		}
		
		private SourceViewer createEditor(Composite parent, String pattern) {
			SourceViewer viewer= createViewer(parent);
			viewer.setEditable(true);
			
			IDocument document= viewer.getDocument();
			if (document != null)
				document.set(pattern);
			else {
				document= new Document(pattern);
				viewer.setDocument(document);
			}

			int nLines= document.getNumberOfLines();
			if (nLines < 5) {
				nLines= 5;
			} else if (nLines > 12) {
				nLines= 12;
			}

			Control control= viewer.getControl();
			GridData data= new GridData(GridData.FILL_BOTH);
			data.widthHint= convertWidthInCharsToPixels(80);
			data.heightHint= convertHeightInCharsToPixels(nLines);
			control.setLayoutData(data);

			viewer.addTextListener(new ITextListener() {
				public void textChanged(TextEvent event) {
					if (event .getDocumentEvent() != null)
						doSourceChanged(event.getDocumentEvent().getDocument());
				}
			});

			viewer.addSelectionChangedListener(new ISelectionChangedListener() {
				public void selectionChanged(SelectionChangedEvent event) {
					updateSelectionDependentActions();
				}
			});

		 	viewer.prependVerifyKeyListener(new VerifyKeyListener() {
				public void verifyKey(VerifyEvent event) {
					handleVerifyKeyPressed(event);
				}
			});

			return viewer;
		}

		/**
		 * Creates the viewer to be used to display the pattern. Subclasses may override.
		 *
		 * @param parent the parent composite of the viewer
		 * @return a configured <code>SourceViewer</code>
		 */
		protected SourceViewer createViewer(Composite parent) {
			SourceViewer viewer= new SourceViewer(parent, null, null, false, SWT.BORDER | SWT.V_SCROLL | SWT.H_SCROLL);
			SourceViewerConfiguration configuration= new SourceViewerConfiguration() {
				public IContentAssistant getContentAssistant(ISourceViewer sourceViewer) {

					ContentAssistant assistant= new ContentAssistant();
					assistant.enableAutoActivation(true);
					assistant.enableAutoInsert(true);
					assistant.setContentAssistProcessor(fTemplateProcessor, IDocument.DEFAULT_CONTENT_TYPE);
					return assistant;
				}
			};
			viewer.configure(configuration);
			return viewer;
		}

		private void handleVerifyKeyPressed(VerifyEvent event) {
			if (!event.doit)
				return;

			if (event.stateMask != SWT.MOD1)
				return;

			switch (event.character) {
				case ' ':
					fPatternEditor.doOperation(ISourceViewer.CONTENTASSIST_PROPOSALS);
					event.doit= false;
					break;

				// CTRL-Z
				case 'z' - 'a' + 1:
					fPatternEditor.doOperation(ITextOperationTarget.UNDO);
					event.doit= false;
					break;
			}
		}

		private void initializeActions() {
			TextViewerAction action= new TextViewerAction(fPatternEditor, ITextOperationTarget.UNDO);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_undo);
			fGlobalActions.put(ITextEditorActionConstants.UNDO, action);

			action= new TextViewerAction(fPatternEditor, ITextOperationTarget.CUT);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_cut);
			fGlobalActions.put(ITextEditorActionConstants.CUT, action);

			action= new TextViewerAction(fPatternEditor, ITextOperationTarget.COPY);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_copy);
			fGlobalActions.put(ITextEditorActionConstants.COPY, action);

			action= new TextViewerAction(fPatternEditor, ITextOperationTarget.PASTE);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_paste);
			fGlobalActions.put(ITextEditorActionConstants.PASTE, action);

			action= new TextViewerAction(fPatternEditor, ITextOperationTarget.SELECT_ALL);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_select_all);
			fGlobalActions.put(ITextEditorActionConstants.SELECT_ALL, action);

			action= new TextViewerAction(fPatternEditor, ISourceViewer.CONTENTASSIST_PROPOSALS);
			action.setText(TextEditorTemplateMessages.EditTemplateDialog_content_assist);
			fGlobalActions.put("ContentAssistProposal", action); //$NON-NLS-1$

			fSelectionActions.add(ITextEditorActionConstants.CUT);
			fSelectionActions.add(ITextEditorActionConstants.COPY);
			fSelectionActions.add(ITextEditorActionConstants.PASTE);

			// create context menu
			MenuManager manager= new MenuManager(null, null);
			manager.setRemoveAllWhenShown(true);
			manager.addMenuListener(new IMenuListener() {
				public void menuAboutToShow(IMenuManager mgr) {
					fillContextMenu(mgr);
				}
			});

			StyledText text= fPatternEditor.getTextWidget();
			Menu menu= manager.createContextMenu(text);
			text.setMenu(menu);
		}

		private void fillContextMenu(IMenuManager menu) {
			menu.add(new GroupMarker(ITextEditorActionConstants.GROUP_UNDO));
			menu.appendToGroup(ITextEditorActionConstants.GROUP_UNDO, (IAction) fGlobalActions.get(ITextEditorActionConstants.UNDO));

			menu.add(new Separator(ITextEditorActionConstants.GROUP_EDIT));
			menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.CUT));
			menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.COPY));
			menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.PASTE));
			menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.SELECT_ALL));

			menu.add(new Separator("templates")); //$NON-NLS-1$
			menu.appendToGroup("templates", (IAction) fGlobalActions.get("ContentAssistProposal")); //$NON-NLS-1$ //$NON-NLS-2$
		}

		private void updateSelectionDependentActions() {
			Iterator iterator= fSelectionActions.iterator();
			while (iterator.hasNext())
				updateAction((String)iterator.next());
		}

		private void updateUndoAction() {
			IAction action= (IAction) fGlobalActions.get(ITextEditorActionConstants.UNDO);
			if (action instanceof IUpdate)
				((IUpdate) action).update();
		}

		private void updateAction(String actionId) {
			IAction action= (IAction) fGlobalActions.get(actionId);
			if (action instanceof IUpdate)
				((IUpdate) action).update();
		}

		private int getIndex(String contextid) {

			if (contextid == null)
				return -1;

			for (int i= 0; i < fContextTypes.length; i++) {
				if (contextid.equals(fContextTypes[i][0])) {
					return i;
				}
			}
			return -1;
		}

		private void updateButtons() {
			StatusInfo status;

			boolean valid= fNameText == null || fNameText.getText().trim().length() != 0;
			if (!valid) {
				status = new StatusInfo();
				if (!fSuppressError) {
					status.setError(TextEditorTemplateMessages.EditTemplateDialog_error_noname);
				}
	 		} else {
	 			status= fValidationStatus;
	 		}
			updateStatus(status);
		}

		/*
		 * @since 3.1
		 */
		protected void okPressed() {
			String name= fNameText == null ? fOriginalTemplate.getName() : fNameText.getText();
			boolean isAutoInsertable= fAutoInsertCheckbox != null && fAutoInsertCheckbox.getSelection();
			fNewTemplate= new Template(name, fDescriptionText.getText(), getContextId(), fPatternEditor.getDocument().get(), isAutoInsertable);
			super.okPressed();
		}

		/**
		 * Returns the created template.
		 *
		 * @return the created template
		 * @since 3.1
		 */
		public Template getTemplate() {
			return fNewTemplate;
		}
		
		/**
		 * Returns the content assist processor that
		 * suggests template variables.
		 * 
		 * @return the processor to suggest variables
		 * @since 3.3
		 */
		protected IContentAssistProcessor getTemplateProcessor() {
			return fTemplateProcessor;
		}

		/*
		 * @see org.eclipse.jface.dialogs.Dialog#getDialogBoundsSettings()
		 * @since 3.2
		 */
		protected IDialogSettings getDialogBoundsSettings() {
			String sectionName= this.getClass().getName() + "_dialogBounds"; //$NON-NLS-1$
			IDialogSettings settings= TextEditorPlugin.getDefault().getDialogSettings();
			IDialogSettings section= settings.getSection(sectionName);
			if (section == null)
				section= settings.addNewSection(sectionName);
			return section;
		}

	}

Added Link Here

(-)icons/full/elcl16/edit_template.gif (+7 lines)
1	GIF89aæôöüõ÷üôöûêïúðóúg}©ùúümt³s²»»Âáé÷äëøÀ¢Ä¥Ç³ÀÖ·ÄÙ½ÉÝÞèøßè÷éïùóöûðôúöøûïôûõøüô÷ûéðù"Cgìòùõøû÷ùûÛÓ¡»´\|p>{o>{p>v<s<q=\|o>~B7y9w:©I\|8ÜµVÄ£OàÈ²0¯1¬2¨3Ã=Û±NÔ²hÔ²iÚ½\|Õ²iðØ¨éÄ~öæÈ\|W]`xQi8i8l>m>pCpDtJi9ÿÿÿ!ùN,N55<59=>AD:"
2	4=;6?AC®!7@ªB 8E·AEÉ-LÅL½¿ 1K·#J.2I$$H¾ /3FGMõ(0
3
4	ÿ
5	Rba¡`Á
6
7	ª(db%N(±Â!£;

Added Link Here

(-)icons/full/elcl16/collapse_expand_all.gif (+5 lines)
1	GIF89aÕ"·Òä>r§2]z9¯1©3 5¤45¬2w9²0}q=~p=\|7p°iªs²m®k¬ôüÿøýÿþþÿüÿÿùýÿöüÿw´u²úþÿüþÿýþÿ~q=(bùþÿÿÿÿ!ù",p@P$ Å¡p°. X(E'À TáðÏçÄµÐi»Ýë!D¯×WCÄïBW!!W{~\|!WvW
2	v
3	Wu¡t£J ¥§J
4
5	±±W´µ"A;




package org.eclipse.ui.texteditor.templates;

import org.eclipse.ui.internal.texteditor.TextEditorPlugin;

/**
 * Image constants for the template page
 * 
 * @author kd
 * 
 */
public interface ITemplateViewImageConstants {
	public static final String PREFIX = TextEditorPlugin.PLUGIN_ID + "."; //$NON-NLS-1$

	public final static String IMG_TEMPLATE_NEW = PREFIX + "new_template.gif"; //$NON-NLS-1$
	public static final String IMG_TEMPLATE_DELETE = "delete_template.gif"; //$NON-NLS-1$
	public final static String IMG_TEMPLATE_EDIT = PREFIX + "edit_template.gif"; //$NON-NLS-1$
	public static final String IMG_TEMPLATE_LINK = "link_to_editor.gif"; //$NON-NLS-1$
	public static final String IMG_TEMPLATE_COLLAPSE_EXPAND = "collapse_expand_all.gif"; //$NON-NLS-1$
}

Added Link Here

(-)icons/full/elcl16/link_to_editor.gif (+1 lines)
1	GIF89a³½ªo¦küì±ûåüñÃýñÃþýïüê©ýöÕº&þøÞþøÝýøÝûì±ÿÿÿ!ù,MðÉÀ¼18[wL³Th5Á/\bx>cAì¢IHQp#18ù¨<©JbÊv»>à°ÀG0¿>óy¬^·;




/*******************************************************************************
 * Copyright (c) 2004, 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.texteditor.templates;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.util.ArrayList;

import org.eclipse.jface.text.templates.Template;
import org.eclipse.swt.dnd.ByteArrayTransfer;
import org.eclipse.swt.dnd.TransferData;

/**
 * Transfer type used for clip board and DnD operations for template objects
 * 
 * @see TemplatesPage
 * 
 */
public class TemplateTransfer extends ByteArrayTransfer {

	private static TemplateTransfer instance;

	private static final String LOCAL_NAME = TemplateTransfer.class.getName()
			+ System.currentTimeMillis();
	private static final int LOCAL_TYPE = registerType(LOCAL_NAME);

	private static String[] names = null;
	private static int types[] = null;

	/**
	 * @return the registered Transfer instance
	 */
	public static TemplateTransfer getInstance() {
		if (instance == null) {
			instance = new TemplateTransfer();
			types = new int[] { LOCAL_TYPE };
			names = new String[] { LOCAL_NAME };
		}
		return instance;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.swt.dnd.Transfer#getTypeIds()
	 */
	protected int[] getTypeIds() {
		return types;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.swt.dnd.Transfer#getTypeNames()
	 */
	protected String[] getTypeNames() {
		return names;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.swt.dnd.ByteArrayTransfer#javaToNative(java.lang.Object,
	 *      org.eclipse.swt.dnd.TransferData)
	 */
	protected void javaToNative(Object object, TransferData transferData) {
		if (object == null || !(object instanceof Template[])
				|| !isSupportedType(transferData))
			return;
		ByteArrayOutputStream out = new ByteArrayOutputStream();
		DataOutputStream dataOut = new DataOutputStream(out);
		Template[] templates = (Template[]) object;
		for (int i = 0; i < templates.length; i++) {
			writeTemplate(dataOut, templates[i]);
		}
		byte[] byteArray = out.toByteArray();
		try {
			dataOut.close();
		} catch (IOException e) {
		}
		super.javaToNative(byteArray, transferData);
	}

	/**
	 * Write a template to the output stream
	 * 
	 * @param dataOut
	 * @param template
	 */
	private void writeTemplate(DataOutputStream dataOut, Template template) {
		try {
			writeString(dataOut, template.getName());
			writeString(dataOut, template.getDescription());
			writeString(dataOut, template.getContextTypeId());
			writeString(dataOut, template.getPattern());
			dataOut.writeBoolean(template.isAutoInsertable());
		} catch (IOException e) {
		}
	}

	/**
	 * Write a string to the output stream
	 * 
	 * @param dataOut
	 * @param name
	 * @throws IOException
	 */
	private void writeString(DataOutputStream dataOut, String name)
			throws IOException {
		byte[] bytes = name.getBytes();
		dataOut.writeInt(bytes.length);
		dataOut.write(bytes);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.swt.dnd.ByteArrayTransfer#nativeToJava(org.eclipse.swt.dnd.TransferData)
	 */
	protected Object nativeToJava(TransferData transferData) {
		byte[] bytes = (byte[]) super.nativeToJava(transferData);
		if (bytes == null)
			return null;
		ArrayList listTemplates = new ArrayList();
		ByteArrayInputStream in = new ByteArrayInputStream(bytes);
		DataInputStream dataIn = new DataInputStream(in);
		try {
			while (dataIn.available() > 0) {
				Template template = readTempate(dataIn);
				if (template == null)
					break;
				listTemplates.add(template);
			}
		} catch (IOException e) {
		} finally {
			try {
				dataIn.close();
			} catch (IOException e) {
			}
		}
		return listTemplates.toArray(new Template[listTemplates.size()]);
	}

	/**
	 * Read a template from the data input stream.
	 * 
	 * @param dataIn
	 * @return the template
	 * @throws IOException
	 */
	private Template readTempate(DataInputStream dataIn) throws IOException {
		return new Template(readString(dataIn), readString(dataIn),
				readString(dataIn), readString(dataIn), dataIn.readBoolean());
	}

	/**
	 * Read a string from the data input stream
	 * 
	 * @param dataIn
	 * @return the string
	 * @throws IOException
	 */
	private String readString(DataInputStream dataIn) throws IOException {
		byte[] bytes = new byte[dataIn.readInt()];
		dataIn.read(bytes);
		return new String(bytes);
	}
}

Added Link Here

(-)icons/full/elcl16/new_template.gif (+4 lines)
1	GIF89aæ«¤©ª£¨ª¢¨¶°µ´®³²¬±°ª¯®¨¬¦«¬¥««¤ªª¢©²¬²°ª°·²·µ±µ³¯´¹µº¸´¹°¯°°¯¯®°¯««¨¥íùÿðúÿ¢óûÿöüÿìùÿïúÿëùÿîúÿñûÿ¡õüÿøýÿìúÿôüÿëúÿïûÿóüÿ÷ýÿòüÿ£¢£¦£¥¨¨¬¹·£¹³¶±²®®«³°º·¢¼µ¶°Â¿Á¾¿¶³¯º¶£ÊÇ¸Â¾ÓÐÃËÇ¸ËÇ¹ÜÙÏÔÐÄÜÙÐäáÙàÈÝÙÏÔ²iÚ½\|ÜØÏåáÙëèâåàÙëçâðìèÿÿÿ!ù\,²\F\B--TF<3UT<=%[¢¢RC>%ZXZ¬Z%>:/YWQ¹Q,?92SNPVVN/974OÑKÑ$85*
2	IÜLIM*6#"EDDJJE1+ );HHõA ' !
3	@@<¸°@Ã!:Ê(L¸p¡ 4P¸ä4
4	;

Added Link Here

(-)icons/full/elcl16/delete_template.gif (+5 lines)
1	GIF89aÕÇ35ôqtôstórtósuØ*/à,4ß,3Ç)0æ6>å6>Å +å09òU`ôckócjóckódkÅ'Æ(Å'Æ ,òT`Å%ñ?Rð?QòHXñHXÔetß¨Ê]IÎn^ÊWFÊXFÉXFÕ\|ÉPCÜ¦ ÉG>ÉG?ÈG?Ç=9àa[õ}Ç=:ãROõ~ô~ãÄÄÿÿÿ!ù1,\|ÀpH,FgTy`DX¨b
2	G¢*,\+Ò§ô!½Â%âE¨LªAàd%rXÈÃñHq
3
4
5	H1HEB ¦C0¨C«\B±£B«¹ÀÁBA;




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     John-Mason P. Shackelford (john-mason.shackelford@pearson.com) - bug 49380, 49445, 53547
 *******************************************************************************/
package org.eclipse.ui.texteditor.templates;

import java.net.URL;

import org.eclipse.core.runtime.FileLocator;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.internal.texteditor.TextEditorPlugin;
import org.osgi.framework.Bundle;

/**
 * The images provided by the texteditor plugin
 */
public class TemplateViewImages {

	/**
	 * The image registry containing <code>Image</code>s.
	 */
	private static ImageRegistry imageRegistry;

	private static String ICONS_PATH = "$nl$/icons/full/"; //$NON-NLS-1$

	// Use IPath and toOSString to build the names to ensure they have the
	// slashes correct
	private final static String LOCALTOOL = ICONS_PATH + "elcl16/"; //$NON-NLS-1$

	/**
	 * Declare all images
	 */
	private static void declareImages() {
		// Ant Editor images
		declareRegistryImage(ITemplateViewImageConstants.IMG_TEMPLATE_NEW,
				LOCALTOOL + "new_template.gif"); //$NON-NLS-1$
		declareRegistryImage(ITemplateViewImageConstants.IMG_TEMPLATE_DELETE,
				LOCALTOOL + "delete_template.gif"); //$NON-NLS-1$
		declareRegistryImage(ITemplateViewImageConstants.IMG_TEMPLATE_EDIT,
				LOCALTOOL + "edit_template.gif"); //$NON-NLS-1$
		declareRegistryImage(ITemplateViewImageConstants.IMG_TEMPLATE_LINK,
				LOCALTOOL + "link_to_editor.gif"); //$NON-NLS-1$
		declareRegistryImage(
				ITemplateViewImageConstants.IMG_TEMPLATE_COLLAPSE_EXPAND,
				LOCALTOOL + "collapse_expand_all.gif"); //$NON-NLS-1$
	}

	/**
	 * Declare an Image in the registry table.
	 * 
	 * @param key
	 *            The key to use when registering the image
	 * @param path
	 *            The path where the image can be found. This path is relative
	 *            to where this plugin class is found (i.e. typically the
	 *            packages directory)
	 */
	private final static void declareRegistryImage(String key, String path) {
		ImageDescriptor desc = ImageDescriptor.getMissingImageDescriptor();
		Bundle bundle = Platform.getBundle(TextEditorPlugin.PLUGIN_ID);
		URL url = null;
		if (bundle != null) {
			url = FileLocator.find(bundle, new Path(path), null);
			desc = ImageDescriptor.createFromURL(url);
		}
		imageRegistry.put(key, desc);
	}

	/**
	 * Returns the ImageRegistry.
	 * 
	 * @return image registry
	 */
	public static ImageRegistry getImageRegistry() {
		if (imageRegistry == null) {
			initializeImageRegistry();
		}
		return imageRegistry;
	}

	/**
	 * Initialize the image registry by declaring all of the required graphics.
	 * This involves creating JFace image descriptors describing how to
	 * create/find the image should it be needed. The image is not actually
	 * allocated until requested.
	 * 
	 * Prefix conventions Wizard Banners WIZBAN_ Preference Banners PREF_BAN_
	 * Property Page Banners PROPBAN_ Color toolbar CTOOL_ Enable toolbar ETOOL_
	 * Disable toolbar DTOOL_ Local enabled toolbar ELCL_ Local Disable toolbar
	 * DLCL_ Object large OBJL_ Object small OBJS_ View VIEW_ Product images
	 * PROD_ Misc images MISC_
	 * 
	 * Where are the images? The images (typically gifs) are found in the same
	 * location as this plugin class. This may mean the same package directory
	 * as the package holding this class. The images are declared using
	 * this.getClass() to ensure they are looked up via this plugin class.
	 * 
	 * @return the image registry
	 * @see org.eclipse.jface.resource.ImageRegistry
	 */
	public static ImageRegistry initializeImageRegistry() {
		imageRegistry = new ImageRegistry(getStandardDisplay());
		declareImages();
		return imageRegistry;
	}

	/**
	 * Returns the standard display to be used. The method first checks, if the
	 * thread calling this method has an associated display. If so, this display
	 * is returned. Otherwise the method returns the default display.
	 * 
	 * @return the display
	 */
	public static Display getStandardDisplay() {
		Display display = Display.getCurrent();
		if (display == null) {
			display = Display.getDefault();
		}
		return display;
	}

	/**
	 * Returns the <code>Image<code> identified by the given key,
	 * or <code>null</code> if it does not exist.
	 * @param key 
	 * @return the image
	 */
	public static Image getImage(String key) {
		return getImageRegistry().get(key);
	}

	/**
	 * Returns the <code>ImageDescriptor<code> identified by the given key,
	 * or <code>null</code> if it does not exist.
	 * @param key 
	 * @return the image descriptor
	 */
	public static ImageDescriptor getImageDescriptor(String key) {
		return getImageRegistry().getDescriptor(key);
	}

}

Lines 41-52 Link Here

(-)ui/org/eclipse/jdt/internal/ui/javaeditor/ClipboardOperationAction.java (-1 / +11 lines)
41	import org.eclipse.jface.text.ITextOperationTarget;	41	import org.eclipse.jface.text.ITextOperationTarget;
42	import org.eclipse.jface.text.ITextSelection;	42	import org.eclipse.jface.text.ITextSelection;
43	import org.eclipse.jface.text.Region;	43	import org.eclipse.jface.text.Region;
		44	import org.eclipse.jface.text.templates.Template;
44		45
45	import org.eclipse.ui.IWorkbenchPartSite;	46	import org.eclipse.ui.IWorkbenchPartSite;
46	import org.eclipse.ui.texteditor.IAbstractTextEditorHelpContextIds;	47	import org.eclipse.ui.texteditor.IAbstractTextEditorHelpContextIds;
47	import org.eclipse.ui.texteditor.ITextEditor;	48	import org.eclipse.ui.texteditor.ITextEditor;
48	import org.eclipse.ui.texteditor.IWorkbenchActionDefinitionIds;	49	import org.eclipse.ui.texteditor.IWorkbenchActionDefinitionIds;
49	import org.eclipse.ui.texteditor.TextEditorAction;	50	import org.eclipse.ui.texteditor.TextEditorAction;
		51	import org.eclipse.ui.texteditor.templates.TemplateTransfer;
		52
		53	import org.eclipse.ui.views.templates.ITemplatesPage;
50		54
51	import org.eclipse.jdt.core.ICompilationUnit;	55	import org.eclipse.jdt.core.ICompilationUnit;
52	import org.eclipse.jdt.core.IJavaElement;	56	import org.eclipse.jdt.core.IJavaElement;
Lines 66-71 Link Here
66	import org.eclipse.jdt.ui.PreferenceConstants;	70	import org.eclipse.jdt.ui.PreferenceConstants;
67		71
68	import org.eclipse.jdt.internal.ui.JavaPlugin;	72	import org.eclipse.jdt.internal.ui.JavaPlugin;
		73	import org.eclipse.jdt.internal.ui.preferences.JavaTemplatesPage;
69		74
70		75
71	/**	76	/**
Lines 489-495 Link Here
489	}	494	}
490	}	495	}
491	} else {	496	} else {
492	fOperationTarget.doOperation(fOperationCode);	497	Template[] templates= (Template[]) clipboard.getContents(TemplateTransfer.getInstance());
		498	if (templates != null) {
		499	JavaTemplatesPage page= (JavaTemplatesPage) editor.getAdapter(ITemplatesPage.class);
		500	page.insertTemplate(templates[0]);
		501	} else
		502	fOperationTarget.doOperation(fOperationCode);
493	}	503	}
494	}	504	}
495		505

Lines 141-146 Link Here

(-)ui/org/eclipse/jdt/internal/ui/javaeditor/JavaEditor.java (+19 lines)
141		141
142	import org.eclipse.ui.views.contentoutline.ContentOutline;	142	import org.eclipse.ui.views.contentoutline.ContentOutline;
143	import org.eclipse.ui.views.contentoutline.IContentOutlinePage;	143	import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
		144	import org.eclipse.ui.views.templates.ITemplatesPage;
144		145
145	import org.eclipse.jdt.core.IClassFile;	146	import org.eclipse.jdt.core.IClassFile;
146	import org.eclipse.jdt.core.ICompilationUnit;	147	import org.eclipse.jdt.core.ICompilationUnit;
Lines 194-199 Link Here
194	import org.eclipse.jdt.internal.ui.javaeditor.selectionactions.StructureSelectNextAction;	195	import org.eclipse.jdt.internal.ui.javaeditor.selectionactions.StructureSelectNextAction;
195	import org.eclipse.jdt.internal.ui.javaeditor.selectionactions.StructureSelectPreviousAction;	196	import org.eclipse.jdt.internal.ui.javaeditor.selectionactions.StructureSelectPreviousAction;
196	import org.eclipse.jdt.internal.ui.javaeditor.selectionactions.StructureSelectionAction;	197	import org.eclipse.jdt.internal.ui.javaeditor.selectionactions.StructureSelectionAction;
		198	import org.eclipse.jdt.internal.ui.preferences.JavaTemplatesPage;
197	import org.eclipse.jdt.internal.ui.search.BreakContinueTargetFinder;	199	import org.eclipse.jdt.internal.ui.search.BreakContinueTargetFinder;
198	import org.eclipse.jdt.internal.ui.search.ExceptionOccurrencesFinder;	200	import org.eclipse.jdt.internal.ui.search.ExceptionOccurrencesFinder;
199	import org.eclipse.jdt.internal.ui.search.ImplementOccurrencesFinder;	201	import org.eclipse.jdt.internal.ui.search.ImplementOccurrencesFinder;
Lines 1333-1338 Link Here
1333	protected JavaOutlinePage fOutlinePage;	1335	protected JavaOutlinePage fOutlinePage;
1334	/** Outliner context menu Id */	1336	/** Outliner context menu Id */
1335	protected String fOutlinerContextMenuId;	1337	protected String fOutlinerContextMenuId;
		1338	/** The templates page */
		1339	private JavaTemplatesPage fTemplatesPage;
		1340
1336	/**	1341	/**
1337	* The editor selection changed listener.	1342	* The editor selection changed listener.
1338	*	1343	*
Lines 1778-1783 Link Here
1778	return fOutlinePage;	1783	return fOutlinePage;
1779	}	1784	}
1780		1785
		1786	if (required.equals(ITemplatesPage.class)) {
		1787	return getTemplatesPage();
		1788	}
		1789
1781	if (IEncodingSupport.class.equals(required))	1790	if (IEncodingSupport.class.equals(required))
1782	return fEncodingSupport;	1791	return fEncodingSupport;
1783		1792
Lines 1832-1837 Link Here
1832	return super.getAdapter(required);	1841	return super.getAdapter(required);
1833	}	1842	}
1834		1843
		1844	private JavaTemplatesPage getTemplatesPage() {
		1845	if (fTemplatesPage == null) {
		1846	fTemplatesPage= new JavaTemplatesPage(this);
		1847
		1848	}
		1849	return fTemplatesPage;
		1850	}
		1851
1835	/**	1852	/**
1836	* React to changed selection.	1853	* React to changed selection.
1837	*	1854	*
Lines 3225-3230 Link Here
3225	protected void handleCursorPositionChanged() {	3242	protected void handleCursorPositionChanged() {
3226	super.handleCursorPositionChanged();	3243	super.handleCursorPositionChanged();
3227	fCachedSelectedRange= getViewer().getSelectedRange();	3244	fCachedSelectedRange= getViewer().getSelectedRange();
		3245	if (fTemplatesPage != null)
		3246	fTemplatesPage.cursorPositionChanged();
3228	}	3247	}
3229		3248
3230	private static boolean isBracket(char character) {	3249	private static boolean isBracket(char character) {




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jdt.internal.ui.preferences;

import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;

import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.window.Window;

import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextSelection;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.Region;
import org.eclipse.jface.text.TextSelection;
import org.eclipse.jface.text.TextUtilities;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.jface.text.source.SourceViewer;
import org.eclipse.jface.text.templates.ContextTypeRegistry;
import org.eclipse.jface.text.templates.Template;
import org.eclipse.jface.text.templates.TemplateContextType;

import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.part.FileEditorInput;
import org.eclipse.ui.texteditor.templates.TemplatesPage;

import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.JavaCore;

import org.eclipse.jdt.internal.corext.template.java.CompilationUnitContext;
import org.eclipse.jdt.internal.corext.template.java.CompilationUnitContextType;
import org.eclipse.jdt.internal.corext.template.java.JavaContextType;
import org.eclipse.jdt.internal.corext.template.java.JavaDocContextType;

import org.eclipse.jdt.ui.PreferenceConstants;
import org.eclipse.jdt.ui.text.IJavaPartitions;
import org.eclipse.jdt.ui.text.JavaTextTools;

import org.eclipse.jdt.internal.ui.JavaPlugin;
import org.eclipse.jdt.internal.ui.javaeditor.JavaEditor;
import org.eclipse.jdt.internal.ui.javaeditor.JavaSourceViewer;
import org.eclipse.jdt.internal.ui.text.SimpleJavaSourceViewerConfiguration;
import org.eclipse.jdt.internal.ui.text.template.contentassist.TemplateProposal;
import org.eclipse.jdt.internal.ui.text.template.preferences.TemplateVariableProcessor;

/**
 * A TemplatesPage implementation for Java CompilationUnitEditor
 * 
 * @author kd
 */
public class JavaTemplatesPage extends TemplatesPage {

	private static final ContextTypeRegistry TEMPLATE_CONTEXT_REGISTRY= JavaPlugin.getDefault().getTemplateContextRegistry();
	private TemplateVariableProcessor fTemplateProcessor;
	private ScrolledPageContent fScrolled;
	private final JavaEditor fEditor;
	private IDocument fDocument;
	private String fJavaDocId;
	private String fJavaId;
	private String fCurrentId;

	/**
	 * @param javaEditor
	 */
	public JavaTemplatesPage(JavaEditor javaEditor) {
		fEditor= javaEditor;
		setTemplateStore(JavaPlugin.getDefault().getTemplateStore(), JavaPlugin.getDefault().getPreferenceStore());
		setContextTypeRegistry(TEMPLATE_CONTEXT_REGISTRY);
		fJavaDocId= new JavaDocContextType().getId();
		fJavaId= new JavaContextType().getId();
		fTemplateProcessor= new TemplateVariableProcessor();
		fDocument= fEditor.getDocumentProvider().getDocument(fEditor.getEditorInput());
		cursorPositionChanged();
		setupEditorDropTarget(fEditor.getSite(), fEditor.getViewer().getTextWidget());
	}

	public void dispose() {
		super.dispose();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.texteditor.templates.TemplatesPage#createControl(org.eclipse.swt.widgets.Composite)
	 */
	public void createControl(Composite ancestor) {
		fScrolled= new ScrolledPageContent(ancestor, SWT.H_SCROLL | SWT.V_SCROLL);
		fScrolled.setExpandHorizontal(true);
		fScrolled.setExpandVertical(true);

		super.createControl(fScrolled);
		Control control= super.getControl();

		fScrolled.setContent(control);
		final Point size= control.computeSize(SWT.DEFAULT, SWT.DEFAULT);
		fScrolled.setMinSize(size.x, size.y);
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.texteditor.templates.TemplatesPage#editTemplate(org.eclipse.jface.text.templates.Template, boolean, boolean)
	 */
	protected Template editTemplate(Template template, boolean edit, boolean isNameModifiable) {
		EditTemplateDialog dialog= new EditTemplateDialog(getShell(), template, edit, isNameModifiable, getContextTypeRegistry());
		if (dialog.open() == Window.OK) {
			return dialog.getTemplate();
		}
		return null;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.texteditor.templates.TemplatesPage#createViewer(org.eclipse.swt.widgets.Composite)
	 */
	protected SourceViewer createViewer(Composite parent) {
		IDocument document= new Document();
		JavaTextTools tools= JavaPlugin.getDefault().getJavaTextTools();
		tools.setupJavaDocumentPartitioner(document, IJavaPartitions.JAVA_PARTITIONING);
		IPreferenceStore store= JavaPlugin.getDefault().getCombinedPreferenceStore();
		SourceViewer viewer= new JavaSourceViewer(parent, null, null, false, SWT.BORDER | SWT.V_SCROLL | SWT.H_SCROLL, store);
		SimpleJavaSourceViewerConfiguration configuration= new SimpleJavaSourceViewerConfiguration(tools.getColorManager(), store, null, IJavaPartitions.JAVA_PARTITIONING, false);
		viewer.configure(configuration);
		viewer.setEditable(false);
		viewer.setDocument(document);

		Font font= JFaceResources.getFont(PreferenceConstants.EDITOR_TEXT_FONT);
		viewer.getTextWidget().setFont(font);
		new JavaSourcePreviewerUpdater(viewer, configuration, store);

		Control control= viewer.getControl();
		GridData data= new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.FILL_VERTICAL);
		control.setLayoutData(data);

		return viewer;
	}


	/* (non-Javadoc)
	 * @see org.eclipse.ui.texteditor.templates.TemplatesPage#updateViewerInput(org.eclipse.jface.text.templates.Template)
	 */
	protected void updateViewerInput(Template template) {
		SourceViewer viewer= getViewer();

		String contextId= template.getContextTypeId();
		TemplateContextType type= TEMPLATE_CONTEXT_REGISTRY.getContextType(contextId);
		fTemplateProcessor.setContextType(type);

		IDocument doc= viewer.getDocument();

		String start= null;
		if ("javadoc".equals(contextId)) { //$NON-NLS-1$
			start= "/**" + doc.getLegalLineDelimiters()[0]; //$NON-NLS-1$
		} else
			start= ""; //$NON-NLS-1$

		doc.set(start + template.getPattern());
		int startLen= start.length();
		viewer.setDocument(doc, startLen, doc.getLength() - startLen);
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.texteditor.templates.TemplatesPage#getControl()
	 */
	public Control getControl() {
		return fScrolled;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.part.Page#setFocus()
	 */
	public void setFocus() {
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.texteditor.templates.TemplatesPage#getPreferencePageId()
	 */
	protected String getPreferencePageId() {
		return "org.eclipse.jdt.ui.preferences.JavaTemplatePreferencePage"; //$NON-NLS-1$
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.texteditor.templates.TemplatesPage#insertTemplate(org.eclipse.jface.text.templates.Template)
	 */
	public void insertTemplate(Template template) {
		if (!fEditor.isEditorInputModifiable())
			return;
		TemplateContextType type= TEMPLATE_CONTEXT_REGISTRY.getContextType(template.getContextTypeId());
		if (type == null)
			return;
		ISourceViewer contextViewer= fEditor.getViewer();
		ITextSelection textSelection= (ITextSelection) contextViewer.getSelectionProvider().getSelection();
		IDocument document= contextViewer.getDocument();
		/*
		 * The Editor checks whether a completion for a word exists before it allows for the template to be
		 * applied. We pickup the current text at the selection position and replace it with the first char
		 * of the template name for this to succeed.
		 * We don't need to go through this, if the editors simply support applyTemplate(Template).
		 */
		String savedText;
		try {
			savedText= document.get(textSelection.getOffset(), textSelection.getLength());
			document.replace(textSelection.getOffset(), textSelection.getLength(), template.getName().substring(0, 1));
		} catch (BadLocationException e) {
			e.printStackTrace();
			return;
		}
		Position position= new Position(textSelection.getOffset() + 1, 0);
		Region region= new Region(textSelection.getOffset() + 1, 0);
		contextViewer.getSelectionProvider().setSelection(new TextSelection(textSelection.getOffset(), 1));
		ICompilationUnit compilationUnit= JavaCore.createCompilationUnitFrom(((FileEditorInput) fEditor.getEditorInput()).getFile());

		CompilationUnitContext context= ((CompilationUnitContextType) type).createContext(document, position, compilationUnit);
		context.setVariable("selection", savedText); //$NON-NLS-1$
		if (context.getKey().length() == 0) {
			try {
				document.replace(textSelection.getOffset(), 1, savedText);
			} catch (BadLocationException e) {
				e.printStackTrace();
				return;
			}
		}
		TemplateProposal proposal= new TemplateProposal(template, context, region, null);
		PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().activate(fEditor);
		proposal.apply(fEditor.getViewer(), ' ', 0, region.getOffset());
	}

	/**
	 * Invoked by the editor whenever the caret position is updated
	 */
	public void cursorPositionChanged() {
		Point selectedRange= fEditor.getViewer().getSelectedRange();
		int cursor= selectedRange.x + selectedRange.y;
		String partition;
		try {
			partition= TextUtilities.getContentType(fDocument, IJavaPartitions.JAVA_PARTITIONING, cursor, true);
		} catch (BadLocationException e) {
			return;
		}
		String id= fJavaId;
		if (partition.equals(IJavaPartitions.JAVA_DOC))
			id= fJavaDocId;
		if (!id.equals(fCurrentId)) {
			fCurrentId= id;
			contextTypeChanged(new String[] { id });
		}
	}
}

Return to bug 69581

Lines 34-39 Link Here

(-)Ant Editor/org/eclipse/ant/internal/ui/editor/AntEditor.java (-1 / +70 lines)
34	import org.eclipse.ant.internal.ui.editor.actions.RunToLineAdapter;	34	import org.eclipse.ant.internal.ui.editor.actions.RunToLineAdapter;
35	import org.eclipse.ant.internal.ui.editor.actions.ToggleLineBreakpointAction;	35	import org.eclipse.ant.internal.ui.editor.actions.ToggleLineBreakpointAction;
36	import org.eclipse.ant.internal.ui.editor.outline.AntEditorContentOutlinePage;	36	import org.eclipse.ant.internal.ui.editor.outline.AntEditorContentOutlinePage;
		37	import org.eclipse.ant.internal.ui.editor.templates.AntTemplatesPage;
37	import org.eclipse.ant.internal.ui.editor.text.AntEditorDocumentProvider;	38	import org.eclipse.ant.internal.ui.editor.text.AntEditorDocumentProvider;
38	import org.eclipse.ant.internal.ui.editor.text.AntFoldingStructureProvider;	39	import org.eclipse.ant.internal.ui.editor.text.AntFoldingStructureProvider;
39	import org.eclipse.ant.internal.ui.editor.text.IReconcilingParticipant;	40	import org.eclipse.ant.internal.ui.editor.text.IReconcilingParticipant;
Lines 71-76 Link Here
71	import org.eclipse.jface.text.ISelectionValidator;	72	import org.eclipse.jface.text.ISelectionValidator;
72	import org.eclipse.jface.text.ISynchronizable;	73	import org.eclipse.jface.text.ISynchronizable;
73	import org.eclipse.jface.text.ITextInputListener;	74	import org.eclipse.jface.text.ITextInputListener;
		75	import org.eclipse.jface.text.ITextOperationTarget;
74	import org.eclipse.jface.text.ITextSelection;	76	import org.eclipse.jface.text.ITextSelection;
75	import org.eclipse.jface.text.ITextViewer;	77	import org.eclipse.jface.text.ITextViewer;
76	import org.eclipse.jface.text.Position;	78	import org.eclipse.jface.text.Position;
Lines 85-90 Link Here
85	import org.eclipse.jface.text.source.projection.IProjectionListener;	87	import org.eclipse.jface.text.source.projection.IProjectionListener;
86	import org.eclipse.jface.text.source.projection.ProjectionSupport;	88	import org.eclipse.jface.text.source.projection.ProjectionSupport;
87	import org.eclipse.jface.text.source.projection.ProjectionViewer;	89	import org.eclipse.jface.text.source.projection.ProjectionViewer;
		90	import org.eclipse.jface.text.templates.Template;
88	import org.eclipse.jface.util.PropertyChangeEvent;	91	import org.eclipse.jface.util.PropertyChangeEvent;
89	import org.eclipse.jface.viewers.IPostSelectionProvider;	92	import org.eclipse.jface.viewers.IPostSelectionProvider;
90	import org.eclipse.jface.viewers.ISelection;	93	import org.eclipse.jface.viewers.ISelection;
Lines 93-98 Link Here
93	import org.eclipse.jface.viewers.IStructuredSelection;	96	import org.eclipse.jface.viewers.IStructuredSelection;
94	import org.eclipse.jface.viewers.SelectionChangedEvent;	97	import org.eclipse.jface.viewers.SelectionChangedEvent;
95	import org.eclipse.swt.custom.StyledText;	98	import org.eclipse.swt.custom.StyledText;
		99	import org.eclipse.swt.dnd.Clipboard;
96	import org.eclipse.swt.events.ShellAdapter;	100	import org.eclipse.swt.events.ShellAdapter;
97	import org.eclipse.swt.events.ShellEvent;	101	import org.eclipse.swt.events.ShellEvent;
98	import org.eclipse.swt.graphics.Image;	102	import org.eclipse.swt.graphics.Image;
Lines 112-127 Link Here
112	import org.eclipse.ui.texteditor.ContentAssistAction;	116	import org.eclipse.ui.texteditor.ContentAssistAction;
113	import org.eclipse.ui.texteditor.IDocumentProvider;	117	import org.eclipse.ui.texteditor.IDocumentProvider;
114	import org.eclipse.ui.texteditor.IEditorStatusLine;	118	import org.eclipse.ui.texteditor.IEditorStatusLine;
		119	import org.eclipse.ui.texteditor.ITextEditor;
115	import org.eclipse.ui.texteditor.ITextEditorActionConstants;	120	import org.eclipse.ui.texteditor.ITextEditorActionConstants;
116	import org.eclipse.ui.texteditor.ITextEditorActionDefinitionIds;	121	import org.eclipse.ui.texteditor.ITextEditorActionDefinitionIds;
		122	import org.eclipse.ui.texteditor.IWorkbenchActionDefinitionIds;
		123	import org.eclipse.ui.texteditor.TextEditorAction;
117	import org.eclipse.ui.texteditor.TextOperationAction;	124	import org.eclipse.ui.texteditor.TextOperationAction;
		125	import org.eclipse.ui.texteditor.templates.TemplateTransfer;
118	import org.eclipse.ui.views.contentoutline.ContentOutline;	126	import org.eclipse.ui.views.contentoutline.ContentOutline;
119	import org.eclipse.ui.views.contentoutline.IContentOutlinePage;	127	import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
		128	import org.eclipse.ui.views.templates.ITemplatesPage;
120		129
121	/**	130	/**
122	* The actual editor implementation for Eclipse's Ant integration.	131	* The actual editor implementation for Eclipse's Ant integration.
123	*/	132	*/
124	public class AntEditor extends TextEditor implements IReconcilingParticipant, IProjectionListener {	133	public class AntEditor extends TextEditor implements IReconcilingParticipant, IProjectionListener {
		134
		135	class ClipboardPasteOperation extends TextEditorAction {
		136	private ITextOperationTarget fOperationTarget;
		137	private int fOperationCode = -1;
		138
		139	protected ClipboardPasteOperation(ResourceBundle bundle, String prefix, ITextEditor editor,
		140	int style) {
		141	super(bundle, prefix, editor, style);
		142	}
		143
		144	public void run() {
		145	ITextEditor editor = getTextEditor();
		146	Clipboard clipboard = new Clipboard(getSite().getShell().getDisplay());
		147	Template[] templates = (Template[]) clipboard.getContents(TemplateTransfer
		148	.getInstance());
		149	if (templates != null) {
		150	AntTemplatesPage page = (AntTemplatesPage) editor.getAdapter(ITemplatesPage.class);
		151	page.insertTemplate(templates[0]);
		152	} else
		153	fOperationTarget.doOperation(fOperationCode);
		154	}
		155
		156	/*
		157	* (non-Javadoc)
		158	*
		159	* @see org.eclipse.ui.texteditor.IUpdate#update()
		160	*/
		161	public void update() {
		162	super.update();
		163	}
		164
		165	}
		166
		167
125	/**	168	/**
126	* Updates the Ant outline page selection and this editor's range indicator.	169	* Updates the Ant outline page selection and this editor's range indicator.
127	*	170	*
Lines 461-467 Link Here
461	* The page that shows the outline.	504	* The page that shows the outline.
462	*/	505	*/
463	protected AntEditorContentOutlinePage fOutlinePage;	506	protected AntEditorContentOutlinePage fOutlinePage;
464		507	/**
		508	* The templates page
		509	*/
		510	protected AntTemplatesPage fTemplatesPage;
465		511
466	private boolean fInitialReconcile= true;	512	private boolean fInitialReconcile= true;
467		513
Lines 538-543 Link Here
538	action= new RenameInFileAction(this);	584	action= new RenameInFileAction(this);
539	action.setActionDefinitionId("org.eclipse.ant.ui.renameInFile"); //$NON-NLS-1$	585	action.setActionDefinitionId("org.eclipse.ant.ui.renameInFile"); //$NON-NLS-1$
540	setAction("renameInFile", action); //$NON-NLS-1$	586	setAction("renameInFile", action); //$NON-NLS-1$
		587
		588	// Override the TextEditor paste operation to support templates
		589	action = new ClipboardPasteOperation(bundle,
		590	"Editor.Paste.", this, ITextOperationTarget.PASTE); //$NON-NLS-1$
		591	action.setActionDefinitionId(IWorkbenchActionDefinitionIds.PASTE);
		592	setAction(ITextEditorActionConstants.PASTE, action);
541	}	593	}
542		594
543	/*	595	/*
Lines 564-569 Link Here
564	return getOutlinePage();	616	return getOutlinePage();
565	}	617	}
566		618
		619	if (key.equals(ITemplatesPage.class)) {
		620	return getTemplatesPage();
		621	}
		622
567	if (fProjectionSupport != null) {	623	if (fProjectionSupport != null) {
568	Object adapter= fProjectionSupport.getAdapter(getSourceViewer(), key);	624	Object adapter= fProjectionSupport.getAdapter(getSourceViewer(), key);
569	if (adapter != null) {	625	if (adapter != null) {
Lines 599-604 Link Here
599	return fOutlinePage;	655	return fOutlinePage;
600	}	656	}
601		657
		658	private AntTemplatesPage getTemplatesPage() {
		659	if (fTemplatesPage == null) {
		660	fTemplatesPage = new AntTemplatesPage(this);
		661	}
		662	return fTemplatesPage;
		663	}
		664
		665	protected void handleCursorPositionChanged() {
		666	super.handleCursorPositionChanged();
		667	if (fTemplatesPage != null)
		668	fTemplatesPage.cursorPositionChanged();
		669	}
		670
602	private void doSelectionChanged(SelectionChangedEvent selectionChangedEvent) {	671	private void doSelectionChanged(SelectionChangedEvent selectionChangedEvent) {
603	IStructuredSelection selection= (IStructuredSelection)selectionChangedEvent.getSelection();	672	IStructuredSelection selection= (IStructuredSelection)selectionChangedEvent.getSelection();
604		673

Added Link Here

(-)Ant (+186 lines)
1	/*******************************************************************************
2	* Copyright (c) 2000, 2005 John-Mason P. Shackelford and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* John-Mason P. Shackelford - initial API and implementation
10	* IBM Corporation - bug fixes
11	*******************************************************************************/
12	package org.eclipse.ant.internal.ui.editor.templates;
13
14	import org.eclipse.ant.internal.ui.AntUIPlugin;
15	import org.eclipse.ant.internal.ui.editor.AntEditor;
16	import org.eclipse.ant.internal.ui.editor.formatter.FormattingPreferences;
17	import org.eclipse.ant.internal.ui.editor.formatter.XmlFormatter;
18	import org.eclipse.ant.internal.ui.editor.text.AntDocumentSetupParticipant;
19	import org.eclipse.ant.internal.ui.preferences.AntEditorPreferenceConstants;
20	import org.eclipse.jface.resource.JFaceResources;
21	import org.eclipse.jface.text.Document;
22	import org.eclipse.jface.text.IDocument;
23	import org.eclipse.jface.text.IRegion;
24	import org.eclipse.jface.text.ITextSelection;
25	import org.eclipse.jface.text.Position;
26	import org.eclipse.jface.text.Region;
27	import org.eclipse.jface.text.source.ISourceViewer;
28	import org.eclipse.jface.text.source.SourceViewer;
29	import org.eclipse.jface.text.source.SourceViewerConfiguration;
30	import org.eclipse.jface.text.templates.ContextTypeRegistry;
31	import org.eclipse.jface.text.templates.Template;
32	import org.eclipse.jface.text.templates.TemplateContextType;
33	import org.eclipse.swt.SWT;
34	import org.eclipse.swt.graphics.Font;
35	import org.eclipse.swt.graphics.Point;
36	import org.eclipse.swt.widgets.Composite;
37	import org.eclipse.ui.PlatformUI;
38	import org.eclipse.ui.texteditor.templates.TemplatesPage;
39
40	/**
41	* An implementation of TemplatesPage for AntEditor
42	*
43	* @see TemplatesPage
44	*/
45	public class AntTemplatesPage extends TemplatesPage {
46
47	private static final ContextTypeRegistry CONTEXT_TYPE_REGISTRY = AntTemplateAccess
48	.getDefault().getContextTypeRegistry();
49	private FormattingPreferences fFormattingPreferences = new FormattingPreferences();
50	private final AntEditor fEditor;
51	private String fCurrentId;
52
53	/**
54	* Constructor
55	*
56	* @param editor
57	*/
58	public AntTemplatesPage(AntEditor editor) {
59	fEditor = editor;
60	setTemplateStore(AntTemplateAccess.getDefault().getTemplateStore(),
61	AntUIPlugin.getDefault().getPreferenceStore());
62	setContextTypeRegistry(CONTEXT_TYPE_REGISTRY);
63	cursorPositionChanged();
64	setupEditorDropTarget(fEditor.getSite(), fEditor.getViewer()
65	.getTextWidget());
66	}
67
68	/*
69	* (non-Javadoc)
70	*
71	* @see org.eclipse.ui.texteditor.templates.TemplatePreferencePage#createViewer(org.eclipse.swt.widgets.Composite)
72	*/
73	protected SourceViewer createViewer(Composite parent) {
74	SourceViewer viewer = new SourceViewer(parent, null, SWT.BORDER
75	\| SWT.V_SCROLL \| SWT.H_SCROLL);
76
77	SourceViewerConfiguration configuration = new AntTemplateViewerConfiguration();
78	IDocument document = new Document();
79	new AntDocumentSetupParticipant().setup(document);
80	viewer.configure(configuration);
81	viewer.setDocument(document);
82	viewer.setEditable(false);
83	Font font = JFaceResources.getFont(JFaceResources.TEXT_FONT);
84	viewer.getTextWidget().setFont(font);
85
86	return viewer;
87	}
88
89	/*
90	* (non-Javadoc)
91	*
92	* @see org.eclipse.ui.texteditor.templates.TemplatePreferencePage#getFormatterPreferenceKey()
93	*/
94	protected String getFormatterPreferenceKey() {
95	return AntEditorPreferenceConstants.TEMPLATES_USE_CODEFORMATTER;
96	}
97
98	/*
99	* @see org.eclipse.ui.texteditor.templates.TemplatePreferencePage#updateViewerInput()
100	*/
101	protected void updateViewerInput(Template template) {
102	SourceViewer viewer = getViewer();
103
104	if (AntUIPlugin.getDefault().getPreferenceStore().getBoolean(
105	getFormatterPreferenceKey())) {
106	String formatted = XmlFormatter.format(template.getPattern(),
107	fFormattingPreferences);
108	viewer.getDocument().set(formatted);
109	} else {
110	viewer.getDocument().set(template.getPattern());
111	}
112	}
113
114	/*
115	* (non-Javadoc)
116	*
117	* @see org.eclipse.ui.part.Page#setFocus()
118	*/
119	public void setFocus() {
120	}
121
122	/*
123	* (non-Javadoc)
124	*
125	* @see org.eclipse.ui.texteditor.templates.TemplatesPage#getPreferencePageId()
126	*/
127	protected String getPreferencePageId() {
128	return "org.eclipse.ant.ui.TemplatesPreferencePage"; //$NON-NLS-1$
129	}
130
131	/*
132	* (non-Javadoc)
133	*
134	* @see org.eclipse.ui.texteditor.templates.TemplatesPage#insertTemplate(org.eclipse.jface.text.templates.Template)
135	*/
136	public void insertTemplate(Template template) {
137	IRegion region;
138	TemplateContextType type = CONTEXT_TYPE_REGISTRY
139	.getContextType(template.getContextTypeId());
140	if (type == null)
141	return;
142	ISourceViewer contextViewer = fEditor.getViewer();
143	ITextSelection textSelection = (ITextSelection) contextViewer
144	.getSelectionProvider().getSelection();
145	region = new Region(textSelection.getOffset(), textSelection
146	.getLength());
147	Point selection = contextViewer.getSelectedRange();
148	Position position;
149	if (selection.y > 0) {
150	position = new Position(selection.x, selection.y);
151	} else {
152	position = new Position(region.getOffset(), region.getLength());
153	}
154
155	IDocument document = contextViewer.getDocument();
156	AntContext context = new AntContext(type, document, fEditor
157	.getAntModel(), position);
158	context.setVariable("selection", textSelection.getText()); //$NON-NLS-1$
159	AntTemplateProposal proposal = new AntTemplateProposal(template,
160	context, region, null, 100);
161	PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage()
162	.activate(fEditor);
163	proposal.apply(fEditor.getViewer(), ' ', 0, region.getOffset());
164	}
165
166	/**
167	* Invoked by the editor whenever the caret position is updated
168	*/
169	public void cursorPositionChanged() {
170	String id;
171	if (fEditor.getDocumentProvider().getDocument(fEditor.getEditorInput())
172	.getLength() == 0)
173	id = BuildFileContextType.BUILDFILE_CONTEXT_TYPE;
174	else
175	id = TargetContextType.TARGET_CONTEXT_TYPE;
176	if (id.equals(fCurrentId))
177	return;
178	fCurrentId = id;
179	if (fCurrentId.equals(BuildFileContextType.BUILDFILE_CONTEXT_TYPE))
180	contextTypeChanged(new String[] { BuildFileContextType.BUILDFILE_CONTEXT_TYPE });
181	else
182	contextTypeChanged(new String[] {
183	TargetContextType.TARGET_CONTEXT_TYPE,
184	TaskContextType.TASK_CONTEXT_TYPE });
185	}
186	}

Added Link Here

(-)src/org/eclipse/ui/internal/views/templates/TemplatesMessages.java (+21 lines)
1	package org.eclipse.ui.internal.views.templates;
2
3	import org.eclipse.osgi.util.NLS;
4
5	/**
6	* TemplatesMessages is the message class for the messages used in the templates view.
7	*
8	*/
9	public class TemplatesMessages extends NLS {
10	private static final String BUNDLE_NAME = "org.eclipse.ui.internal.views.templates.TemplatesMessages"; //$NON-NLS-1$
11
12	// Default message for an empty templates view
13	public static String Templates_defaultMessage;
14	static {
15	// initialize resource bundle
16	NLS.initializeMessages(BUNDLE_NAME, TemplatesMessages.class);
17	}
18
19	private TemplatesMessages() {
20	}
21	}

Added Link Here

(-)src/org/eclipse/ui/views/templates/Templates.java (+183 lines)
1	/*******************************************************************************
2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11
12	package org.eclipse.ui.views.templates;
13
14	import org.eclipse.swt.widgets.Composite;
15	import org.eclipse.ui.IEditorPart;
16	import org.eclipse.ui.IWorkbenchPage;
17	import org.eclipse.ui.IWorkbenchPart;
18	import org.eclipse.ui.PlatformUI;
19	import org.eclipse.ui.internal.views.ViewsPlugin;
20	import org.eclipse.ui.internal.views.templates.TemplatesMessages;
21	import org.eclipse.ui.part.IContributedContentsView;
22	import org.eclipse.ui.part.IPage;
23	import org.eclipse.ui.part.MessagePage;
24	import org.eclipse.ui.part.PageBook;
25	import org.eclipse.ui.part.PageBookView;
26
27	/**
28	* Main class for the Templates View.
29	* <p>
30	* This standard view has id <code>"org.eclipse.ui.views.TemplatesView"</code>.
31	* </p>
32	* When a <b>templates view</b> notices an editor being activated, it
33	* asks the editor whether it has a <b>template page</b> to include
34	* in the templates view. This is done using <code>getAdapter</code>:
35	* <pre>
36	* IEditorPart editor = ...;
37	* ITemplatePage templatePage = (ITemplatePage) editor.getAdapter(ITemplatePage.class);
38	* if (templatePage != null) {
39	* // editor wishes to contribute templatePage to templates view
40	* }
41	* </pre>
42	* If the editor supports a templates page, the editor instantiates
43	* and configures the page, and returns it. This page is then added to the
44	* templates view (a pagebook which presents one page at a time) and
45	* immediately made the current page (the templates view need not be
46	* visible). If the editor does not support a template page, the templates
47	* view shows a special default page which makes it clear to the user
48	* that the templates view is disengaged. When the templates view notices a
49	* different editor being activated, it flips to the editor's corresponding
50	* template page. When the templates view notices an editor being
51	* closed, it may destroy the editor's corresponding content outline page.
52	* </p>
53	* <p>
54	* The workbench will automatically instantiate this class when a templates
55	* view is needed for a workbench window. This class was not intended
56	* to be instantiated or subclassed by clients.
57	* </p>
58	*/
59	public class Templates extends PageBookView {
60	/**
61	* The plugin prefix.
62	*/
63	public static final String PREFIX = PlatformUI.PLUGIN_ID + "."; //$NON-NLS-1$
64
65	/**
66	* Help context id used for the content outline view
67	* (value <code>"org.eclipse.ui.content_outline_context"</code>).
68	*/
69	public static final String TEMPLATES_VIEW_HELP_CONTEXT_ID = PREFIX
70	+ "templates_view_context";//$NON-NLS-1$
71
72	/**
73	* Message to show on the default page.
74	*/
75	private String defaultText = TemplatesMessages.Templates_defaultMessage;
76
77	/**
78	* Creates a content outline view with no content outline pages.
79	*/
80	public Templates() {
81	super();
82	}
83
84	/* (non-Javadoc)
85	* Method declared on PageBookView.
86	*/
87	protected IPage createDefaultPage(PageBook book) {
88	MessagePage page = new MessagePage();
89	initPage(page);
90	page.createControl(book);
91	page.setMessage(defaultText);
92	return page;
93	}
94
95	/**
96	* The <code>PageBookView</code> implementation of this <code>IWorkbenchPart</code>
97	* method creates a <code>PageBook</code> control with its default page showing.
98	*/
99	public void createPartControl(Composite parent) {
100	super.createPartControl(parent);
101	PlatformUI.getWorkbench().getHelpSystem().setHelp(getPageBook(),
102	TEMPLATES_VIEW_HELP_CONTEXT_ID);
103	}
104
105	/* (non-Javadoc)
106	* Method declared on PageBookView.
107	*/
108	protected PageRec doCreatePage(IWorkbenchPart part) {
109	// Try to get template page.
110	Object obj = ViewsPlugin.getAdapter(part, ITemplatesPage.class, false);
111	if (obj instanceof ITemplatesPage) {
112	ITemplatesPage page = (ITemplatesPage) obj;
113	initPage(page);
114	page.createControl(getPageBook());
115	return new PageRec(part, page);
116	}
117	// There is no template page
118	return null;
119	}
120
121	/* (non-Javadoc)
122	* Method declared on PageBookView.
123	*/
124	protected void doDestroyPage(IWorkbenchPart part, PageRec rec) {
125	ITemplatesPage page = (ITemplatesPage) rec.page;
126	page.dispose();
127	rec.dispose();
128	}
129
130	/* (non-Javadoc)
131	* Method declared on IAdaptable.
132	*/
133	public Object getAdapter(Class key) {
134	if (key == IContributedContentsView.class) {
135	return new IContributedContentsView() {
136	public IWorkbenchPart getContributingPart() {
137	return getContributingEditor();
138	}
139	};
140	}
141	return super.getAdapter(key);
142	}
143
144	/* (non-Javadoc)
145	* Method declared on PageBookView.
146	*/
147	protected IWorkbenchPart getBootstrapPart() {
148	IWorkbenchPage page = getSite().getPage();
149	if (page != null) {
150	return page.getActiveEditor();
151	}
152
153	return null;
154	}
155
156	/**
157	* Returns the editor which contributed the current
158	* page to this view.
159	*
160	* @return the editor which contributed the current page
161	* or <code>null</code> if no editor contributed the current page
162	*/
163	private IWorkbenchPart getContributingEditor() {
164	return getCurrentContributingPart();
165	}
166
167	/* (non-Javadoc)
168	* Method declared on PageBookView.
169	* We only want to track editors.
170	*/
171	protected boolean isImportant(IWorkbenchPart part) {
172	//We only care about editors
173	return (part instanceof IEditorPart);
174	}
175
176	/* (non-Javadoc)
177	* Method declared on IViewPart.
178	* Treat this the same as part activation.
179	*/
180	public void partBroughtToTop(IWorkbenchPart part) {
181	partActivated(part);
182	}
183	}

Added Link Here

(-)src/org/eclipse/ui/views/templates/ITemplatesPage.java (+13 lines)
1	package org.eclipse.ui.views.templates;
2
3	import org.eclipse.ui.part.IPageBookViewPage;
4
5	/**
6	* Interface for a template page. This interface defines
7	* the minimum requirement for pages within the templates view, namely
8	* they must be pages (implement <code>IPageBookViewPage</code>).
9	*
10	* @see TemplatesView
11	*/
12	public interface ITemplatesPage extends IPageBookViewPage {
13	}

Lines 20-30 Link Here

(-)src/org/eclipse/ui/texteditor/templates/TextEditorTemplateMessages.java (-1 / +24 lines)
20	final class TextEditorTemplateMessages extends NLS {	20	final class TextEditorTemplateMessages extends NLS {
21		21
22	private static final String BUNDLE_NAME= TextEditorTemplateMessages.class.getName();	22	private static final String BUNDLE_NAME= TextEditorTemplateMessages.class.getName();
23
24	private TextEditorTemplateMessages() {	23	private TextEditorTemplateMessages() {
25	// Do not instantiate	24	// Do not instantiate
26	}	25	}
27		26
		27	// TemplatesView
		28	public static String TemplatesPage_collapse_expand;
		29	public static String TemplatesPage_column_context;
		30	public static String TemplatesPage_column_description;
		31	public static String TemplatesPage_column_name;
		32	public static String TemplatesPage_insert;
		33	public static String TemplatesPage_edit;
		34	public static String TemplatesPage_paste_description;
		35	public static String TemplatesPage_preference_page;
		36	public static String TemplatesPage_link_to_editor;
		37	public static String TemplatesPage_new;
		38	public static String TemplatesPage_preview;
		39	public static String TemplatesPage_question_create_new_message;
		40	public static String TemplatesPage_question_create_new_title;
		41	public static String TemplatesPage_remove;
		42	public static String TemplatesPage_save_error_message;
		43	public static String TemplatesPage_snippet;
		44	public static String TemplatesPage_show_disabled;
		45	public static String TemplatesPage_show_new_dialog;
		46	public static String TemplatesPage_context_description;
		47	public static String TemplatesPage_remove_message;
		48	public static String TemplatesPage_remove_title;
		49
		50	// TemplatePreferencePage
28	public static String TemplatePreferencePage_error_import;	51	public static String TemplatePreferencePage_error_import;
29	public static String TemplatePreferencePage_error_export;	52	public static String TemplatePreferencePage_error_export;
30	public static String TemplatePreferencePage_error_read_title;	53	public static String TemplatePreferencePage_error_read_title;

Lines 9-14 Link Here

(-)src/org/eclipse/ui/texteditor/templates/TextEditorTemplateMessages.properties (+23 lines)
9	# IBM Corporation - initial API and implementation	9	# IBM Corporation - initial API and implementation
10	###############################################################################	10	###############################################################################
11		11
		12	# templates page (view)
		13	TemplatesPage_collapse_expand=Collapse or Expand
		14	TemplatesPage_column_context=Context
		15	TemplatesPage_column_description=Description
		16	TemplatesPage_save_error_message=Error Saving the Templates
		17	TemplatesPage_column_name=Name
		18	TemplatesPage_edit=&Edit...
		19	TemplatesPage_insert=&Insert...
		20	TemplatesPage_preference_page=&Preference Page...
		21	TemplatesPage_paste_description=Pasted from editor
		22	TemplatesPage_link_to_editor=Link to Editor
		23	TemplatesPage_new=&New...
		24	TemplatesPage_preview=Previe&w:
		25	TemplatesPage_snippet=snippet
		26	TemplatesPage_question_create_new_message= The name of the template has been changed. Click 'Yes' to create an additional template with the new name or 'No' to rename the existing one.
		27	TemplatesPage_context_description=Context
		28	TemplatesPage_remove_title=Removing Templates
		29	TemplatesPage_remove_message=Are you sure you want to remove the selected templates?
		30	TemplatesPage_question_create_new_title= Edit Template
		31	TemplatesPage_remove=&Remove
		32	TemplatesPage_show_disabled=&Show Disabled
		33	TemplatesPage_show_new_dialog=S&how New Dialog on Drop
		34
12	# preference page	35	# preference page
13	TemplatePreferencePage_error_import=Failed to import templates.	36	TemplatePreferencePage_error_import=Failed to import templates.
14	TemplatePreferencePage_error_export=Failed to export templates.	37	TemplatePreferencePage_error_export=Failed to export templates.

Added Link Here

(-)src/org/eclipse/ui/texteditor/templates/EditTemplateDialog.java (+598 lines)
1	package org.eclipse.ui.texteditor.templates;
2
3	import java.util.ArrayList;
4	import java.util.HashMap;
5	import java.util.Iterator;
6	import java.util.List;
7	import java.util.Map;
8
9	import org.eclipse.jface.action.Action;
10	import org.eclipse.jface.action.GroupMarker;
11	import org.eclipse.jface.action.IAction;
12	import org.eclipse.jface.action.IMenuListener;
13	import org.eclipse.jface.action.IMenuManager;
14	import org.eclipse.jface.action.MenuManager;
15	import org.eclipse.jface.action.Separator;
16	import org.eclipse.jface.dialogs.IDialogSettings;
17	import org.eclipse.jface.dialogs.StatusDialog;
18	import org.eclipse.jface.text.Document;
19	import org.eclipse.jface.text.IDocument;
20	import org.eclipse.jface.text.ITextListener;
21	import org.eclipse.jface.text.ITextOperationTarget;
22	import org.eclipse.jface.text.ITextViewer;
23	import org.eclipse.jface.text.TextEvent;
24	import org.eclipse.jface.text.contentassist.ContentAssistant;
25	import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
26	import org.eclipse.jface.text.contentassist.IContentAssistant;
27	import org.eclipse.jface.text.source.ISourceViewer;
28	import org.eclipse.jface.text.source.SourceViewer;
29	import org.eclipse.jface.text.source.SourceViewerConfiguration;
30	import org.eclipse.jface.text.templates.ContextTypeRegistry;
31	import org.eclipse.jface.text.templates.Template;
32	import org.eclipse.jface.text.templates.TemplateContextType;
33	import org.eclipse.jface.text.templates.TemplateException;
34	import org.eclipse.jface.viewers.ISelectionChangedListener;
35	import org.eclipse.jface.viewers.SelectionChangedEvent;
36	import org.eclipse.swt.SWT;
37	import org.eclipse.swt.custom.StyledText;
38	import org.eclipse.swt.custom.VerifyKeyListener;
39	import org.eclipse.swt.events.FocusEvent;
40	import org.eclipse.swt.events.FocusListener;
41	import org.eclipse.swt.events.ModifyEvent;
42	import org.eclipse.swt.events.ModifyListener;
43	import org.eclipse.swt.events.SelectionEvent;
44	import org.eclipse.swt.events.SelectionListener;
45	import org.eclipse.swt.events.VerifyEvent;
46	import org.eclipse.swt.layout.GridData;
47	import org.eclipse.swt.layout.GridLayout;
48	import org.eclipse.swt.widgets.Button;
49	import org.eclipse.swt.widgets.Combo;
50	import org.eclipse.swt.widgets.Composite;
51	import org.eclipse.swt.widgets.Control;
52	import org.eclipse.swt.widgets.Label;
53	import org.eclipse.swt.widgets.Menu;
54	import org.eclipse.swt.widgets.Shell;
55	import org.eclipse.swt.widgets.Text;
56	import org.eclipse.swt.widgets.Widget;
57	import org.eclipse.ui.internal.texteditor.TextEditorPlugin;
58	import org.eclipse.ui.texteditor.ITextEditorActionConstants;
59	import org.eclipse.ui.texteditor.IUpdate;
60
61	/**
62	* Dialog to edit a template. Clients will usually instantiate, but
63	* may also extend.
64	*
65	* @since 3.3
66	*/
67	public class EditTemplateDialog extends StatusDialog {
68
69	private class TextViewerAction extends Action implements IUpdate {
70
71	private int fOperationCode= -1;
72	private ITextOperationTarget fOperationTarget;
73
74	/**
75	* Creates a new action.
76	*
77	* @param viewer the viewer
78	* @param operationCode the opcode
79	*/
80	public TextViewerAction(ITextViewer viewer, int operationCode) {
81	fOperationCode= operationCode;
82	fOperationTarget= viewer.getTextOperationTarget();
83	update();
84	}
85
86	/**
87	* Updates the enabled state of the action.
88	* Fires a property change if the enabled state changes.
89	*
90	* @see Action#firePropertyChange(String, Object, Object)
91	*/
92	public void update() {
93
94	boolean wasEnabled= isEnabled();
95	boolean isEnabled= (fOperationTarget != null && fOperationTarget.canDoOperation(fOperationCode));
96	setEnabled(isEnabled);
97
98	if (wasEnabled != isEnabled) {
99	firePropertyChange(ENABLED, wasEnabled ? Boolean.TRUE : Boolean.FALSE, isEnabled ? Boolean.TRUE : Boolean.FALSE);
100	}
101	}
102
103	/**
104	* @see Action#run()
105	*/
106	public void run() {
107	if (fOperationCode != -1 && fOperationTarget != null) {
108	fOperationTarget.doOperation(fOperationCode);
109	}
110	}
111	}
112
113	private final Template fOriginalTemplate;
114
115	private Text fNameText;
116	private Text fDescriptionText;
117	private Combo fContextCombo;
118	private SourceViewer fPatternEditor;
119	private Button fInsertVariableButton;
120	private Button fAutoInsertCheckbox;
121	private boolean fIsNameModifiable;
122
123	private StatusInfo fValidationStatus;
124	private boolean fSuppressError= true; // #4354
125	private Map fGlobalActions= new HashMap(10);
126	private List fSelectionActions = new ArrayList(3);
127	private String[][] fContextTypes;
128
129	private ContextTypeRegistry fContextTypeRegistry;
130
131	private final TemplateVariableProcessor fTemplateProcessor= new TemplateVariableProcessor();
132
133	private Template fNewTemplate;
134
135	/**
136	* Creates a new dialog.
137	*
138	* @param parent the shell parent of the dialog
139	* @param template the template to edit
140	* @param edit whether this is a new template or an existing being edited
141	* @param isNameModifiable whether the name of the template may be modified
142	* @param registry the context type registry to use
143	*/
144	public EditTemplateDialog(Shell parent, Template template, boolean edit, boolean isNameModifiable, ContextTypeRegistry registry) {
145	super(parent);
146
147	setShellStyle(getShellStyle() \| SWT.MAX \| SWT.RESIZE);
148
149	String title= edit
150	? TextEditorTemplateMessages.EditTemplateDialog_title_edit
151	: TextEditorTemplateMessages.EditTemplateDialog_title_new;
152	setTitle(title);
153
154	fOriginalTemplate= template;
155	fIsNameModifiable= isNameModifiable;
156
157	List contexts= new ArrayList();
158	for (Iterator it= registry.contextTypes(); it.hasNext();) {
159	TemplateContextType type= (TemplateContextType) it.next();
160	contexts.add(new String[] { type.getId(), type.getName() });
161	}
162	fContextTypes= (String[][]) contexts.toArray(new String[contexts.size()][]);
163
164	fValidationStatus= new StatusInfo();
165
166	fContextTypeRegistry= registry;
167
168	TemplateContextType type= fContextTypeRegistry.getContextType(template.getContextTypeId());
169	fTemplateProcessor.setContextType(type);
170	}
171
172	/*
173	* @see org.eclipse.ui.texteditor.templates.StatusDialog#create()
174	*/
175	public void create() {
176	super.create();
177	// update initial OK button to be disabled for new templates
178	boolean valid= fNameText == null \|\| fNameText.getText().trim().length() != 0;
179	if (!valid) {
180	StatusInfo status = new StatusInfo();
181	status.setError(TextEditorTemplateMessages.EditTemplateDialog_error_noname);
182	updateButtonsEnableState(status);
183	}
184	}
185
186	/*
187	* @see Dialog#createDialogArea(Composite)
188	*/
189	protected Control createDialogArea(Composite ancestor) {
190	Composite parent= new Composite(ancestor, SWT.NONE);
191	GridLayout layout= new GridLayout();
192	layout.numColumns= 2;
193	parent.setLayout(layout);
194	parent.setLayoutData(new GridData(GridData.FILL_BOTH));
195
196	ModifyListener listener= new ModifyListener() {
197	public void modifyText(ModifyEvent e) {
198	doTextWidgetChanged(e.widget);
199	}
200	};
201
202	if (fIsNameModifiable) {
203	createLabel(parent, TextEditorTemplateMessages.EditTemplateDialog_name);
204
205	Composite composite= new Composite(parent, SWT.NONE);
206	composite.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
207	layout= new GridLayout();
208	layout.numColumns= 4;
209	layout.marginWidth= 0;
210	layout.marginHeight= 0;
211	composite.setLayout(layout);
212
213	fNameText= createText(composite);
214	fNameText.addModifyListener(listener);
215	fNameText.addFocusListener(new FocusListener() {
216
217	public void focusGained(FocusEvent e) {
218	}
219
220	public void focusLost(FocusEvent e) {
221	if (fSuppressError) {
222	fSuppressError= false;
223	updateButtons();
224	}
225	}
226	});
227
228	createLabel(composite, TextEditorTemplateMessages.EditTemplateDialog_context);
229	fContextCombo= new Combo(composite, SWT.READ_ONLY);
230
231	for (int i= 0; i < fContextTypes.length; i++) {
232	fContextCombo.add(fContextTypes[i][1]);
233	}
234
235	fContextCombo.addModifyListener(listener);
236
237	fAutoInsertCheckbox= createCheckbox(composite, TextEditorTemplateMessages.EditTemplateDialog_autoinsert);
238	fAutoInsertCheckbox.setSelection(fOriginalTemplate.isAutoInsertable());
239	}
240
241	createLabel(parent, TextEditorTemplateMessages.EditTemplateDialog_description);
242
243	int descFlags= fIsNameModifiable ? SWT.BORDER : SWT.BORDER \| SWT.READ_ONLY;
244	fDescriptionText= new Text(parent, descFlags );
245	fDescriptionText.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
246
247	fDescriptionText.addModifyListener(listener);
248
249	Label patternLabel= createLabel(parent, TextEditorTemplateMessages.EditTemplateDialog_pattern);
250	patternLabel.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_BEGINNING));
251	fPatternEditor= createEditor(parent, fOriginalTemplate.getPattern());
252
253	Label filler= new Label(parent, SWT.NONE);
254	filler.setLayoutData(new GridData());
255
256	Composite composite= new Composite(parent, SWT.NONE);
257	layout= new GridLayout();
258	layout.marginWidth= 0;
259	layout.marginHeight= 0;
260	composite.setLayout(layout);
261	composite.setLayoutData(new GridData());
262
263	fInsertVariableButton= new Button(composite, SWT.NONE);
264	fInsertVariableButton.setLayoutData(getButtonGridData(fInsertVariableButton));
265	fInsertVariableButton.setText(TextEditorTemplateMessages.EditTemplateDialog_insert_variable);
266	fInsertVariableButton.addSelectionListener(new SelectionListener() {
267	public void widgetSelected(SelectionEvent e) {
268	fPatternEditor.getTextWidget().setFocus();
269	fPatternEditor.doOperation(ISourceViewer.CONTENTASSIST_PROPOSALS);
270	}
271
272	public void widgetDefaultSelected(SelectionEvent e) {}
273	});
274
275	fDescriptionText.setText(fOriginalTemplate.getDescription());
276	if (fIsNameModifiable) {
277	fNameText.setText(fOriginalTemplate.getName());
278	fNameText.addModifyListener(listener);
279	fContextCombo.select(getIndex(fOriginalTemplate.getContextTypeId()));
280	} else {
281	fPatternEditor.getControl().setFocus();
282	}
283	initializeActions();
284
285	applyDialogFont(parent);
286	return composite;
287	}
288
289	private void doTextWidgetChanged(Widget w) {
290	if (w == fNameText) {
291	fSuppressError= false;
292	updateButtons();
293	} else if (w == fContextCombo) {
294	String contextId= getContextId();
295	fTemplateProcessor.setContextType(fContextTypeRegistry.getContextType(contextId));
296	} else if (w == fDescriptionText) {
297	// oh, nothing
298	}
299	}
300
301	private String getContextId() {
302	if (fContextCombo != null && !fContextCombo.isDisposed()) {
303	String name= fContextCombo.getText();
304	for (int i= 0; i < fContextTypes.length; i++) {
305	if (name.equals(fContextTypes[i][1])) {
306	return fContextTypes[i][0];
307	}
308	}
309	}
310
311	return fOriginalTemplate.getContextTypeId();
312	}
313
314	private void doSourceChanged(IDocument document) {
315	String text= document.get();
316	fValidationStatus.setOK();
317	TemplateContextType contextType= fContextTypeRegistry.getContextType(getContextId());
318	if (contextType != null) {
319	try {
320	contextType.validate(text);
321	} catch (TemplateException e) {
322	fValidationStatus.setError(e.getLocalizedMessage());
323	}
324	}
325
326	updateUndoAction();
327	updateButtons();
328	}
329
330	private static GridData getButtonGridData(Button button) {
331	GridData data= new GridData(GridData.FILL_HORIZONTAL);
332	// TODO get some button hints.
333	// data.heightHint= SWTUtil.getButtonHeightHint(button);
334
335	return data;
336	}
337
338	private static Label createLabel(Composite parent, String name) {
339	Label label= new Label(parent, SWT.NULL);
340	label.setText(name);
341	label.setLayoutData(new GridData());
342
343	return label;
344	}
345
346	private static Text createText(Composite parent) {
347	Text text= new Text(parent, SWT.BORDER);
348	text.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
349
350	return text;
351	}
352
353	private static Button createCheckbox(Composite parent, String name) {
354	Button button= new Button(parent, SWT.CHECK);
355	button.setText(name);
356	button.setLayoutData(new GridData());
357
358	return button;
359	}
360
361	private SourceViewer createEditor(Composite parent, String pattern) {
362	SourceViewer viewer= createViewer(parent);
363	viewer.setEditable(true);
364
365	IDocument document= viewer.getDocument();
366	if (document != null)
367	document.set(pattern);
368	else {
369	document= new Document(pattern);
370	viewer.setDocument(document);
371	}
372
373	int nLines= document.getNumberOfLines();
374	if (nLines < 5) {
375	nLines= 5;
376	} else if (nLines > 12) {
377	nLines= 12;
378	}
379
380	Control control= viewer.getControl();
381	GridData data= new GridData(GridData.FILL_BOTH);
382	data.widthHint= convertWidthInCharsToPixels(80);
383	data.heightHint= convertHeightInCharsToPixels(nLines);
384	control.setLayoutData(data);
385
386	viewer.addTextListener(new ITextListener() {
387	public void textChanged(TextEvent event) {
388	if (event .getDocumentEvent() != null)
389	doSourceChanged(event.getDocumentEvent().getDocument());
390	}
391	});
392
393	viewer.addSelectionChangedListener(new ISelectionChangedListener() {
394	public void selectionChanged(SelectionChangedEvent event) {
395	updateSelectionDependentActions();
396	}
397	});
398
399	viewer.prependVerifyKeyListener(new VerifyKeyListener() {
400	public void verifyKey(VerifyEvent event) {
401	handleVerifyKeyPressed(event);
402	}
403	});
404
405	return viewer;
406	}
407
408	/**
409	* Creates the viewer to be used to display the pattern. Subclasses may override.
410	*
411	* @param parent the parent composite of the viewer
412	* @return a configured <code>SourceViewer</code>
413	*/
414	protected SourceViewer createViewer(Composite parent) {
415	SourceViewer viewer= new SourceViewer(parent, null, null, false, SWT.BORDER \| SWT.V_SCROLL \| SWT.H_SCROLL);
416	SourceViewerConfiguration configuration= new SourceViewerConfiguration() {
417	public IContentAssistant getContentAssistant(ISourceViewer sourceViewer) {
418
419	ContentAssistant assistant= new ContentAssistant();
420	assistant.enableAutoActivation(true);
421	assistant.enableAutoInsert(true);
422	assistant.setContentAssistProcessor(fTemplateProcessor, IDocument.DEFAULT_CONTENT_TYPE);
423	return assistant;
424	}
425	};
426	viewer.configure(configuration);
427	return viewer;
428	}
429
430	private void handleVerifyKeyPressed(VerifyEvent event) {
431	if (!event.doit)
432	return;
433
434	if (event.stateMask != SWT.MOD1)
435	return;
436
437	switch (event.character) {
438	case ' ':
439	fPatternEditor.doOperation(ISourceViewer.CONTENTASSIST_PROPOSALS);
440	event.doit= false;
441	break;
442
443	// CTRL-Z
444	case 'z' - 'a' + 1:
445	fPatternEditor.doOperation(ITextOperationTarget.UNDO);
446	event.doit= false;
447	break;
448	}
449	}
450
451	private void initializeActions() {
452	TextViewerAction action= new TextViewerAction(fPatternEditor, ITextOperationTarget.UNDO);
453	action.setText(TextEditorTemplateMessages.EditTemplateDialog_undo);
454	fGlobalActions.put(ITextEditorActionConstants.UNDO, action);
455
456	action= new TextViewerAction(fPatternEditor, ITextOperationTarget.CUT);
457	action.setText(TextEditorTemplateMessages.EditTemplateDialog_cut);
458	fGlobalActions.put(ITextEditorActionConstants.CUT, action);
459
460	action= new TextViewerAction(fPatternEditor, ITextOperationTarget.COPY);
461	action.setText(TextEditorTemplateMessages.EditTemplateDialog_copy);
462	fGlobalActions.put(ITextEditorActionConstants.COPY, action);
463
464	action= new TextViewerAction(fPatternEditor, ITextOperationTarget.PASTE);
465	action.setText(TextEditorTemplateMessages.EditTemplateDialog_paste);
466	fGlobalActions.put(ITextEditorActionConstants.PASTE, action);
467
468	action= new TextViewerAction(fPatternEditor, ITextOperationTarget.SELECT_ALL);
469	action.setText(TextEditorTemplateMessages.EditTemplateDialog_select_all);
470	fGlobalActions.put(ITextEditorActionConstants.SELECT_ALL, action);
471
472	action= new TextViewerAction(fPatternEditor, ISourceViewer.CONTENTASSIST_PROPOSALS);
473	action.setText(TextEditorTemplateMessages.EditTemplateDialog_content_assist);
474	fGlobalActions.put("ContentAssistProposal", action); //$NON-NLS-1$
475
476	fSelectionActions.add(ITextEditorActionConstants.CUT);
477	fSelectionActions.add(ITextEditorActionConstants.COPY);
478	fSelectionActions.add(ITextEditorActionConstants.PASTE);
479
480	// create context menu
481	MenuManager manager= new MenuManager(null, null);
482	manager.setRemoveAllWhenShown(true);
483	manager.addMenuListener(new IMenuListener() {
484	public void menuAboutToShow(IMenuManager mgr) {
485	fillContextMenu(mgr);
486	}
487	});
488
489	StyledText text= fPatternEditor.getTextWidget();
490	Menu menu= manager.createContextMenu(text);
491	text.setMenu(menu);
492	}
493
494	private void fillContextMenu(IMenuManager menu) {
495	menu.add(new GroupMarker(ITextEditorActionConstants.GROUP_UNDO));
496	menu.appendToGroup(ITextEditorActionConstants.GROUP_UNDO, (IAction) fGlobalActions.get(ITextEditorActionConstants.UNDO));
497
498	menu.add(new Separator(ITextEditorActionConstants.GROUP_EDIT));
499	menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.CUT));
500	menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.COPY));
501	menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.PASTE));
502	menu.appendToGroup(ITextEditorActionConstants.GROUP_EDIT, (IAction) fGlobalActions.get(ITextEditorActionConstants.SELECT_ALL));
503
504	menu.add(new Separator("templates")); //$NON-NLS-1$
505	menu.appendToGroup("templates", (IAction) fGlobalActions.get("ContentAssistProposal")); //$NON-NLS-1$ //$NON-NLS-2$
506	}
507
508	private void updateSelectionDependentActions() {
509	Iterator iterator= fSelectionActions.iterator();
510	while (iterator.hasNext())
511	updateAction((String)iterator.next());
512	}
513
514	private void updateUndoAction() {
515	IAction action= (IAction) fGlobalActions.get(ITextEditorActionConstants.UNDO);
516	if (action instanceof IUpdate)
517	((IUpdate) action).update();
518	}
519
520	private void updateAction(String actionId) {
521	IAction action= (IAction) fGlobalActions.get(actionId);
522	if (action instanceof IUpdate)
523	((IUpdate) action).update();
524	}
525
526	private int getIndex(String contextid) {
527
528	if (contextid == null)
529	return -1;
530
531	for (int i= 0; i < fContextTypes.length; i++) {
532	if (contextid.equals(fContextTypes[i][0])) {
533	return i;
534	}
535	}
536	return -1;
537	}
538
539	private void updateButtons() {
540	StatusInfo status;
541
542	boolean valid= fNameText == null \|\| fNameText.getText().trim().length() != 0;
543	if (!valid) {
544	status = new StatusInfo();
545	if (!fSuppressError) {
546	status.setError(TextEditorTemplateMessages.EditTemplateDialog_error_noname);
547	}
548	} else {
549	status= fValidationStatus;
550	}
551	updateStatus(status);
552	}
553
554	/*
555	* @since 3.1
556	*/
557	protected void okPressed() {
558	String name= fNameText == null ? fOriginalTemplate.getName() : fNameText.getText();
559	boolean isAutoInsertable= fAutoInsertCheckbox != null && fAutoInsertCheckbox.getSelection();
560	fNewTemplate= new Template(name, fDescriptionText.getText(), getContextId(), fPatternEditor.getDocument().get(), isAutoInsertable);
561	super.okPressed();
562	}
563
564	/**
565	* Returns the created template.
566	*
567	* @return the created template
568	* @since 3.1
569	*/
570	public Template getTemplate() {
571	return fNewTemplate;
572	}
573
574	/**
575	* Returns the content assist processor that
576	* suggests template variables.
577	*
578	* @return the processor to suggest variables
579	* @since 3.3
580	*/
581	protected IContentAssistProcessor getTemplateProcessor() {
582	return fTemplateProcessor;
583	}
584
585	/*
586	* @see org.eclipse.jface.dialogs.Dialog#getDialogBoundsSettings()
587	* @since 3.2
588	*/
589	protected IDialogSettings getDialogBoundsSettings() {
590	String sectionName= this.getClass().getName() + "_dialogBounds"; //$NON-NLS-1$
591	IDialogSettings settings= TextEditorPlugin.getDefault().getDialogSettings();
592	IDialogSettings section= settings.getSection(sectionName);
593	if (section == null)
594	section= settings.addNewSection(sectionName);
595	return section;
596	}
597
598	}

Added Link Here

(-)src/org/eclipse/ui/texteditor/templates/TemplateTransfer.java (+179 lines)
1	/*******************************************************************************
2	* Copyright (c) 2004, 2005 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.ui.texteditor.templates;
12
13	import java.io.ByteArrayInputStream;
14	import java.io.ByteArrayOutputStream;
15	import java.io.DataInputStream;
16	import java.io.DataOutputStream;
17	import java.io.IOException;
18	import java.util.ArrayList;
19
20	import org.eclipse.jface.text.templates.Template;
21	import org.eclipse.swt.dnd.ByteArrayTransfer;
22	import org.eclipse.swt.dnd.TransferData;
23
24	/**
25	* Transfer type used for clip board and DnD operations for template objects
26	*
27	* @see TemplatesPage
28	*
29	*/
30	public class TemplateTransfer extends ByteArrayTransfer {
31
32	private static TemplateTransfer instance;
33
34	private static final String LOCAL_NAME = TemplateTransfer.class.getName()
35	+ System.currentTimeMillis();
36	private static final int LOCAL_TYPE = registerType(LOCAL_NAME);
37
38	private static String[] names = null;
39	private static int types[] = null;
40
41	/**
42	* @return the registered Transfer instance
43	*/
44	public static TemplateTransfer getInstance() {
45	if (instance == null) {
46	instance = new TemplateTransfer();
47	types = new int[] { LOCAL_TYPE };
48	names = new String[] { LOCAL_NAME };
49	}
50	return instance;
51	}
52
53	/*
54	* (non-Javadoc)
55	*
56	* @see org.eclipse.swt.dnd.Transfer#getTypeIds()
57	*/
58	protected int[] getTypeIds() {
59	return types;
60	}
61
62	/*
63	* (non-Javadoc)
64	*
65	* @see org.eclipse.swt.dnd.Transfer#getTypeNames()
66	*/
67	protected String[] getTypeNames() {
68	return names;
69	}
70
71	/*
72	* (non-Javadoc)
73	*
74	* @see org.eclipse.swt.dnd.ByteArrayTransfer#javaToNative(java.lang.Object,
75	* org.eclipse.swt.dnd.TransferData)
76	*/
77	protected void javaToNative(Object object, TransferData transferData) {
78	if (object == null \|\| !(object instanceof Template[])
79	\|\| !isSupportedType(transferData))
80	return;
81	ByteArrayOutputStream out = new ByteArrayOutputStream();
82	DataOutputStream dataOut = new DataOutputStream(out);
83	Template[] templates = (Template[]) object;
84	for (int i = 0; i < templates.length; i++) {
85	writeTemplate(dataOut, templates[i]);
86	}
87	byte[] byteArray = out.toByteArray();
88	try {
89	dataOut.close();
90	} catch (IOException e) {
91	}
92	super.javaToNative(byteArray, transferData);
93	}
94
95	/**
96	* Write a template to the output stream
97	*
98	* @param dataOut
99	* @param template
100	*/
101	private void writeTemplate(DataOutputStream dataOut, Template template) {
102	try {
103	writeString(dataOut, template.getName());
104	writeString(dataOut, template.getDescription());
105	writeString(dataOut, template.getContextTypeId());
106	writeString(dataOut, template.getPattern());
107	dataOut.writeBoolean(template.isAutoInsertable());
108	} catch (IOException e) {
109	}
110	}
111
112	/**
113	* Write a string to the output stream
114	*
115	* @param dataOut
116	* @param name
117	* @throws IOException
118	*/
119	private void writeString(DataOutputStream dataOut, String name)
120	throws IOException {
121	byte[] bytes = name.getBytes();
122	dataOut.writeInt(bytes.length);
123	dataOut.write(bytes);
124	}
125
126	/*
127	* (non-Javadoc)
128	*
129	* @see org.eclipse.swt.dnd.ByteArrayTransfer#nativeToJava(org.eclipse.swt.dnd.TransferData)
130	*/
131	protected Object nativeToJava(TransferData transferData) {
132	byte[] bytes = (byte[]) super.nativeToJava(transferData);
133	if (bytes == null)
134	return null;
135	ArrayList listTemplates = new ArrayList();
136	ByteArrayInputStream in = new ByteArrayInputStream(bytes);
137	DataInputStream dataIn = new DataInputStream(in);
138	try {
139	while (dataIn.available() > 0) {
140	Template template = readTempate(dataIn);
141	if (template == null)
142	break;
143	listTemplates.add(template);
144	}
145	} catch (IOException e) {
146	} finally {
147	try {
148	dataIn.close();
149	} catch (IOException e) {
150	}
151	}
152	return listTemplates.toArray(new Template[listTemplates.size()]);
153	}
154
155	/**
156	* Read a template from the data input stream.
157	*
158	* @param dataIn
159	* @return the template
160	* @throws IOException
161	*/
162	private Template readTempate(DataInputStream dataIn) throws IOException {
163	return new Template(readString(dataIn), readString(dataIn),
164	readString(dataIn), readString(dataIn), dataIn.readBoolean());
165	}
166
167	/**
168	* Read a string from the data input stream
169	*
170	* @param dataIn
171	* @return the string
172	* @throws IOException
173	*/
174	private String readString(DataInputStream dataIn) throws IOException {
175	byte[] bytes = new byte[dataIn.readInt()];
176	dataIn.read(bytes);
177	return new String(bytes);
178	}
179	}

Added Link Here

(-)ui/org/eclipse/jdt/internal/ui/preferences/JavaTemplatesPage.java (+258 lines)
1	/*******************************************************************************
2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.jdt.internal.ui.preferences;
12
13	import org.eclipse.swt.SWT;
14	import org.eclipse.swt.graphics.Font;
15	import org.eclipse.swt.graphics.Point;
16	import org.eclipse.swt.layout.GridData;
17	import org.eclipse.swt.widgets.Composite;
18	import org.eclipse.swt.widgets.Control;
19
20	import org.eclipse.jface.preference.IPreferenceStore;
21	import org.eclipse.jface.resource.JFaceResources;
22	import org.eclipse.jface.window.Window;
23
24	import org.eclipse.jface.text.BadLocationException;
25	import org.eclipse.jface.text.Document;
26	import org.eclipse.jface.text.IDocument;
27	import org.eclipse.jface.text.ITextSelection;
28	import org.eclipse.jface.text.Position;
29	import org.eclipse.jface.text.Region;
30	import org.eclipse.jface.text.TextSelection;
31	import org.eclipse.jface.text.TextUtilities;
32	import org.eclipse.jface.text.source.ISourceViewer;
33	import org.eclipse.jface.text.source.SourceViewer;
34	import org.eclipse.jface.text.templates.ContextTypeRegistry;
35	import org.eclipse.jface.text.templates.Template;
36	import org.eclipse.jface.text.templates.TemplateContextType;
37
38	import org.eclipse.ui.PlatformUI;
39	import org.eclipse.ui.part.FileEditorInput;
40	import org.eclipse.ui.texteditor.templates.TemplatesPage;
41
42	import org.eclipse.jdt.core.ICompilationUnit;
43	import org.eclipse.jdt.core.JavaCore;
44
45	import org.eclipse.jdt.internal.corext.template.java.CompilationUnitContext;
46	import org.eclipse.jdt.internal.corext.template.java.CompilationUnitContextType;
47	import org.eclipse.jdt.internal.corext.template.java.JavaContextType;
48	import org.eclipse.jdt.internal.corext.template.java.JavaDocContextType;
49
50	import org.eclipse.jdt.ui.PreferenceConstants;
51	import org.eclipse.jdt.ui.text.IJavaPartitions;
52	import org.eclipse.jdt.ui.text.JavaTextTools;
53
54	import org.eclipse.jdt.internal.ui.JavaPlugin;
55	import org.eclipse.jdt.internal.ui.javaeditor.JavaEditor;
56	import org.eclipse.jdt.internal.ui.javaeditor.JavaSourceViewer;
57	import org.eclipse.jdt.internal.ui.text.SimpleJavaSourceViewerConfiguration;
58	import org.eclipse.jdt.internal.ui.text.template.contentassist.TemplateProposal;
59	import org.eclipse.jdt.internal.ui.text.template.preferences.TemplateVariableProcessor;
60
61	/**
62	* A TemplatesPage implementation for Java CompilationUnitEditor
63	*
64	* @author kd
65	*/
66	public class JavaTemplatesPage extends TemplatesPage {
67
68	private static final ContextTypeRegistry TEMPLATE_CONTEXT_REGISTRY= JavaPlugin.getDefault().getTemplateContextRegistry();
69	private TemplateVariableProcessor fTemplateProcessor;
70	private ScrolledPageContent fScrolled;
71	private final JavaEditor fEditor;
72	private IDocument fDocument;
73	private String fJavaDocId;
74	private String fJavaId;
75	private String fCurrentId;
76
77	/**
78	* @param javaEditor
79	*/
80	public JavaTemplatesPage(JavaEditor javaEditor) {
81	fEditor= javaEditor;
82	setTemplateStore(JavaPlugin.getDefault().getTemplateStore(), JavaPlugin.getDefault().getPreferenceStore());
83	setContextTypeRegistry(TEMPLATE_CONTEXT_REGISTRY);
84	fJavaDocId= new JavaDocContextType().getId();
85	fJavaId= new JavaContextType().getId();
86	fTemplateProcessor= new TemplateVariableProcessor();
87	fDocument= fEditor.getDocumentProvider().getDocument(fEditor.getEditorInput());
88	cursorPositionChanged();
89	setupEditorDropTarget(fEditor.getSite(), fEditor.getViewer().getTextWidget());
90	}
91
92	public void dispose() {
93	super.dispose();
94	}
95
96	/* (non-Javadoc)
97	* @see org.eclipse.ui.texteditor.templates.TemplatesPage#createControl(org.eclipse.swt.widgets.Composite)
98	*/
99	public void createControl(Composite ancestor) {
100	fScrolled= new ScrolledPageContent(ancestor, SWT.H_SCROLL \| SWT.V_SCROLL);
101	fScrolled.setExpandHorizontal(true);
102	fScrolled.setExpandVertical(true);
103
104	super.createControl(fScrolled);
105	Control control= super.getControl();
106
107	fScrolled.setContent(control);
108	final Point size= control.computeSize(SWT.DEFAULT, SWT.DEFAULT);
109	fScrolled.setMinSize(size.x, size.y);
110	}
111
112	/* (non-Javadoc)
113	* @see org.eclipse.ui.texteditor.templates.TemplatesPage#editTemplate(org.eclipse.jface.text.templates.Template, boolean, boolean)
114	*/
115	protected Template editTemplate(Template template, boolean edit, boolean isNameModifiable) {
116	EditTemplateDialog dialog= new EditTemplateDialog(getShell(), template, edit, isNameModifiable, getContextTypeRegistry());
117	if (dialog.open() == Window.OK) {
118	return dialog.getTemplate();
119	}
120	return null;
121	}
122
123	/* (non-Javadoc)
124	* @see org.eclipse.ui.texteditor.templates.TemplatesPage#createViewer(org.eclipse.swt.widgets.Composite)
125	*/
126	protected SourceViewer createViewer(Composite parent) {
127	IDocument document= new Document();
128	JavaTextTools tools= JavaPlugin.getDefault().getJavaTextTools();
129	tools.setupJavaDocumentPartitioner(document, IJavaPartitions.JAVA_PARTITIONING);
130	IPreferenceStore store= JavaPlugin.getDefault().getCombinedPreferenceStore();
131	SourceViewer viewer= new JavaSourceViewer(parent, null, null, false, SWT.BORDER \| SWT.V_SCROLL \| SWT.H_SCROLL, store);
132	SimpleJavaSourceViewerConfiguration configuration= new SimpleJavaSourceViewerConfiguration(tools.getColorManager(), store, null, IJavaPartitions.JAVA_PARTITIONING, false);
133	viewer.configure(configuration);
134	viewer.setEditable(false);
135	viewer.setDocument(document);
136
137	Font font= JFaceResources.getFont(PreferenceConstants.EDITOR_TEXT_FONT);
138	viewer.getTextWidget().setFont(font);
139	new JavaSourcePreviewerUpdater(viewer, configuration, store);
140
141	Control control= viewer.getControl();
142	GridData data= new GridData(GridData.HORIZONTAL_ALIGN_FILL \| GridData.FILL_VERTICAL);
143	control.setLayoutData(data);
144
145	return viewer;
146	}
147
148
149	/* (non-Javadoc)
150	* @see org.eclipse.ui.texteditor.templates.TemplatesPage#updateViewerInput(org.eclipse.jface.text.templates.Template)
151	*/
152	protected void updateViewerInput(Template template) {
153	SourceViewer viewer= getViewer();
154
155	String contextId= template.getContextTypeId();
156	TemplateContextType type= TEMPLATE_CONTEXT_REGISTRY.getContextType(contextId);
157	fTemplateProcessor.setContextType(type);
158
159	IDocument doc= viewer.getDocument();
160
161	String start= null;
162	if ("javadoc".equals(contextId)) { //$NON-NLS-1$
163	start= "/**" + doc.getLegalLineDelimiters()[0]; //$NON-NLS-1$
164	} else
165	start= ""; //$NON-NLS-1$
166
167	doc.set(start + template.getPattern());
168	int startLen= start.length();
169	viewer.setDocument(doc, startLen, doc.getLength() - startLen);
170	}
171
172	/* (non-Javadoc)
173	* @see org.eclipse.ui.texteditor.templates.TemplatesPage#getControl()
174	*/
175	public Control getControl() {
176	return fScrolled;
177	}
178
179	/* (non-Javadoc)
180	* @see org.eclipse.ui.part.Page#setFocus()
181	*/
182	public void setFocus() {
183	}
184
185	/* (non-Javadoc)
186	* @see org.eclipse.ui.texteditor.templates.TemplatesPage#getPreferencePageId()
187	*/
188	protected String getPreferencePageId() {
189	return "org.eclipse.jdt.ui.preferences.JavaTemplatePreferencePage"; //$NON-NLS-1$
190	}
191
192	/* (non-Javadoc)
193	* @see org.eclipse.ui.texteditor.templates.TemplatesPage#insertTemplate(org.eclipse.jface.text.templates.Template)
194	*/
195	public void insertTemplate(Template template) {
196	if (!fEditor.isEditorInputModifiable())
197	return;
198	TemplateContextType type= TEMPLATE_CONTEXT_REGISTRY.getContextType(template.getContextTypeId());
199	if (type == null)
200	return;
201	ISourceViewer contextViewer= fEditor.getViewer();
202	ITextSelection textSelection= (ITextSelection) contextViewer.getSelectionProvider().getSelection();
203	IDocument document= contextViewer.getDocument();
204	/*
205	* The Editor checks whether a completion for a word exists before it allows for the template to be
206	* applied. We pickup the current text at the selection position and replace it with the first char
207	* of the template name for this to succeed.
208	* We don't need to go through this, if the editors simply support applyTemplate(Template).
209	*/
210	String savedText;
211	try {
212	savedText= document.get(textSelection.getOffset(), textSelection.getLength());
213	document.replace(textSelection.getOffset(), textSelection.getLength(), template.getName().substring(0, 1));
214	} catch (BadLocationException e) {
215	e.printStackTrace();
216	return;
217	}
218	Position position= new Position(textSelection.getOffset() + 1, 0);
219	Region region= new Region(textSelection.getOffset() + 1, 0);
220	contextViewer.getSelectionProvider().setSelection(new TextSelection(textSelection.getOffset(), 1));
221	ICompilationUnit compilationUnit= JavaCore.createCompilationUnitFrom(((FileEditorInput) fEditor.getEditorInput()).getFile());
222
223	CompilationUnitContext context= ((CompilationUnitContextType) type).createContext(document, position, compilationUnit);
224	context.setVariable("selection", savedText); //$NON-NLS-1$
225	if (context.getKey().length() == 0) {
226	try {
227	document.replace(textSelection.getOffset(), 1, savedText);
228	} catch (BadLocationException e) {
229	e.printStackTrace();
230	return;
231	}
232	}
233	TemplateProposal proposal= new TemplateProposal(template, context, region, null);
234	PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().activate(fEditor);
235	proposal.apply(fEditor.getViewer(), ' ', 0, region.getOffset());
236	}
237
238	/**
239	* Invoked by the editor whenever the caret position is updated
240	*/
241	public void cursorPositionChanged() {
242	Point selectedRange= fEditor.getViewer().getSelectedRange();
243	int cursor= selectedRange.x + selectedRange.y;
244	String partition;
245	try {
246	partition= TextUtilities.getContentType(fDocument, IJavaPartitions.JAVA_PARTITIONING, cursor, true);
247	} catch (BadLocationException e) {
248	return;
249	}
250	String id= fJavaId;
251	if (partition.equals(IJavaPartitions.JAVA_DOC))
252	id= fJavaDocId;
253	if (!id.equals(fCurrentId)) {
254	fCurrentId= id;
255	contextTypeChanged(new String[] { id });
256	}
257	}
258	}