Eclipse Platform
2.0

org.eclipse.jface.text.source
Class SourceViewerConfiguration

java.lang.Object
  |
  +--org.eclipse.jface.text.source.SourceViewerConfiguration

public class SourceViewerConfiguration
extends Object

This class bundles the whole configuration space of a source viewer. Instances of this class are passed to the configure method of ISourceViewer.

Each method in this class get as argument the source viewer for which it should provide a particular configurational setting such as a presentation reconciler. Based on its specific knowlegde about the returned object, the configuration might share such objects or compute them according to some rules.

Clients should subclass and override just those methods which must be specific to their needs.

See Also:
ISourceViewer

Constructor Summary
SourceViewerConfiguration()
          Creates a new source viewer configuration that behaves according to specification of this class' methods.
 
Method Summary
 IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer)
          Returns the annotation hover which will provide the information to be shown in a hover popup window when requested for the given source viewer.This implementation always returns null.
 IAutoIndentStrategy getAutoIndentStrategy(ISourceViewer sourceViewer, String contentType)
          Returns the auto indentation strategy ready to be used with the given source viewer when manipulating text of the given content type.
 String[] getConfiguredContentTypes(ISourceViewer sourceViewer)
          Returns all configured content types for the given source viewer.
 IContentAssistant getContentAssistant(ISourceViewer sourceViewer)
          Returns the content assistant ready to be used with the given source viewer.
 IContentFormatter getContentFormatter(ISourceViewer sourceViewer)
          Returns the content formatter ready to be used with the given source viewer.
 String[] getDefaultPrefixes(ISourceViewer sourceViewer, String contentType)
          Returns the default prefixes to be used by the line-prefix operation in the given source viewer for text of the given content type.
 ITextDoubleClickStrategy getDoubleClickStrategy(ISourceViewer sourceViewer, String contentType)
          Returns the double-click strategy ready to be used in this viewer when double clicking onto text of the given content type.
 String[] getIndentPrefixes(ISourceViewer sourceViewer, String contentType)
          Returns the prefixes to be used by the line-shift operation.
 IInformationControlCreator getInformationControlCreator(ISourceViewer sourceViewer)
          Returns the information control creator.
 IInformationPresenter getInformationPresenter(ISourceViewer sourceViewer)
          Returns the information presenter which will determine and shown information requested for the current cursor position.
 IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer)
          Returns the presentation reconciler ready to be used with the given source viewer.
 IReconciler getReconciler(ISourceViewer sourceViewer)
          Returns the reconciler ready to be used with the given source viewer.
 int getTabWidth(ISourceViewer sourceViewer)
          Returns the visual width of the tab character.
 ITextHover getTextHover(ISourceViewer sourceViewer, String contentType)
          Returns the text hover which will provide the information to be shown in a text hover popup window when requested for the given source viewer and the given content type.
 IUndoManager getUndoManager(ISourceViewer sourceViewer)
          Returns the undo manager for the given source viewer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SourceViewerConfiguration

public SourceViewerConfiguration()
Creates a new source viewer configuration that behaves according to specification of this class' methods.

Method Detail

getTabWidth

public int getTabWidth(ISourceViewer sourceViewer)
Returns the visual width of the tab character. This implementation always returns 4.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
Returns:
the tab width

getUndoManager

public IUndoManager getUndoManager(ISourceViewer sourceViewer)
Returns the undo manager for the given source viewer. This implementation always returns a new instance of DefaultUndoManager whose history length is set to 25.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
Returns:
an undo manager or null

getReconciler

public IReconciler getReconciler(ISourceViewer sourceViewer)
Returns the reconciler ready to be used with the given source viewer. This implementation always returns null.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
Returns:
a reconciler or null if reconciling should not be supported

getPresentationReconciler

public IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer)
Returns the presentation reconciler ready to be used with the given source viewer. This implementation always returns null.

Returns:
the presentation reconciler or null if presentation reconciling should not be supported

getContentFormatter

public IContentFormatter getContentFormatter(ISourceViewer sourceViewer)
Returns the content formatter ready to be used with the given source viewer. This implementation always returns null.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
Returns:
a content formatter or null if formatting should not be supported

getContentAssistant

public IContentAssistant getContentAssistant(ISourceViewer sourceViewer)
Returns the content assistant ready to be used with the given source viewer. This implementation always returns null.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
Returns:
a content assistant or null if content assist should not be supported

getAutoIndentStrategy

public IAutoIndentStrategy getAutoIndentStrategy(ISourceViewer sourceViewer,
                                                 String contentType)
Returns the auto indentation strategy ready to be used with the given source viewer when manipulating text of the given content type. This implementation always returns an new instance of DefaultAutoIndentStrategy.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
contentType - the content type for which the strategy is applicable
Returns:
the auto indent strategy or null if automatic indentation is not to be enabled

getDefaultPrefixes

public String[] getDefaultPrefixes(ISourceViewer sourceViewer,
                                   String contentType)
Returns the default prefixes to be used by the line-prefix operation in the given source viewer for text of the given content type. This implementation always returns null.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
contentType - the content type for which the prefix is applicable
Returns:
the default prefixes or null if the prefix operation should not be supported
Since:
2.0

getDoubleClickStrategy

public ITextDoubleClickStrategy getDoubleClickStrategy(ISourceViewer sourceViewer,
                                                       String contentType)
Returns the double-click strategy ready to be used in this viewer when double clicking onto text of the given content type. This implementation always returns a new instance of DefaultTextDoubleClickStrategy.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
contentType - the content type for which the strategy is applicable
Returns:
a double-click strategy or null if double clicking should not be supported

getIndentPrefixes

public String[] getIndentPrefixes(ISourceViewer sourceViewer,
                                  String contentType)
Returns the prefixes to be used by the line-shift operation. This implementation always returns new String[] { "\t", " " }.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
contentType - the content type for which the prefix is applicable
Returns:
the prefixes or null if the prefix operation should not be supported

getAnnotationHover

public IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer)
Returns the annotation hover which will provide the information to be shown in a hover popup window when requested for the given source viewer.This implementation always returns null.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
Returns:
an annotation hover or null if no hover support should be installed

getTextHover

public ITextHover getTextHover(ISourceViewer sourceViewer,
                               String contentType)
Returns the text hover which will provide the information to be shown in a text hover popup window when requested for the given source viewer and the given content type. This implementation always returns null.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
contentType - the content type
Returns:
a text hover or null if no hover support should be installed

getInformationControlCreator

public IInformationControlCreator getInformationControlCreator(ISourceViewer sourceViewer)
Returns the information control creator. The creator is a factory creating information controls for the given source viewer. This implementation always returns a creator for DefaultInformationControl instances.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
Returns:
the information control creator or null if no information support should be installed
Since:
2.0

getInformationPresenter

public IInformationPresenter getInformationPresenter(ISourceViewer sourceViewer)
Returns the information presenter which will determine and shown information requested for the current cursor position. This implementation always returns null.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
Returns:
an information presenter null if no information presenter should be installed
Since:
2.0

getConfiguredContentTypes

public String[] getConfiguredContentTypes(ISourceViewer sourceViewer)
Returns all configured content types for the given source viewer. This list tells the caller which content types must be configured for the given source viewer, i.e. for which content types the given source viewer's functionalities must be specified. This implementation always returns new String[] { IDocument.DEFAULT_CONTENT_TYPE }.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
Returns:
the configured content types for the given viewer

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.