OverlayDecorator

This project has retired. For details please refer to its Attic page.

OverlayDecorator

java.lang.Object
- org.apache.pivot.wtk.effects.OverlayDecorator

All Implemented Interfaces:

Decorator
```
public class OverlayDecorator
extends java.lang.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

Constructors
Constructor Description

OverlayDecorator()

OverlayDecorator(Component overlay)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Component`	`getOverlay()`
`java.awt.Graphics2D`	`prepare(Component component, java.awt.Graphics2D graphicsValue)`	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

Methods inherited from interface org.apache.pivot.wtk.effects.Decorator
getBounds, getTransform

- Constructor Detail
  - OverlayDecorator
```
public OverlayDecorator()
```
  - OverlayDecorator
```
public OverlayDecorator(Component overlay)
```
- Method Detail
  - getOverlay
```
public Component getOverlay()
```
  - setOverlay
```
public void setOverlay(Component overlay)
```
  - prepare
```
public java.awt.Graphics2D prepare(Component component,
                                   java.awt.Graphics2D graphicsValue)
```
    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
    
    Parameters:
    
    component - The component the decorator is attached to.
    
    graphicsValue - The graphics context to draw into.
    
    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.
    This default version simply returns, without doing anything (often the appropriate thing to do).
    
    Specified by:
    
    update in interface Decorator