com.alee.laf.text.AbstractTextEditorPainter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
Show all versions of weblaf-ui Show documentation
WebLaf is a Java Swing Look and Feel and extended components library for cross-platform applications
/*
* This file is part of WebLookAndFeel library.
*
* WebLookAndFeel library is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* WebLookAndFeel library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebLookAndFeel library. If not, see >
extends AbstractDecorationPainter implements IAbstractTextEditorPainter, SwingConstants
{
/**
* Input prompt text horizontal position.
*/
protected int inputPromptHorizontalPosition = SwingConstants.CENTER;
/**
* Input prompt text vertical position.
* Important mostly for text area components.
*/
protected int inputPromptVerticalPosition = SwingConstants.CENTER;
/**
* Input prompt text font.
*/
@XStreamConverter ( FontConverter.class )
protected Font inputPromptFont = null;
/**
* Input prompt tex foreground.
*/
protected Color inputPromptForeground = new Color ( 160, 160, 160 );
/**
* Whether or not should display input prompt only when component is editable.
*/
protected boolean inputPromptOnlyWhenEditable = true;
/**
* Whether or not should hide input prompt on focus gain.
*/
protected boolean hideInputPromptOnFocus = true;
/**
* Listeners.
*/
protected transient Pair documentChangeListeners;
@Override
public void install ( final E c, final U ui )
{
super.install ( c, ui );
// Proper document change listener
// This is required to update emptiness state
documentChangeListeners = EventUtils.onChange ( component, new DocumentEventRunnable ()
{
@Override
public void run ( final DocumentEvent e )
{
updateDecorationState ();
}
} );
}
@Override
public void uninstall ( final E c, final U ui )
{
// Uninstalling listeners
component.removePropertyChangeListener ( WebLookAndFeel.DOCUMENT_PROPERTY, documentChangeListeners.getValue () );
component.getDocument ().removeDocumentListener ( documentChangeListeners.getKey () );
super.uninstall ( c, ui );
}
@Override
protected List getDecorationStates ()
{
final List states = super.getDecorationStates ();
if ( TextUtils.isEmpty ( component.getText () ) )
{
states.add ( DecorationState.empty );
}
return states;
}
@Override
protected void paintContent ( final Graphics2D g2d, final Rectangle bounds, final E c, final U ui )
{
// Paints text highligher
final Highlighter highlighter = component.getHighlighter ();
if ( highlighter != null )
{
highlighter.paint ( g2d );
}
final Map hints = SwingUtils.setupTextAntialias ( g2d );
// Paints input prompt
paintInputPrompt ( g2d );
// Paints editor view
final Rectangle alloc = getEditorRect ();
if ( alloc != null )
{
ui.getRootView ( component ).paint ( g2d, alloc );
}
SwingUtils.restoreTextAntialias ( g2d, hints );
// Paints caret
final Caret caret = component.getCaret ();
if ( caret != null )
{
caret.paint ( g2d );
}
// Paints drop caret
final DefaultCaret dropCaret = ReflectUtils.getFieldValueSafely ( ui, "dropCaret" );
if ( dropCaret != null )
{
dropCaret.paint ( g2d );
}
}
/**
* Draws input prompt text if it is available and should be visible at the moment.
*
* @param g2d graphics context
*/
protected void paintInputPrompt ( final Graphics2D g2d )
{
if ( isInputPromptVisible () )
{
final Rectangle b = getEditorRect ();
final Shape oc = GraphicsUtils.intersectClip ( g2d, b );
g2d.setFont ( inputPromptFont != null ? inputPromptFont : component.getFont () );
g2d.setPaint ( inputPromptForeground != null ? inputPromptForeground : component.getForeground () );
final String text = LM.get ( getInputPrompt () );
final FontMetrics fm = g2d.getFontMetrics ();
final int x;
if ( inputPromptHorizontalPosition == CENTER )
{
x = b.x + b.width / 2 - fm.stringWidth ( text ) / 2;
}
else if ( ltr && inputPromptHorizontalPosition == LEADING || !ltr && inputPromptHorizontalPosition == TRAILING ||
inputPromptHorizontalPosition == LEFT )
{
x = b.x;
}
else
{
x = b.x + b.width - fm.stringWidth ( text );
}
final int y;
if ( inputPromptVerticalPosition == CENTER )
{
y = b.y + b.height / 2 + LafUtils.getTextCenterShiftY ( fm );
}
else
{
y = ui.getBaseline ( component, component.getWidth (), component.getHeight () );
}
g2d.drawString ( text, x, y );
GraphicsUtils.restoreClip ( g2d, oc );
}
}
/**
* Returns the bounding box for the root view.
* The component must have a non-zero positive size for this translation to be computed.
*
* @return the bounding box for the root view
*/
protected Rectangle getEditorRect ()
{
final Rectangle alloc = component.getBounds ();
if ( alloc.width > 0 && alloc.height > 0 )
{
final Insets insets = component.getInsets ();
alloc.x = insets.left;
alloc.y = insets.top;
alloc.width -= insets.left + insets.right;
alloc.height -= insets.top + insets.bottom;
return alloc;
}
return null;
}
@Override
public boolean isInputPromptVisible ()
{
final String inputPrompt = LM.get ( getInputPrompt () );
return inputPrompt != null && !inputPrompt.isEmpty () && TextUtils.isEmpty ( component.getText () ) &&
( !inputPromptOnlyWhenEditable || component.isEditable () && component.isEnabled () ) &&
( !hideInputPromptOnFocus || !isFocused () );
}
}