com.portal.pfc.ui

Class PFCDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.portal.pfc.ui.PFCDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

AboutDialog

public class PFCDialog
extends JDialog

Wrapper around a JDialog that displays a dialog as prescribed by the Portal UI guidelines. The appropriate borders, spacing, etc. are automatically applied - you simply provide the contents.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BUTTON_START_LOCATION
protected JPanel	mBtnPanel
protected ArrayList	mButtonsArray
protected boolean	mDialogInitialized
protected JButton	mHelpButton
protected JPanel	mMainPanel
protected Gripper	mOuterPanel
protected Dimension	mPreferredBtnSize
protected JCheckBox	mSaveAsDefaultChkBox
protected JPanel	mTopPanel

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
PFCDialog() Creates a non-modal dialog without a title and without a specified Frame owner.
PFCDialog(Dialog owner) Creates a non-modal dialog without a title with the specifed Dialog as its owner.
PFCDialog(Dialog owner, boolean modal) Creates a modal or non-modal dialog without a title and with the specified owner dialog.
PFCDialog(Dialog owner, String title) Creates a non-modal dialog with the specified title and with the specified owner dialog.
PFCDialog(Dialog owner, String title, boolean modal) Creates a modal or non-modal dialog with the specified title and the specified owner frame.
PFCDialog(Dialog owner, String title, JPanel mainPanel, boolean modal) Creates a modal or non-modal dialog with the specified title, the specified owner frame and the specified main panel.
PFCDialog(Dialog owner, String title, JPanel topPanel, JPanel mainPanel, boolean modal) Creates a modal or non-modal dialog with the specified title, the specified owner frame, the specified main panel and the specified top panel.
PFCDialog(Frame owner) Creates a non-modal dialog without a title with the specifed Frame as its owner.
PFCDialog(Frame owner, boolean modal) Creates a modal or non-modal dialog without a title and with the specified owner Frame.
PFCDialog(Frame owner, String title) Creates a non-modal dialog with the specified title and with the specified owner frame.
PFCDialog(Frame owner, String title, boolean modal) Creates a modal or non-modal dialog with the specified title and the specified owner Frame.
PFCDialog(Frame owner, String title, JPanel mainPanel, boolean modal) Creates a modal or non-modal dialog with the specified title, the specified owner frame and the specified main panel.
PFCDialog(Frame owner, String title, JPanel topPanel, JPanel mainPanel, boolean modal) Creates a modal or non-modal dialog with the specified title, the specified owner frame, the specified main panel and the specified top panel.

Method Summary

Modifier and Type	Method and Description
void	addButton(JButton button) Adds the specified button to the right most position on the button panel which is at the bottom of the dialog.
protected static ResourceBundle	getResourceBundle()
void	hideHelpButton() Hides the help button on the dialog.
protected void	initPFCDialog(JPanel topPanel, JPanel mainPanel)
protected void	initPFCDialogLayout()
boolean	isSaveAsDefault() Returns whether the "Save As Default" check box is being checked.
protected void	setCentered()
protected void	setColors(JComponent c)
void	setHelpID(ImageIcon helpIcon, String helpID) Displays a Help button with the specified icon at the left most position of the button panel which displays a help page for the specified help ID.
void	setHelpID(String helpID) Displays a Help button at the left most position of the button panel which displays a help page for the specified help ID.
void	setMainPanel(JPanel mainPanel) Sets the main panel in the dialog to be displayed.
protected void	setPanelsLnF()
protected void	setPreferredBtnSize()
void	setSaveAsDefault() Displays a "Save as default" check box in between the help button and the button group.
void	setTopPanel(JPanel topPanel) Sets the top panel in the dialog to be displayed.
void	setVisible(boolean b)
static int	showConfirmDialog(Component owner, String title, JPanel topPanel, JComponent mainPanel) Convenience wrapper that manages the button display automatically.
static int	showConfirmDialog(Component owner, String title, JPanel topPanel, JComponent mainPanel, JTextField tf) Convenience wrapper that manages the button display automatically.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

