de.weltraumschaf.commons.swing

Class MenuBuilder

java.lang.Object

de.weltraumschaf.commons.swing.MenuBuilder

public final class MenuBuilder
extends Object

Builder to create a menu.

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 JMenu	menu The built menu.
private MenuBarBuilder	parent The menu bar builder which creates the menu bar to which menu will belong.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MenuBarBuilder	end() Call if ready with building the menu.
(package private) JMenu	getMenu() Get the built menu.
MenuItemBuilder	item(String name) Creates a menu item in the menu.
MenuBuilder	separator() Add a separator to the menu.

Methods inherited from class java.lang.Object

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

Field Detail

menu

private final JMenu menu

The built menu.

parent

private final MenuBarBuilder parent

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

Constructor Detail

MenuBuilder

MenuBuilder(String name,
           MenuBarBuilder parent)

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

Parameters:

name - Name of the menu.

parent - Constructing menu bar builder.

Method Detail

getMenu

JMenu getMenu()

Get the built menu.

Returns:

Always return the same instance per builder.

item

public MenuItemBuilder item(String name)

Creates a menu item in the menu.

Parameters:

name - Name of the item.

Returns:

A menu item builder.

separator

public MenuBuilder separator()

Add a separator to the menu.

Returns:

Returns the menu builder itself.

end

public MenuBarBuilder end()

Call if ready with building the menu.

Returns:

The parent menu bar builder.