Eclipse Plug-in Developer Guide (Galileo) - org.eclipse.jface.text.quickassist (Eclipse Platform API Specification)

Eclipse Plug-in Developer Guide
Previous Page	Home	Next Page

Platform Plug-in Developer Guide Reference API Reference

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV PACKAGE NEXT PACKAGE

NO FRAMES

Package org.eclipse.jface.text.quickassist

This package provides the quick assist assistant add-on for an ISourceViewer.

See:
Description

Interface Summary

IQuickAssistAssistant An IQuickAssistAssistant provides support for quick fixes and quick assists.

IQuickAssistAssistantExtension Extends IQuickAssistAssistant with the following function: allows to get a handler for the given command identifier allows to enable support for colored labels in the proposal popup

IQuickAssistInvocationContext Context information for quick fix and quick assist processors.

IQuickAssistProcessor Quick assist processor for quick fixes and quick assists.

IQuickFixableAnnotation Allows an annotation to tell whether there are quick fixes for it and to cache that state.

Class Summary

QuickAssistAssistant Default implementation of IQuickAssistAssistant.

Package org.eclipse.jface.text.quickassist Description

This package provides the quick assist assistant add-on for an ISourceViewer. The quick assist assistant's purpose is to propose, display, and insert quick assists and quick fixes available at the current source viewer's quick assist invocation context.

A quick fix is a completion that can correct a problem reported and visible through an Annotation while a quick assist is not related to a problem or Annotation. Since quick assists can be proposed where appropriate they are normally not visible in the viewer. The quick assist assistant implementation in this package can show the quick assists that are available on the current line.

Package Specification

IQuickAssistAssistant defines the concept of the quick assist assistant add-on. It collaborates with a quick assist processor (IQuickAssistProcessor) in order to generate quick fix and quick assist completion proposals (ICompletionProposal) available at the current quick assist invocation context (IQuickAssistInvocationContext). The package provides a default implementation QuickAssistAssistant which completely defines and implements the UI and the control flow for a quick assist assistant.