Package com.intellij.openapi.actionSystem

Class Presentation

java.lang.Object

com.intellij.openapi.actionSystem.Presentation

All Implemented Interfaces:

java.lang.Cloneable

public final class Presentation
extends java.lang.Object
implements java.lang.Cloneable

The presentation of an action in a specific place in the user interface.

See Also:

AnAction, ActionPlaces

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_WEIGHT
static double	EVEN_HIGHER_WEIGHT
static double	HIGHER_WEIGHT
static java.util.function.Supplier<java.lang.String>	NULL_STRING
static java.lang.String	PROP_DESCRIPTION value: String
static java.lang.String	PROP_DISABLED_ICON value: Icon
static java.lang.String	PROP_ENABLED The actual value is a Boolean.
static java.lang.String	PROP_HOVERED_ICON value: Icon
static java.lang.String	PROP_ICON value: Icon
static java.lang.String	PROP_MNEMONIC_INDEX value: Integer
static java.lang.String	PROP_MNEMONIC_KEY value: Integer
static java.lang.String	PROP_SELECTED_ICON value: Icon
static java.lang.String	PROP_TEXT Defines tool tip for button at tool bar or text for element at menu value: String
static java.lang.String	PROP_VISIBLE value: Boolean

Constructor Summary

Constructors

Constructor and Description
Presentation()
Presentation(java.lang.String text)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener l)
Presentation	clone()
void	copyFrom(Presentation presentation)
<T> T	getClientProperty(Key<T> key)
java.lang.Object	getClientProperty(java.lang.String key)
java.lang.String	getDescription()
javax.swing.Icon	getDisabledIcon()
int	getDisplayedMnemonicIndex()
javax.swing.Icon	getHoveredIcon()
javax.swing.Icon	getIcon()
int	getMnemonic()
javax.swing.Icon	getSelectedIcon()
java.lang.String	getText()
java.lang.String	getTextWithMnemonic()
java.util.function.Supplier<TextWithMnemonic>	getTextWithMnemonic(java.util.function.Supplier<java.lang.String> text, boolean mayContainMnemonic)
java.util.function.Supplier<TextWithMnemonic>	getTextWithPossibleMnemonic()
double	getWeight()
boolean	isEnabled() Returns the state of this action.
boolean	isEnabledAndVisible()
boolean	isVisible()
<T> void	putClientProperty(Key<T> key, T value)
void	putClientProperty(java.lang.String key, java.lang.Object value)
void	removePropertyChangeListener(java.beans.PropertyChangeListener l)
void	restoreTextWithMnemonic(Presentation presentation)
static java.lang.String	restoreTextWithMnemonic(java.lang.String text, int mnemonic)
void	setDescription(java.lang.String description)
void	setDescription(java.util.function.Supplier<java.lang.String> dynamicDescription)
void	setDisabledIcon(javax.swing.Icon icon)
void	setEnabled(boolean enabled) Sets whether the action enabled or not.
void	setEnabledAndVisible(boolean enabled)
void	setHoveredIcon(javax.swing.Icon hoveredIcon)
void	setIcon(javax.swing.Icon icon)
void	setSelectedIcon(javax.swing.Icon selectedIcon)
void	setText(java.lang.String text) Sets the text with mnemonic.
void	setText(java.lang.String text, boolean mayContainMnemonic) Sets the presentation text.
void	setText(java.util.function.Supplier<java.lang.String> text) Sets the text with mnemonic supplier.
void	setText(java.util.function.Supplier<java.lang.String> text, boolean mayContainMnemonic) Sets the presentation text.
void	setTextWithMnemonic(java.util.function.Supplier<TextWithMnemonic> textWithMnemonicSupplier) Sets the presentation text
void	setVisible(boolean visible)
void	setWeight(double weight) Some action groups (like 'New...') may filter out actions with non-highest priority.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NULL_STRING

public static final java.util.function.Supplier<java.lang.String> NULL_STRING

PROP_TEXT

public static final java.lang.String PROP_TEXT

Defines tool tip for button at tool bar or text for element at menu value: String

See Also:

Constant Field Values

PROP_MNEMONIC_KEY

public static final java.lang.String PROP_MNEMONIC_KEY

value: Integer

See Also:

Constant Field Values

PROP_MNEMONIC_INDEX

public static final java.lang.String PROP_MNEMONIC_INDEX

value: Integer

See Also:

Constant Field Values

PROP_DESCRIPTION

public static final java.lang.String PROP_DESCRIPTION

value: String

See Also:

Constant Field Values

PROP_ICON

public static final java.lang.String PROP_ICON

value: Icon

See Also:

Constant Field Values

PROP_DISABLED_ICON

public static final java.lang.String PROP_DISABLED_ICON

value: Icon

See Also:

Constant Field Values

PROP_SELECTED_ICON

public static final java.lang.String PROP_SELECTED_ICON

value: Icon

