SynthPainter (Java 2 Platform SE 5.0)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Standard Ed. 5.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing.plaf.synth
Class SynthPainter

java.lang.Object
  javax.swing.plaf.synth.SynthPainter

public abstract class SynthPainter
extends Object
extends Object

SynthPainter is used for painting portions of JComponents. At a minimum each JComponent has two paint methods: one for the border and one for the background. Some JComponents have more than one Region, and as a consequence more paint methods.

Instances of SynthPainter are obtained from the SynthStyle.getPainter(javax.swing.plaf.synth.SynthContext) method.

You typically supply a SynthPainter by way of Synth's file format. The following example registers a painter for all JButtons that will render the image myImage.png:

  <style id="buttonStyle">
    <imagePainter path="myImage.png" sourceInsets="2 2 2 2"
                  paintCenter="true" stretch="true"/>
    <insets top="2" bottom="2" left="2" right="2"/>
  </style>
  <bind style="buttonStyle" type="REGION" key="button"/>

SynthPainter is abstract in so far as it does no painting, all the methods are empty. While none of these methods are typed to throw an exception, subclasses can assume that valid arguments are passed in, and if not they can throw a NullPointerException or IllegalArgumentException in response to invalid arguments.

Since:: 1.5

Constructor Summary
`SynthPainter()`

