Package com.intellij.ide

Class DataManager

java.lang.Object

com.intellij.ide.DataManager

Direct Known Subclasses:

DataManagerImpl

public abstract class DataManager
extends java.lang.Object

Provides access to DataContext.

Use AnActionEvent.getData(DataKey) in AnAction.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLIENT_PROPERTY_DATA_PROVIDER

Constructor Summary

Constructors

Constructor and Description
DataManager()

Method Summary

Modifier and Type	Method and Description
abstract DataContext	getDataContext() Deprecated. use either getDataContext(Component) or getDataContextFromFocus()
abstract DataContext	getDataContext(java.awt.Component component)
abstract DataContext	getDataContext(java.awt.Component component, int x, int y)
<any>	getDataContextFromFocus() Deprecated. Use getDataContextFromFocusAsync()
abstract Promise<DataContext>	getDataContextFromFocusAsync()
static DataProvider	getDataProvider(javax.swing.JComponent component)
static DataManager	getInstance()
static DataManager	getInstanceIfCreated()
abstract <T> T	loadFromDataContext(DataContext dataContext, Key<T> dataKey)
static void	registerDataProvider(javax.swing.JComponent component, DataProvider provider)
static void	removeDataProvider(javax.swing.JComponent component)
abstract <T> void	saveInDataContext(DataContext dataContext, Key<T> dataKey, T data)

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_PROPERTY_DATA_PROVIDER

public static final java.lang.String CLIENT_PROPERTY_DATA_PROVIDER

See Also:

Constant Field Values

Constructor Detail

DataManager

public DataManager()

Method Detail

getInstance

public static DataManager getInstance()

getInstanceIfCreated

public static DataManager getInstanceIfCreated()

getDataContext

@Deprecated
public abstract DataContext getDataContext()

Deprecated. use either getDataContext(Component) or getDataContextFromFocus()

Returns:

DataContext constructed by the currently focused component

getDataContextFromFocus

@Deprecated
public final <any> getDataContextFromFocus()

Deprecated. Use getDataContextFromFocusAsync()

getDataContextFromFocusAsync

public abstract Promise<DataContext> getDataContextFromFocusAsync()

Returns:

DataContext constructed by the currently focused component.

getDataContext

public abstract DataContext getDataContext(java.awt.Component component)

Returns:

DataContext constructed by the specified component

getDataContext

public abstract DataContext getDataContext(java.awt.Component component,
                                           int x,
                                           int y)

Returns:

DataContext constructed be the specified component and the point specified by x and y coordinate inside the component.

Throws:

java.lang.IllegalArgumentException - if point (x, y) is not inside component's bounds

saveInDataContext

public abstract <T> void saveInDataContext(DataContext dataContext,
                                           Key<T> dataKey,
                                           T data)

Parameters:

dataContext - should be instance of UserDataHolder

dataKey - key to store value

data - value to store

loadFromDataContext

public abstract <T> T loadFromDataContext(DataContext dataContext,
                                          Key<T> dataKey)

Parameters:

dataContext - find by key if instance of UserDataHolder

dataKey - key to find value by

Returns:

value stored by saveInDataContext(DataContext, Key, Object)

registerDataProvider

public static void registerDataProvider(javax.swing.JComponent component,
                                        DataProvider provider)

getDataProvider

public static DataProvider getDataProvider(javax.swing.JComponent component)

removeDataProvider

public static void removeDataProvider(javax.swing.JComponent component)