Class PainterUIResource
- java.lang.Object
-
- org.jdesktop.swingx.plaf.PainterUIResource
-
- All Implemented Interfaces:
javax.swing.plaf.UIResource
,Painter<javax.swing.JComponent>
public class PainterUIResource extends java.lang.Object implements Painter<javax.swing.JComponent>, javax.swing.plaf.UIResource
An impl of Painter that implements UIResource. UI classes that create Painters should use this class.
-
-
Constructor Summary
Constructors Constructor Description PainterUIResource(Painter p)
Creates a new instance of PainterUIResource
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
paint(java.awt.Graphics2D g, javax.swing.JComponent component, int width, int height)
Renders to the givenGraphics2D
object.
-
-
-
Constructor Detail
-
PainterUIResource
public PainterUIResource(Painter p)
Creates a new instance of PainterUIResource
-
-
Method Detail
-
paint
public void paint(java.awt.Graphics2D g, javax.swing.JComponent component, int width, int height)
Description copied from interface:Painter
Renders to the given
Graphics2D
object. Implementations of this method may modify state on theGraphics2D
, and are not required to restore that state upon completion. In most cases, it is recommended that the caller pass in a scratch graphics object. TheGraphics2D
must never be null.State on the graphics object may be honored by the
paint
method, but may not be. For instance, setting the antialiasing rendering hint on the graphics may or may not be respected by thePainter
implementation.The supplied object parameter acts as an optional configuration argument. For example, it could be of type
Component
. APainter
that expected it could then read state from thatComponent
and use the state for painting. For example, an implementation may read the backgroundColor and use that.Generally, to enhance reusability, most standard
Painter
s ignore this parameter. They can thus be reused in any context. Theobject
may be null. Implementations must not throw a NullPointerException if the object parameter is null.Finally, the
width
andheight
arguments specify the width and height that thePainter
should paint into. More specifically, the specified width and height instruct the painter that it should paint fully within this width and height. Any specified clip on theg
param will further constrain the region.For example, suppose I have a
Painter
implementation that draws a gradient. The gradient goes from white to black. It "stretches" to fill the painted region. Thus, if I use thisPainter
to paint a 500 x 500 region, the far left would be black, the far right would be white, and a smooth gradient would be painted between. I could then, without modification, reuse thePainter
to paint a region that is 20x20 in size. This region would also be black on the left, white on the right, and a smooth gradient painted between.
-
-