org.barrelorgandiscovery.gui.atrace

Class PunchLayer

java.lang.Object

org.barrelorgandiscovery.gui.atrace.PunchLayer

All Implemented Interfaces:

VirtualBookComponentLayer, VirtualBookComponentLayerName

public class PunchLayer
extends java.lang.Object
implements VirtualBookComponentLayer, VirtualBookComponentLayerName

Layer for displaying the punch vision of a book

Field Summary

Fields

Modifier and Type	Field and Description
static int	ORIGIN_CENTER
static int	ORIGIN_LEFT_MIDDLE
static int	ORIGIN_LEFT_UPPER

Constructor Summary

Constructors

Constructor and Description
PunchLayer()

Method Summary

Modifier and Type	Method and Description
void	draw(java.awt.Graphics g, JVirtualBookComponent jcarton) ask for a draw in the component
java.lang.String	getDisplayName()
int	getOrigin()
Punch[]	getPunch()
double	getPunchHeight()
int	getPunchType()
double	getPunchWidth()
boolean	isVisible() ask if the layer is visible
void	setLayerName(java.lang.String displayName)
void	setOrigin(int origin)
void	setPunch(Punch[] punches) set the punches to display
void	setPunchHeight(double punchHeight)
void	setPunchType(int punchType)
void	setPunchWidth(double punchWidth)
void	setVisible(boolean visible) define if the layer is visible or not

Methods inherited from class java.lang.Object

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

Field Detail

ORIGIN_LEFT_UPPER

public static final int ORIGIN_LEFT_UPPER

See Also:

Constant Field Values

ORIGIN_LEFT_MIDDLE

public static final int ORIGIN_LEFT_MIDDLE

See Also:

Constant Field Values

ORIGIN_CENTER

public static final int ORIGIN_CENTER

See Also:

Constant Field Values

Constructor Detail

PunchLayer

public PunchLayer()

Method Detail

setOrigin

public void setOrigin(int origin)

getOrigin

public int getOrigin()

draw

public void draw(java.awt.Graphics g,
                 JVirtualBookComponent jcarton)

Description copied from interface: VirtualBookComponentLayer

ask for a draw in the component

Specified by:

draw in interface VirtualBookComponentLayer

Parameters:

g - the graphic reference for drawing with Java2D

jcarton - the VirtualBookComponent reference

setPunch

public void setPunch(Punch[] punches)

set the punches to display

Parameters:

punches -

getPunchWidth

public double getPunchWidth()

setPunchWidth

public void setPunchWidth(double punchWidth)

getPunchHeight

public double getPunchHeight()

setPunchHeight

public void setPunchHeight(double punchHeight)

getPunchType

public int getPunchType()

setPunchType

public void setPunchType(int punchType)

getPunch

public Punch[] getPunch()

isVisible

public boolean isVisible()

Description copied from interface: VirtualBookComponentLayer

ask if the layer is visible

Specified by:

isVisible in interface VirtualBookComponentLayer

Returns:

setVisible

public void setVisible(boolean visible)

Description copied from interface: VirtualBookComponentLayer

define if the layer is visible or not

Specified by:

setVisible in interface VirtualBookComponentLayer

setLayerName

public void setLayerName(java.lang.String displayName)

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface VirtualBookComponentLayerName