com.alee.painter

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

java.lang.Object

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

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

Type Parameters:

E - component type

U - component UI type

All Implemented Interfaces:

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

Direct Known Subclasses:

AdaptiveButtonPainter, AdaptiveCheckBoxMenuItemPainter, AdaptiveCheckBoxPainter, AdaptiveColorChooserPainter, AdaptiveComboBoxPainter, AdaptiveDateFieldPainter, AdaptiveDesktopIconPainter, AdaptiveDesktopPanePainter, AdaptiveEditorPanePainter, AdaptiveFileChooserPainter, AdaptiveFormattedTextFieldPainter, AdaptiveInternalFramePainter, AdaptiveLabelPainter, AdaptiveListPainter, AdaptiveMenuBarPainter, AdaptiveMenuItemPainter, AdaptiveMenuPainter, AdaptiveOptionPanePainter, AdaptivePanelPainter, AdaptivePasswordFieldPainter, AdaptivePopupMenuPainter, AdaptivePopupMenuSeparatorPainter, AdaptiveProgressBarPainter, AdaptiveRadioButtonMenuItemPainter, AdaptiveRadioButtonPainter, AdaptiveRootPanePainter, AdaptiveScrollBarPainter, AdaptiveScrollPanePainter, AdaptiveSeparatorPainter, AdaptiveSliderPainter, AdaptiveSpinnerPainter, AdaptiveSplitButtonPainter, AdaptiveSplitPanePainter, AdaptiveStatusBarPainter, AdaptiveStyledLabelPainter, AdaptiveTabbedPanePainter, AdaptiveTableHeaderPainter, AdaptiveTablePainter, AdaptiveTextAreaPainter, AdaptiveTextFieldPainter, AdaptiveTextPanePainter, AdaptiveToggleButtonPainter, AdaptiveToolBarPainter, AdaptiveToolBarSeparatorPainter, AdaptiveToolTipPainter, AdaptiveTreePainter, AdaptiveTristateCheckBoxPainter, AdaptiveViewportPainter

public abstract class AdaptivePainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
extends AbstractPainter<E,U>
implements SpecificPainter<E,U>

Special painter made to adapts any kind of painters to fit custom painters within the specific UIs. To use it properly you should extend this class and implement UI painter interface methods. In general cases those methods might have no effect since general-type painters do not know anything about component specifics.

Field Summary

Fields inherited from class com.alee.painter.AbstractPainter

component, listeners, ltr, propertyChangeListener, ui

Constructor Summary

Constructors

Constructor and Description
AdaptivePainter(Painter painter) Constructs new AdaptivePainter to adapt specified painter.

Method Summary

Modifier and Type	Method and Description
void	addPainterListener(PainterListener listener) Adds new painter listener.
java.awt.Insets	getBorders() Returns borders required for visual data provided by this painter.
Painter	getPainter() Returns adapted painter.
java.awt.Dimension	getPreferredSize() Returns preferred size required for proper painting of visual data provided by this painter.
void	install(E c, U ui) Called when painter is installed onto some component.
java.lang.Boolean	isOpaque() Returns whether visual data provided by this painter is opaque or not.
void	paint(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, U ui) Paints visual data using component graphics context.
void	removePainterListener(PainterListener listener) Removes painter listener.
void	uninstall(E c, U ui) Called when painter is installed into some component.

Methods inherited from class com.alee.painter.AbstractPainter

b, borderChange, getCompleteBorder, i, i, i, installPropertyChangeListener, isSectionPainter, isSettingsUpdateAllowed, orientationChange, p, propertyChange, 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

Constructor Detail

AdaptivePainter

public AdaptivePainter(Painter painter)

Constructs new AdaptivePainter to adapt specified painter.

Parameters:

painter - painter to adapt

Method Detail

getPainter

public Painter getPainter()

Returns adapted painter.

Returns:

adapted painter

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>

Overrides:

install in class AbstractPainter<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>

Overrides:

uninstall in class AbstractPainter<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>

Overrides:

isOpaque in class AbstractPainter<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>

Overrides:

getBorders in class AbstractPainter<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

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>

Overrides:

addPainterListener in class AbstractPainter<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>

Overrides:

removePainterListener in class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Parameters:

listener - painter listener to remove

See Also:

PainterListener

paint

public void paint(java.awt.Graphics2D g2d,
                  java.awt.Rectangle bounds,
                  E c,
                  U ui)

Description copied from interface: Painter

Paints visual data using component graphics context. Provided graphics context and component are taken directly from component UI paint method.

It is highly recommended to honor provided painting bounds to avoid painting issues. These bounds might be representing full component size or contain just a small portion of the component.

Specified by:

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

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

ui - painted component UI

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>

Overrides:

getPreferredSize in class AbstractPainter<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