bibliothek.gui.dock.station.stack.menu

Class CombinedMenuContent.Item

java.lang.Object

bibliothek.gui.dock.station.stack.menu.CombinedMenuContent.Item

Enclosing interface:

CombinedMenuContent

public static class CombinedMenuContent.Item
extends Object

Describes one item of a menu.

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
Item(Dockable dockable, String text, String tooltip, Icon icon, boolean enabled) Creates a new CombinedMenuContent.Item.

Method Summary

Modifier and Type	Method and Description
Dockable	getDockable() Gets the element which is represented by this item.
Icon	getIcon() Gets the icon of this item.
String	getText() Gets the text to be shown to the user.
String	getToolTip() Gets the description of this item.
boolean	isEnabled() Tells whether this item can be selected.

Methods inherited from class java.lang.Object

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

Constructor Detail

Item

public Item(Dockable dockable,
            String text,
            String tooltip,
            Icon icon,
            boolean enabled)

Creates a new CombinedMenuContent.Item.

Parameters:

dockable - the items value

text - the items text

tooltip - the items description

icon - the items icon

enabled - whether this item is selectable

Method Detail

getDockable

public Dockable getDockable()

Gets the element which is represented by this item.

Returns:

the element, may not be null

getText

public String getText()

Gets the text to be shown to the user.

Returns:

the title, may be null

getToolTip

public String getToolTip()

Gets the description of this item.

Returns:

the description, may be null

getIcon

public Icon getIcon()

Gets the icon of this item.

Returns:

the icon, may be null

isEnabled

public boolean isEnabled()

Tells whether this item can be selected.

Returns:

whether this item is enabled