org.apache.pivot.wtk.effects
Class OverlayDecorator

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

public class OverlayDecorator
extends Object
implements Decorator

Decorator that overlays a component on top of another component. The overlay component is strictly visual and does not respond to user input.


Constructor Summary
OverlayDecorator()
           
OverlayDecorator(Component overlay)
           
 
Method Summary
 Bounds getBounds(Component component)
          Returns the bounding area of the decorator.
 Component getOverlay()
           
 AffineTransform getTransform(Component component)
          Returns the transformation the decorator applies to the component's coordinate space.
 Graphics2D prepare(Component component, Graphics2D graphicsArgument)
          Prepares the graphics context into which the component or prior decorator will paint.
 void setOverlay(Component overlay)
           
 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

OverlayDecorator

public OverlayDecorator()

OverlayDecorator

public OverlayDecorator(Component overlay)
Method Detail

getOverlay

public Component getOverlay()

setOverlay

public void setOverlay(Component overlay)

prepare

public Graphics2D prepare(Component component,
                          Graphics2D graphicsArgument)
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.