org.compiere.print.layout
Class PrintElement

java.lang.Object
  org.compiere.print.layout.PrintElement

All Implemented Interfaces:

ImageObserver

Direct Known Subclasses:

BarcodeElement, BoxElement, GraphElement, GridElement, HTMLElement, ImageElement, StringElement, TableElement

public abstract class PrintElement
extends Object
implements ImageObserver

Print Element

Version:

$Id: PrintElement.java,v 1.2 2006/07/30 00:53:02 jjanke Exp $

Author:

Jorg Janke

Field Summary

static Color	LINK_COLOR Link Color
protected CLogger	log Logger
protected String	p_FieldAlignmentType Field Align Type
protected float	p_height
protected String	p_info Image Info
protected float	p_maxHeight
protected float	p_maxWidth Max Size of Element
protected Point2D.Double	p_pageLocation Location on Page
protected boolean	p_sizeCalculated
protected float	p_width Calculated Size of Element

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

protected

PrintElement() Constructor

Method Summary

protected abstract boolean	calculateSize() Layout and Calculate Size Set p_width & p_height
protected Point2D.Double	getAbsoluteLocation(Point2D pageStart) Return Absolute Position
Rectangle	getBounds() Get relative Bounds of Element
Query	getDrillAcross(Point relativePoint, int pageNo) Get Drill Across value
Query	getDrillDown(Point relativePoint, int pageNo) Get Drill Down value
float	getHeight() Get Calculated Height
float	getHeight(int pageNo) Get Calculated Height on page
Point2D	getLocation() Get Location within page
int	getPageCount() Get number of pages
float	getWidth() Get Calculated Width
boolean	imageUpdate(Image img, int infoflags, int x, int y, int width, int height) Image Observer
boolean	isTranslated() Content is translated
void	layout(float maxWidth, float maxHeight, boolean isHeightOneLine, String FieldAlignmentType) Layout Element
abstract void	paint(Graphics2D g2D, int pageNo, Point2D pageStart, Ctx ctx, boolean isView) Paint/Print.
void	setLocation(Point2D pageLocation) Set Location within page.
void	setMaxHeight(float maxHeight) Set Maximum Height
void	setMaxWidth(float maxWidth) Set Maximum Width
String	toString() String Representation
void	translate(Ctx ctx) Translate Context if required.
boolean	waitForLoad(Image image) Wait until Image is loaded.

Methods inherited from class java.lang.Object

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

Field Detail

LINK_COLOR

public static final Color LINK_COLOR

Link Color

p_width

protected float p_width

Calculated Size of Element

p_height

protected float p_height

p_sizeCalculated

protected boolean p_sizeCalculated

p_maxWidth

protected float p_maxWidth

Max Size of Element

p_maxHeight

protected float p_maxHeight

p_FieldAlignmentType

protected String p_FieldAlignmentType

Field Align Type

p_pageLocation

protected Point2D.Double p_pageLocation

Location on Page

p_info

protected String p_info

Image Info

log

protected CLogger log

Logger

Constructor Detail

PrintElement

protected PrintElement()

Constructor

Method Detail

getWidth

public float getWidth()

Get Calculated Width

Returns:

Width

getHeight

public float getHeight()

Get Calculated Height

Returns:

Height

getHeight

public float getHeight(int pageNo)

Get Calculated Height on page

Parameters:

pageNo - page number

Returns:

Height

getPageCount

public int getPageCount()

Get number of pages

Returns:

page count (1)

calculateSize

protected abstract boolean calculateSize()

Layout and Calculate Size Set p_width & p_height

Returns:

true if calculated

layout

public void layout(float maxWidth,
                   float maxHeight,
                   boolean isHeightOneLine,
                   String FieldAlignmentType)

Layout Element

Parameters:

maxWidth - max width

maxHeight - max height

isHeightOneLine - just one line

FieldAlignmentType - alignment type (MPrintFormatItem.FIELD_ALIGN_*)

setMaxHeight

public void setMaxHeight(float maxHeight)

Set Maximum Height

Parameters:

maxHeight - maximum height (0) is no limit

setMaxWidth

public void setMaxWidth(float maxWidth)

Set Maximum Width

Parameters:

maxWidth - maximum width (0) is no limit

setLocation

public void setLocation(Point2D pageLocation)

Set Location within page. Called from LayoutEngine.layoutForm(), lauout(), createStandardFooterHeader()

Parameters:

pageLocation - location within page

getLocation

public Point2D getLocation()

Get Location within page

Returns:

location within page

getAbsoluteLocation

protected Point2D.Double getAbsoluteLocation(Point2D pageStart)

Return Absolute Position

Parameters:

pageStart - start of page

Returns:

absolite position

getBounds

public Rectangle getBounds()

Get relative Bounds of Element

Returns:

bounds relative position on page

getDrillDown

public Query getDrillDown(Point relativePoint,
                          int pageNo)

Get Drill Down value

Parameters:

relativePoint - relative Point

pageNo - page number

Returns:

null (subclasses overwrite)

getDrillAcross

public Query getDrillAcross(Point relativePoint,
                            int pageNo)

Get Drill Across value

Parameters:

relativePoint - relative Point

pageNo - page number

Returns:

null (subclasses overwrite)

translate

public void translate(Ctx ctx)

Translate Context if required. If content is translated, the element needs to stay in the bounds of the originally calculated size and need to align the field.

Parameters:

ctx - context

isTranslated

public boolean isTranslated()

Content is translated

Returns:

false

paint

public abstract void paint(Graphics2D g2D,
                           int pageNo,
                           Point2D pageStart,
                           Ctx ctx,
                           boolean isView)

Paint/Print.

Parameters:

g2D - Graphics

pageNo - page number for multi page support (0 = header/footer)

pageStart - top left Location of page

ctx - context

isView - true if online view (IDs are links)

imageUpdate

public boolean imageUpdate(Image img,
                           int infoflags,
                           int x,
                           int y,
                           int width,
                           int height)

Image Observer

Specified by:

imageUpdate in interface ImageObserver

Parameters:

img - image

infoflags - Observer flags

x - x coordinate

y - y coordinate

width - image width

height - image height

Returns:

false if the infoflags indicate that the image is completely loaded; true otherwise

waitForLoad

public boolean waitForLoad(Image image)

Wait until Image is loaded.

Parameters:

image - image

Returns:

true if loaded

toString

public String toString()

String Representation

Overrides:

toString in class Object

Returns:

info