Package ca.corbett.forms

Class FontDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

ca.corbett.forms.FontDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public final class FontDialog
extends JDialog

Represents a dialog that can be shown to the user to allow selection of a font with style properties and optional foreground/background color selection. This dialog was written for and is used by the FontField, but you could also invoke this dialog standalone if needed.

Since:

2025-04-07

Author:

scorbo2

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	Description
static final Font	INITIAL_FONT

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 java.awt.image.ImageObserver

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
FontDialog(Component owner)	Creates a new FontDialog with a default initial font and with foreground/background color selection disabled.
FontDialog(Component owner, Font initialFont)	Creates a new FontDialog with the given initial font and with foreground/background color selection disabled.
FontDialog(Component owner, Font initialFont, Color textColor)	Creates a new FontDialog with the given initial font and with foreground color selection enabled, but background color selection disabled.
FontDialog(Component owner, Font initialFont, Color textColor, Color bgColor)	Creates a new FontDialog with the given initial font and with foreground and background color selection enabled.

Method Summary

Modifier and Type	Method	Description
Color	getSelectedBgColor()	If background color editing was enabled in this dialog, will return the text background color that was selected by the user, otherwise null.
Font	getSelectedFont()	Returns the Font that was selected by the user, with style and size included.
Color	getSelectedTextColor()	If foreground color editing was enabled in this dialog, will return the text foreground color that was selected by the user, otherwise null.
boolean	isShowSizeField()	Reports whether the size field is visible on this dialog.
void	setShowSizeField(boolean show)	Toggles the visibility of the size chooser - this must be set before the dialog is shown.
boolean	wasOkayed()	Reports whether the dialog was okayed by the user or not.

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, setVisible, 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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, 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 Details

INITIAL_FONT

public static final Font INITIAL_FONT

Constructor Details

FontDialog

public FontDialog(Component owner)

Creates a new FontDialog with a default initial font and with foreground/background color selection disabled.

Parameters:

owner - The owning component (for dialog positioning purposes).

FontDialog

public FontDialog(Component owner,
 Font initialFont)

Creates a new FontDialog with the given initial font and with foreground/background color selection disabled.

Parameters:

owner - The owning component (for dialog positioning purposes).

FontDialog

public FontDialog(Component owner,
 Font initialFont,
 Color textColor)

Creates a new FontDialog with the given initial font and with foreground color selection enabled, but background color selection disabled.

Parameters:

owner - The owning component (for dialog positioning purposes).

FontDialog

public FontDialog(Component owner,
 Font initialFont,
 Color textColor,
 Color bgColor)

Creates a new FontDialog with the given initial font and with foreground and background color selection enabled.

Parameters:

owner - The owning component (for dialog positioning purposes).

Method Details

isShowSizeField

public boolean isShowSizeField()

Reports whether the size field is visible on this dialog. The size field is optional and the visibility can be set before the dialog is shown, with setSizeFieldVisible().

setShowSizeField

public void setShowSizeField(boolean show)

Toggles the visibility of the size chooser - this must be set before the dialog is shown. Some use cases require the setting of just the font face and style, without size.

wasOkayed

public boolean wasOkayed()

Reports whether the dialog was okayed by the user or not.

Returns:

True if the user hit OK, false if the dialog was closed any other way.

getSelectedFont

public Font getSelectedFont()

Returns the Font that was selected by the user, with style and size included.

Returns:

A Font object.

getSelectedTextColor

public Color getSelectedTextColor()

If foreground color editing was enabled in this dialog, will return the text foreground color that was selected by the user, otherwise null.

Returns:

A Color for text foreground, or null if foreground color editing disabled.

getSelectedBgColor

public Color getSelectedBgColor()

If background color editing was enabled in this dialog, will return the text background color that was selected by the user, otherwise null.

Returns:

A Color for text background, or null if background color editing disabled.