Method Summary
`void`	`paintArrowButtonBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of an arrow button.
`void`	`paintArrowButtonBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of an arrow button.
`void`	`paintArrowButtonForeground(SynthContext context, Graphics g, int x, int y, int w, int h, int direction)` Paints the foreground of an arrow button.
`void`	`paintButtonBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a button.
`void`	`paintButtonBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a button.
`void`	`paintCheckBoxBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a check box.
`void`	`paintCheckBoxBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a check box.
`void`	`paintCheckBoxMenuItemBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a check box menu item.
`void`	`paintCheckBoxMenuItemBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a check box menu item.
`void`	`paintColorChooserBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a color chooser.
`void`	`paintColorChooserBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a color chooser.
`void`	`paintComboBoxBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a combo box.
`void`	`paintComboBoxBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a combo box.
`void`	`paintDesktopIconBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a desktop icon.
`void`	`paintDesktopIconBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a desktop icon.
`void`	`paintDesktopPaneBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a desktop pane.
`void`	`paintDesktopPaneBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a desktop pane.
`void`	`paintEditorPaneBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of an editor pane.
`void`	`paintEditorPaneBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of an editor pane.
`void`	`paintFileChooserBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a file chooser.
`void`	`paintFileChooserBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a file chooser.
`void`	`paintFormattedTextFieldBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a formatted text field.
`void`	`paintFormattedTextFieldBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a formatted text field.
`void`	`paintInternalFrameBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of an internal frame.
`void`	`paintInternalFrameBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of an internal frame.
`void`	`paintInternalFrameTitlePaneBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of an internal frame title pane.
`void`	`paintInternalFrameTitlePaneBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of an internal frame title pane.
`void`	`paintLabelBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a label.
`void`	`paintLabelBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a label.
`void`	`paintListBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a list.
`void`	`paintListBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a list.
`void`	`paintMenuBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a menu.
`void`	`paintMenuBarBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a menu bar.
`void`	`paintMenuBarBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a menu bar.
`void`	`paintMenuBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a menu.
`void`	`paintMenuItemBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a menu item.
`void`	`paintMenuItemBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a menu item.
`void`	`paintOptionPaneBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of an option pane.
`void`	`paintOptionPaneBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of an option pane.
`void`	`paintPanelBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a panel.
`void`	`paintPanelBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a panel.
`void`	`paintPasswordFieldBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a password field.
`void`	`paintPasswordFieldBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a password field.
`void`	`paintPopupMenuBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a popup menu.
`void`	`paintPopupMenuBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a popup menu.
`void`	`paintProgressBarBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a progress bar.
`void`	`paintProgressBarBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a progress bar.
`void`	`paintProgressBarForeground(SynthContext context, Graphics g, int x, int y, int w, int h, int orientation)` Paints the foreground of a progress bar.
`void`	`paintRadioButtonBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a radio button.
`void`	`paintRadioButtonBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a radio button.
`void`	`paintRadioButtonMenuItemBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a radio button menu item.
`void`	`paintRadioButtonMenuItemBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a radio button menu item.
`void`	`paintRootPaneBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a root pane.
`void`	`paintRootPaneBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a root pane.
`void`	`paintScrollBarBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a scrollbar.
`void`	`paintScrollBarBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a scrollbar.
`void`	`paintScrollBarThumbBackground(SynthContext context, Graphics g, int x, int y, int w, int h, int orientation)` Paints the background of the thumb of a scrollbar.
`void`	`paintScrollBarThumbBorder(SynthContext context, Graphics g, int x, int y, int w, int h, int orientation)` Paints the border of the thumb of a scrollbar.
`void`	`paintScrollBarTrackBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of the track of a scrollbar.
`void`	`paintScrollBarTrackBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of the track of a scrollbar.
`void`	`paintScrollPaneBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a scroll pane.
`void`	`paintScrollPaneBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a scroll pane.
`void`	`paintSeparatorBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a separator.
`void`	`paintSeparatorBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a separator.
`void`	`paintSeparatorForeground(SynthContext context, Graphics g, int x, int y, int w, int h, int orientation)` Paints the foreground of a separator.
`void`	`paintSliderBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a slider.
`void`	`paintSliderBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a slider.
`void`	`paintSliderThumbBackground(SynthContext context, Graphics g, int x, int y, int w, int h, int orientation)` Paints the background of the thumb of a slider.
`void`	`paintSliderThumbBorder(SynthContext context, Graphics g, int x, int y, int w, int h, int orientation)` Paints the border of the thumb of a slider.
`void`	`paintSliderTrackBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of the track of a slider.
`void`	`paintSliderTrackBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of the track of a slider.
`void`	`paintSpinnerBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a spinner.
`void`	`paintSpinnerBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a spinner.
`void`	`paintSplitPaneBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a split pane.
`void`	`paintSplitPaneBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a split pane.
`void`	`paintSplitPaneDividerBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of the divider of a split pane.
`void`	`paintSplitPaneDividerForeground(SynthContext context, Graphics g, int x, int y, int w, int h, int orientation)` Paints the foreground of the divider of a split pane.
`void`	`paintSplitPaneDragDivider(SynthContext context, Graphics g, int x, int y, int w, int h, int orientation)` Paints the divider, when the user is dragging the divider, of a split pane.
`void`	`paintTabbedPaneBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a tabbed pane.
`void`	`paintTabbedPaneBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a tabbed pane.
`void`	`paintTabbedPaneContentBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of the area that contains the content of the selected tab of a tabbed pane.
`void`	`paintTabbedPaneContentBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of the area that contains the content of the selected tab of a tabbed pane.
`void`	`paintTabbedPaneTabAreaBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of the area behind the tabs of a tabbed pane.
`void`	`paintTabbedPaneTabAreaBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of the area behind the tabs of a tabbed pane.
`void`	`paintTabbedPaneTabBackground(SynthContext context, Graphics g, int x, int y, int w, int h, int tabIndex)` Paints the background of a tab of a tabbed pane.
`void`	`paintTabbedPaneTabBorder(SynthContext context, Graphics g, int x, int y, int w, int h, int tabIndex)` Paints the border of a tab of a tabbed pane.
`void`	`paintTableBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a table.
`void`	`paintTableBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a table.
`void`	`paintTableHeaderBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of the header of a table.
`void`	`paintTableHeaderBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of the header of a table.
`void`	`paintTextAreaBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a text area.
`void`	`paintTextAreaBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a text area.
`void`	`paintTextFieldBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a text field.
`void`	`paintTextFieldBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a text field.
`void`	`paintTextPaneBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a text pane.
`void`	`paintTextPaneBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a text pane.
`void`	`paintToggleButtonBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a toggle button.
`void`	`paintToggleButtonBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a toggle button.
`void`	`paintToolBarBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a tool bar.
`void`	`paintToolBarBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a tool bar.
`void`	`paintToolBarContentBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of the tool bar's content area.
`void`	`paintToolBarContentBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of the content area of a tool bar.
`void`	`paintToolBarDragWindowBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of the window containing the tool bar when it has been detached from its primary frame.
`void`	`paintToolBarDragWindowBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of the window containing the tool bar when it has been detached from it's primary frame.
`void`	`paintToolTipBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a tool tip.
`void`	`paintToolTipBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a tool tip.
`void`	`paintTreeBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of a tree.
`void`	`paintTreeBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a tree.
`void`	`paintTreeCellBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of the row containing a cell in a tree.
`void`	`paintTreeCellBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of the row containing a cell in a tree.
`void`	`paintTreeCellFocus(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the focus indicator for a cell in a tree when it has focus.
`void`	`paintViewportBackground(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the background of the viewport.
`void`	`paintViewportBorder(SynthContext context, Graphics g, int x, int y, int w, int h)` Paints the border of a viewport.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

SynthPainter

public SynthPainter()

Method Detail

paintArrowButtonBackground

public void paintArrowButtonBackground(SynthContext context,
                                       Graphics g,
                                       int x,
                                       int y,
                                       int w,
                                       int h)

Paints the background of an arrow button. Arrow buttons are created by some components, such as JScrollBar.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintArrowButtonBorder

public void paintArrowButtonBorder(SynthContext context,
                                   Graphics g,
                                   int x,
                                   int y,
                                   int w,
                                   int h)

Paints the border of an arrow button. Arrow buttons are created by some components, such as JScrollBar.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintArrowButtonForeground

public void paintArrowButtonForeground(SynthContext context,
                                       Graphics g,
                                       int x,
                                       int y,
                                       int w,
                                       int h,
                                       int direction)

Paints the foreground of an arrow button. This method is responsible for drawing a graphical representation of a direction, typically an arrow. Arrow buttons are created by some components, such as JScrollBar

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to; direction - One of SwingConstants.NORTH, SwingConstants.SOUTH SwingConstants.EAST or SwingConstants.WEST

paintButtonBackground

public void paintButtonBackground(SynthContext context,
                                  Graphics g,
                                  int x,
                                  int y,
                                  int w,
                                  int h)

Paints the background of a button.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintButtonBorder

public void paintButtonBorder(SynthContext context,
                              Graphics g,
                              int x,
                              int y,
                              int w,
                              int h)

Paints the border of a button.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintCheckBoxMenuItemBackground

public void paintCheckBoxMenuItemBackground(SynthContext context,
                                            Graphics g,
                                            int x,
                                            int y,
                                            int w,
                                            int h)

Paints the background of a check box menu item.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintCheckBoxMenuItemBorder

public void paintCheckBoxMenuItemBorder(SynthContext context,
                                        Graphics g,
                                        int x,
                                        int y,
                                        int w,
                                        int h)

Paints the border of a check box menu item.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintCheckBoxBackground

public void paintCheckBoxBackground(SynthContext context,
                                    Graphics g,
                                    int x,
                                    int y,
                                    int w,
                                    int h)

Paints the background of a check box.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintCheckBoxBorder

public void paintCheckBoxBorder(SynthContext context,
                                Graphics g,
                                int x,
                                int y,
                                int w,
                                int h)

Paints the border of a check box.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintColorChooserBackground

public void paintColorChooserBackground(SynthContext context,
                                        Graphics g,
                                        int x,
                                        int y,
                                        int w,
                                        int h)

Paints the background of a color chooser.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintColorChooserBorder

public void paintColorChooserBorder(SynthContext context,
                                    Graphics g,
                                    int x,
                                    int y,
                                    int w,
                                    int h)

Paints the border of a color chooser.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintComboBoxBackground

public void paintComboBoxBackground(SynthContext context,
                                    Graphics g,
                                    int x,
                                    int y,
                                    int w,
                                    int h)

Paints the background of a combo box.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintComboBoxBorder

public void paintComboBoxBorder(SynthContext context,
                                Graphics g,
                                int x,
                                int y,
                                int w,
                                int h)

Paints the border of a combo box.

Parameters:: context - SynthContext identifying the JComponent and Region to paint to; g - Graphics to paint to; x - X coordinate of the area to paint to; y - Y coordinate of the area to paint to; w - Width of the area to paint to; h - Height of the area to paint to

paintDesktopIconBackground

public void paintDesktopIconBackground(SynthContext context,
                                       Graphics g,
                                       int x,
                                       int y,
                                       int w,
                                       int h)

Paints the background of a desktop icon.

Parameters:

javax.swing.plaf.synth Class SynthPainter