de.weltraumschaf.commons.swing

Class MenuItemBuilder

java.lang.Object

de.weltraumschaf.commons.swing.MenuItemBuilder

public final class MenuItemBuilder
extends Object

Builder to create a menu item.

You should not use this class directly. Instead use MenuBarBuilder.

Since:

1.0.0

Author:

Sven Strittmatter

Field Summary

Fields

Modifier and Type	Field and Description
private JMenuItem	menuItem The built item.
private static OperatingSystem	OS Used for OS specific differences.
private MenuBuilder	parent The menu builder which creates the menu to which item will belong.

Constructor Summary

Constructors

Constructor and Description
MenuItemBuilder(String name, MenuBuilder parent) Package private constructor.

Method Summary

Methods

Modifier and Type	Method and Description
MenuItemBuilder	addListener(ActionListener listener) Add a listener to the item.
MenuBuilder	end() Call if ready with building the menu item.
(package private) JMenuItem	getMenuItem() Get the built item.
MenuItemBuilder	setAccelerator(char accelerator) Add an accelerator key.

Methods inherited from class java.lang.Object

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

Field Detail

OS

private static final OperatingSystem OS

Used for OS specific differences.

menuItem

private final JMenuItem menuItem

The built item.

parent

private final MenuBuilder parent

The menu builder which creates the menu to which item will belong.

Constructor Detail

MenuItemBuilder

MenuItemBuilder(String name,
               MenuBuilder parent)

Package private constructor. This sub builder is constructed by the MenuBuilder.

Parameters:

name - Name of the item.

parent - Constructing menu builder.

Method Detail

getMenuItem

JMenuItem getMenuItem()

Get the built item.

Returns:

Always return the same instance per builder.

addListener

public MenuItemBuilder addListener(ActionListener listener)

Add a listener to the item.

Parameters:

listener - Action listener to handle events.

Returns:

Returns the builder itself.

setAccelerator

public MenuItemBuilder setAccelerator(char accelerator)

Add an accelerator key. For Mac OS with mask InputEvent.META_DOWN_MASK for all other systems InputEvent.CTRL_DOWN_MASK.

Parameters:

accelerator - Accelerator key character.

Returns:

Returns the builder itself.

end

public MenuBuilder end()

Call if ready with building the menu item.

Returns:

The parent menu builder.