mHelpButton

protected JButton mHelpButton

mSaveAsDefaultChkBox

protected JCheckBox mSaveAsDefaultChkBox

mTopPanel

protected JPanel mTopPanel

mMainPanel

protected JPanel mMainPanel

mBtnPanel

protected JPanel mBtnPanel

mOuterPanel

protected Gripper mOuterPanel

mPreferredBtnSize

protected Dimension mPreferredBtnSize

mButtonsArray

protected ArrayList mButtonsArray

mDialogInitialized

protected boolean mDialogInitialized

BUTTON_START_LOCATION

protected static final int BUTTON_START_LOCATION

See Also:

Constant Field Values

Constructor Detail

PFCDialog

public PFCDialog(Dialog owner)

Creates a non-modal dialog without a title with the specifed Dialog as its owner.

Parameters:

owner - the Dialog from which the dialog is displayed

PFCDialog

public PFCDialog(Dialog owner,
                 boolean modal)

Creates a modal or non-modal dialog without a title and with the specified owner dialog.

Parameters:

owner - the Dialog from which the dialog is displayed

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

PFCDialog

public PFCDialog(Dialog owner,
                 String title)

Creates a non-modal dialog with the specified title and with the specified owner dialog.

Parameters:

owner - the Dialog from which the dialog is displayed

title - the String to display in the dialog's title bar

PFCDialog

public PFCDialog(Dialog owner,
                 String title,
                 boolean modal)

Creates a modal or non-modal dialog with the specified title and the specified owner frame.

Parameters:

owner - the Dialog from which the dialog is displayed

title - the String to display in the dialog's title bar

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

PFCDialog

public PFCDialog(Dialog owner,
                 String title,
                 JPanel mainPanel,
                 boolean modal)

Creates a modal or non-modal dialog with the specified title, the specified owner frame and the specified main panel.

Parameters:

owner - the Dialog from which the dialog is displayed

title - the String to display in the dialog's title bar

mainPanel - the JPanel to display in the dialog's main area

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

PFCDialog

public PFCDialog(Dialog owner,
                 String title,
                 JPanel topPanel,
                 JPanel mainPanel,
                 boolean modal)

Creates a modal or non-modal dialog with the specified title, the specified owner frame, the specified main panel and the specified top panel.

Parameters:

owner - the Dialog from which the dialog is displayed

title - the String to display in the dialog's title bar

topPanel - the JPanel to display in the dialog's top area

mainPanel - the JPanel to display in the dialog's main area

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

PFCDialog

public PFCDialog()

Creates a non-modal dialog without a title and without a specified Frame owner. A shared, hidden frame will be set as the owner of the dialog.

PFCDialog

public PFCDialog(Frame owner)

Creates a non-modal dialog without a title with the specifed Frame as its owner.

Parameters:

owner - the Frame from which the dialog is displayed

PFCDialog

public PFCDialog(Frame owner,
                 boolean modal)

Creates a modal or non-modal dialog without a title and with the specified owner Frame.

Parameters:

owner - the Frame from which the dialog is displayed

modal - true for a modal dialog, false for one that allows others windows to be active at the same time

PFCDialog

public PFCDialog(Frame owner,
                 String title)

Creates a non-modal dialog with the specified title and with the specified owner frame.

Parameters:

owner - the Frame from which the dialog is displayed

title - the String to display in the dialog's title bar

PFCDialog

public PFCDialog(Frame owner,
                 String title,
                 boolean modal)

Creates a modal or non-modal dialog with the specified title and the specified owner Frame. All constructors defer to this one.

NOTE: Any popup components (JComboBox, JPopupMenu, JMenuBar) created within a modal dialog will be forced to be lightweight.

Parameters:

owner - the Frame from which the dialog is displayed

title - the String to display in the dialog's title bar

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

PFCDialog

public PFCDialog(Frame owner,
                 String title,
                 JPanel mainPanel,
                 boolean modal)

