org.norvelle.textcite.gui
Class FontChooser

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by org.norvelle.textcite.gui.FontChooser
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class FontChooser
extends javax.swing.JComponent

FontChooser provides a pane of controls designed to allow a user to manipulate and select a font.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static java.lang.String SELECTED_FONT_CHANGED_KEY
           
protected  java.awt.Font selectedFont
           
 
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
FontChooser()
          Creates a font chooser with an initial default font and a default model.
FontChooser(com.l2fprod.common.swing.FontChooserModel model, java.lang.String sampleText)
          Creates a font chooser with an initial default font and a custom model.
FontChooser(java.lang.String sampleText)
          Creates a font chooser with an initial default font and a default model.
 
Method Summary
protected  com.l2fprod.common.swing.BaseDialog createDialog(java.awt.Component parent, java.lang.String title)
           
 com.l2fprod.common.swing.FontChooserModel getModel()
          Gets the font chooser model of this font chooser.
 java.lang.String getSampleText()
           
 java.awt.Font getSelectedFont()
          Gets the current font value from the font chooser.
 java.lang.String getUIClassID()
          Returns the name of the L&F class that renders this component.
 void setSelectedFont(java.awt.Font f)
          Sets the selected font of this FontChooser.
 void setUI(com.l2fprod.common.swing.plaf.FontChooserUI ui)
          Sets the L&F object that renders this component.
static java.awt.Font showDialog(java.awt.Component parent, java.lang.String title, java.lang.String sampleText, java.awt.Font initialFont)
          Similar to showFontDialog(Component, String) except it can be called from a static context.
 java.awt.Font showFontDialog(java.awt.Component parent, java.lang.String title)
          Shows a modal font-chooser dialog and blocks until the dialog is hidden.
 void updateUI()
          Notification from the UIManager that the L&F has changed.
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

SELECTED_FONT_CHANGED_KEY

public static final java.lang.String SELECTED_FONT_CHANGED_KEY
See Also:
Constant Field Values

selectedFont

protected java.awt.Font selectedFont
Constructor Detail

FontChooser

public FontChooser()
Creates a font chooser with an initial default font and a default model.


FontChooser

public FontChooser(java.lang.String sampleText)
Creates a font chooser with an initial default font and a default model.


FontChooser

public FontChooser(com.l2fprod.common.swing.FontChooserModel model,
                   java.lang.String sampleText)
Creates a font chooser with an initial default font and a custom model.

Parameters:
model -
Method Detail

updateUI

public void updateUI()
Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.

Overrides:
updateUI in class javax.swing.JComponent
See Also:
JComponent.updateUI()

setUI

public void setUI(com.l2fprod.common.swing.plaf.FontChooserUI ui)
Sets the L&F object that renders this component.

Parameters:
ui - the FontChooserUI L&F object
See Also:
UIDefaults.getUI(javax.swing.JComponent)

getUIClassID

public java.lang.String getUIClassID()
Returns the name of the L&F class that renders this component.

Overrides:
getUIClassID in class javax.swing.JComponent
Returns:
the string "FontChooserUI"
See Also:
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setSelectedFont

public void setSelectedFont(java.awt.Font f)
Sets the selected font of this FontChooser. This will fire a PropertyChangeEvent for the property named SELECTED_FONT_CHANGED_KEY.

Parameters:
f - the font to select
See Also:
Container.addPropertyChangeListener(java.beans.PropertyChangeListener)

getSelectedFont

public java.awt.Font getSelectedFont()
Gets the current font value from the font chooser.

Returns:
the current font value of the font chooser

getModel

public com.l2fprod.common.swing.FontChooserModel getModel()
Gets the font chooser model of this font chooser.

Returns:
the font chooser model of this font chooser.

getSampleText

public java.lang.String getSampleText()

showFontDialog

public java.awt.Font showFontDialog(java.awt.Component parent,
                                    java.lang.String title)
Shows a modal font-chooser dialog and blocks until the dialog is hidden. If the user presses the "OK" button, then this method hides/disposes the dialog and returns the selected color. If the user presses the "Cancel" button or closes the dialog without pressing "OK", then this method hides/disposes the dialog and returns null.

Parameters:
parent - the parent Component for the dialog
title - the String containing the dialog's title
Returns:
the selected font or null if the user opted out
Throws:
java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
See Also:
GraphicsEnvironment.isHeadless()

createDialog

protected com.l2fprod.common.swing.BaseDialog createDialog(java.awt.Component parent,
                                                           java.lang.String title)

showDialog

public static java.awt.Font showDialog(java.awt.Component parent,
                                       java.lang.String title,
                                       java.lang.String sampleText,
                                       java.awt.Font initialFont)
Similar to showFontDialog(Component, String) except it can be called from a static context. Prefer showFontDialog(Component, String) if you want to control the dialog created by the method call or if you want to specify a custom FontChooserModel.

Parameters:
parent - the parent Component for the dialog
title - the String containing the dialog's title
initialFont - the initial Font set when the font-chooser is shown
Returns:
the selected font or null if the user opted out
Throws:
java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
See Also:
GraphicsEnvironment.isHeadless(), showFontDialog(Component, String)