org.apache.pivot.wtk.effects
Class TranslationDecorator

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

public class TranslationDecorator
extends Object
implements Decorator

Decorator that translates the paint origin of its component.


Constructor Summary
TranslationDecorator()
           
TranslationDecorator(boolean clip)
           
TranslationDecorator(int x, int y, boolean clip)
           
 
Method Summary
 Bounds getBounds(Component component)
          Returns the bounding area of the decorator.
 boolean getClip()
           
 Point getOffset()
           
 AffineTransform getTransform(Component component)
          Returns the transformation the decorator applies to the component's coordinate space.
 int getX()
           
 int getY()
           
 Graphics2D prepare(Component component, Graphics2D graphics)
          Prepares the graphics context into which the component or prior decorator will paint.
 void setClip(boolean clip)
           
 void setOffset(int x, int y)
           
 void setOffset(Point offset)
           
 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

TranslationDecorator

public TranslationDecorator()

TranslationDecorator

public TranslationDecorator(boolean clip)

TranslationDecorator

public TranslationDecorator(int x,
                            int y,
                            boolean clip)
Method Detail

getX

public int getX()

setX

public void setX(int x)

getY

public int getY()

setY

public void setY(int y)

getOffset

public Point getOffset()

setOffset

public void setOffset(Point offset)

setOffset

public void setOffset(int x,
                      int y)

getClip

public boolean getClip()

setClip

public void setClip(boolean clip)

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.