com.alee.laf.text

Class AbstractTextEditorPainter<E extends javax.swing.text.JTextComponent,U extends javax.swing.plaf.basic.BasicTextUI,D extends IDecoration<E,D>>

java.lang.Object

com.alee.painter.AbstractPainter<E,U>

com.alee.painter.decoration.AbstractDecorationPainter<E,U,D>

com.alee.laf.text.AbstractTextEditorPainter<E,U,D>

All Implemented Interfaces:

IAbstractTextEditorPainter<E,U>, PainterShapeProvider<E>, Painter<E,U>, SpecificPainter<E,U>, BorderMethods, com.alee.utils.swing.SwingMethods, javax.swing.SwingConstants

Direct Known Subclasses:

AbstractTextAreaPainter, AbstractTextFieldPainter

public abstract class AbstractTextEditorPainter<E extends javax.swing.text.JTextComponent,U extends javax.swing.plaf.basic.BasicTextUI,D extends IDecoration<E,D>>
extends AbstractDecorationPainter<E,U,D>
implements IAbstractTextEditorPainter<E,U>, javax.swing.SwingConstants

Abstract painter base for all text editing components.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.alee.utils.general.Pair<DocumentChangeListener,java.beans.PropertyChangeListener>	documentChangeListeners Listeners.
protected boolean	hideInputPromptOnFocus Whether or not should hide input prompt on focus gain.
protected java.awt.Font	inputPromptFont Input prompt text font.
protected java.awt.Color	inputPromptForeground Input prompt tex foreground.
protected int	inputPromptHorizontalPosition Input prompt text horizontal position.
protected boolean	inputPromptOnlyWhenEditable Whether or not should display input prompt only when component is editable.
protected int	inputPromptVerticalPosition Input prompt text vertical position.

Fields inherited from class com.alee.painter.decoration.AbstractDecorationPainter

ancestor, DECORATION_STATES_PROPERTY, decorationCache, decorations, focused, focusStateTracker, hierarchyTracker, hover, hoverStateTracker, neighboursTracker, states

Fields inherited from class com.alee.painter.AbstractPainter

component, listeners, ltr, propertyChangeListener, ui

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor and Description
AbstractTextEditorPainter()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	getDecorationStates() Returns current component decoration states.
protected java.awt.Rectangle	getEditorRect() Returns the bounding box for the root view.
void	install(E c, U ui) Called when painter is installed onto some component.
boolean	isInputPromptVisible() Returns whether input prompt visible or not.
protected void	paintContent(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, U ui) Paints content decorated by this painter.
protected void	paintInputPrompt(java.awt.Graphics2D g2d) Draws input prompt text if it is available and should be visible at the moment.
void	uninstall(E c, U ui) Called when painter is installed into some component.

Methods inherited from class com.alee.painter.decoration.AbstractDecorationPainter

adjustBounds, asList, collectDecorationStates, getBorders, getDecoration, getDecorations, getDecorationSize, getPreferredSize, getSectionPainters, installFocusListener, installHierarchyListener, installHoverListener, isDecorated, isDecorationPaintAllowed, isEnabled, isFocused, isHover, isOpaque, isOpaqueDecorated, isOpaqueUndecorated, isPlainBackgroundPaintAllowed, paint, propertyChange, provideShape, uninstallFocusListener, uninstallHierarchyListener, uninstallHoverListener, updateDecorationState, usesState, usesState

Methods inherited from class com.alee.painter.AbstractPainter

addPainterListener, b, borderChange, getCompleteBorder, i, i, i, installPropertyChangeListener, isSectionPainter, isSettingsUpdateAllowed, orientationChange, p, removePainterListener, repaint, repaint, repaint, revalidate, saveOrientation, uninstallPropertyChangeListener, updateAll, updateBorder, updateOpacity, updateOrientation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alee.laf.text.IAbstractTextEditorPainter

getInputPrompt

