org.vizzini.ui.text
Class TextStyleChooser

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.vizzini.ui.text.TextStyleChooser

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class TextStyleChooser
extends JPanel

Provides a generic GUI component for selection of a text style. A text style consists of a font, and normal and selection colors.

A text style changed event can be obtained by registering a java.beans.PropertyChangeListener using addTextStyleListener().

Listener example:

    _textStyleUI.addTextStyleListener(new PropertyChangeListener()

        {

            public void propertyChange(PropertyChangeEvent event)

            {

                TextStyleChooser chooser = (TextStyleChooser)event.getSource();

                TextStyle textStyle = (TextStyle)event.getNewValue();

                // Do something

            }

        } );

 

Since:

v0.2

Version:

v0.2

Author:

Jeffrey M. Thompson

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static String

TEXT_STYLE_PROPERTY Name of the text style 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

TextStyleChooser()
Construct this object.

Method Summary

void	addTextStyleListener(PropertyChangeListener listener) Add a property listener for the color property.
protected FontChooser	createFontUI() Create a font user interface component.
protected TextColorSetChooser	createNormalTextColorSetUI() Create a normal text color set user interface component.
protected JTextField	createPreviewUI() Create a preview user interface component.
protected TextColorSetChooser	createSelectionTextColorSetUI() Create a selection text color set user interface component.
TextStyle	getTextStyle() Return the text style.
boolean	isDirty()
void	removeTextStyleListener(PropertyChangeListener listener) Remove a property listener for the color property.
void	setDirty(boolean isDirty)
void	setEnabled(boolean enabled) Set the enabled state of this widget.
void	setPreviewText(String text) Set the text of the preview widget.
void	setPreviewVisible(boolean isVisible) Set the visibility of the preview widget.
void	setSelectionTextColorSetVisible(boolean isVisible) Set the visibility of the selection text color set user interface component.
void	setTextStyle(TextStyle textStyle) Set the color scheme.
void	setTitle(String title) Create a titled border with the given string.
protected void	updatePreviewUIFont() Update the preview widget for a new font choice.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, 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, 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, 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

TEXT_STYLE_PROPERTY

public static final String TEXT_STYLE_PROPERTY

Name of the text style property.

See Also:

Constant Field Values

Constructor Detail

TextStyleChooser

public TextStyleChooser()

Construct this object.

Since:

v0.2

Method Detail

addTextStyleListener

public void addTextStyleListener(PropertyChangeListener listener)

Add a property listener for the color property.

Since:

v0.2

getTextStyle

public TextStyle getTextStyle()

Return the text style.

Since:

v0.2

isDirty

public boolean isDirty()

Returns:

Return isDirty.

Since:

v0.2

removeTextStyleListener

public void removeTextStyleListener(PropertyChangeListener listener)

Remove a property listener for the color property.

Since:

v0.2

setDirty

public void setDirty(boolean isDirty)

Parameters:

isDirty - The isDirty to set.

Since:

v0.2

setEnabled

public void setEnabled(boolean enabled)

Set the enabled state of this widget.

Overrides:

setEnabled in class JComponent

Since:

v0.2

setPreviewText

public void setPreviewText(String text)

Set the text of the preview widget.

Parameters:

text - The new text.

Since:

v0.2

setPreviewVisible

public void setPreviewVisible(boolean isVisible)

Set the visibility of the preview widget.

Parameters:

isVisible - Flag indicating whether the preview pane is visible.

Since:

v0.2

setSelectionTextColorSetVisible

public void setSelectionTextColorSetVisible(boolean isVisible)

Set the visibility of the selection text color set user interface component.

Parameters:

isVisible -

Since:

v0.2

setTextStyle

public void setTextStyle(TextStyle textStyle)

Set the color scheme.

Since:

v0.2

setTitle

public void setTitle(String title)

Create a titled border with the given string.

Parameters:

title - The title for the titled border.

Since:

v0.2

createFontUI

protected FontChooser createFontUI()

Create a font user interface component.

Since:

v0.2

createNormalTextColorSetUI

protected TextColorSetChooser createNormalTextColorSetUI()

Create a normal text color set user interface component.

Since:

v0.2

createPreviewUI

protected JTextField createPreviewUI()

Create a preview user interface component.

Since:

v0.2

createSelectionTextColorSetUI

protected TextColorSetChooser createSelectionTextColorSetUI()

Create a selection text color set user interface component.

Since:

v0.2

updatePreviewUIFont

protected void updatePreviewUIFont()

Update the preview widget for a new font choice.

Since:

v0.2