Creates a modal or non-modal dialog with the specified title, the specified owner frame and the specified main panel.

Parameters:

owner - the Frame from which the dialog is displayed

title - the String to display in the dialog's title bar

mainPanel - the JPanel to display in the dialog's main area

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

PFCDialog

public PFCDialog(Frame owner,
                 String title,
                 JPanel topPanel,
                 JPanel mainPanel,
                 boolean modal)

Creates a modal or non-modal dialog with the specified title, the specified owner frame, the specified main panel and the specified top panel.

Parameters:

owner - the Frame from which the dialog is displayed

title - the String to display in the dialog's title bar

topPanel - the JPanel to display in the dialog's top area

mainPanel - the JPanel to display in the dialog's main area

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

Method Detail

showConfirmDialog

public static int showConfirmDialog(Component owner,
                                    String title,
                                    JPanel topPanel,
                                    JComponent mainPanel)

Convenience wrapper that manages the button display automatically. 2 buttons are displayed, OK and CANCEL.

Parameters:

owner - the Frame from which the dialog is displayed

title - the String to display in the dialog's title bar

topPanel - the JPanel to display in the dialog's top area

mainPanel - the JPanel to display in the dialog's main area

Returns:

One of JOptionPane.OK or JOptionPane.CANCEL

showConfirmDialog

public static int showConfirmDialog(Component owner,
                                    String title,
                                    JPanel topPanel,
                                    JComponent mainPanel,
                                    JTextField tf)

Convenience wrapper that manages the button display automatically. 2 buttons are displayed, OK and CANCEL. If the textfield parameter is non-null, the assumption is that this textfield is contained within the dialog and the caller wants the user to be able to hit Enter and impact the OK button.

Parameters:

owner - the Component on which to center this dialog. This component should be in a JFrame

title - the String to display in the dialog's title bar

topPanel - the JPanel to display in the dialog's top area

mainPanel - the JPanel to display in the dialog's main area

tf - JTextField contained in either the topPanel or mainPanel. Hitting the Enter key in the textfield will have the same effect as the user pressing the OK button.

Returns:

One of JOptionPane.OK or JOptionPane.CANCEL

setTopPanel

public void setTopPanel(JPanel topPanel)

Sets the top panel in the dialog to be displayed.

Parameters:

topPanel - the top panel to be displayed in this dialog

setMainPanel

public void setMainPanel(JPanel mainPanel)

Sets the main panel in the dialog to be displayed.

Parameters:

mainPanel - the main panel to be displayed in this dialog

setVisible

public void setVisible(boolean b)

Overrides:

setVisible in class Dialog

addButton

public void addButton(JButton button)

Adds the specified button to the right most position on the button panel which is at the bottom of the dialog.

Parameters:

button - the button will be added to the end of the button panel

setHelpID

public void setHelpID(String helpID)

Displays a Help button at the left most position of the button panel which displays a help page for the specified help ID.

Parameters:

helpID - the help ID to be associated with the help button.

setHelpID

public void setHelpID(ImageIcon helpIcon,
                      String helpID)

Displays a Help button with the specified icon at the left most position of the button panel which displays a help page for the specified help ID.

Parameters:

helpIcon - the icon to be display on the help button.

helpID - the help ID to be associated with the help button.

hideHelpButton

public void hideHelpButton()

Hides the help button on the dialog.

setSaveAsDefault

public void setSaveAsDefault()

Displays a "Save as default" check box in between the help button and the button group.

isSaveAsDefault

public boolean isSaveAsDefault()

Returns whether the "Save As Default" check box is being checked.

setCentered

protected void setCentered()

initPFCDialog

protected void initPFCDialog(JPanel topPanel,
                             JPanel mainPanel)

getResourceBundle

protected static ResourceBundle getResourceBundle()

initPFCDialogLayout

protected void initPFCDialogLayout()

setPanelsLnF

protected void setPanelsLnF()

setPreferredBtnSize

protected void setPreferredBtnSize()

setColors

protected void setColors(JComponent c)