org.apache.pivot.wtk.effects
Class ClipDecorator

java.lang.Object
  extended by org.apache.pivot.wtk.effects.ClipDecorator
All Implemented Interfaces:
Decorator

public class ClipDecorator
extends Object
implements Decorator

Decorator that adds a rectangular region to the current clip.


Constructor Summary
ClipDecorator()
           
 
Method Summary
 Bounds getBounds(Component component)
          Returns the bounding area of the decorator.
 int getHeight()
           
 Point getOrigin()
           
 Dimensions getSize()
           
 AffineTransform getTransform(Component component)
          Returns the transformation the decorator applies to the component's coordinate space.
 int getWidth()
           
 int getX()
           
 int getY()
           
 Graphics2D prepare(Component component, Graphics2D graphics)
          Prepares the graphics context into which the component or prior decorator will paint.
 void setHeight(int height)
           
 void setOrigin(int x, int y)
           
 void setSize(int width, int height)
           
 void setWidth(int width)
           
 void setX(int x)
           
 void setY(int y)
           
 void update()
          Updates the graphics context into which the component or prior decorator was painted.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClipDecorator

public ClipDecorator()
Method Detail

getX

public int getX()

setX

public void setX(int x)

getY

public int getY()

setY

public void setY(int y)

setOrigin

public void setOrigin(int x,
                      int y)

getOrigin

public Point getOrigin()

getWidth

public int getWidth()

setWidth

public void setWidth(int width)

getHeight

public int getHeight()

setHeight

public void setHeight(int height)

setSize

public void setSize(int width,
                    int height)

getSize

public Dimensions getSize()

prepare

public Graphics2D prepare(Component component,
                          Graphics2D graphics)
Description copied from interface: Decorator
Prepares the graphics context into which the component or prior decorator will paint. This method is called immediately prior to Component.paint(Graphics2D); decorators are called in descending order.

Specified by:
prepare in interface Decorator
Returns:
The graphics context that should be used by the component or prior decorators.

update

public void update()
Description copied from interface: Decorator
Updates the graphics context into which the component or prior decorator was painted. This method is called immediately after Component.paint(Graphics2D); decorators are called in ascending order.

Specified by:
update in interface Decorator

getBounds

public Bounds getBounds(Component component)
Description copied from interface: Decorator
Returns the bounding area of the decorator.

Specified by:
getBounds in interface Decorator
Returns:
The decorator's bounds, relative to the component's origin.

getTransform

public AffineTransform getTransform(Component component)
Description copied from interface: Decorator
Returns the transformation the decorator applies to the component's coordinate space.

Specified by:
getTransform in interface Decorator
Returns:
The decorator's transform.