com.alee.laf.label

Class AbstractLabelPainter<E extends javax.swing.JLabel,U extends javax.swing.plaf.basic.BasicLabelUI,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.label.AbstractLabelPainter<E,U,D>

Type Parameters:

E - component type

U - component UI type

D - decoration type

All Implemented Interfaces:

IAbstractLabelPainter<E,U>, PainterShapeProvider<E>, Painter<E,U>, SpecificPainter<E,U>, BorderMethods, com.alee.utils.swing.SwingMethods

Direct Known Subclasses:

LabelPainter, StyledLabelPainter

public abstract class AbstractLabelPainter<E extends javax.swing.JLabel,U extends javax.swing.plaf.basic.BasicLabelUI,D extends IDecoration<E,D>>
extends AbstractDecorationPainter<E,U,D>
implements IAbstractLabelPainter<E,U>

Abstract painter for label components.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	drawShade Style settings.
protected java.awt.Rectangle	paintIconR Runtime variables.
protected java.awt.Rectangle	paintTextR
protected java.awt.Rectangle	paintViewR
protected Rotation	rotation
protected java.awt.Color	shadeColor
protected int	shadeSize

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

Constructor Summary

Constructors

Constructor and Description
AbstractLabelPainter()

Method Summary

Modifier and Type	Method and Description
protected Rotation	getActualRotation() Returns actual label rotation.
java.awt.Insets	getCompleteBorder() Updates component border according to component's margin and padding and painter's borders.
protected java.awt.Dimension	getContentSize() Returns label content size.
java.awt.Dimension	getPreferredSize() Returns preferred size required for proper painting of visual data provided by this painter.
protected boolean	isHtmlText(E label) Returns whether or not label contains HTML text.
protected java.lang.Boolean	isOpaqueUndecorated() Returns opacity state for undecorated component.
protected java.lang.String	layout(E label, java.awt.FontMetrics fm, int width, int height) Updates painted label layout and returns clipped or full label text.
protected java.lang.String	layoutCL(E label, java.awt.FontMetrics fm, java.lang.String text, javax.swing.Icon icon, java.awt.Rectangle viewR, java.awt.Rectangle iconR, java.awt.Rectangle textR) Performs label layout and returns clipped or full label text.
protected void	paintBackground(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E label, U ui) Paints background.
protected void	paintContent(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, U ui) Paints content decorated by this painter.
protected void	paintDisabledText(E label, java.awt.Graphics2D g2d, java.lang.String text, int textX, int textY) Performs disabled text painting.
protected void	paintEnabledText(E label, java.awt.Graphics2D g2d, java.lang.String text, int textX, int textY) Performs enabled text painting.
protected void	paintHtmlText(java.awt.Graphics2D g2d, E label) Paints HTML text view.
protected void	paintIcon(java.awt.Graphics2D g2d, E label, javax.swing.Icon icon) Paints label icon.
protected void	paintPlainText(java.awt.Graphics2D g2d, E label, java.lang.String text, java.awt.FontMetrics fm) Paints plain text view.
protected void	paintShadowText(java.awt.Graphics2D g2d, java.lang.String text, int textX, int textY) Paints custom text shade.
protected void	paintText(java.awt.Graphics2D g2d, E label, java.lang.String text, java.awt.FontMetrics fm) Paints label text.
protected java.awt.Dimension	transposeDimension(java.awt.Dimension from) Returns transposed dimension.

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

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

Methods inherited from class com.alee.painter.AbstractPainter

addPainterListener, b, borderChange, 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.painter.Painter

addPainterListener, getBorders, install, isOpaque, paint, removePainterListener, uninstall

Field Detail

drawShade

protected boolean drawShade

Style settings.

shadeColor

protected java.awt.Color shadeColor

shadeSize

protected int shadeSize

rotation

protected Rotation rotation

paintIconR

protected java.awt.Rectangle paintIconR

Runtime variables.

paintTextR

protected java.awt.Rectangle paintTextR

paintViewR

protected java.awt.Rectangle paintViewR

Constructor Detail

AbstractLabelPainter

public AbstractLabelPainter()

Method Detail

getActualRotation

protected Rotation getActualRotation()

Returns actual label rotation.

Returns:

actual label rotation

isOpaqueUndecorated

protected java.lang.Boolean isOpaqueUndecorated()

Description copied from class: AbstractDecorationPainter

Returns opacity state for undecorated component. This is separated from base opacity state method to allow deep customization.

Overrides:

isOpaqueUndecorated in class AbstractDecorationPainter<E extends javax.swing.JLabel,U extends javax.swing.plaf.basic.BasicLabelUI,D extends IDecoration<E,D>>

Returns:

opacity state for undecorated component

