oracle.cabo.image.painter
Class AbstractWrappingPainter

java.lang.Object
  |
  +--oracle.cabo.image.painter.AbstractPainter
        |
        +--oracle.cabo.image.painter.AbstractWrappingPainter

All Implemented Interfaces:

Painter

Direct Known Subclasses:

AbstractBorderPainter, AbstractPainterSwitcher, ColorChange, OffscreenWrappingPainter

public abstract class AbstractWrappingPainter

extends AbstractPainter

Abstract baseclass for Painters that wrap other painters, modifying the attributes of the wrapped painter. This class delegates all Painter methods through to the wrapped Painter.

Fields inherited from interface oracle.cabo.image.painter.Painter

STATE_ACTIVE_CHANGED, STATE_ARMED_CHANGED, STATE_BACKGROUND_CHANGED, STATE_ENABLED_CHANGED, STATE_FOCUSED_CHANGED, STATE_FONT_CHANGED, STATE_FOREGROUND_CHANGED, STATE_ISDEFAULT_CHANGED, STATE_MOUSE_OVER_CHANGED, STATE_READING_DIRECTION_CHANGED, STATE_SELECTED_CHANGED, STATE_SET_CHANGED, STATE_SIZE_CHANGED, STATE_XALIGNMENT_CHANGED, STATE_YALIGNMENT_CHANGED

Constructor Summary

AbstractWrappingPainter()
Create an AbstractWrappingPainter wrapping a NullPainter.

AbstractWrappingPainter(Painter wrappedPainter)
Create an AbstractWrappingPainter wrapping another Painter.

Method Summary

int	getInvalidateFlags(PaintContext context) Returns the flags indicating the conditions under which the Painter must be invalidated.
java.awt.Dimension	getMaximumSize(PaintContext context) Returns the maximum size of the wrapped painter.
java.awt.Dimension	getMinimumSize(PaintContext context) Returns the minimum size of the wrapped painter.
Painter	getPainterAt(PaintContext context, int availableWidth, int availableHeight, int x, int y, Painter proxyPainter) Returns the Painter inside this Painter at location x,y of the available size.
java.awt.Dimension	getPreferredSize(PaintContext context) Returns the preferred size of the wrapped painter.
int	getRepaintFlags(PaintContext context) Returns the flags indicating the conditions under which the Painter must be repainted.
java.awt.Dimension	getSize(PaintContext context, int availableWidth, int availableHeight) Returns the size of the wrapped Painter for the specified amount of availableWidth and availableHeight.
protected Painter	getWrappedPainter(PaintContext context) Returns the wrapped painter.
boolean	isTransparent(PaintContext context) Returns true if the wrapped Painter doesn't paint all of its pixels.
void	paint(PaintContext context, java.awt.Graphics g, int x, int y, int width, int height) Paints the wrapped Painter.

Methods inherited from class oracle.cabo.image.painter.AbstractPainter

contains, getData, getDataKey

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWrappingPainter

public AbstractWrappingPainter()

Create an AbstractWrappingPainter wrapping a NullPainter.

See Also:

NullPainter.getPainter()

AbstractWrappingPainter

public AbstractWrappingPainter(Painter wrappedPainter)

Create an AbstractWrappingPainter wrapping another Painter.

Parameters:

wrappedPainter - The Painter to wrap.

Method Detail

getSize

public java.awt.Dimension getSize(PaintContext context,
                                  int availableWidth,
                                  int availableHeight)

Returns the size of the wrapped Painter for the specified amount of availableWidth and availableHeight. Most Painters will simply return the availableWidth and availableHeight.

Overrides:

getSize in class AbstractPainter

Parameters:

context - the context for deterimining the size.

availableWidth - Amount of width available to the Painter.

availableHeight - Amount of height available to the Painter.

Returns:

The size of the Painter.

getPreferredSize

public java.awt.Dimension getPreferredSize(PaintContext context)

Returns the preferred size of the wrapped painter.

Overrides:

getPreferredSize in class AbstractPainter

Parameters:

context - Context for determining the preferred size.

Returns:

The preferred size of the Painter.

getMinimumSize

public java.awt.Dimension getMinimumSize(PaintContext context)

Returns the minimum size of the wrapped painter.

Parameters:

context - Context for determining the minimum size.

Returns:

The minimum size of the Painter.

getMaximumSize

public java.awt.Dimension getMaximumSize(PaintContext context)

Returns the maximum size of the wrapped painter.

Overrides:

getMaximumSize in class AbstractPainter

Parameters:

context - Context for determining the maximum size.

Returns:

The maximum size of the Painter.

paint

public void paint(PaintContext context,
                  java.awt.Graphics g,
                  int x,
                  int y,
                  int width,
                  int height)

Paints the wrapped Painter.

Parameters:

context - Context for painting.

g - Graphics object to draw into.

x - X position to draw at.

y - Y position to draw at.

width - Width to draw into.

height - Height to draw into.

getPainterAt

public Painter getPainterAt(PaintContext context,
                            int availableWidth,
                            int availableHeight,
                            int x,
                            int y,
                            Painter proxyPainter)

Returns the Painter inside this Painter at location x,y of the available size. If no Painter is at that location, this method returns null.

Overrides:

getPainterAt in class AbstractPainter

Parameters:

context - Context for determining containership.

availableWidth - Amount of width available to the Painter.

availableHeight - Amount of height available to the Painter.

x - X location to test for containership in this Painter.

y - Y location to test for containership in this Painter.

proxyPainter - Painter to return instead of child painters

Returns:

The Painter at the specified loaction, or null if none.

isTransparent

public boolean isTransparent(PaintContext context)

Returns true if the wrapped Painter doesn't paint all of its pixels.

Overrides:

isTransparent in class AbstractPainter

Parameters:

context - Context for determining transparency.

Returns:

True if the Painter is transparent.

getRepaintFlags

public int getRepaintFlags(PaintContext context)

Returns the flags indicating the conditions under which the Painter must be repainted.

Overrides:

getRepaintFlags in class AbstractPainter

Parameters:

context - Context to use for determining the conditions under which reapinting is required.

Returns:

Flags indicating the conditions under which this Painter must be repainted.

getInvalidateFlags

public int getInvalidateFlags(PaintContext context)

Returns the flags indicating the conditions under which the Painter must be invalidated.

Overrides:

getInvalidateFlags in class AbstractPainter

Parameters:

context - Context to use for determining the conditions under which invalidation is required.

Returns:

Flags indicating the conditions under which this Painter must be invalidated.

getWrappedPainter

protected Painter getWrappedPainter(PaintContext context)

Returns the wrapped painter. By default, just returns the painter passed to the constructor, but subclasses can override this method to dynamically adjust the wrapped painter depending on the PaintContext.

Parameters:

context - Context to use for determining the wrapped painter.