|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.text.source.projection.ProjectionSupport
Supports the configuration of projection capabilities a ProjectionViewer
.
This class is not intended to be subclassed. Clients are supposed to configure and use it as is.
Field Summary | |
---|---|
static Object |
PROJECTION
Key of the projection annotation model inside the visual annotation model. |
Constructor Summary | |
---|---|
ProjectionSupport(ProjectionViewer viewer,
IAnnotationAccess annotationAccess,
ISharedTextColors sharedTextColors)
Creates new projection support for the given projection viewer. |
Method Summary | |
---|---|
void |
addSummarizableAnnotationType(String annotationType)
Marks the given annotation type to be considered when creating summaries for collapsed regions of the projection viewer. |
void |
dispose()
Disposes this projection support. |
protected void |
doDisableProjection()
Removes the projection ruler column and the painter from the projection viewer. |
protected void |
doEnableProjection()
Enables projection mode. |
Object |
getAdapter(ISourceViewer viewer,
Class required)
Implements the contract of IAdaptable.getAdapter(java.lang.Class)
by forwarding the adapter requests to the given viewer. |
void |
install()
Installs this projection support on its viewer. |
void |
removeSummarizableAnnotationType(String annotationType)
Marks the given annotation type to be ignored when creating summaries for collapsed regions of the projection viewer. |
void |
setAnnotationPainterDrawingStrategy(AnnotationPainter.IDrawingStrategy strategy)
Sets the drawing strategy that the projection support's annotation painter uses to draw the indication of collapsed regions onto the projection viewer's text widget. |
void |
setHoverControlCreator(IInformationControlCreator creator)
Sets the hover control creator that is used for the annotation hovers that are shown in the projection viewer's projection ruler column. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final Object PROJECTION
Constructor Detail |
public ProjectionSupport(ProjectionViewer viewer, IAnnotationAccess annotationAccess, ISharedTextColors sharedTextColors)
viewer
- the projection viewerannotationAccess
- the annotation accesssharedTextColors
- the shared text colors to useMethod Detail |
public void addSummarizableAnnotationType(String annotationType)
A summary is an annotation that gets created out of all annotations with a type that has been registered through this method and that are inside the folded region.
annotationType
- the annotation type to considerpublic void removeSummarizableAnnotationType(String annotationType)
addSummarizableAnnotationType
has been called before for
the give annotation type.
A summary is an annotation that gets created out of all annotations with a type that has been registered through this method and that are inside the folded region.
annotationType
- the annotation type to removepublic void setHoverControlCreator(IInformationControlCreator creator)
creator
- the hover control creatorpublic void setAnnotationPainterDrawingStrategy(AnnotationPainter.IDrawingStrategy strategy)
null
is passed in,
the drawing strategy is reset to the default. In order to avoid any
representation use AnnotationPainter.NullStrategy
.
strategy
- the drawing strategy or null
to reset the
strategy to the defaultpublic void install()
public void dispose()
protected void doEnableProjection()
protected void doDisableProjection()
public Object getAdapter(ISourceViewer viewer, Class required)
IAdaptable.getAdapter(java.lang.Class)
by forwarding the adapter requests to the given viewer.
viewer
- the viewerrequired
- the required class of the adapter
null
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.