com.alee.painter

Class PainterSupport

java.lang.Object

com.alee.painter.PainterSupport

public final class PainterSupport
extends java.lang.Object

This special class provides basic methods to link painter with components.

Constructor Summary

Constructors

Constructor and Description
PainterSupport()

Method Summary

Modifier and Type	Method and Description
static <T extends Painter> T	getAdaptedPainter(Painter painter) Returns either the specified painter if it is not an adapted painter or the adapted painter.
static java.awt.Dimension	getPreferredSize(javax.swing.JComponent component, java.awt.Dimension preferred, Painter painter) Returns component preferred size or null if there is no preferred size.
static java.awt.Dimension	getPreferredSize(javax.swing.JComponent component, java.awt.Dimension preferred, Painter painter, boolean ignoreLayoutSize) Returns component preferred size or null if there is no preferred size.
static java.awt.Dimension	getPreferredSize(javax.swing.JComponent component, Painter painter) Returns component preferred size or null if there is no preferred size.
static <T extends SpecificPainter> T	getProperPainter(Painter painter, java.lang.Class<T> properClass, java.lang.Class<? extends T> adapterClass) Returns the specified painter if it can be assigned to proper painter type.
static java.awt.Shape	getShape(javax.swing.JComponent component, Painter painter) Returns component shape according to its painter.
static void	installPainter(javax.swing.JComponent component, Painter painter) Installs painter into the specified component.
static <T extends SectionPainter> T	installSectionPainter(Painter origin, T painter, Painter old, javax.swing.JComponent component, javax.swing.plaf.ComponentUI ui) Installs section painter into the specified component.
static boolean	isDecoratable(java.awt.Component component) Returns whether or not component uses decoratable painter.
static <P extends SpecificPainter> void	setPainter(javax.swing.JComponent component, com.alee.utils.swing.DataRunnable<P> setter, P oldPainter, Painter painter, java.lang.Class<P> specificClass, java.lang.Class<? extends P> specificAdapterClass) Sets component painter.
static void	uninstallPainter(javax.swing.JComponent component, Painter painter) Uninstalls painter from the specified component.
static <T extends SectionPainter> T	uninstallSectionPainter(T painter, javax.swing.JComponent component, javax.swing.plaf.ComponentUI ui) Uninstalls section painter from the specified component.
static void	updateBorder(Painter painter) Force painter to update border of the component it is attached to.

Methods inherited from class java.lang.Object

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

Constructor Detail

PainterSupport

public PainterSupport()

Method Detail

getProperPainter

public static <T extends SpecificPainter> T getProperPainter(Painter painter,
                                                             java.lang.Class<T> properClass,
                                                             java.lang.Class<? extends T> adapterClass)

Returns the specified painter if it can be assigned to proper painter type. Otherwise returns newly created adapter painter that wraps the specified painter. Used by component UIs to adapt general-type painters for their specific-type needs.

Type Parameters:

T - proper painter type

Parameters:

painter - processed painter

properClass - proper painter class

adapterClass - adapter painter class

Returns:

specified painter if it can be assigned to proper painter type, new painter adapter if it cannot be assigned

getAdaptedPainter

public static <T extends Painter> T getAdaptedPainter(Painter painter)

Returns either the specified painter if it is not an adapted painter or the adapted painter. Used by component UIs to retrieve painters adapted for their specific needs.

Type Parameters:

T - desired painter type

Parameters:

painter - painter to process

Returns:

either the specified painter if it is not an adapted painter or the adapted painter

setPainter

public static <P extends SpecificPainter> void setPainter(javax.swing.JComponent component,
                                                          com.alee.utils.swing.DataRunnable<P> setter,
                                                          P oldPainter,
                                                          Painter painter,
                                                          java.lang.Class<P> specificClass,
                                                          java.lang.Class<? extends P> specificAdapterClass)

Sets component painter. null can be provided to uninstall painter.

Type Parameters:

P - specific painter class type

Parameters:

component - component painter should be installed into

setter - runnable that updates actual painter field

oldPainter - previously installed painter

painter - painter to install

specificClass - specific painter class

specificAdapterClass - specific painter adapter class

installPainter

public static void installPainter(javax.swing.JComponent component,
                                  Painter painter)

Installs painter into the specified component. It is highly recommended to call this method only from EDT.

Parameters:

component - component painter is applied to

painter - painter to install

uninstallPainter

public static void uninstallPainter(javax.swing.JComponent component,
                                    Painter painter)

Uninstalls painter from the specified component. It is highly recommended to call this method only from EDT.

Parameters:

component - component painter is uninstalled from

painter - painter to uninstall

installSectionPainter

public static <T extends SectionPainter> T installSectionPainter(Painter origin,
                                                                 T painter,
                                                                 Painter old,
                                                                 javax.swing.JComponent component,
                                                                 javax.swing.plaf.ComponentUI ui)

Installs section painter into the specified component. It is highly recommended to call this method only from EDT.

Type Parameters:

T - section painter type

Parameters:

origin - origin painter

painter - section painter to install

old - previously installed section painter

component - component painter should be installed into

ui - component UI

Returns:

installed sub-painter

uninstallSectionPainter

public static <T extends SectionPainter> T uninstallSectionPainter(T painter,
                                                                   javax.swing.JComponent component,
                                                                   javax.swing.plaf.ComponentUI ui)

Uninstalls section painter from the specified component. It is highly recommended to call this method only from EDT.

Type Parameters:

T - section painter type

Parameters:

painter - section painter to uninstall

component - component painter should be uninstalled from

ui - component UI

Returns:

null

updateBorder

public static void updateBorder(Painter painter)

Force painter to update border of the component it is attached to.

Parameters:

painter - painter to ask for border update

getShape

public static java.awt.Shape getShape(javax.swing.JComponent component,
                                      Painter painter)

Returns component shape according to its painter.

Parameters:

component - component painter is applied to

painter - component painter

Returns:

component shape according to its painter

getPreferredSize

public static java.awt.Dimension getPreferredSize(javax.swing.JComponent component,
                                                  Painter painter)

Returns component preferred size or null if there is no preferred size.

Parameters:

component - component painter is applied to

painter - component painter

Returns:

component preferred size or null if there is no preferred size

getPreferredSize

public static java.awt.Dimension getPreferredSize(javax.swing.JComponent component,
                                                  java.awt.Dimension preferred,
                                                  Painter painter)

Returns component preferred size or null if there is no preferred size. todo Probably get rid of this method and force painters to determine full preferred size?

Parameters:

component - component painter is applied to

preferred - component preferred size

painter - component painter

Returns:

component preferred size or null if there is no preferred size

getPreferredSize

public static java.awt.Dimension getPreferredSize(javax.swing.JComponent component,
                                                  java.awt.Dimension preferred,
                                                  Painter painter,
                                                  boolean ignoreLayoutSize)

Returns component preferred size or null if there is no preferred size.

Parameters:

component - component painter is applied to

preferred - component preferred size

painter - component painter

ignoreLayoutSize - whether or not layout preferred size should be ignored

Returns:

component preferred size or null if there is no preferred size

isDecoratable

public static boolean isDecoratable(java.awt.Component component)

Returns whether or not component uses decoratable painter.

Parameters:

component - component to process

Returns:

true if component uses decoratable painter, false otherwise