com.highqsoft.fwk.factory

Class FwkGUIFactory

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkPresentation

com.highqsoft.fwk.factory.FwkGUIFactory

All Implemented Interfaces:

FwkInterface, FwkPresentationInterface, FwkPropertyChangeListenerInterface, java.awt.event.ItemListener, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener

public class FwkGUIFactory
extends FwkPresentation
implements FwkPropertyChangeListenerInterface, java.awt.event.ItemListener

The FwkGUIFactory is a class with static methods to create pulldown and popup menus or buttons from a command array.

Since:

$Date: 2017/04/28 08:47:42 $

Version:

$Revision: 1.20 $

Author:

Andreas Hofmann, HighQSoft GmbH

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Hashtable	cache
protected static FwkGUIFactory	guiFactory
protected static java.util.Hashtable	values
static java.lang.String	version

Method Summary

Methods

Modifier and Type	Method and Description
static void	appendToToolBar(javax.swing.JToolBar toolbar, FwkCommandInterface[] commands) Append the specified command object array icons to the toolsbar.
static javax.swing.JComponent	createButton(FwkCommandInterface cb, javax.swing.ButtonGroup bg) Get a button from command object.
static FwkIconButton	createIconButton(FwkCommandInterface cb, javax.swing.ButtonGroup bg) Get an icon button for the toolbar.
static javax.swing.JMenu	createMenu(FwkCommandInterface[] commands, boolean lightWeightEnabled) Create a menu from command object array.
static javax.swing.JMenuBar	createMenuBar(FwkCommandInterface[] commands) Create a menubar from command object array.
static javax.swing.JMenuBar	createMenuBar(FwkCommandInterface[] commands, boolean lightWeightEnabled) Create a menubar from command object array.
static javax.swing.JComponent	createMenuItem(FwkCommandInterface cb, javax.swing.ButtonGroup bg, boolean lightWeightEnabled) Get a menu item from command object.
static javax.swing.JPopupMenu	createPopupMenu(FwkCommandInterface[] commands) Create a popupmenu from command object array
static javax.swing.JPopupMenu	createPopupMenu(FwkCommandInterface[] commands, boolean lightWeightEnabled) Create a popupmenu from command object array
static javax.swing.JPopupMenu	createPopupMenu(java.lang.String label, FwkCommandInterface[] commands, boolean lightWeightEnabled) Create a popupmenu from command object array
static void	createSubMenu(javax.swing.JMenuBar menubar, FwkCommandInterface[] commands, javax.swing.ButtonGroup bg, boolean lightWeightEnabled) Create a submenu from command object array.
static void	createSubMenu(javax.swing.JMenu menu, FwkCommandInterface[] commands, javax.swing.ButtonGroup bg, boolean lightWeightEnabled) Create a submenu from command object array.
static void	createSubMenu(javax.swing.JPopupMenu menu, FwkCommandInterface[] subCommands, javax.swing.ButtonGroup bg, boolean lightWeightEnabled) Create a submenu from command object array.
static javax.swing.JToolBar	createToolBar(FwkCommandInterface[] commands) Create a toolbar from command object array.
static javax.swing.JToolBar	createToolBar(FwkCommandInterface[] commands, java.lang.String position, int alignment) Create a toolbar from command object array.
static void	createToolBarIcon(javax.swing.JToolBar toolbar, FwkCommandInterface[] commands, javax.swing.ButtonGroup bg) Create a toolbar icon from command.
static java.awt.Container	getDialogParent(java.util.EventObject ev) Get the dialog parent for the given event.
static java.awt.Container	getInvoker(java.awt.Container item) Get the popup parent for the given menu.
java.lang.String	getVersion() Return the version string of the FWK component.
void	itemStateChanged(java.awt.event.ItemEvent ev)
void	propertyChange(java.beans.PropertyChangeEvent e)
static void	registerCommand(FwkCommandInterface cmd, java.lang.Object obj) Register a command.
java.lang.String	toString() This function returns a string containing the string representation of the object.
static void	unregisterCommand(FwkCommandInterface cmd) Unregister a single command.
static void	unregisterCommands(FwkCommandInterface[] commands) Unregister all commands in a command object array.
static void	unregisterMenu(javax.swing.JMenu menu) Unregister a men.
static void	unregisterMenuBar(javax.swing.JMenuBar menuBar) Unregister a menubar.
static void	unregisterObject(java.lang.Object obj) Unregister a signle object.
static void	unregisterPopupMenu(javax.swing.JPopupMenu popup) Unregister a popupmenu.
static void	unregisterToolBar(javax.swing.JToolBar toolBar) Unregister a toolbar.

