com.alee.painter

Class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

java.lang.Object

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

Type Parameters:

E - component type

U - component UI type

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDecorationPainter, AbstractMenuItemPainter, AbstractPopupPainter, AbstractSeparatorPainter, AdaptivePainter, AlternateTreeRowPainter, BorderPainter, BreadcrumbButtonPainter, BreadcrumbToggleButtonPainter, ColorPainter, NinePatchIconPainter, NinePatchStatePainter, NPDecorationPainter, ScrollBarPainter, SelectablePanelPainter, SliderPainter, SyntaxPanelPainter, TabbedPanePainter, TableCornerPainter, TableHeaderPainter, TablePainter, TexturePainter, ViewportPainter

public abstract class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
extends java.lang.Object
implements Painter<E,U>, BorderMethods

This abstract painter provides a few additional useful features atop of the Painter interface. Usually this class is extended by various painters instead of implementing Painter interface directly.

See Also:

Painter

Field Summary

Fields

Modifier and Type	Field and Description
protected E	component Component reference.
protected java.util.List<PainterListener>	listeners Painter listeners.
protected boolean	ltr Whether or not painted component has LTR orientation.
protected java.beans.PropertyChangeListener	propertyChangeListener Listeners.
protected U	ui Component UI reference.

Constructor Summary

Constructors

Constructor and Description
AbstractPainter()

Method Summary

Modifier and Type	Method and Description
void	addPainterListener(PainterListener listener) Adds new painter listener.
protected java.awt.Rectangle	b(java.awt.Rectangle bounds, java.awt.Insets limit) Returns bounds reduced by specified insets.
protected void	borderChange(javax.swing.border.Border border) Performs various border-related operations.
java.awt.Insets	getBorders() Returns borders required for visual data provided by this painter.
java.awt.Insets	getCompleteBorder() Updates component border according to component's margin and padding and painter's borders.
java.awt.Dimension	getPreferredSize() Returns preferred size required for proper painting of visual data provided by this painter.
protected java.awt.Insets	i(java.awt.Insets i1, java.awt.Insets i2) Returns combined insets.
protected java.awt.Insets	i(java.awt.Insets insets, int top, int left, int bottom, int right) Returns combined insets with the specified settings.
protected java.awt.Insets	i(int top, int left, int bottom, int right) Returns insets with the specified settings.
void	install(E c, U ui) Called when painter is installed onto some component.
protected void	installPropertyChangeListener() Installs listener that will inform about component property changes.
java.lang.Boolean	isOpaque() Returns whether visual data provided by this painter is opaque or not.
protected boolean	isSectionPainter() Returns whether or not this is a section painter.
protected boolean	isSettingsUpdateAllowed() Returns whether or not this painter is allowed to update component settings and visual state.
protected void	orientationChange() Performs various updates on orientation change.
protected java.awt.Point	p(int x, int y) Returns point for the specified coordinates.
protected void	propertyChange(java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue) Performs various updates on property changes.
void	removePainterListener(PainterListener listener) Removes painter listener.
void	repaint() Should be called when painter visual representation changes.
void	repaint(int x, int y, int width, int height) Should be called when part of painter visual representation changes.
void	repaint(java.awt.Rectangle bounds) Should be called when part of painter visual representation changes.
void	revalidate() Should be called when painter size or border changes.
protected void	saveOrientation() Saves current component orientation state.
void	uninstall(E c, U ui) Called when painter is installed into some component.
protected void	uninstallPropertyChangeListener() Uninstalls listener that is informing about component property changes.
void	updateAll() Should be called when painter size, border and visual representation changes.
void	updateBorder() Updates component with complete border.
void	updateOpacity() Should be called when painter opacity changes.
void	updateOrientation() Updates component orientation based on global orientation.

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

paint

Field Detail

listeners

protected final transient java.util.List<PainterListener> listeners

Painter listeners.

propertyChangeListener

protected transient java.beans.PropertyChangeListener propertyChangeListener

Listeners.

component

protected transient E extends javax.swing.JComponent component

Component reference.

ui

protected transient U extends javax.swing.plaf.ComponentUI ui

Component UI reference.

ltr

protected transient boolean ltr

Whether or not painted component has LTR orientation.

Constructor Detail

AbstractPainter

public AbstractPainter()

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.JComponent,U extends javax.swing.plaf.ComponentUI>

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.JComponent,U extends javax.swing.plaf.ComponentUI>

Parameters:

c - component this painter is being uninstalled from

ui - component UI

isOpaque

public java.lang.Boolean isOpaque()

Description copied from interface: Painter

Returns whether visual data provided by this painter is opaque or not. Returned value might affect component opacity depending on painter support inside that component UI. Simply return null if you don't want to change default component opacity.

