oracle.ide.controller
Interface LabelUpdater

All Known Implementing Classes:

ContextAwareLabelUpdater, MenuAwareLabelUpdater

public interface LabelUpdater

LabelUpdater is responsible for updating an action's label.

Field Summary

static java.lang.String

LABEL_UPDATER_MACROS

Method Summary

java.lang.String	labelWhenDisabled(Context context, IdeAction action, java.lang.String originalLabel) Returns the action's label when it is disabled. If null then the action will be left unchanged.
java.lang.String	labelWhenEnabled(Context context, IdeAction action, java.lang.String originalLabel) Returns the action's label when it is enabled. If null then the action will be left unchanged.
void	setDisabledFormat(java.lang.String format) Sets the value for the disabled format.
void	setEnabledFormat(java.lang.String format) Sets the value for the enabled format.

Field Detail

LABEL_UPDATER_MACROS

static final java.lang.String LABEL_UPDATER_MACROS

See Also:

Constant Field Values

Method Detail

labelWhenEnabled

java.lang.String labelWhenEnabled(Context context,
                                  IdeAction action,
                                  java.lang.String originalLabel)

Returns the action's label when it is enabled.
If null then the action will be left unchanged.

Parameters:

context - the current context

action - the action to be updated

originalLabel - the action's first label

labelWhenDisabled

java.lang.String labelWhenDisabled(Context context,
                                   IdeAction action,
                                   java.lang.String originalLabel)

Returns the action's label when it is disabled.
If null then the action will be left unchanged.

Parameters:

context - the current context

action - the action to be updated

originalLabel - the action's first label

setEnabledFormat

void setEnabledFormat(java.lang.String format)

Sets the value for the enabled format.

Parameters:

format - the value for enabled format

setDisabledFormat

void setDisabledFormat(java.lang.String format)

Sets the value for the disabled format.

Parameters:

format - the value for disabled format