| /******************************************************************************* |
| * Copyright (c) 2000, 2010 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 |
| * Brock Janiczak <brockj@tpg.com.au> - [nls tooling] Properties file editor should have "toggle comment" action - https://bugs.eclipse.org/bugs/show_bug.cgi?id=192045 |
| *******************************************************************************/ |
| package org.eclipse.jdt.internal.ui.propertiesfileeditor; |
| |
| import java.util.ArrayList; |
| import java.util.List; |
| import java.util.Map; |
| |
| import org.eclipse.swt.widgets.Shell; |
| |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.Platform; |
| import org.eclipse.core.runtime.content.IContentType; |
| |
| import org.eclipse.jface.preference.IPreferenceStore; |
| import org.eclipse.jface.util.PropertyChangeEvent; |
| |
| import org.eclipse.jface.text.DefaultInformationControl; |
| import org.eclipse.jface.text.IAutoEditStrategy; |
| import org.eclipse.jface.text.IDocument; |
| import org.eclipse.jface.text.IInformationControl; |
| import org.eclipse.jface.text.IInformationControlCreator; |
| import org.eclipse.jface.text.ITextDoubleClickStrategy; |
| import org.eclipse.jface.text.ITextHover; |
| import org.eclipse.jface.text.presentation.IPresentationReconciler; |
| import org.eclipse.jface.text.presentation.PresentationReconciler; |
| import org.eclipse.jface.text.quickassist.IQuickAssistAssistant; |
| import org.eclipse.jface.text.reconciler.IReconciler; |
| import org.eclipse.jface.text.reconciler.IReconcilingStrategy; |
| import org.eclipse.jface.text.reconciler.MonoReconciler; |
| import org.eclipse.jface.text.rules.DefaultDamagerRepairer; |
| import org.eclipse.jface.text.rules.RuleBasedScanner; |
| import org.eclipse.jface.text.source.Annotation; |
| import org.eclipse.jface.text.source.IAnnotationHover; |
| import org.eclipse.jface.text.source.ISourceViewer; |
| |
| import org.eclipse.ui.IFileEditorInput; |
| |
| import org.eclipse.ui.texteditor.ITextEditor; |
| import org.eclipse.ui.texteditor.spelling.SpellingReconcileStrategy; |
| import org.eclipse.ui.texteditor.spelling.SpellingService; |
| |
| import org.eclipse.ui.editors.text.EditorsUI; |
| import org.eclipse.ui.editors.text.TextSourceViewerConfiguration; |
| |
| import org.eclipse.jdt.ui.PreferenceConstants; |
| import org.eclipse.jdt.ui.text.IColorManager; |
| |
| import org.eclipse.jdt.internal.ui.JavaPlugin; |
| import org.eclipse.jdt.internal.ui.text.AbstractJavaScanner; |
| import org.eclipse.jdt.internal.ui.text.HTMLAnnotationHover; |
| import org.eclipse.jdt.internal.ui.text.JavaPresentationReconciler; |
| import org.eclipse.jdt.internal.ui.text.SingleTokenJavaScanner; |
| import org.eclipse.jdt.internal.ui.text.java.PartitionDoubleClickSelector; |
| |
| |
| /** |
| * Configuration for a source viewer which shows a properties file. |
| * <p> |
| * This class may be instantiated; it is not intended to be subclassed. |
| * </p> |
| * |
| * @since 3.1 |
| */ |
| public class PropertiesFileSourceViewerConfiguration extends TextSourceViewerConfiguration { |
| |
| /** Properties file content type */ |
| private static final IContentType PROPERTIES_CONTENT_TYPE= Platform.getContentTypeManager().getContentType("org.eclipse.jdt.core.javaProperties"); //$NON-NLS-1$ |
| |
| /** |
| * The text editor. |
| */ |
| private ITextEditor fTextEditor; |
| /** |
| * The document partitioning. |
| */ |
| private String fDocumentPartitioning; |
| /** |
| * The property key scanner. |
| */ |
| private AbstractJavaScanner fPropertyKeyScanner; |
| /** |
| * The comment scanner. |
| */ |
| private AbstractJavaScanner fCommentScanner; |
| /** |
| * The property value scanner. |
| */ |
| private AbstractJavaScanner fPropertyValueScanner; |
| /** |
| * The color manager. |
| */ |
| private IColorManager fColorManager; |
| |
| |
| /** |
| * Creates a new properties file source viewer configuration for viewers in the given editor |
| * using the given preference store, the color manager and the specified document partitioning. |
| * |
| * @param colorManager the color manager |
| * @param preferenceStore the preference store, can be read-only |
| * @param editor the editor in which the configured viewer(s) will reside |
| * @param partitioning the document partitioning for this configuration |
| */ |
| public PropertiesFileSourceViewerConfiguration(IColorManager colorManager, IPreferenceStore preferenceStore, ITextEditor editor, String partitioning) { |
| super(preferenceStore); |
| fColorManager= colorManager; |
| fTextEditor= editor; |
| fDocumentPartitioning= partitioning; |
| initializeScanners(); |
| } |
| |
| /** |
| * Returns the property key scanner for this configuration. |
| * |
| * @return the property key scanner |
| */ |
| protected RuleBasedScanner getPropertyKeyScanner() { |
| return fPropertyKeyScanner; |
| } |
| |
| /** |
| * Returns the comment scanner for this configuration. |
| * |
| * @return the comment scanner |
| */ |
| protected RuleBasedScanner getCommentScanner() { |
| return fCommentScanner; |
| } |
| |
| /** |
| * Returns the property value scanner for this configuration. |
| * |
| * @return the property value scanner |
| */ |
| protected RuleBasedScanner getPropertyValueScanner() { |
| return fPropertyValueScanner; |
| } |
| |
| /** |
| * Returns the color manager for this configuration. |
| * |
| * @return the color manager |
| */ |
| protected IColorManager getColorManager() { |
| return fColorManager; |
| } |
| |
| /** |
| * Returns the editor in which the configured viewer(s) will reside. |
| * |
| * @return the enclosing editor |
| */ |
| protected ITextEditor getEditor() { |
| return fTextEditor; |
| } |
| |
| /** |
| * Initializes the scanners. |
| */ |
| private void initializeScanners() { |
| fPropertyKeyScanner= new SingleTokenJavaScanner(getColorManager(), fPreferenceStore, PreferenceConstants.PROPERTIES_FILE_COLORING_KEY); |
| fPropertyValueScanner= new PropertyValueScanner(getColorManager(), fPreferenceStore); |
| fCommentScanner= new SingleTokenJavaScanner(getColorManager(), fPreferenceStore, PreferenceConstants.PROPERTIES_FILE_COLORING_COMMENT); |
| } |
| |
| /* |
| * @see SourceViewerConfiguration#getPresentationReconciler(ISourceViewer) |
| */ |
| public IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer) { |
| |
| PresentationReconciler reconciler= new JavaPresentationReconciler(); |
| reconciler.setDocumentPartitioning(getConfiguredDocumentPartitioning(sourceViewer)); |
| |
| DefaultDamagerRepairer dr= new DefaultDamagerRepairer(getPropertyKeyScanner()); |
| reconciler.setDamager(dr, IDocument.DEFAULT_CONTENT_TYPE); |
| reconciler.setRepairer(dr, IDocument.DEFAULT_CONTENT_TYPE); |
| |
| dr= new DefaultDamagerRepairer(getCommentScanner()); |
| reconciler.setDamager(dr, IPropertiesFilePartitions.COMMENT); |
| reconciler.setRepairer(dr, IPropertiesFilePartitions.COMMENT); |
| |
| dr= new DefaultDamagerRepairer(getPropertyValueScanner()); |
| reconciler.setDamager(dr, IPropertiesFilePartitions.PROPERTY_VALUE); |
| reconciler.setRepairer(dr, IPropertiesFilePartitions.PROPERTY_VALUE); |
| |
| return reconciler; |
| } |
| |
| /* |
| * @see SourceViewerConfiguration#getDoubleClickStrategy(ISourceViewer, String) |
| */ |
| public ITextDoubleClickStrategy getDoubleClickStrategy(ISourceViewer sourceViewer, String contentType) { |
| if (IDocument.DEFAULT_CONTENT_TYPE.equals(contentType)) |
| return new PartitionDoubleClickSelector(getConfiguredDocumentPartitioning(sourceViewer), 0, 0, 0); |
| if (IPropertiesFilePartitions.COMMENT.equals(contentType)) |
| return new PartitionDoubleClickSelector(getConfiguredDocumentPartitioning(sourceViewer), 0, 0); |
| if (IPropertiesFilePartitions.PROPERTY_VALUE.equals(contentType)) |
| return new PartitionDoubleClickSelector(getConfiguredDocumentPartitioning(sourceViewer), 1, -1); |
| |
| return super.getDoubleClickStrategy(sourceViewer, contentType); |
| } |
| |
| /* |
| * @see SourceViewerConfiguration#getConfiguredContentTypes(ISourceViewer) |
| */ |
| public String[] getConfiguredContentTypes(ISourceViewer sourceViewer) { |
| int length= IPropertiesFilePartitions.PARTITIONS.length; |
| String[] contentTypes= new String[length + 1]; |
| contentTypes[0]= IDocument.DEFAULT_CONTENT_TYPE; |
| for (int i= 0; i < length; i++) |
| contentTypes[i+1]= IPropertiesFilePartitions.PARTITIONS[i]; |
| |
| return contentTypes; |
| } |
| |
| /* |
| * @see org.eclipse.jface.text.source.SourceViewerConfiguration#getConfiguredDocumentPartitioning(org.eclipse.jface.text.source.ISourceViewer) |
| */ |
| public String getConfiguredDocumentPartitioning(ISourceViewer sourceViewer) { |
| if (fDocumentPartitioning != null) |
| return fDocumentPartitioning; |
| return super.getConfiguredDocumentPartitioning(sourceViewer); |
| } |
| |
| /** |
| * Determines whether the preference change encoded by the given event |
| * changes the behavior of one of its contained components. |
| * |
| * @param event the event to be investigated |
| * @return <code>true</code> if event causes a behavioral change |
| */ |
| public boolean affectsTextPresentation(PropertyChangeEvent event) { |
| return fPropertyKeyScanner.affectsBehavior(event) |
| || fCommentScanner.affectsBehavior(event) |
| || fPropertyValueScanner.affectsBehavior(event); |
| } |
| |
| /** |
| * Adapts the behavior of the contained components to the change |
| * encoded in the given event. |
| * |
| * @param event the event to which to adapt |
| * @see PropertiesFileSourceViewerConfiguration#PropertiesFileSourceViewerConfiguration(IColorManager, IPreferenceStore, ITextEditor, String) |
| */ |
| public void handlePropertyChangeEvent(PropertyChangeEvent event) { |
| if (fPropertyKeyScanner.affectsBehavior(event)) |
| fPropertyKeyScanner.adaptToPreferenceChange(event); |
| if (fCommentScanner.affectsBehavior(event)) |
| fCommentScanner.adaptToPreferenceChange(event); |
| if (fPropertyValueScanner.affectsBehavior(event)) |
| fPropertyValueScanner.adaptToPreferenceChange(event); |
| } |
| |
| /* |
| * @see org.eclipse.jface.text.source.SourceViewerConfiguration#getHyperlinkDetectorTargets(org.eclipse.jface.text.source.ISourceViewer) |
| * @since 3.3 |
| */ |
| protected Map getHyperlinkDetectorTargets(ISourceViewer sourceViewer) { |
| Map targets= super.getHyperlinkDetectorTargets(sourceViewer); |
| targets.put("org.eclipse.jdt.ui.PropertiesFileEditor", fTextEditor); //$NON-NLS-1$ |
| return targets; |
| } |
| |
| /* |
| * @see SourceViewerConfiguration#getAnnotationHover(ISourceViewer) |
| */ |
| public IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer) { |
| return new HTMLAnnotationHover(false) { |
| protected boolean isIncluded(Annotation annotation) { |
| return isShowInVerticalRuler(annotation); |
| } |
| }; |
| } |
| |
| /* |
| * @see SourceViewerConfiguration#getOverviewRulerAnnotationHover(ISourceViewer) |
| */ |
| public IAnnotationHover getOverviewRulerAnnotationHover(ISourceViewer sourceViewer) { |
| return new HTMLAnnotationHover(true) { |
| protected boolean isIncluded(Annotation annotation) { |
| return isShowInOverviewRuler(annotation); |
| } |
| }; |
| } |
| |
| /* |
| * @see SourceViewerConfiguration#getInformationControlCreator(ISourceViewer) |
| */ |
| public IInformationControlCreator getInformationControlCreator(ISourceViewer sourceViewer) { |
| return new IInformationControlCreator() { |
| public IInformationControl createInformationControl(Shell parent) { |
| return new DefaultInformationControl(parent, JavaPlugin.getAdditionalInfoAffordanceString()); |
| } |
| }; |
| } |
| |
| /* |
| * @see org.eclipse.ui.editors.text.TextSourceViewerConfiguration#getReconciler(org.eclipse.jface.text.source.ISourceViewer) |
| */ |
| public IReconciler getReconciler(ISourceViewer sourceViewer) { |
| if (!EditorsUI.getPreferenceStore().getBoolean(SpellingService.PREFERENCE_SPELLING_ENABLED)) |
| return null; |
| |
| IReconcilingStrategy strategy= new SpellingReconcileStrategy(sourceViewer, EditorsUI.getSpellingService()) { |
| protected IContentType getContentType() { |
| return PROPERTIES_CONTENT_TYPE; |
| } |
| }; |
| |
| MonoReconciler reconciler= new MonoReconciler(strategy, false); |
| reconciler.setDelay(500); |
| return reconciler; |
| } |
| |
| /* |
| * @see org.eclipse.jface.text.source.SourceViewerConfiguration#getDefaultPrefixes(org.eclipse.jface.text.source.ISourceViewer, java.lang.String) |
| * @since 3.4 |
| */ |
| public String[] getDefaultPrefixes(ISourceViewer sourceViewer, String contentType) { |
| return new String[] {"#", ""}; //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| |
| /* |
| * (non-Javadoc) |
| * @see org.eclipse.jface.text.source.SourceViewerConfiguration#getAutoEditStrategies(org.eclipse.jface.text.source.ISourceViewer, java.lang.String) |
| * @since 3.7 |
| */ |
| public IAutoEditStrategy[] getAutoEditStrategies(ISourceViewer sourceViewer, String contentType) { |
| IAutoEditStrategy[] autoEditStrategies= super.getAutoEditStrategies(sourceViewer, contentType); |
| |
| if (fTextEditor == null) |
| return autoEditStrategies; |
| |
| try { |
| if (!PropertiesFileDocumentProvider.isJavaPropertiesFile(fTextEditor.getEditorInput())) { |
| return autoEditStrategies; |
| } |
| List stratergies= new ArrayList(); |
| for (int i= 0; i < autoEditStrategies.length; i++) { |
| stratergies.add(autoEditStrategies[i]); |
| } |
| stratergies.add(new PropertiesFileAutoEditStrategy(((IFileEditorInput)fTextEditor.getEditorInput()).getFile(), sourceViewer)); |
| return (IAutoEditStrategy[])stratergies.toArray(new IAutoEditStrategy[stratergies.size()]); |
| } catch (CoreException e) { |
| JavaPlugin.log(e); |
| return autoEditStrategies; |
| } |
| } |
| |
| /* |
| * (non-Javadoc) |
| * @see org.eclipse.jface.text.source.SourceViewerConfiguration#getTextHover(org.eclipse.jface.text.source.ISourceViewer, java.lang.String, int) |
| * @since 3.7 |
| */ |
| public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType, int stateMask) { |
| return new PropertiesFileHover(super.getTextHover(sourceViewer, contentType)); |
| } |
| |
| /* |
| * (non-Javadoc) |
| * @see org.eclipse.ui.editors.text.TextSourceViewerConfiguration#getQuickAssistAssistant(org.eclipse.jface.text.source.ISourceViewer) |
| * @since 3.7 |
| */ |
| public IQuickAssistAssistant getQuickAssistAssistant(ISourceViewer sourceViewer) { |
| if (getEditor() != null) { |
| PropertiesCorrectionAssistant assistant= new PropertiesCorrectionAssistant(); |
| assistant.setRestoreCompletionProposalSize(JavaPlugin.getDefault().getDialogSettingsSection("quick_assist_proposal_size")); //$NON-NLS-1$ |
| return assistant; |
| } |
| return null; |
| } |
| } |
