com.codename1.ui.painter

Class PainterChain

java.lang.Object

com.codename1.ui.painter.PainterChain

All Implemented Interfaces:

Painter

public class PainterChain
extends Object
implements Painter

A painter chain allows us to chain together several painters to provide a "layer" effect where each painter only draws one element.

Author:

Shai Almog

Constructor Summary

Constructors

Constructor and Description
PainterChain(Painter painter) Create a new painter chain which will paint all of the elements in the chain in sequence from 0 to the last element
PainterChain(Painter[] chain) Create a new painter chain which will paint all of the elements in the chain in sequence from 0 to the last element

Method Summary

Modifier and Type	Method and Description
PainterChain	addPainter(Painter p) Creates a new chain based on the existing chain with the new element added at the end
Painter[]	getChain() Allows us to traverse the painter chain
static void	installGlassPane(Form f, Painter p) Installs a glass pane on the given form making sure to make it a painter chain only if required by existing painter
void	paint(Graphics g, Rectangle rect) Draws inside the given rectangle clipping area.
PainterChain	prependPainter(Painter p) Creates a new chain based on the existing chain with the new element added at the beginning
static void	removeGlassPane(Form f, Painter p) Removes a glass pane from the given form, this is the opposite operation for the install glass pane

Methods inherited from class java.lang.Object

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

Constructor Detail

PainterChain

public PainterChain(Painter[] chain)

Create a new painter chain which will paint all of the elements in the chain in sequence from 0 to the last element

Parameters:

chain - the chain of components in the painter

PainterChain

public PainterChain(Painter painter)

Create a new painter chain which will paint all of the elements in the chain in sequence from 0 to the last element

Parameters:

painter - the chain first Painter

Method Detail

addPainter

public PainterChain addPainter(Painter p)

Creates a new chain based on the existing chain with the new element added at the end

Parameters:

p - new painter

Returns:

new chain element

prependPainter

public PainterChain prependPainter(Painter p)

Creates a new chain based on the existing chain with the new element added at the beginning

Parameters:

p - new painter

Returns:

new chain element

paint

public void paint(Graphics g,
                  Rectangle rect)

Draws inside the given rectangle clipping area.

Specified by:

paint in interface Painter

Parameters:

g - the Graphics object

rect - the given rectangle cliping area

installGlassPane

public static void installGlassPane(Form f,
                                    Painter p)

Installs a glass pane on the given form making sure to make it a painter chain only if required by existing painter

Parameters:

f - form on which to install the chain

p - painter to install

getChain

public Painter[] getChain()

Allows us to traverse the painter chain

Returns:

the internal painter chain

removeGlassPane

public static void removeGlassPane(Form f,
                                   Painter p)

Removes a glass pane from the given form, this is the opposite operation for the install glass pane

Parameters:

f - form from which to remove the chain

p - painter to remove