Methods inherited from class com.highqsoft.fwk.FwkPresentation

getPresentationString, getPresentationString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

cache

protected static java.util.Hashtable cache

values

protected static java.util.Hashtable values

guiFactory

protected static FwkGUIFactory guiFactory

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkPresentation

createPopupMenu

public static javax.swing.JPopupMenu createPopupMenu(FwkCommandInterface[] commands)

Create a popupmenu from command object array

Parameters:

commands - The command object array.

Returns:

The newly created popupmenu, or null if there are no commands that describe the popup menu.

createPopupMenu

public static javax.swing.JPopupMenu createPopupMenu(FwkCommandInterface[] commands,
                                     boolean lightWeightEnabled)

Create a popupmenu from command object array

Parameters:

commands - The command object array.

lightWeightEnabled - Enables the light weight component.

Returns:

The newly created popupmenu, or null if there are no commands that describe the popup menu.

createPopupMenu

public static javax.swing.JPopupMenu createPopupMenu(java.lang.String label,
                                     FwkCommandInterface[] commands,
                                     boolean lightWeightEnabled)

Create a popupmenu from command object array

Parameters:

label - The label of the popup menu.

commands - The command object array.

lightWeightEnabled - Enables the light weight component.

Returns:

The newly created popupmenu, or null if there are no commands that describe the popup menu.

createMenuBar

public static javax.swing.JMenuBar createMenuBar(FwkCommandInterface[] commands)

Create a menubar from command object array.

Parameters:

commands - The command object array.

Returns:

The newly created menubar or null if there are no commands to create a menubar.

createMenuBar

public static javax.swing.JMenuBar createMenuBar(FwkCommandInterface[] commands,
                                 boolean lightWeightEnabled)

Create a menubar from command object array.

Parameters:

commands - The command object array.

lightWeightEnabled - Enables the light weight component.

Returns:

The newly created menubar or null if there are no commands to create a menubar.

createMenu

public static javax.swing.JMenu createMenu(FwkCommandInterface[] commands,
                           boolean lightWeightEnabled)

Create a menu from command object array.

Parameters:

commands - The command object array.

Returns:

The newly created menu.

createSubMenu

public static void createSubMenu(javax.swing.JPopupMenu menu,
                 FwkCommandInterface[] subCommands,
                 javax.swing.ButtonGroup bg,
                 boolean lightWeightEnabled)

Create a submenu from command object array.

Parameters:

menu - The parent popup-menu.

subCommands - The command object array.

bg - The optional button group.

lightWeightEnabled - Enables the light weight component.

createSubMenu

public static void createSubMenu(javax.swing.JMenuBar menubar,
                 FwkCommandInterface[] commands,
                 javax.swing.ButtonGroup bg,
                 boolean lightWeightEnabled)

Create a submenu from command object array.

Parameters:

menubar - The parent menubar.

commands - The command object array.

bg - The optional button group.

lightWeightEnabled - Enables the light weight component.

createSubMenu

public static void createSubMenu(javax.swing.JMenu menu,
                 FwkCommandInterface[] commands,
                 javax.swing.ButtonGroup bg,
                 boolean lightWeightEnabled)

Create a submenu from command object array.

Parameters:

menu - The parent menu.

commands - The command object array.

bg - The optional button group.

lightWeightEnabled - Enables the light weight component.

createMenuItem

public static javax.swing.JComponent createMenuItem(FwkCommandInterface cb,
                                    javax.swing.ButtonGroup bg,
                                    boolean lightWeightEnabled)

