org.jdesktop.swingx.painter.effects
Class AbstractAreaEffect

java.lang.Object
  extended by org.jdesktop.swingx.painter.effects.AbstractAreaEffect
All Implemented Interfaces:
AreaEffect
Direct Known Subclasses:
GlowPathEffect, InnerGlowPathEffect, InnerShadowPathEffect, NeonBorderEffect, ShadowPathEffect

public class AbstractAreaEffect
extends Object
implements AreaEffect

The abstract base class for path effects. It takes care of soft clipping and interpolating brush sizes and colors. Subclasses can change these values to provide prefab effect behavior, like dropshadows and glows.


Constructor Summary
AbstractAreaEffect()
          Creates a new instance of AreaEffect
 
Method Summary
 void addPropertyChangeListener(PropertyChangeListener l)
          Adds a PropertyChangeListener to the listener list.
 void apply(Graphics2D g, Shape clipShape, int width, int height)
          Draws an effect on the specified graphics and path using the specified width and height.
 Color getBrushColor()
          Getter for property brushColor.
 int getBrushSteps()
          Getter for property brushSteps.
 int getEffectWidth()
          Getter for property effectWidth.
 Point2D getOffset()
          Getter for property offset.
 boolean isRenderInsideShape()
          Getter for property renderInsideShape.
 boolean isShapeMasked()
          Getter for property shapeMasked.
 boolean isShouldFillShape()
          Getter for property shouldFillShape.
protected  void paintBorderGlow(Graphics2D g2, Shape clipShape, int width, int height)
          Paints the border glow
 void removePropertyChangeListener(PropertyChangeListener l)
          Removes a PropertyChangeListener from the listener list.
 void setBrushColor(Color brushColor)
          Setter for property brushColor.
 void setBrushSteps(int brushSteps)
          Setter for property brushSteps.
 void setEffectWidth(int effectWidth)
          Setter for property effectWidth.
 void setOffset(Point2D offset)
          Setter for property offset.
 void setRenderInsideShape(boolean renderInsideShape)
          Setter for property renderInsideShape.
 void setShapeMasked(boolean shapeMasked)
          Setter for property shapeMasked.
 void setShouldFillShape(boolean shouldFillShape)
          Setter for property shouldFillShape.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractAreaEffect

public AbstractAreaEffect()
Creates a new instance of AreaEffect

Method Detail

apply

public void apply(Graphics2D g,
                  Shape clipShape,
                  int width,
                  int height)
Description copied from interface: AreaEffect
Draws an effect on the specified graphics and path using the specified width and height.

Specified by:
apply in interface AreaEffect

paintBorderGlow

protected void paintBorderGlow(Graphics2D g2,
                               Shape clipShape,
                               int width,
                               int height)
Paints the border glow

Parameters:
g2 -
clipShape -
width -
height -

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)
Adds a PropertyChangeListener to the listener list.

Parameters:
l - The listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)
Removes a PropertyChangeListener from the listener list.

Parameters:
l - The listener to remove.

getBrushColor

public Color getBrushColor()
Getter for property brushColor.

Returns:
Value of property brushColor.

setBrushColor

public void setBrushColor(Color brushColor)
Setter for property brushColor.

Parameters:
brushColor - New value of property brushColor.

getBrushSteps

public int getBrushSteps()
Getter for property brushSteps.

Returns:
Value of property brushSteps.

setBrushSteps

public void setBrushSteps(int brushSteps)
Setter for property brushSteps.

Parameters:
brushSteps - New value of property brushSteps.

getEffectWidth

public int getEffectWidth()
Getter for property effectWidth.

Returns:
Value of property effectWidth.

setEffectWidth

public void setEffectWidth(int effectWidth)
Setter for property effectWidth.

Parameters:
effectWidth - New value of property effectWidth.

isRenderInsideShape

public boolean isRenderInsideShape()
Getter for property renderInsideShape.

Returns:
Value of property renderInsideShape.

setRenderInsideShape

public void setRenderInsideShape(boolean renderInsideShape)
Setter for property renderInsideShape.

Parameters:
renderInsideShape - New value of property renderInsideShape.

getOffset

public Point2D getOffset()
Getter for property offset.

Returns:
Value of property offset.

setOffset

public void setOffset(Point2D offset)
Setter for property offset.

Parameters:
offset - New value of property offset.

isShouldFillShape

public boolean isShouldFillShape()
Getter for property shouldFillShape.

Returns:
Value of property shouldFillShape.

setShouldFillShape

public void setShouldFillShape(boolean shouldFillShape)
Setter for property shouldFillShape.

Parameters:
shouldFillShape - New value of property shouldFillShape.

isShapeMasked

public boolean isShapeMasked()
Getter for property shapeMasked.

Returns:
Value of property shapeMasked.

setShapeMasked

public void setShapeMasked(boolean shapeMasked)
Setter for property shapeMasked.

Parameters:
shapeMasked - New value of property shapeMasked.