repicea.gui

Class UIControlManager

java.lang.Object

repicea.gui.UIControlManager

public class UIControlManager
extends java.lang.Object

The UIControlManager class contains static methods that facilitate the design of the dialog. Common messages are also included.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIControlManager.CommonControlID This enum variable provides the most common controls.
static class	UIControlManager.CommonMenuTitle This enum variable provides the most common menu titles in the menu bar.
static class	UIControlManager.FontType
static class	UIControlManager.InformationMessage This enum variable provides the most common information messages.
static class	UIControlManager.InformationMessageTitle This enum variable provides the most common message titles.

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.image.BufferedImage	REpiceaIcon

Method Summary

Modifier and Type	Method and Description
static javax.swing.JButton	createButtonWithRedCircleIcon() This method returns a button with a red circle icon and no text.
static javax.swing.JButton	createCommonButton(UIControlManager.CommonControlID buttonID) This method creates a button corresponding to the buttonName parameter.
static javax.swing.JMenu	createCommonMenu(UIControlManager.CommonMenuTitle menuTitle) This method creates a menu corresponding to the menuTitle parameter.
static javax.swing.JMenuItem	createCommonMenuItem(UIControlManager.CommonControlID menuItemID) This method creates a menu item corresponding to the menuItemID parameter.
static REpiceaMenuItem	createCommonMenuItem(UIControlManager.CommonControlID menuItemID, GenericTaskFactory taskMaker) This method creates a menu item corresponding to the menuItemID parameter.
static javax.swing.JPanel	createSimpleHorizontalPanel(java.awt.Component label, java.awt.Component control, int margin, boolean expandable) This static method creates an horizontal JPanel with a label and a control.
static javax.swing.JPanel	createSimpleHorizontalPanel(REpiceaTranslator.TextableEnum labelEnum, java.awt.Component control, int margin, boolean expandable) This static method creates an horizontal JPanel with a label and a control.
static java.awt.Dimension	getDimensionRelativeToScreen(double widthFraction, double heightFraction) This method returns a Dimension instance whose width and height are the specified fraction of the screen dimension.
static java.awt.Font	getFont(UIControlManager.FontType fontType) This method returns the font associated to this FontType enum variable
static AutomatedHelper	getHelper(java.lang.Class<?> clazz) This method returns the help method for this class.
static javax.swing.JLabel	getLabel(REpiceaTranslator.TextableEnum textableEnum) This method returns a JLabel instance with no predefined width.
static javax.swing.JLabel	getLabel(REpiceaTranslator.TextableEnum textableEnum, int width) This method returns a JLabel instance.
static javax.swing.JLabel	getLabel(java.lang.String labelString) This method returns a JLabel instance with no predefined width.
static javax.swing.JLabel	getLabel(java.lang.String labelString, int width) This method returns a JLabel instance.
protected static java.awt.Point	getLocation(java.awt.Window window) This method returns the location of the window.
static java.lang.String	getTitle(java.lang.Class<? extends java.awt.Window> clazz) This method returns the title associated to this Window-derived class.
static javax.swing.border.TitledBorder	getTitledBorder(java.lang.String title) This static method returns a Border instance with a title.
protected static void	registerLocation(java.awt.Window window) This method registers the window location.
static void	setFont(UIControlManager.FontType fontType, java.awt.Font font) This method makes it possible to change the fonts of the different controls.
static void	setHelpMethod(java.lang.Class<? extends java.awt.Window> clazz, AutomatedHelper helper) This method registers the help method for this Window-derived class.
static void	setLocation(java.awt.Window window, java.awt.Point point) This method sets the location of a particular window.
static void	setTitle(java.lang.Class<? extends java.awt.Window> clazz, java.lang.String englishTitle, java.lang.String frenchTitle) This method registers a title for this Window-derived class.

Methods inherited from class java.lang.Object

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

Field Detail

REpiceaIcon

public static final java.awt.image.BufferedImage REpiceaIcon

Method Detail

registerLocation

protected static void registerLocation(java.awt.Window window)

This method registers the window location.

Parameters:

window - a Window instance

setLocation

public static void setLocation(java.awt.Window window,
                               java.awt.Point point)

This method sets the location of a particular window.

Parameters:

window - a Window instance

point - a Point instance

getLocation

protected static java.awt.Point getLocation(java.awt.Window window)

This method returns the location of the window.

Parameters:

window - the window that is to be shown

Returns:

a Point instance or null if the window has not been registered yet

setTitle

public static void setTitle(java.lang.Class<? extends java.awt.Window> clazz,
                            java.lang.String englishTitle,
                            java.lang.String frenchTitle)

This method registers a title for this Window-derived class.

Parameters:

clazz - the Window-derived class

englishTitle - the title in English

frenchTitle - the title in French

getTitle

public static java.lang.String getTitle(java.lang.Class<? extends java.awt.Window> clazz)

This method returns the title associated to this Window-derived class.

Parameters:

clazz - the Window-derived class

Returns:

the title or an empty string if the title has not been registered

setHelpMethod