Get a menu item from command object.
Parent command will not get an icon! The created button will be registered at the command.

Parameters:

cb - The command object.

bg - The optional button group.

Returns:

A menu item.

createButton

public static javax.swing.JComponent createButton(FwkCommandInterface cb,
                                  javax.swing.ButtonGroup bg)

Get a button from command object.
The created button will be registered at the command.

Parameters:

cb - The command object.

bg - The optional button group.

Returns:

A menu item.

createToolBar

public static javax.swing.JToolBar createToolBar(FwkCommandInterface[] commands,
                                 java.lang.String position,
                                 int alignment)

Create a toolbar from command object array. This method loops through all available command a create buttons onto the toolbar. If the toolbar doesn't exist, it will be created.

Parameters:

commands - The command object array.

position - The border layout position constants. Use NORTH, EAST, SOUTH or WEST only. CENTER is not supported and will be ignored.

alignment - The alignment of the flow layout.

Returns:

The created toolbar or null, if there are no commands.

createToolBar

public static javax.swing.JToolBar createToolBar(FwkCommandInterface[] commands)

Create a toolbar from command object array. This method loops through all available command a create buttons onto the toolbar. If the toolbar doesn't exist, it will be created.

Parameters:

commands - The command object array.

layout - The layout manager for the tool bar.

Returns:

The created toolbar or null, if there are no commands.

appendToToolBar

public static void appendToToolBar(javax.swing.JToolBar toolbar,
                   FwkCommandInterface[] commands)

Append the specified command object array icons to the toolsbar.

Parameters:

toolbar - The toolbar to that the method should append the icons.

commands - The command object array.

createToolBarIcon

public static void createToolBarIcon(javax.swing.JToolBar toolbar,
                     FwkCommandInterface[] commands,
                     javax.swing.ButtonGroup bg)

Create a toolbar icon from command.

Parameters:

toolbar - The toolbar (optional).

commands - The command object array.

bg - The optional button group.

createIconButton

public static FwkIconButton createIconButton(FwkCommandInterface cb,
                             javax.swing.ButtonGroup bg)

Get an icon button for the toolbar. The created button will be registered at the command.

Parameters:

cb - The command object.

bg - The optional button group.

Returns:

An icon button.

registerCommand

public static void registerCommand(FwkCommandInterface cmd,
                   java.lang.Object obj)

Register a command.

Parameters:

command - The command to be registered.

obj - The object to be registered.

unregisterCommands

public static void unregisterCommands(FwkCommandInterface[] commands)

Unregister all commands in a command object array.

Parameters:

commands - The command object array.

unregisterCommand

public static void unregisterCommand(FwkCommandInterface cmd)

Unregister a single command.

Parameters:

cmd - The command to be unregistered.

unregisterPopupMenu

public static void unregisterPopupMenu(javax.swing.JPopupMenu popup)

Unregister a popupmenu.

Parameters:

popup - The JPopupMenu to be unregistered.

unregisterMenuBar

public static void unregisterMenuBar(javax.swing.JMenuBar menuBar)

Unregister a menubar.

Parameters:

menubar - The JMenuBar to be unregistered.

unregisterMenu

public static void unregisterMenu(javax.swing.JMenu menu)

Unregister a men.

Parameters:

menu - The JMenu to be unregistered.

unregisterToolBar

public static void unregisterToolBar(javax.swing.JToolBar toolBar)

Unregister a toolbar.

Parameters:

toolBar - The JToolBar to be unregistered.

unregisterObject

public static void unregisterObject(java.lang.Object obj)

Unregister a signle object.

Parameters:

obj - The object to be unregistered.

toString

public java.lang.String toString()

This function returns a string containing the string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of the object.

See Also:

getParams

getDialogParent

public static java.awt.Container getDialogParent(java.util.EventObject ev)

Get the dialog parent for the given event.

Parameters:

ev - the event.

getInvoker

public static java.awt.Container getInvoker(java.awt.Container item)

Get the popup parent for the given menu.

Parameters:

ev - the event.

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent ev)

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener