Package com.intellij.openapi.editor.actionSystem

Class TypedAction

java.lang.Object

com.intellij.openapi.editor.actionSystem.TypedAction

Direct Known Subclasses:

TypedActionImpl

public abstract class TypedAction
extends java.lang.Object

Provides services for registering actions which are activated by typing in the editor.

Constructor Summary

Constructors

Constructor and Description
TypedAction()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(Editor editor, char charTyped, DataContext dataContext)
void	beforeActionPerformed(Editor editor, char c, DataContext context, ActionPlan plan)
TypedActionHandler	getHandler() Gets the current typing handler.
static TypedAction	getInstance()
TypedActionHandler	getRawHandler() Gets the current 'raw' typing handler.
TypedActionHandler	setupHandler(TypedActionHandler handler) Deprecated. Use <typedHandler> extension point for registering typing handlers
TypedActionHandler	setupRawHandler(TypedActionHandler handler) Replaces current 'raw' typing handler with the specified handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedAction

public TypedAction()

Method Detail

getInstance

public static TypedAction getInstance()

getHandler

public TypedActionHandler getHandler()

Gets the current typing handler.

Returns:

the current typing handler.

setupHandler

@Deprecated
public TypedActionHandler setupHandler(TypedActionHandler handler)

Deprecated. Use <typedHandler> extension point for registering typing handlers

Replaces the typing handler with the specified handler. The handler should pass unprocessed typing to the previously registered handler.

Parameters:

handler - the handler to set.

Returns:

the previously registered handler.

getRawHandler

public TypedActionHandler getRawHandler()

Gets the current 'raw' typing handler.

See Also:

setupRawHandler(TypedActionHandler)

setupRawHandler

public TypedActionHandler setupRawHandler(TypedActionHandler handler)

Replaces current 'raw' typing handler with the specified handler. The handler should pass unprocessed typing to the previously registered 'raw' handler.

'Raw' handler is a handler directly invoked by the code which handles typing in editor. Default 'raw' handler performs some generic logic that has to be done on typing (like checking whether file has write access, creating a command instance for undo subsystem, initiating write action, etc), but delegates to 'normal' handler for actual typing logic.

Parameters:

handler - the handler to set.

Returns:

the previously registered handler.

See Also:

getRawHandler(), getHandler(), setupHandler(TypedActionHandler)

beforeActionPerformed

public void beforeActionPerformed(Editor editor,
                                  char c,
                                  DataContext context,
                                  ActionPlan plan)

actionPerformed

public final void actionPerformed(Editor editor,
                                  char charTyped,
                                  DataContext dataContext)