Specified by:

isOpaque in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Returns:

true if visual data provided by this painter is opaque, false otherwise

getBorders

public java.awt.Insets getBorders()

Description copied from interface: Painter

Returns borders required for visual data provided by this painter. These borders should not include possible component margin and padding, only borders provided by painter. These borders are added to component's margin and padding when the final component border is calculated. These borders should not take component orientation into account, painter will take care of it later.

You may pass null in case additional borders aren't needed for this painter.

Specified by:

getBorders in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Returns:

borders required for visual data provided by this painter or null in case those aren't needed

isSettingsUpdateAllowed

protected boolean isSettingsUpdateAllowed()

Returns whether or not this painter is allowed to update component settings and visual state. By default it is determined by the painter type, for example any SectionPainter should avoid updating settings.

Returns:

true if this painter is allowed to update component settings and visual state, false otherwise

isSectionPainter

protected boolean isSectionPainter()

Returns whether or not this is a section painter. Some internal behaviors might vary depending on what this method returns.

Returns:

true if this is a section painter, false otherwise

installPropertyChangeListener

protected void installPropertyChangeListener()

Installs listener that will inform about component property changes.

uninstallPropertyChangeListener

protected void uninstallPropertyChangeListener()

Uninstalls listener that is informing about component property changes.

propertyChange

protected void propertyChange(java.lang.String property,
                              java.lang.Object oldValue,
                              java.lang.Object newValue)

Performs various updates on property changes.

Parameters:

property - modified property

oldValue - old property value

newValue - new property value

orientationChange

protected void orientationChange()

Performs various updates on orientation change.

borderChange

protected void borderChange(javax.swing.border.Border border)

Performs various border-related operations.

Parameters:

border - new border

saveOrientation

protected void saveOrientation()

Saves current component orientation state.

updateOrientation

public void updateOrientation()

Updates component orientation based on global orientation.

updateBorder

public void updateBorder()

Updates component with complete border. This border takes painter borders and component margin and padding into account.

Specified by:

updateBorder in interface BorderMethods

getCompleteBorder

public java.awt.Insets getCompleteBorder()

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

Returns:

complete painter border

repaint

public void repaint()

Should be called when painter visual representation changes.

repaint

public void repaint(java.awt.Rectangle bounds)

Should be called when part of painter visual representation changes.

Parameters:

bounds - part bounds

repaint

public void repaint(int x,
                    int y,
                    int width,
                    int height)

Should be called when part of painter visual representation changes.

Parameters:

x - part bounds X coordinate

y - part bounds Y coordinate

width - part bounds width

height - part bounds height

revalidate

public void revalidate()

Should be called when painter size or border changes.

updateOpacity

public void updateOpacity()

Should be called when painter opacity changes.

updateAll

public void updateAll()

Should be called when painter size, border and visual representation changes. Calls both revalidate and update listener methods.

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.JComponent,U extends javax.swing.plaf.ComponentUI>

Returns:

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

addPainterListener

public void addPainterListener(PainterListener listener)

Description copied from interface: Painter

Adds new painter listener.

Specified by:

addPainterListener in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Parameters:

listener - painter listener to add

See Also:

PainterListener

removePainterListener

public void removePainterListener(PainterListener listener)

Description copied from interface: Painter

Removes painter listener.

Specified by:

removePainterListener in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Parameters:

listener - painter listener to remove

See Also:

PainterListener

p

protected java.awt.Point p(int x,
                           int y)

Returns point for the specified coordinates.

Parameters:

x - X coordinate

y - Y coordinate

Returns:

point for the specified coordinates

i

protected java.awt.Insets i(int top,
                            int left,
                            int bottom,
                            int right)

Returns insets with the specified settings.

Parameters:

top - the inset from the top

left - the inset from the left

bottom - the inset from the bottom

right - the inset from the right

Returns:

insets with the specified settings

i

protected java.awt.Insets i(java.awt.Insets insets,
                            int top,
                            int left,
                            int bottom,
                            int right)

Returns combined insets with the specified settings.

Parameters:

insets - base insets

top - the inset from the top

left - the inset from the left

bottom - the inset from the bottom

right - the inset from the right

Returns:

combined insets with the specified settings

i

protected java.awt.Insets i(java.awt.Insets i1,
                            java.awt.Insets i2)

Returns combined insets.

Parameters:

i1 - first insets

i2 - second insets

Returns:

combined insets

b

protected java.awt.Rectangle b(java.awt.Rectangle bounds,
                               java.awt.Insets limit)

Returns bounds reduced by specified insets.

Parameters:

bounds - bounds to reduce

limit - limiting insets

Returns:

bounds reduced by specified insets