Eclipse Plug-in Developer Guide (Galileo) - KeyBindingSupportForAssistant (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.texteditor
Class KeyBindingSupportForAssistant


java.lang.Object
  
org.eclipse.ui.texteditor.KeyBindingSupportForAssistant

All Implemented Interfaces:: ICompletionListener

public final class KeyBindingSupportForAssistant
extends Object
implements ICompletionListener
extends Object
implements ICompletionListener

Helper class to make navigation key bindings work for the content assistant and the quick assist assistant while the editor has focus.

Clients normally don't need to use that class as the setup is done by the framework.

Since:: 3.4

Constructor Summary

KeyBindingSupportForAssistant ( ContentAssistant contentAssistant)
          Deprecated. As of 3.5, this is a NOP since the framework installs this now

KeyBindingSupportForAssistant ( ContentAssistantFacade contentAssistFacade)
          Deprecated. As of 3.5, this is a NOP since the framework installs this now

KeyBindingSupportForAssistant ( IQuickAssistAssistant quickAssistAssistant)
          Creates the support for a quick assist assistant.

KeyBindingSupportForAssistant ( ISourceViewerExtension4 sourceViewerExtension)
          Creates the support for a content assistant facade.

Method Summary

void assistSessionEnded ( ContentAssistEvent event)
          Called when a code assist session ends (for example, the proposal popup is closed).

void assistSessionStarted ( ContentAssistEvent event)
          Called when code assist is invoked when there is no current code assist session.

void dispose ()


void selectionChanged ( ICompletionProposal proposal, boolean smartToggle)
          Called when the selection in the proposal popup is changed or if the insert-mode changed.

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyBindingSupportForAssistant

public KeyBindingSupportForAssistant(
ContentAssistantFacade contentAssistFacade)

Deprecated. As of 3.5, this is a NOP since the framework installs this now

Creates the support for a content assistant facade.

Parameters:: contentAssistFacade - the content assist facade

KeyBindingSupportForAssistant

public KeyBindingSupportForAssistant(
ISourceViewerExtension4 sourceViewerExtension)

Creates the support for a content assistant facade.

Parameters:: sourceViewerExtension - the source viewer extension
Since:: 3.5

KeyBindingSupportForAssistant

public KeyBindingSupportForAssistant(
ContentAssistant contentAssistant)

Deprecated. As of 3.5, this is a NOP since the framework installs this now

Creates the support for a content assistant facade.

Parameters:: contentAssistant - the content assist facade

KeyBindingSupportForAssistant

public KeyBindingSupportForAssistant(
IQuickAssistAssistant quickAssistAssistant)

Creates the support for a quick assist assistant.

Parameters:: quickAssistAssistant - the quick assist assistant.

Method Detail

assistSessionStarted

public void assistSessionStarted(
ContentAssistEvent event)

Description copied from interface: ICompletionListener

Called when code assist is invoked when there is no current code assist session.

Specified by:: assistSessionStarted in interface ICompletionListener

Parameters:: event - the content assist event

assistSessionEnded

public void assistSessionEnded(
ContentAssistEvent event)

Description copied from interface: ICompletionListener

Called when a code assist session ends (for example, the proposal popup is closed).

Specified by:: assistSessionEnded in interface ICompletionListener

Parameters:: event - the content assist event

selectionChanged

public void selectionChanged(
ICompletionProposal proposal,
                             boolean smartToggle)

Description copied from interface: ICompletionListener

Called when the selection in the proposal popup is changed or if the insert-mode changed.

Specified by:: selectionChanged in interface ICompletionListener

Parameters:: proposal - the newly selected proposal, possibly null; smartToggle - true if the insert-mode toggle is being pressed, false otherwise