Package com.intellij.openapi.actionSystem

Class PlatformDataKeys

java.lang.Object

com.intellij.openapi.actionSystem.CommonDataKeys

com.intellij.openapi.actionSystem.PlatformDataKeys

Direct Known Subclasses:

LangDataKeys

public class PlatformDataKeys
extends CommonDataKeys

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<java.util.Comparator<? super AnAction>>	ACTIONS_SORTER Deprecated. use ActionPromoter
static DataKey<ContentManager>	CONTENT_MANAGER
static DataKey<java.awt.Component>	CONTEXT_COMPONENT Returns Component currently in focus, DataContext should be retrieved for.
static DataKey<java.awt.Point>	CONTEXT_MENU_POINT Returns Point to guess where to show context menu invoked by key.
static DataKey<CopyProvider>	COPY_PROVIDER
static DataKey<CutProvider>	CUT_PROVIDER
static DataKey<DeleteProvider>	DELETE_ELEMENT_PROVIDER
static DataKey<java.awt.Rectangle>	DOMINANT_HINT_AREA_RECTANGLE
static DataKey<ExporterToTextFile>	EXPORTER_TO_TEXT_FILE
static DataKey<FileEditor>	FILE_EDITOR
static DataKey<java.lang.String>	FILE_TEXT Returns the text of currently selected file/file revision
static DataKey<java.lang.String>	HELP_ID Returns help id.
static DataKey<java.lang.Boolean>	IS_MODAL_CONTEXT Returns Boolean.TRUE if action is executed in modal context and Boolean.FALSE if action is executed not in modal context.
static DataKey<ModalityState>	MODALITY_STATE
static DataKey<ContentManager>	NONEMPTY_CONTENT_MANAGER
static DataKey<PasteProvider>	PASTE_PROVIDER
static DataKey<java.lang.String>	PREDEFINED_TEXT
static DataKey<Project>	PROJECT_CONTEXT Returns project if project node is selected (in project view)
static DataKey<VirtualFile>	PROJECT_FILE_DIRECTORY
static DataKey<java.lang.String>	SEARCH_INPUT_TEXT
static DataKey<java.lang.Object>	SELECTED_ITEM Returns single selection item.
static DataKey<java.lang.Object[]>	SELECTED_ITEMS Returns multi selection items.
static DataKey<java.lang.Boolean>	SOURCE_NAVIGATION_LOCKED
static DataKey<java.lang.Object>	SPEED_SEARCH_COMPONENT
static DataKey<StatusBar>	STATUS_BAR
static DataKey<ToolWindow>	TOOL_WINDOW
static DataKey<TreeExpander>	TREE_EXPANDER
static DataKey<Disposable>	UI_DISPOSABLE

Fields inherited from class com.intellij.openapi.actionSystem.CommonDataKeys

CARET, EDITOR, EDITOR_EVEN_IF_INACTIVE, EDITOR_VIRTUAL_SPACE, HOST_EDITOR, NAVIGATABLE, NAVIGATABLE_ARRAY, PROJECT, PSI_ELEMENT, PSI_FILE, VIRTUAL_FILE, VIRTUAL_FILE_ARRAY

Constructor Summary

Constructors

Constructor and Description
PlatformDataKeys()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

FILE_EDITOR

public static final DataKey<FileEditor> FILE_EDITOR

FILE_TEXT

public static final DataKey<java.lang.String> FILE_TEXT

Returns the text of currently selected file/file revision

IS_MODAL_CONTEXT

public static final DataKey<java.lang.Boolean> IS_MODAL_CONTEXT

Returns Boolean.TRUE if action is executed in modal context and Boolean.FALSE if action is executed not in modal context. If context is unknown returns null.

HELP_ID

public static final DataKey<java.lang.String> HELP_ID

Returns help id.

See Also:

HelpManager.invokeHelp(String)

PROJECT_CONTEXT

public static final DataKey<Project> PROJECT_CONTEXT

Returns project if project node is selected (in project view)

CONTEXT_COMPONENT

public static final DataKey<java.awt.Component> CONTEXT_COMPONENT

Returns Component currently in focus, DataContext should be retrieved for.

COPY_PROVIDER

public static final DataKey<CopyProvider> COPY_PROVIDER

CUT_PROVIDER

public static final DataKey<CutProvider> CUT_PROVIDER

PASTE_PROVIDER

public static final DataKey<PasteProvider> PASTE_PROVIDER

DELETE_ELEMENT_PROVIDER

public static final DataKey<DeleteProvider> DELETE_ELEMENT_PROVIDER

SELECTED_ITEM

public static final DataKey<java.lang.Object> SELECTED_ITEM

Returns single selection item.

See Also:

SELECTED_ITEMS

SELECTED_ITEMS

public static final DataKey<java.lang.Object[]> SELECTED_ITEMS

Returns multi selection items.

See Also:

SELECTED_ITEM

DOMINANT_HINT_AREA_RECTANGLE

public static final DataKey<java.awt.Rectangle> DOMINANT_HINT_AREA_RECTANGLE

CONTENT_MANAGER

public static final DataKey<ContentManager> CONTENT_MANAGER

NONEMPTY_CONTENT_MANAGER

public static final DataKey<ContentManager> NONEMPTY_CONTENT_MANAGER

TOOL_WINDOW

public static final DataKey<ToolWindow> TOOL_WINDOW

STATUS_BAR

public static final DataKey<StatusBar> STATUS_BAR

TREE_EXPANDER

public static final DataKey<TreeExpander> TREE_EXPANDER

EXPORTER_TO_TEXT_FILE

public static final DataKey<ExporterToTextFile> EXPORTER_TO_TEXT_FILE

See Also:

ExportToTextFileAction

PROJECT_FILE_DIRECTORY

public static final DataKey<VirtualFile> PROJECT_FILE_DIRECTORY

UI_DISPOSABLE

public static final DataKey<Disposable> UI_DISPOSABLE

MODALITY_STATE

public static final DataKey<ModalityState> MODALITY_STATE

SOURCE_NAVIGATION_LOCKED

public static final DataKey<java.lang.Boolean> SOURCE_NAVIGATION_LOCKED

PREDEFINED_TEXT

public static final DataKey<java.lang.String> PREDEFINED_TEXT

SEARCH_INPUT_TEXT

public static final DataKey<java.lang.String> SEARCH_INPUT_TEXT

SPEED_SEARCH_COMPONENT

public static final DataKey<java.lang.Object> SPEED_SEARCH_COMPONENT

CONTEXT_MENU_POINT

public static final DataKey<java.awt.Point> CONTEXT_MENU_POINT

Returns Point to guess where to show context menu invoked by key.

This point should be relative to the currently focused component

ACTIONS_SORTER

@Deprecated
public static final DataKey<java.util.Comparator<? super AnAction>> ACTIONS_SORTER

Deprecated. use ActionPromoter

It's allowed to assign multiple actions to the same keyboard shortcut. Actions system filters them on the current context basis during processing (e.g., we can have two actions assigned to the same shortcut, but one of them is configured to be inapplicable in modal dialog context).

However, there is a possible case that there is still more than one action applicable for particular keyboard shortcut after filtering. The first one is executed then. Hence, actions processing order becomes very important.

Current key allows specifying custom actions sorter to use if any. I.e., every component can define its custom sorting rule to define priorities for target actions (classes of actions).

Constructor Detail

PlatformDataKeys

public PlatformDataKeys()