com.alee.painter

Interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Type Parameters:

E - component type

U - component UI type

All Known Subinterfaces:

IAbstractButtonPainter<E,U>, IAbstractLabelPainter<E,U>, IAbstractMenuItemPainter<E,U>, IAbstractSeparatorPainter<E,U>, IAbstractStateButtonPainter<E,U>, IAbstractTextAreaPainter<E,U>, IAbstractTextEditorPainter<E,U>, IAbstractTextFieldPainter<E,U>, IButtonPainter<E,U>, IButtonStatePainter<E,U>, ICheckBoxMenuItemPainter<E,U>, ICheckBoxPainter<E,U>, IColorChooserPainter<E,U>, IComboBoxPainter<E,U>, IDateFieldPainter<E,U>, IDesktopIconPainter<E,U>, IDesktopPanePainter<E,U>, IEditorPanePainter<E,U>, IFileChooserPainter<E,U>, IFormattedTextFieldPainter<E,U>, IInternalFramePainter<E,U>, ILabelPainter<E,U>, IListItemPainter<E,U>, IListPainter<E,U>, IMenuBarPainter<E,U>, IMenuItemPainter<E,U>, IMenuPainter<E,U>, IOptionPanePainter<E,U>, IPanelPainter<E,U>, IPasswordFieldPainter<E,U>, IPopOverPainter<E,U>, IPopupMenuPainter<E,U>, IPopupMenuSeparatorPainter<E,U>, IPopupPainter<E,U>, IProgressBarPainter<E,U>, IProgressPainter<E,U>, IRadioButtonMenuItemPainter<E,U>, IRadioButtonPainter<E,U>, IRootPanePainter<E,U>, IScrollBarPainter<E,U>, IScrollPanePainter<E,U>, ISeparatorPainter<E,U>, ISliderPainter<E,U>, ISpinnerPainter<E,U>, ISplitButtonPainter<E,U>, ISplitPanePainter<E,U>, IStatusBarPainter<E,U>, IStyledLabelPainter<E,U>, ITabbedPanePainter<E,U>, ITableHeaderPainter<E,U>, ITablePainter<E,U>, ITextAreaPainter<E,U>, ITextFieldPainter<E,U>, ITextPanePainter<E,U>, IToggleButtonPainter<E,U>, IToolBarPainter<E,U>, IToolBarSeparatorPainter<E,U>, IToolTipPainter<E,U>, ITreeDropLocationPainter<E,U>, ITreeNodePainter<E,U>, ITreePainter<E,U>, ITreeRowPainter<E,U>, ITreeSelectorPainter<E,U>, ITristateCheckBoxPainter<E,U>, IViewportPainter<E,U>, SectionPainter<E,U>, SpecificPainter<E,U>

All Known Implementing Classes:

AbstractButtonPainter, AbstractContainerPainter, AbstractDecorationPainter, AbstractLabelPainter, AbstractMenuItemPainter, AbstractPainter, AbstractPopupPainter, AbstractSectionDecorationPainter, AbstractSeparatorPainter, AbstractStateButtonPainter, AbstractTextAreaPainter, AbstractTextEditorPainter, AbstractTextFieldPainter, AdaptiveButtonPainter, AdaptiveCheckBoxMenuItemPainter, AdaptiveCheckBoxPainter, AdaptiveColorChooserPainter, AdaptiveComboBoxPainter, AdaptiveDateFieldPainter, AdaptiveDesktopIconPainter, AdaptiveDesktopPanePainter, AdaptiveEditorPanePainter, AdaptiveFileChooserPainter, AdaptiveFormattedTextFieldPainter, AdaptiveInternalFramePainter, AdaptiveLabelPainter, AdaptiveListPainter, AdaptiveMenuBarPainter, AdaptiveMenuItemPainter, AdaptiveMenuPainter, AdaptiveOptionPanePainter, AdaptivePainter, 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, AlternateTreeRowPainter, BorderPainter, BreadcrumbButtonPainter, BreadcrumbLabelPainter, BreadcrumbPanelPainter, BreadcrumbToggleButtonPainter, ButtonPainter, ButtonStatePainter, CheckBoxMenuItemPainter, CheckBoxPainter, ColorChooserPainter, ColorPainter, ComboBoxPainter, DateFieldPainter, DesktopIconPainter, DesktopPanePainter, EditorPanePainter, FileChooserPainter, FormattedTextFieldPainter, HotkeyLabelPainter, InternalFramePainter, LabelPainter, ListItemPainter, ListPainter, MenuBarPainter, MenuItemPainter, MenuPainter, NinePatchIconPainter, NinePatchStatePainter, NPDecorationPainter, NPLabelPainter, NPPanelPainter, NPScrollBarPainter, OptionPanePainter, PanelPainter, PasswordFieldPainter, PopOverPainter, PopupMenuPainter, PopupMenuSeparatorPainter, ProgressBarPainter, ProgressPainter, RadioButtonMenuItemPainter, RadioButtonPainter, RootPanePainter, ScrollBarPainter, ScrollPanePainter, SelectablePanelPainter, SeparatorPainter, SliderPainter, SpinnerPainter, SplitButtonPainter, SplitPanePainter, StatusBarPainter, StyledLabelPainter, SyntaxPanelPainter, TabbedPanePainter, TableCornerPainter, TableHeaderPainter, TablePainter, TextAreaPainter, TextFieldPainter, TextPanePainter, TexturePainter, TitledBorderPainter, ToggleButtonPainter, ToolBarPainter, ToolBarSeparatorPainter, ToolTipPainter, TreeDropLocationPainter, TreeNodePainter, TreePainter, TreeSelectorPainter, TristateCheckBoxPainter, ViewportPainter, WebButtonPopup.ButtonPopupPainter

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

This interface provides basic methods for drawing components or sections of components. Using painters you can easily change Swing and WebLaF components visual representation.

Whether or not single painter can be used for multiply components exclusively depends on its implementation. In most cases painters which does some animation won't work well with multiply components unless stated otherwise in JavaDoc.

See Also:

AbstractPainter, SpecificPainter, SectionPainter

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.
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.

Method Detail

install

void install(E c,
             U ui)

Called when painter is installed onto some component. You might want to use this method to add custom component listeners or modify component settings.

Parameters:

c - component this painter is being installed onto

ui - component UI

uninstall

void uninstall(E c,
               U ui)

Called when painter is installed into some component. You might want to use this method to add custom component listeners or modify component settings.

Parameters:

c - component this painter is being uninstalled from

ui - component UI

isOpaque

java.lang.Boolean isOpaque()

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.

Returns:

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

getBorders

java.awt.Insets getBorders()

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.

Returns:

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

paint

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

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.

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

ui - painted component UI

getPreferredSize

java.awt.Dimension getPreferredSize()

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.

Returns:

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

addPainterListener

void addPainterListener(PainterListener listener)

Adds new painter listener.

Parameters:

listener - painter listener to add

See Also:

PainterListener

removePainterListener

void removePainterListener(PainterListener listener)

Removes painter listener.

Parameters:

listener - painter listener to remove

See Also:

PainterListener