public static void setHelpMethod(java.lang.Class<? extends java.awt.Window> clazz,
                                 AutomatedHelper helper)

This method registers the help method for this Window-derived class.

Parameters:

clazz - the Window-derived class

helper - an AutomatedHelper instance

getHelper

public static AutomatedHelper getHelper(java.lang.Class<?> clazz)

This method returns the help method for this class.

Parameters:

clazz - the Window-derived class

Returns:

an AutomatedHelper instance or null if the Window instance has not been registered

createCommonButton

public static javax.swing.JButton createCommonButton(UIControlManager.CommonControlID buttonID)

This method creates a button corresponding to the buttonName parameter.

Parameters:

buttonID - a enum that represents the button

Returns:

a JButton instance.

createCommonMenuItem

public static javax.swing.JMenuItem createCommonMenuItem(UIControlManager.CommonControlID menuItemID)

This method creates a menu item corresponding to the menuItemID parameter.

Parameters:

menuItemID - a enum that represents the control

Returns:

a JMenuItem instance.

createCommonMenuItem

public static REpiceaMenuItem createCommonMenuItem(UIControlManager.CommonControlID menuItemID,
                                                   GenericTaskFactory taskMaker)

This method creates a menu item corresponding to the menuItemID parameter.

Parameters:

menuItemID - a enum that represents the control

taskMaker - a GenericTaskFactory insUIControlManagertance

Returns:

a RepiceaMenuItem instance.

createCommonMenu

public static javax.swing.JMenu createCommonMenu(UIControlManager.CommonMenuTitle menuTitle)

This method creates a menu corresponding to the menuTitle parameter.

Parameters:

menuTitle - a enum that represents the control

Returns:

a JMenu instance.

getLabel

public static javax.swing.JLabel getLabel(java.lang.String labelString,
                                          int width)

This method returns a JLabel instance.

Parameters:

labelString - the label to be displayed

width - the width of the label (0 for no predifined width)

Returns:

a JLabel instance

getLabel

public static javax.swing.JLabel getLabel(REpiceaTranslator.TextableEnum textableEnum,
                                          int width)

This method returns a JLabel instance.

Parameters:

textableEnum - a TextableEnum enum var

width - the width of the label (0 for no predefined width)

Returns:

a JLabel instance

getLabel

public static javax.swing.JLabel getLabel(java.lang.String labelString)

This method returns a JLabel instance with no predefined width.

Parameters:

labelString - the string that appears in the label

Returns:

a JLabel instance

getLabel

public static javax.swing.JLabel getLabel(REpiceaTranslator.TextableEnum textableEnum)

This method returns a JLabel instance with no predefined width.

Parameters:

textableEnum - a TextableEnum enum var

Returns:

a JLabel instance

setFont

public static void setFont(UIControlManager.FontType fontType,
                           java.awt.Font font)

This method makes it possible to change the fonts of the different controls.

Parameters:

fontType - a FontType instance

font - a Font instance

getFont

public static java.awt.Font getFont(UIControlManager.FontType fontType)

This method returns the font associated to this FontType enum variable

Parameters:

fontType - a FontType enum variable

Returns:

a Font instance

getDimensionRelativeToScreen

public static java.awt.Dimension getDimensionRelativeToScreen(double widthFraction,
                                                              double heightFraction)

This method returns a Dimension instance whose width and height are the specified fraction of the screen dimension.

Parameters:

widthFraction - a double between 0 and 1

heightFraction - a double between 0 and 1

Returns:

a Dimension instance

getTitledBorder

public static javax.swing.border.TitledBorder getTitledBorder(java.lang.String title)

This static method returns a Border instance with a title.

Parameters:

title - the title to appear in the Border instance

Returns:

a TitledBorder instance

createSimpleHorizontalPanel

public static javax.swing.JPanel createSimpleHorizontalPanel(java.awt.Component label,
                                                             java.awt.Component control,
                                                             int margin,
                                                             boolean expandable)

This static method creates an horizontal JPanel with a label and a control.

Parameters:

label - a Component instance

control - a Component to be displayed

margin - the size of the horizontal strut

expandable - a boolean if true the component is located in the CENTER of the BorderLayout. Otherwise, it is put in the EAST of the BorderLayout

Returns:

a JPanel instance

createSimpleHorizontalPanel

public static javax.swing.JPanel createSimpleHorizontalPanel(REpiceaTranslator.TextableEnum labelEnum,
                                                             java.awt.Component control,
                                                             int margin,
                                                             boolean expandable)

This static method creates an horizontal JPanel with a label and a control.

Parameters:

labelEnum - a TextableEnum instance

control - a Component to be displayed

margin - the size of the horizontal strut

expandable - a boolean if true the component is located in the CENTER of the BorderLayout. Otherwise, it is put in the EAST of the BorderLayout

Returns:

a JPanel instance

createButtonWithRedCircleIcon

public static javax.swing.JButton createButtonWithRedCircleIcon()

This method returns a button with a red circle icon and no text.

Returns:

a JButton instance