Methods inherited from interface com.alee.painter.Painter

addPainterListener, getBorders, getPreferredSize, isOpaque, paint, removePainterListener

Field Detail

inputPromptHorizontalPosition

protected int inputPromptHorizontalPosition

Input prompt text horizontal position.

inputPromptVerticalPosition

protected int inputPromptVerticalPosition

Input prompt text vertical position. Important mostly for text area components.

inputPromptFont

@XStreamConverter(value=com.alee.utils.xml.FontConverter.class)
protected java.awt.Font inputPromptFont

Input prompt text font.

inputPromptForeground

protected java.awt.Color inputPromptForeground

Input prompt tex foreground.

inputPromptOnlyWhenEditable

protected boolean inputPromptOnlyWhenEditable

Whether or not should display input prompt only when component is editable.

hideInputPromptOnFocus

protected boolean hideInputPromptOnFocus

Whether or not should hide input prompt on focus gain.

documentChangeListeners

protected transient com.alee.utils.general.Pair<DocumentChangeListener,java.beans.PropertyChangeListener> documentChangeListeners

Listeners.

Constructor Detail

AbstractTextEditorPainter

public AbstractTextEditorPainter()

Method Detail

install

public void install(E c,
                    U ui)

Description copied from interface: Painter

Called when painter is installed onto some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

install in interface Painter<E extends javax.swing.text.JTextComponent,U extends javax.swing.plaf.basic.BasicTextUI>

Overrides:

install in class AbstractDecorationPainter<E extends javax.swing.text.JTextComponent,U extends javax.swing.plaf.basic.BasicTextUI,D extends IDecoration<E,D>>

Parameters:

c - component this painter is being installed onto

ui - component UI

uninstall

public void uninstall(E c,
                      U ui)

Description copied from interface: Painter

Called when painter is installed into some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

uninstall in interface Painter<E extends javax.swing.text.JTextComponent,U extends javax.swing.plaf.basic.BasicTextUI>

Overrides:

uninstall in class AbstractDecorationPainter<E extends javax.swing.text.JTextComponent,U extends javax.swing.plaf.basic.BasicTextUI,D extends IDecoration<E,D>>

Parameters:

c - component this painter is being uninstalled from

ui - component UI

getDecorationStates

protected java.util.List<java.lang.String> getDecorationStates()

Description copied from class: AbstractDecorationPainter

Returns current component decoration states.

Overrides:

getDecorationStates in class AbstractDecorationPainter<E extends javax.swing.text.JTextComponent,U extends javax.swing.plaf.basic.BasicTextUI,D extends IDecoration<E,D>>

Returns:

current component decoration states

paintContent

protected void paintContent(java.awt.Graphics2D g2d,
                            java.awt.Rectangle bounds,
                            E c,
                            U ui)

Description copied from class: AbstractDecorationPainter

Paints content decorated by this painter. todo This method should eventually be removed since all content will be painted by IContent implementations

Overrides:

paintContent in class AbstractDecorationPainter<E extends javax.swing.text.JTextComponent,U extends javax.swing.plaf.basic.BasicTextUI,D extends IDecoration<E,D>>

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

ui - painted component UI

paintInputPrompt

protected void paintInputPrompt(java.awt.Graphics2D g2d)

Draws input prompt text if it is available and should be visible at the moment.

Parameters:

g2d - graphics context

getEditorRect

protected java.awt.Rectangle getEditorRect()

Returns the bounding box for the root view. The component must have a non-zero positive size for this translation to be computed.

Returns:

the bounding box for the root view

isInputPromptVisible

public boolean isInputPromptVisible()

Description copied from interface: IAbstractTextEditorPainter

Returns whether input prompt visible or not.

Specified by:

isInputPromptVisible in interface IAbstractTextEditorPainter<E extends javax.swing.text.JTextComponent,U extends javax.swing.plaf.basic.BasicTextUI>

Returns:

whether input prompt visible or not