org.fife.ui
Class FontSelector

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.fife.ui.FontSelector

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class FontSelector

extends javax.swing.JPanel

implements java.awt.event.ActionListener

A panel allowing the user to select a font, for use in things such as options dialogs.

Version:

1.0

Author:

Robert Futrell

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static java.lang.String	ENABLED_PROPERTY
static java.lang.String	FONT_COLOR_PROPERTY
static java.lang.String	FONT_PROPERTY

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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

Constructor Summary

FontSelector()
Constructor.

FontSelector(boolean togglable)
Constructor.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Listens for actions in this panel.
java.awt.Font	getDisplayedFont() Returns the font being displayed.
java.awt.Color	getFontColor() Returns the font color selected by the user.
boolean	getUnderline() Returns whether the current font is underlined.
boolean	isColorSelectable() Sets whether the font color is selectable in the font dialog used by this font selector.
boolean	isToggledOn() Returns whether this font selector is "toggled on."
boolean	isUnderlineSelectable() Sets whether "underline" is selectable in the font dialog used by this font selector.
void	setColorSelectable(boolean selectable) Toggles whether font color will be selectable in the font dialog used by this font selector.
void	setDisplayedFont(java.awt.Font font, boolean underline) Sets the font displayed.
void	setFontColor(java.awt.Color color) Sets the font color displayed.
void	setToggledOn(boolean toggled) Sets whether this font selector is "toggled on."
void	setUnderlineSelectable(boolean selectable) Toggles whether "underline" will be selectable in the font dialog used by this font selector.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

ENABLED_PROPERTY

public static final java.lang.String ENABLED_PROPERTY

See Also:

Constant Field Values

FONT_PROPERTY

public static final java.lang.String FONT_PROPERTY

See Also:

Constant Field Values

FONT_COLOR_PROPERTY

public static final java.lang.String FONT_COLOR_PROPERTY

See Also:

Constant Field Values

Constructor Detail

FontSelector

public FontSelector()

Constructor.

FontSelector

public FontSelector(boolean togglable)

Constructor.

Parameters:

togglable - Whether the user should be able to enable and disable this font selector via a checkbox.

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Listens for actions in this panel.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

getDisplayedFont

public java.awt.Font getDisplayedFont()

Returns the font being displayed.

Returns:

The displayed font.

See Also:

setDisplayedFont(Font, boolean)

getFontColor

public java.awt.Color getFontColor()

Returns the font color selected by the user. This value will be null if isColorSelectable() returns false.

Returns:

The font color selected by the user.

See Also:

setFontColor(Color)

getUnderline

public boolean getUnderline()

Returns whether the current font is underlined. Note that if isUnderlineSelectable() returns false, this method will always return false also.

Returns:

Whether the current font is underlined.

See Also:

getDisplayedFont()

isColorSelectable

public boolean isColorSelectable()

Sets whether the font color is selectable in the font dialog used by this font selector.

Returns:

Whether the color option is available.

See Also:

setColorSelectable(boolean)

isToggledOn

public boolean isToggledOn()

Returns whether this font selector is "toggled on." This method is unfortunately named because isEnabled() is already a method defined by Component.

If this font selector is not togglable, this method always returns true.

Returns:

Whether this font selector is toggled on.

See Also:

setToggledOn(boolean)

isUnderlineSelectable

public boolean isUnderlineSelectable()

Sets whether "underline" is selectable in the font dialog used by this font selector.

Returns:

Whether "underline" is available.

See Also:

setUnderlineSelectable(boolean)

setColorSelectable

public void setColorSelectable(boolean selectable)

Toggles whether font color will be selectable in the font dialog used by this font selector.

Parameters:

selectable - Whether color will be available.

See Also:

isColorSelectable()

setDisplayedFont

public void setDisplayedFont(java.awt.Font font,
                             boolean underline)

Sets the font displayed.

Parameters:

font - The font to display.

underline - Whether the font should be underlined. Note that if isUnderlineSelectable() returns false, this parameter will do nothing. this method will always return false also.

See Also:

getDisplayedFont(), getUnderline()

setFontColor

public void setFontColor(java.awt.Color color)

Sets the font color displayed. This method will do nothing if isColorSelectable() returns false.

Parameters:

color - The font color to display.

See Also:

getFontColor()

setToggledOn

public void setToggledOn(boolean toggled)

Sets whether this font selector is "toggled on." This method is unfortunately named since setEnabled is already a method defined by Component.

If this font selector is not togglable, this method does nothing.

Parameters:

toggled - Whether this font selector should be enabled.

See Also:

isToggledOn()

setUnderlineSelectable

public void setUnderlineSelectable(boolean selectable)

Toggles whether "underline" will be selectable in the font dialog used by this font selector.

Parameters:

selectable - Whether "underline" will be available.

See Also:

isUnderlineSelectable()