de.espirit.firstspirit.client.plugin.contextmenu

Interface JavaClientContextMenuItem

All Superinterfaces:

Item<ContextMenuContext>

All Known Subinterfaces:

ExecutableContextMenuItem, GroupingContextMenuItem

All Known Implementing Classes:

SeparatorContextMenuItem

public interface JavaClientContextMenuItem
extends Item<ContextMenuContext>

An item to be used in context menus of the java client.

Since:

5.0.204

Method Summary

Methods

Modifier and Type	Method and Description
Icon	getIcon(ContextMenuContext context) Returns the icon of this item or null if this item has no icon.
String	getLabel(ContextMenuContext context) Provides a label for this item wrt. the given context.
boolean	isEnabled(ContextMenuContext context) Indicates, whether this item is enabled wrt. the given context.
boolean	isVisible(ContextMenuContext context) Indicates the visibility of this item wrt. the given context.

Method Detail

getLabel

@NotNull
String getLabel(@NotNull
                      ContextMenuContext context)

Provides a label for this item wrt. the given context.

Parameters:

context - The context to be considered for providing a label.

Returns:

The resulting label.

Since:

5.0.204

getIcon

@Nullable
Icon getIcon(@NotNull
                    ContextMenuContext context)

Returns the icon of this item or null if this item has no icon.
The recommended dimensions for this icon is 19x19

Parameters:

context - The context to be considered for providing the icon.

Returns:

The icon of this item or null, if the item has no icon.

Since:

5.0.204

isEnabled

boolean isEnabled(@NotNull
                ContextMenuContext context)

Indicates, whether this item is enabled wrt. the given context.

Specified by:

isEnabled in interface Item<ContextMenuContext>

Parameters:

context - The context to be considered for deciding upon the item being enabled.

Returns:

true, if enabled, false, else.

Since:

5.0.204

isVisible

boolean isVisible(@NotNull
                ContextMenuContext context)

Indicates the visibility of this item wrt. the given context.

Specified by:

isVisible in interface Item<ContextMenuContext>

Parameters:

context - The context to be considered for deciding upon visibility.

Returns:

true, if visible, false, else.

Since:

5.0.204