Class Repainter

java.lang.Object

VASSAL.tools.imageop.Repainter

All Implemented Interfaces:

ImageOpObserver, OpObserver<BufferedImage>

public class Repainter
extends Object
implements ImageOpObserver

An ImageOpObserver which repaints Components. This class stores a reference to a Component and a rectangle of that component which will be repainted when imageOpChange(VASSAL.tools.imageop.ImageOp, boolean) is called and success is true.

Since:

3.1.0

Author:

Joel Uckelman

Field Summary

Fields

Modifier and Type	Field	Description
protected final Component	c
protected final int	h
protected final int	w
protected final int	x
protected final int	y

Constructor Summary

Constructors

Constructor	Description
Repainter(Component c, int x, int y, int w, int h)	Creates a Repainter for the specified component and rectangle.
Repainter(Component c, Rectangle r)	Creates a Repainter for the specified component and area.

Method Summary

Modifier and Type	Method	Description
void	cancelled(Op<BufferedImage> op, CancellationException e)	Callback which is run when the observed Op is cancelled.
void	failed(Op<BufferedImage> op, ExecutionException e)	Callback which is run when the observed Op fails.
void	imageOpChange(ImageOp op, boolean success)	Called when the ImageOp under observation completes.
void	interrupted(Op<BufferedImage> op, InterruptedException e)	Callback which is run when the observed Op is interrupted.
void	succeeded(Op<BufferedImage> op, BufferedImage img)	Callback which is run when the observed Op completes successfully.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

c

protected final Component c

x

protected final int x

y

protected final int y

w

protected final int w

h

protected final int h

Constructor Details

Repainter

public Repainter(Component c,
 int x,
 int y,
 int w,
 int h)

Creates a Repainter for the specified component and rectangle. Repainters will usually be constructed during paint operations on the Event Dispatch Thread, and so will be created in enormous quantities. In order to minimize object creation, always use this constructor rather Repainter(Component c, Rectangle r), except in the case where the Rectangle already exists.

Parameters:

c - the component to repaint

x - the x coordinate of the upper-left corner of the rectangle to repaint

y - the y coordinate of the upper-left corner of the rectangle to repaint

w - the width of the rectangle to repaint

h - the height of the rectangle to repaint

Throws:

IllegalArgumentException - if c == null

Repainter

public Repainter(Component c,
 Rectangle r)

Creates a Repainter for the specified component and area.

Parameters:

c - the component to be repainted

r - the area to be repainted

Throws:

IllegalArgumentException - if c == null

Method Details

imageOpChange

public void imageOpChange(ImageOp op,
 boolean success)

Called when the ImageOp under observation completes.

Specified by:

imageOpChange in interface ImageOpObserver

Parameters:

op - the ImageOp being observed

success - repaint the Component iff true

succeeded

public void succeeded(Op<BufferedImage> op,
 BufferedImage img)

Description copied from interface: OpObserver

Callback which is run when the observed Op completes successfully.

Specified by:

succeeded in interface OpObserver<BufferedImage>

Parameters:

op - the successfully completed Op

img - the value of the Op

cancelled

public void cancelled(Op<BufferedImage> op,
 CancellationException e)

Description copied from interface: OpObserver

Callback which is run when the observed Op is cancelled.

Specified by:

cancelled in interface OpObserver<BufferedImage>

Parameters:

op - the cancelled Op

e - the CancellationException thrown when the Op was cancelled

interrupted

public void interrupted(Op<BufferedImage> op,
 InterruptedException e)

Description copied from interface: OpObserver

Callback which is run when the observed Op is interrupted.

Specified by:

interrupted in interface OpObserver<BufferedImage>

Parameters:

op - the interrupted Op

e - the InterruptedException thrown when the Op was interrupted

failed

public void failed(Op<BufferedImage> op,
 ExecutionException e)

Description copied from interface: OpObserver

Callback which is run when the observed Op fails.

Specified by:

failed in interface OpObserver<BufferedImage>

Parameters:

op - the failed Op

e - the ExecutionException thrown when the Op failed