See Also:

Constant Field Values

PROP_HOVERED_ICON

public static final java.lang.String PROP_HOVERED_ICON

value: Icon

See Also:

Constant Field Values

PROP_VISIBLE

public static final java.lang.String PROP_VISIBLE

value: Boolean

See Also:

Constant Field Values

PROP_ENABLED

public static final java.lang.String PROP_ENABLED

The actual value is a Boolean.

See Also:

Constant Field Values

DEFAULT_WEIGHT

public static final double DEFAULT_WEIGHT

See Also:

Constant Field Values

HIGHER_WEIGHT

public static final double HIGHER_WEIGHT

See Also:

Constant Field Values

EVEN_HIGHER_WEIGHT

public static final double EVEN_HIGHER_WEIGHT

See Also:

Constant Field Values

Constructor Detail

Presentation

public Presentation()

Presentation

public Presentation(java.lang.String text)

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

getText

public java.lang.String getText()

setText

public void setText(java.util.function.Supplier<java.lang.String> text,
                    boolean mayContainMnemonic)

Sets the presentation text.

Parameters:

text - presentation text. Use it if you need to localize text.

mayContainMnemonic - if true, the text has text-with-mnemonic format, otherwise it's a plain text and no mnemonic will be used.

setText

public void setText(java.lang.String text,
                    boolean mayContainMnemonic)

Sets the presentation text.

Parameters:

text - presentation text.

mayContainMnemonic - if true, the text has text-with-mnemonic format, otherwise it's a plain text and no mnemonic will be used.

getTextWithMnemonic

public java.util.function.Supplier<TextWithMnemonic> getTextWithMnemonic(java.util.function.Supplier<java.lang.String> text,
                                                                         boolean mayContainMnemonic)

setTextWithMnemonic

public void setTextWithMnemonic(java.util.function.Supplier<TextWithMnemonic> textWithMnemonicSupplier)

Sets the presentation text

Parameters:

textWithMnemonicSupplier - text with mnemonic to set

setText

public void setText(java.lang.String text)

Sets the text with mnemonic.

See Also:

setText(String, boolean)

setText

public void setText(java.util.function.Supplier<java.lang.String> text)

Sets the text with mnemonic supplier. Use it if you need to localize text.

getTextWithMnemonic

public java.lang.String getTextWithMnemonic()

Returns:

the text with mnemonic, properly escaped, so it could be passed to setText(String) (e.g. to copy the presentation).

getTextWithPossibleMnemonic

public java.util.function.Supplier<TextWithMnemonic> getTextWithPossibleMnemonic()

restoreTextWithMnemonic

public void restoreTextWithMnemonic(Presentation presentation)

restoreTextWithMnemonic

public static java.lang.String restoreTextWithMnemonic(java.lang.String text,
                                                       int mnemonic)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.util.function.Supplier<java.lang.String> dynamicDescription)

setDescription

public void setDescription(java.lang.String description)

getIcon

public javax.swing.Icon getIcon()

setIcon

public void setIcon(javax.swing.Icon icon)

getDisabledIcon

public javax.swing.Icon getDisabledIcon()

setDisabledIcon

public void setDisabledIcon(javax.swing.Icon icon)

getHoveredIcon

public javax.swing.Icon getHoveredIcon()

setHoveredIcon

public void setHoveredIcon(javax.swing.Icon hoveredIcon)

getSelectedIcon

public javax.swing.Icon getSelectedIcon()

setSelectedIcon

public void setSelectedIcon(javax.swing.Icon selectedIcon)

getMnemonic

public int getMnemonic()

getDisplayedMnemonicIndex

public int getDisplayedMnemonicIndex()

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

isEnabled

public boolean isEnabled()

Returns the state of this action.

Returns:

true if action is enabled, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Sets whether the action enabled or not. If an action is disabled, AnAction.actionPerformed(com.intellij.openapi.actionSystem.AnActionEvent) won't be called. In case when action represents a button or a menu item, the representing button or item will be greyed out.

Parameters:

enabled - true if you want to enable action, false otherwise

setEnabledAndVisible

public final void setEnabledAndVisible(boolean enabled)

clone

public Presentation clone()

Overrides:

clone in class java.lang.Object

copyFrom

public void copyFrom(Presentation presentation)

getClientProperty

public <T> T getClientProperty(Key<T> key)

putClientProperty

public <T> void putClientProperty(Key<T> key,
                                  T value)

getClientProperty

public java.lang.Object getClientProperty(java.lang.String key)

putClientProperty

public void putClientProperty(java.lang.String key,
                              java.lang.Object value)

getWeight

public double getWeight()

setWeight

public void setWeight(double weight)

Some action groups (like 'New...') may filter out actions with non-highest priority.

Parameters:

weight - please use HIGHER_WEIGHT or EVEN_HIGHER_WEIGHT

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isEnabledAndVisible

public boolean isEnabledAndVisible()