Package com.intellij.openapi.actionSystem

Interface DataProvider

All Known Subinterfaces:

BackgroundableDataProvider

All Known Implementing Classes:

AbstractPopup.MyContentPanel, AbstractProjectViewPane, AbstractProjectViewPSIPane, ActionLink, AnalysisProblemsViewPanel, AnalyzeStacktraceUtil.StacktraceEditorPanel, AntBuildMessageView, AntExplorer, ArrangementGroupingRulesPanel, ArrangementMatchingRulesPanel, ArrangementRuleAliasesPanel, BrowserPanel, BuildTextConsoleView, BuildTreeConsoleView, BuildView, CallHierarchyBrowser, CallHierarchyBrowserBase, CannotUndoReportDialog, CaptionPanel, ChangeListTodosPanel, ChangesBrowserBase, ChangesBrowserBase.ChangesBrowserTreeList, ChangesBrowserWithRollback, ChangesListView, ChangesTree, ChangesTreeImpl, ChangesTreeImpl.Changes, ChangesTreeImpl.FilePaths, ChangesTreeImpl.VirtualFiles, ChangesTreeList, ChangesViewManager.ChangesViewToolWindowPanel, ChooseByNameBase.JPanelProvider, ClassesTable, CollectionTree, ComboboxEditorTextField, Commander, CommitDialogChangesBrowser, CommitMessage, CommittedChangeListPanel, CommittedChangesBrowser, CommittedChangesTreeBrowser, CompilerErrorTreeView, ComponentTree, ComponentTree, CompositeView, ConsoleViewImpl, CoverageView, CvsConfigurationsListEditor, CvsTabbedWindowComponent, CyclicDependenciesPanel, DebuggerSessionTabBase, DebuggerTree, DebuggerTreePanel, DependenciesPanel, DependenciesUsagesPanel, DesignerActionPanel, DesignerEditorPanel, DiffPanelBase, DiffViewerBase, DirDiffPanel, DocumentationComponent, DomModelTreeView, DuplexConsoleView, EditorComponentImpl, EditorSearchSession, EditorTextField, EditorWindow.TComp, EditScopesDialog, ExternalProjectsViewImpl, FavoritesTreeViewPanel, FileChooserDialogImpl.MyPanel, FileHistoryPanel, FileHistoryPanelImpl, FinderRecursivePanel, GenericDataProvider, GitPushAfterCommitDialog, GlassLayer, GlassLayer, GradleToolWindowPanel, GridCaptionPanel, GridImpl, GrMethodSignatureComponent, GroovyShellLanguageConsoleView, GuiEditor, HgMqUnAppliedPatchesPanel, HierarchyBrowserBase, HierarchyBrowserBaseEx, HighlightingOutputConsole, IdeErrorsDialog, IdeFrameImpl, IdeStatusBarImpl, InspectionResultsView, InstancesTree, InternalCompilerRefServiceView, InternalDecorator, JBEditorTabs, JBTabsImpl, JBTerminalWidget, LanguageConsoleBuilder.GutteredLanguageConsole, LanguageConsoleImpl, LanguageTextField, ListenerDiffViewerBase, ListWithFilter, LocalChangesBrowser, MainFrame, MethodHierarchyBrowser, MethodHierarchyBrowserBase, MethodSignatureComponent, MigrationConflictsPanel, MigrationUsagesPanel, ModuleStructureComponent, ModuleStructurePane, MvcProjectViewPane, NavBarItem, NavBarPanel, NewEditableErrorTreeViewPanel, NewErrorTreeViewPanel, OnesideBinaryDiffViewer, OnesideDiffViewer, OnesideTextDiffViewer, OverheadView, PackageViewPane, PaletteGroupHeader, PalettePanel, PaletteWindow, PanelWithActionsAndCloseButton, ProblemsViewPanel, ProjectFrameHelper, ProjectViewPane, PropertiesFileStructureViewComponent, PropertiesGroupingStructureViewComponent, PropertyInspectorTable, PsiViewerDialog, PushLog, PushTargetTextField, PyCallHierarchyBrowser, PythonConsoleView, PythonDebugLanguageConsoleView, PyTypeHierarchyBrowser, RadPropertyTable, RepositoryBrowserComponent, RepositoryChangesBrowser, ResourceBundleStructureViewComponent, RunContentBuilder, RunInspectionAction, RunnerLayoutUiImpl, RunTab, ScopeBasedTodosPanel, ScopeViewPane, ScratchProjectViewPane, SearchEverywhereAction, SearchEverywhereUI, SearchReplaceComponent, SelectFilesDialog.VirtualFileList, SettingsDialog, ShellTerminalWidget, SimpleChangesBrowser, SimpleDiffPanel, SimpleDiffViewer, SimpleLocalChangeListDiffViewer, SimpleOnesideDiffViewer, SimpleThreesideDiffViewer, SimpleToolWindowPanel, SingleElementTree, StripeButton, StructureViewComponent, SvnPropertiesDiffViewer, Switcher.SwitcherPanel, TabbedPaneWrapper.TabWrapper, TextFieldWithAutoCompletion, TextFieldWithCompletion, TextMergeViewer.MyThreesideViewer, TextViewer, ThreadDumpPanel, ThreadsDebuggerTree, ThreadsPanel, ThreesideBinaryDiffViewer, ThreesideDiffViewer, ThreesideTextDiffViewer, ThreesideTextDiffViewerEx, ToolWindowContentUi, TwosideBinaryDiffViewer, TwosideDiffViewer, TwosideTextDiffViewer, TypeHierarchyBrowser, TypeHierarchyBrowserBase, TypeSafeDataProviderAdapter, UnifiedDiffPanel, UnifiedDiffViewer, UnifiedLocalChangeListDiffViewer, UpdateInfoTree, UsagePreviewPanel, UsagesPanel, VcsLogChangesBrowser, VcsLogChangesBrowser.MyChangesTree, VcsLogGraphTable, VcsLogPanel, VcsPushDialog, VcsSelectionHistoryDialog, XDebuggerTree, XDebugSessionTab, XVariablesView, XWatchesViewImpl

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface DataProvider

Allows a component hosting actions to provide context information to the actions. When a specific data item is requested, the component hierarchy is walked up from the currently focused component, and every component implementing the DataProvider interface is queried for the data until one of them returns the data. Data items can also be mapped to each other - for example, if a data provider provides an item for CommonDataKeys.NAVIGATABLE, an item for CommonDataKeys.NAVIGATABLE_ARRAY can be generated from it automatically.

See Also:

DataContext

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getData(java.lang.String dataId) Returns the object corresponding to the specified data identifier.

Method Detail

getData

java.lang.Object getData(java.lang.String dataId)

Returns the object corresponding to the specified data identifier. Some of the supported data identifiers are defined in the PlatformDataKeys class.

Parameters:

dataId - the data identifier for which the value is requested.

Returns:

the value, or null if no value is available in the current context for this identifier.