com.nelkinda.javax.swing

Class GuiFactory

java.lang.Object

com.nelkinda.javax.swing.GuiFactory

public class GuiFactory
extends Object

The GuiFactory creates components based on a resource bundle and an action map.

The following keys are supported in the resource bundle:

Supported keys

Key	Purpose
menuBar	the menus for the menu bar
toolBar	the buttons for the tool bar
action.menu	the menu items or sub menus for a menu
action.AcceleratorKey	The keystroke for triggering an action
action.SwingDisplayedMnemonicIndexKey	The index of the mnemonic character to underline
action.Name	The main text of the action, appears in menus
action.MnemonicKey	The key to use as mnemonic
action.ShortDescription	The text to show as a tooltip
action.SmallIcon	Small icon, shown in menus
action.SwingLargeIconKey	Large icon, shown in toolbars

Since:

0.0.2

Version:

0.0.2

Author:

Christian Hujer, Nelkinda Software Craft Pvt Ltd

Constructor Summary

Constructors

Constructor and Description
GuiFactory(@NotNull ResourceBundle resourceBundle, @NotNull ActionMap actionMap) Creates a GuiFactory.

Method Summary

Modifier and Type	Method and Description
@NotNull Action	createAction(@NotNull String actionCommand) Creates an dummy action.
@NotNull Action	createAction(@NotNull String actionCommand, @NotNull Action action) Creates an action.
@NotNull Action	createAction(@NotNull String actionCommand, @NotNull ActionListener actionListener) Creates an action.
@NotNull Action	createAction(@NotNull String actionCommand, @NotNull SerializableRunnable runnable) Creates an action.
@NotNull JMenuBar	createJMenuBar() Creates a JMenuBar with the actions specified by the resource bundle.
@NotNull JMenuBar	createJMenuBar(@NotNull String base) Creates a JMenuBar with the actions specified by the resource bundle.
@NotNull JToolBar	createJToolBar() Creates a JToolBar with the actions specified by the resource bundle.
@NotNull JToolBar	createJToolBar(@NotNull String base) Creates a JToolBar with the actions specified by the resource bundle.
@NotNull Action	setupAction(@NotNull String actionCommand, @NotNull Action action) Sets up an Action by initializing it form the resource bundle and storing it in the actionMap.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiFactory

public GuiFactory(@NotNull
                  @NotNull ResourceBundle resourceBundle,
                  @NotNull
                  @NotNull ActionMap actionMap)

Creates a GuiFactory.

Parameters:

resourceBundle - The resource bundle from which to get the information about the components that are to be created.

actionMap - The action map for actions which are used for toolbar buttons and menu items.

Method Detail

createJToolBar

@NotNull
public @NotNull JToolBar createJToolBar(@NotNull
                                                  @NotNull String base)

Creates a JToolBar with the actions specified by the resource bundle. They key used is base + ".toolBar".

Parameters:

base - Base to use.

Returns:

Newly created JToolBar.

createJToolBar

@NotNull
public @NotNull JToolBar createJToolBar()

Creates a JToolBar with the actions specified by the resource bundle. The key used is "toolBar".

Returns:

Newly created JToolBar.

createJMenuBar

@NotNull
public @NotNull JMenuBar createJMenuBar()

Creates a JMenuBar with the actions specified by the resource bundle. The key used is "menuBar".

Returns:

Newly created JMenuBar.

createJMenuBar

@NotNull
public @NotNull JMenuBar createJMenuBar(@NotNull
                                                  @NotNull String base)

Creates a JMenuBar with the actions specified by the resource bundle. The key used is base + ".menuBar".

Parameters:

base - The bae for the key to look up in the resource bundle.

Returns:

Newly created JMenuBar.

createAction

@NotNull
public @NotNull Action createAction(@NotNull
                                              @NotNull String actionCommand,
                                              @NotNull
                                              @NotNull SerializableRunnable runnable)

Creates an action. The action is initialized from the bundle and stored in the action map.

Parameters:

actionCommand - Action command for the action.

runnable - Runnable to run when the action is triggered.

Returns:

Newly created action.

createAction

@NotNull
public @NotNull Action createAction(@NotNull
                                              @NotNull String actionCommand,
                                              @NotNull
                                              @NotNull Action action)

Creates an action. The action is initialized from the bundle and stored in the action map.

Parameters:

actionCommand - Action command for the action.

action - Action to create.

Returns:

Newly created action.

setupAction

@NotNull
public @NotNull Action setupAction(@NotNull
                                             @NotNull String actionCommand,
                                             @NotNull
                                             @NotNull Action action)

Sets up an Action by initializing it form the resource bundle and storing it in the actionMap.

Parameters:

actionCommand - Action command of the action to initialize.

action - Action to setup.

Returns:

action after it was setup.

createAction

@NotNull
public @NotNull Action createAction(@NotNull
                                              @NotNull String actionCommand,
                                              @NotNull
                                              @NotNull ActionListener actionListener)

Creates an action. The action is initialized from the bundle and stored in the action map. If the supplied actionListener is actually an Action, that action is setup instead.

Parameters:

actionCommand - Action command for the action.

actionListener - ActionListener to call when the action is triggered.

Returns:

Newly created action.

createAction

@NotNull
public @NotNull Action createAction(@NotNull
                                              @NotNull String actionCommand)

Creates an dummy action. Dummy actions are useful for using action features where actual triggering is not required. One example is JMenus. The action is initialized from the bundle and stored in the action map.

Parameters:

actionCommand - Action command for the action.

Returns:

Newly created action.