org.softsmithy.lib.swing.customizer

Class AbstractTextCustomizer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.softsmithy.lib.swing.JStyledPanel

org.softsmithy.lib.swing.customizer.AbstractCustomizer

org.softsmithy.lib.swing.customizer.JCustomizer

org.softsmithy.lib.swing.customizer.AbstractTextCustomizer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, org.softsmithy.lib.swing.style.Styleable

Direct Known Subclasses:

JButtonCustomizer, JHtmlCustomizer, JLabelCustomizer

public abstract class AbstractTextCustomizer
extends JCustomizer

This is a base class for customizers of components, which can display a text.
Double-click: inline edit support

Author:

puce

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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

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

Constructors

Constructor and Description
AbstractTextCustomizer() Creates a new instance of this class.
AbstractTextCustomizer(JComponent component) Creates a new instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
protected EditableStateManager	getEditableStateManager() Gets the editable state manager.
JTextComponent	getEditor() Gets the inline text editor of this text customizer.
abstract org.softsmithy.lib.swing.HorizontalAlignment	getHorizontalAlignment() Gets the horizontal alignment of the text.
abstract String	getText() Gets the text from the wrapped component.
boolean	isEditable() Indicates if this text customizer is editable.
boolean	isEditorScrollable() Indicates if the editor should be scrollable.
void	setEditable(boolean editable) Sets if this text customizer is editable.
protected void	setEditableStateManager(EditableStateManager stateManager) Sets the editable state manager.
void	setEditor(JTextComponent editor) Sets the inline text editor of this text customizer.
void	setEditorScrollable(boolean editorScrollable) Sets if the editor should be scrollable.
void	setHorizontalAlignment(org.softsmithy.lib.swing.HorizontalAlignment alignment) Sets the horizontal alignment of the text.
protected abstract void	setHorizontalAlignmentOnly(org.softsmithy.lib.swing.HorizontalAlignment alignment) Sets the horizontal alignment of the text.
protected void	setStateManager(StateManager manager) Sets the editable state mananger of this text customizer.
abstract void	setText(String text) Sets the text of the wrapped component.
String	toString() Returns a string representation of this text customizer.

Methods inherited from class org.softsmithy.lib.swing.customizer.JCustomizer

addActionListener, addCustomizerListener, applyBorder, fireActionEvent, fireCustomizerResetBoundsRel, fireCustomizerReshapeRel, getComponent, getGlassPane, getNormalBorderColor, getParentCustomizerPane, getSelectedBorderColor, getStateManager, getToolTipText, isUsingDefaultNormalBorderColor, isUsingDefaultSelectedBorderColor, removeActionListener, removeCustomizerListener, reshapeRel, reshapeRelOnly, setBoundsRel, setBoundsRelOnly, setComponent, setDefaultBackground, setDefaultFont, setDefaultForeground, setDefaultOpaque, setHeight, setToolTipText, setUsingDefaultNormalBorderColor, setUsingDefaultSelectedBorderColor, setWidth, setX, setY

Methods inherited from class org.softsmithy.lib.swing.customizer.AbstractCustomizer

getCommonCustomizableProperties, getCustomizableProperties, setCustomizableProperties

Methods inherited from class org.softsmithy.lib.swing.JStyledPanel

getBackground, getDefaultBackground, getDefaultFont, getDefaultForeground, getFont, getForeground, getNoneStyle, getParentStyle, getStyle, isDefaultOpaque, isOpaque, setBackground, setFont, setForeground, setOpaque, setStyle

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, getBaseline, getBaselineResizeBehavior, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, 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, 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, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, 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, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.softsmithy.lib.swing.style.Styleable

addHierarchyListener, getParent, removeHierarchyListener

Constructor Detail

AbstractTextCustomizer

public AbstractTextCustomizer()

Creates a new instance of this class.

AbstractTextCustomizer

public AbstractTextCustomizer(JComponent component)

Creates a new instance of this class.

Parameters:

component - the component to wrap

Method Detail

setEditor

public void setEditor(JTextComponent editor)

Sets the inline text editor of this text customizer.

Parameters:

editor - the inline text editor of this text customizer

getEditor

public JTextComponent getEditor()

Gets the inline text editor of this text customizer.

Returns:

the inline text editor of this text customizer

getText

public abstract String getText()

Gets the text from the wrapped component.

Returns:

the text from the wrapped component

setText

public abstract void setText(String text)

Sets the text of the wrapped component.

Parameters:

text - the text to be set

setHorizontalAlignmentOnly

protected abstract void setHorizontalAlignmentOnly(org.softsmithy.lib.swing.HorizontalAlignment alignment)

Sets the horizontal alignment of the text. This method should not fire any events!

Parameters:

alignment - the horizontal alignment of the text

getHorizontalAlignment

public abstract org.softsmithy.lib.swing.HorizontalAlignment getHorizontalAlignment()

Gets the horizontal alignment of the text.

Returns:

the horizontal alignment of the text

setHorizontalAlignment

public void setHorizontalAlignment(org.softsmithy.lib.swing.HorizontalAlignment alignment)

Sets the horizontal alignment of the text.
This methods calls the setHoizontalAlignmentOnly and fires a property changed event if the value changed.

Parameters:

alignment - the horizontal alignment of the text

getEditableStateManager

protected EditableStateManager getEditableStateManager()

Gets the editable state manager.

Returns:

the editable state manager

setEditableStateManager

protected void setEditableStateManager(EditableStateManager stateManager)

Sets the editable state manager.

Parameters:

stateManager - the editable state manager

toString

public String toString()

Returns a string representation of this text customizer.

Overrides:

toString in class Component

Returns:

a string representation of this text customizer

isEditorScrollable

public boolean isEditorScrollable()

Indicates if the editor should be scrollable.

Returns:

True, if the editor should be scrollable, else false

setEditorScrollable

public void setEditorScrollable(boolean editorScrollable)

Sets if the editor should be scrollable.

Parameters:

editorScrollable - True, if the editor should be scrollable, else false.

isEditable

public boolean isEditable()

Indicates if this text customizer is editable.

Returns:

True, if this text customizer is editable, else false.

setEditable

public void setEditable(boolean editable)

Sets if this text customizer is editable.

Parameters:

editable - True, if this text customizer is editable, else false

setStateManager

protected void setStateManager(StateManager manager)

Sets the editable state mananger of this text customizer.

Overrides:

setStateManager in class JCustomizer

Parameters:

manager -

Throws:

IllegalArgumentException - if the state manager is not an EditableStateManager