getCompleteBorder

public java.awt.Insets getCompleteBorder()

Description copied from class: AbstractPainter

Updates component border according to component's margin and padding and painter's borders.

Overrides:

getCompleteBorder in class AbstractPainter<E extends javax.swing.JLabel,U extends javax.swing.plaf.basic.BasicLabelUI>

Returns:

complete painter border

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.JLabel,U extends javax.swing.plaf.basic.BasicLabelUI,D extends IDecoration<E,D>>

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

ui - painted component UI

paintBackground

protected void paintBackground(java.awt.Graphics2D g2d,
                               java.awt.Rectangle bounds,
                               E label,
                               U ui)

Paints background. todo Should be removed upon as soon as decoration supports all kinds of borders used in extending painters so far

Parameters:

g2d - graphics context

bounds - bounds for painter visual data

label - painted component

ui - painted component UI

paintIcon

protected void paintIcon(java.awt.Graphics2D g2d,
                         E label,
                         javax.swing.Icon icon)

Paints label icon.

Parameters:

g2d - graphics context

label - painted component

icon - label icon

paintText

protected void paintText(java.awt.Graphics2D g2d,
                         E label,
                         java.lang.String text,
                         java.awt.FontMetrics fm)

Paints label text.

Parameters:

g2d - graphics context

label - painted component

text - label text

fm - label font metrics

isHtmlText

protected boolean isHtmlText(E label)

Returns whether or not label contains HTML text.

Parameters:

label - painted component

Returns:

true if label contains HTML text, false otherwise

paintHtmlText

protected void paintHtmlText(java.awt.Graphics2D g2d,
                             E label)

Paints HTML text view.

Parameters:

g2d - graphics context

label - painted component

paintPlainText

protected void paintPlainText(java.awt.Graphics2D g2d,
                              E label,
                              java.lang.String text,
                              java.awt.FontMetrics fm)

Paints plain text view.

Parameters:

g2d - graphics context

label - painted component

text - label text

fm - label font metrics

layout

protected java.lang.String layout(E label,
                                  java.awt.FontMetrics fm,
                                  int width,
                                  int height)

Updates painted label layout and returns clipped or full label text.

Parameters:

label - painted component

fm - label font metrics

width - label width

height - label height

Returns:

clipped or full label text

layoutCL

protected java.lang.String layoutCL(E label,
                                    java.awt.FontMetrics fm,
                                    java.lang.String text,
                                    javax.swing.Icon icon,
                                    java.awt.Rectangle viewR,
                                    java.awt.Rectangle iconR,
                                    java.awt.Rectangle textR)

Performs label layout and returns clipped or full label text.

Parameters:

label - painted component

fm - label font metrics

text - label text

icon - label icon

viewR - rectangle limited by label insets

iconR - icon rectangle dummy

textR - text rectangle dummy

Returns:

clipped or full label text

paintEnabledText

protected void paintEnabledText(E label,
                                java.awt.Graphics2D g2d,
                                java.lang.String text,
                                int textX,
                                int textY)

Performs enabled text painting.

Parameters:

label - painted component

g2d - graphics context

text - label text

textX - text X coordinate

textY - text Y coordinate

paintDisabledText

protected void paintDisabledText(E label,
                                 java.awt.Graphics2D g2d,
                                 java.lang.String text,
                                 int textX,
                                 int textY)

Performs disabled text painting.

Parameters:

label - painted component

g2d - graphics context

text - label text

textX - text X coordinate

textY - text Y coordinate

paintShadowText

protected void paintShadowText(java.awt.Graphics2D g2d,
                               java.lang.String text,
                               int textX,
                               int textY)

Paints custom text shade.

Parameters:

g2d - graphics context

text - text

textX - text X coordinate

textY - text Y coordinate

getPreferredSize

public java.awt.Dimension getPreferredSize()

Description copied from interface: Painter

Returns preferred size required for proper painting of visual data provided by this painter. This should not take into account any sizes not related to the painter itself.

Specified by:

getPreferredSize in interface Painter<E extends javax.swing.JLabel,U extends javax.swing.plaf.basic.BasicLabelUI>

Overrides:

getPreferredSize in class AbstractDecorationPainter<E extends javax.swing.JLabel,U extends javax.swing.plaf.basic.BasicLabelUI,D extends IDecoration<E,D>>

Returns:

preferred size required for proper painting of visual data provided by this painter

getContentSize

protected java.awt.Dimension getContentSize()

Returns label content size.

Returns:

label content size.

transposeDimension

protected java.awt.Dimension transposeDimension(java.awt.Dimension from)

Returns transposed dimension.

Parameters:

from - dimension to transpose

Returns:

transposed dimension