Package org.compiere.print

Class MPrintTableFormat

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_PrintTableFormat

org.compiere.print.MPrintTableFormat

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_AD_PrintTableFormat, I_Persistent, Evaluatee, ImmutablePOSupport

public class MPrintTableFormat
extends X_AD_PrintTableFormat
implements ImmutablePOSupport

Table Print Format

Version:

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

Author:

Jorg Janke, victor.perez@e-evolution.com, e-Evolution

BF [ 2011567 ] Implement Background Image for Document printed

https://sourceforge.net/p/adempiere/feature-requests/477/

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_AD_PrintTableFormat

HDRSTROKETYPE_AD_Reference_ID, HDRSTROKETYPE_Dash_DottedLine, HDRSTROKETYPE_DashedLine, HDRSTROKETYPE_DottedLine, HDRSTROKETYPE_SolidLine, LINESTROKETYPE_AD_Reference_ID, LINESTROKETYPE_Dash_DottedLine, LINESTROKETYPE_DashedLine, LINESTROKETYPE_DottedLine, LINESTROKETYPE_SolidLine

Fields inherited from class org.compiere.model.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_PrintTableFormat

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Image_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_PrintTableFormat_ID, COLUMNNAME_AD_PrintTableFormat_UU, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_Description, COLUMNNAME_FooterCenter, COLUMNNAME_FooterLeft, COLUMNNAME_FooterRight, COLUMNNAME_Funct_PrintFont_ID, COLUMNNAME_FunctBG_PrintColor_ID, COLUMNNAME_FunctFG_PrintColor_ID, COLUMNNAME_Hdr_PrintFont_ID, COLUMNNAME_HdrLine_PrintColor_ID, COLUMNNAME_HdrStroke, COLUMNNAME_HdrStrokeType, COLUMNNAME_HdrTextBG_PrintColor_ID, COLUMNNAME_HdrTextFG_PrintColor_ID, COLUMNNAME_HeaderCenter, COLUMNNAME_HeaderLeft, COLUMNNAME_HeaderRight, COLUMNNAME_ImageIsAttached, COLUMNNAME_ImageURL, COLUMNNAME_IsActive, COLUMNNAME_IsDefault, COLUMNNAME_IsMultiLineHeader, COLUMNNAME_IsPaintBoundaryLines, COLUMNNAME_IsPaintHeaderLines, COLUMNNAME_IsPaintHLines, COLUMNNAME_IsPaintVLines, COLUMNNAME_IsPrintFunctionSymbols, COLUMNNAME_Line_PrintColor_ID, COLUMNNAME_LineStroke, COLUMNNAME_LineStrokeType, COLUMNNAME_Name, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MPrintTableFormat(Properties ctx, int AD_PrintTableFormat_ID, String trxName)	Standard Constructor
MPrintTableFormat(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MPrintTableFormat(Properties ctx, MPrintTableFormat copy)
MPrintTableFormat(Properties ctx, MPrintTableFormat copy, String trxName)
MPrintTableFormat(MPrintTableFormat copy)

Method Summary

Modifier and Type	Method	Description
static MPrintTableFormat	get(Properties ctx, int AD_PrintTableFormat_ID, int AD_PrintFont_ID)	Get Table Format
static MPrintTableFormat	get(Properties ctx, int AD_PrintTableFormat_ID, Font standard_font)	Get Table Format.
static MPrintTableFormat	getDefault(Properties ctx)	Get Default Table Format.
Font	getFunct_Font()	Get Function Font
Color	getFunctBG_Color()	Get Function BG Color
Color	getFunctFG_Color()	Get Function FG Color
BigDecimal	getHdrStroke()	Get Header Stroke for horizontal Lines
Font	getHeader_Font()	Get Table Header Font
Stroke	getHeader_Stroke()	Get Header Stroke
Color	getHeaderBG_Color()	Get Header BG Color
Color	getHeaderFG_Color()	Get Header Foreground
Color	getHeaderLine_Color()	Get Header Line Color
Color	getHLine_Color()	Get Horizontal Line Color.
Stroke	getHLine_Stroke()	Get Horizontal Line Stroke - (same DB line column)
Image	getImage()	Get the Image
Image	getImageWaterMark()	Get the Image
BigDecimal	getLineStroke()	Get Horizontal Stroke for Lines -
Font	getPageFooter_Font()	Get Page Footer Font
Color	getPageFooterBG_Color()	Get Page Footer BG_Color
Color	getPageFooterFG_Color()	Get PageFooter FG_Color
Font	getPageHeader_Font()	Get Top Page Header Font
Color	getPageHeaderBG_Color()	Get Page Header BG_Color
Color	getPageHeaderFG_Color()	Get Page Header FG_Color
Color	getParameter_Color()	Get Parameter Color
Font	getParameter_Font()	Get Parameter Font
Font	getStandard_Font()	Get Stndard Font
Color	getVLine_Color()	Get Verical Line Color.
Stroke	getVLine_Stroke()	Get Vertical Line Stroke | (same DB line column)
BigDecimal	getVLineStroke()	Get Vertical Stroke for Lines |
MPrintTableFormat	markImmutable()	mark PO as immutable
void	setStandard_Font(Font standardFont)	Set Standard Font to derive other fonts if not defined

Methods inherited from class org.compiere.model.X_AD_PrintTableFormat

get_AccessLevel, getAD_Image, getAD_Image_ID, getAD_PrintTableFormat_ID, getAD_PrintTableFormat_UU, getDescription, getFooterCenter, getFooterLeft, getFooterRight, getFunct_PrintFont, getFunct_PrintFont_ID, getFunctBG_PrintColor, getFunctBG_PrintColor_ID, getFunctFG_PrintColor, getFunctFG_PrintColor_ID, getHdr_PrintFont, getHdr_PrintFont_ID, getHdrLine_PrintColor, getHdrLine_PrintColor_ID, getHdrStrokeType, getHdrTextBG_PrintColor, getHdrTextBG_PrintColor_ID, getHdrTextFG_PrintColor, getHdrTextFG_PrintColor_ID, getHeaderCenter, getHeaderLeft, getHeaderRight, getImageURL, getKeyNamePair, getLine_PrintColor, getLine_PrintColor_ID, getLineStrokeType, getName, initPO, isDefault, isImageIsAttached, isMultiLineHeader, isPaintBoundaryLines, isPaintHeaderLines, isPaintHLines, isPaintVLines, isPrintFunctionSymbols, setAD_Image_ID, setAD_PrintTableFormat_ID, setAD_PrintTableFormat_UU, setDescription, setFooterCenter, setFooterLeft, setFooterRight, setFunct_PrintFont_ID, setFunctBG_PrintColor_ID, setFunctFG_PrintColor_ID, setHdr_PrintFont_ID, setHdrLine_PrintColor_ID, setHdrStroke, setHdrStrokeType, setHdrTextBG_PrintColor_ID, setHdrTextFG_PrintColor_ID, setHeaderCenter, setHeaderLeft, setHeaderRight, setImageIsAttached, setImageURL, setIsDefault, setIsMultiLineHeader, setIsPaintBoundaryLines, setIsPaintHeaderLines, setIsPaintHLines, setIsPaintVLines, setIsPrintFunctionSymbols, setLine_PrintColor_ID, setLineStroke, setLineStrokeType, setName, toString

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, beforeSave, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_AD_PrintTableFormat

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Constructor Detail

MPrintTableFormat

public MPrintTableFormat(Properties ctx,
                         int AD_PrintTableFormat_ID,
                         String trxName)

Standard Constructor

Parameters:

ctx - context

AD_PrintTableFormat_ID - table format

trxName - transaction

MPrintTableFormat

public MPrintTableFormat(Properties ctx,
                         ResultSet rs,
                         String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MPrintTableFormat

public MPrintTableFormat(MPrintTableFormat copy)

Parameters:

copy -

MPrintTableFormat

public MPrintTableFormat(Properties ctx,
                         MPrintTableFormat copy)

Parameters:

ctx -

copy -

MPrintTableFormat

public MPrintTableFormat(Properties ctx,
                         MPrintTableFormat copy,
                         String trxName)

Parameters:

ctx -

copy -

trxName -

Method Detail

setStandard_Font

public void setStandard_Font(Font standardFont)

Set Standard Font to derive other fonts if not defined

Parameters:

standardFont - standard font

getStandard_Font

public Font getStandard_Font()

Get Stndard Font

Returns:

stndard font

getHeader_Font

public Font getHeader_Font()

Get Table Header Font

Returns:

table header font or Bold standard font

getHeaderFG_Color

public Color getHeaderFG_Color()

Get Header Foreground

Returns:

color or blue black

getHeaderBG_Color

public Color getHeaderBG_Color()

Get Header BG Color

Returns:

color or cyan

getHeaderLine_Color

public Color getHeaderLine_Color()

Get Header Line Color

Returns:

color or blue black

getHeader_Stroke

public Stroke getHeader_Stroke()

Get Header Stroke

Returns:

Header Stroke (default solid 2pt)

getHdrStroke

public BigDecimal getHdrStroke()

Get Header Stroke for horizontal Lines

Specified by:

getHdrStroke in interface I_AD_PrintTableFormat

Overrides:

getHdrStroke in class X_AD_PrintTableFormat

Returns:

stroke in pt (default 2)

getFunct_Font

public Font getFunct_Font()

Get Function Font

Returns:

function font or BoldItalic standard font

getFunctBG_Color

public Color getFunctBG_Color()

Get Function BG Color

Returns:

color or white

getFunctFG_Color

public Color getFunctFG_Color()

Get Function FG Color

Returns:

color or green dark

getParameter_Font

public Font getParameter_Font()

Get Parameter Font

Returns:

Italic standard font

getParameter_Color

public Color getParameter_Color()

Get Parameter Color

Returns:

dark gray

getPageHeader_Font

public Font getPageHeader_Font()

Get Top Page Header Font

Returns:

Bold standard font

getPageHeaderFG_Color

public Color getPageHeaderFG_Color()

Get Page Header FG_Color

Returns:

color or blue black

getPageHeaderBG_Color

public Color getPageHeaderBG_Color()

Get Page Header BG_Color

Returns:

color or white

getPageFooter_Font

public Font getPageFooter_Font()

Get Page Footer Font

Returns:

2pt smaller standard font

getPageFooterFG_Color

public Color getPageFooterFG_Color()

Get PageFooter FG_Color

Returns:

blue black

getPageFooterBG_Color

public Color getPageFooterBG_Color()

Get Page Footer BG_Color

Returns:

white

getHLine_Color

public Color getHLine_Color()

Get Horizontal Line Color. (one db attribute for line color)

Returns:

color or gray light

getVLine_Color

public Color getVLine_Color()

Get Verical Line Color. (one db attribute for line color)

Returns:

color or gray light

getHLine_Stroke

public Stroke getHLine_Stroke()

Get Horizontal Line Stroke - (same DB line column)

Returns:

solid line baded on line width (default solid 1p)

getVLine_Stroke

public Stroke getVLine_Stroke()

Get Vertical Line Stroke | (same DB line column)

Returns:

line based on line (1/2 of) width and stroke (default dotted 1/2p

getLineStroke

public BigDecimal getLineStroke()

Get Horizontal Stroke for Lines -

Specified by:

getLineStroke in interface I_AD_PrintTableFormat

Overrides:

getLineStroke in class X_AD_PrintTableFormat

Returns:

stroke in pt (default 1)

getVLineStroke

public BigDecimal getVLineStroke()

Get Vertical Stroke for Lines |

Returns:

stroke in pt (default 1)

get

public static MPrintTableFormat get(Properties ctx,
                                    int AD_PrintTableFormat_ID,
                                    Font standard_font)

Get Table Format.

Parameters:

ctx - context

AD_PrintTableFormat_ID - table format

standard_font - standard font

Returns:

Table Format

get

public static MPrintTableFormat get(Properties ctx,
                                    int AD_PrintTableFormat_ID,
                                    int AD_PrintFont_ID)

Get Table Format

Parameters:

ctx - context

AD_PrintTableFormat_ID - table format

AD_PrintFont_ID - standard font

Returns:

Table Format

getDefault

public static MPrintTableFormat getDefault(Properties ctx)

Get Default Table Format.

Parameters:

ctx - context

Returns:

Default Table Format (need to set standard font)

getImage

public Image getImage()

Get the Image

Returns:

image

getImageWaterMark

public Image getImageWaterMark()

Get the Image

Returns:

image

markImmutable

public MPrintTableFormat markImmutable()

Description copied from interface: ImmutablePOSupport

mark PO as immutable

Specified by:

markImmutable in interface ImmutablePOSupport

Returns:

PO