Package org.compiere.print

Class MPrintFormat

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_PrintFormat

org.compiere.print.MPrintFormat

All Implemented Interfaces:

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

public class MPrintFormat
extends X_AD_PrintFormat
implements ImmutablePOSupport

AD_PrintFormat - Print Format Model. (Add missing Items with PrintFormatUtil)

Version:

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

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

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_PrintFormat

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_PrintColor_ID, COLUMNNAME_AD_PrintFont_ID, COLUMNNAME_AD_PrintFormat_ID, COLUMNNAME_AD_PrintFormat_UU, COLUMNNAME_AD_PrintHeaderFooter_ID, COLUMNNAME_AD_PrintPaper_ID, COLUMNNAME_AD_PrintTableFormat_ID, COLUMNNAME_AD_ReportView_ID, COLUMNNAME_AD_Table_ID, COLUMNNAME_AD_Window_ID, COLUMNNAME_CreateCopy, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_Description, COLUMNNAME_FooterMargin, COLUMNNAME_HeaderMargin, COLUMNNAME_IsActive, COLUMNNAME_IsBreakPagePerRecord, COLUMNNAME_IsDefault, COLUMNNAME_IsForm, COLUMNNAME_IsStandardHeaderFooter, COLUMNNAME_IsTableBased, COLUMNNAME_JasperProcess_ID, COLUMNNAME_Name, COLUMNNAME_PrinterName, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MPrintFormat(Properties ctx, int AD_PrintFormat_ID, String trxName)	Public Constructor.
MPrintFormat(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MPrintFormat(Properties ctx, MPrintFormat copy)
MPrintFormat(Properties ctx, MPrintFormat copy, String trxName)
MPrintFormat(MPrintFormat copy)

Method Summary

Modifier and Type	Method	Description
MPrintFormat	clone()	Deprecated.
static MPrintFormat	copy(Properties ctx, int from_AD_PrintFormat_ID, int to_AD_PrintFormat_ID)	Copy existing Definition To Client
static MPrintFormat	copyToClient(Properties ctx, int AD_PrintFormat_ID, int to_Client_ID)	Copy existing Definition To Client
static MPrintFormat	copyToClient(Properties ctx, int AD_PrintFormat_ID, int to_Client_ID, String trxName)	Copy existing Definition To Client
static MPrintFormat	createFromGridLayout(Properties ctx, GridTab gridTab, boolean allColumns)
static MPrintFormat	createFromReportView(Properties ctx, int AD_ReportView_ID, String ReportName)	Create MPrintFormat for ReportView
static MPrintFormat	createFromTable(Properties ctx, int AD_Table_ID)	Create MPrintFormat for Table
static MPrintFormat	createFromTable(Properties ctx, int AD_Table_ID, int AD_PrintFormat_ID)	Create MPrintFormat for Table
static MPrintFormat	createFromTable(Properties ctx, int AD_Table_ID, int AD_PrintFormat_ID, String trxName)	Create MPrintFormat for Table
static void	deleteFromCache(int AD_PrintFormat_ID)	Delete Format from Cache
static MPrintFormat	get(int AD_PrintFormat_ID)	Get Format from cache (immutable)
static MPrintFormat	get(Properties ctx, int AD_PrintFormat_ID, boolean readFromDisk)	Get Format from cache (immutable)
static MPrintFormat	get(Properties ctx, int AD_ReportView_ID, int AD_Table_ID)	Get (default) Printformat for Report View or Table
static List<KeyNamePair>	getAccessiblePrintFormats(int AD_Table_ID, int AD_Window_ID, String trxName, boolean makeNewWhenEmpty)
int[]	getAD_Column_IDs()	Get AD_Column_IDs of columns in Report
MPrintFormatItem[]	getAllItems()	Get All Items
MPrintFormatItem[]	getAllItems(String orderBy)	Get All Items
MPrintFormatItem	getItem(int index)	Get Print Format Item
int	getItemCount()	Get Item Count
Language	getLanguage()	Get Language
int[]	getOrderAD_Column_IDs()	Get AD_Column_ID of Order Columns
static int	getPrintFormat_ID(String formatName, int AD_Table_ID, int AD_Client_ID)	Get ID of Print Format use Name
MPrintTableFormat	getTableFormat()	Get Table Format
static int	getZoomWindowID(int AD_PrintFormat_ID)
boolean	isTranslationView()	Get Translation View use
protected Object	loadSpecial(ResultSet rs, int index)	Load Special data (images, ..).
MPrintFormat	markImmutable()	mark PO as immutable
void	reloadItems()
protected String	saveNewSpecial(Object value, int index)	Save Special Data.
void	setAD_PrintTableFormat_ID(int AD_PrintTableFormat_ID)	Get Optional TableFormat
void	setIsTableBased(boolean tableBased)	Set Table based.
void	setLanguage(Language language)	Set Language
void	setStandardHeaderFooter(boolean standardHeaderFooter)	Set Standard Header
void	setTranslation()	Set the translation of the Format Items to the original
void	setTranslationLanguage(Language language)	Set Translation View Language.
void	setTranslationViewQuery(MQuery query)	Update the Query to access the Translation View.
static void	setUniqueName(int AD_Client_ID, MPrintFormat pf, String basename)
String	toString()	Sting Representation

Methods inherited from class org.compiere.model.X_AD_PrintFormat

get_AccessLevel, getAD_PrintColor, getAD_PrintColor_ID, getAD_PrintFont, getAD_PrintFont_ID, getAD_PrintFormat_ID, getAD_PrintFormat_UU, getAD_PrintHeaderFooter, getAD_PrintHeaderFooter_ID, getAD_PrintPaper, getAD_PrintPaper_ID, getAD_PrintTableFormat, getAD_PrintTableFormat_ID, getAD_ReportView, getAD_ReportView_ID, getAD_Table, getAD_Table_ID, getAD_Window, getAD_Window_ID, getCreateCopy, getDescription, getFooterMargin, getHeaderMargin, getJasperProcess, getJasperProcess_ID, getKeyNamePair, getName, getPrinterName, initPO, isBreakPagePerRecord, isDefault, isForm, isStandardHeaderFooter, isTableBased, setAD_PrintColor_ID, setAD_PrintFont_ID, setAD_PrintFormat_ID, setAD_PrintFormat_UU, setAD_PrintHeaderFooter_ID, setAD_PrintPaper_ID, setAD_ReportView_ID, setAD_Table_ID, setAD_Window_ID, setCreateCopy, setDescription, setFooterMargin, setHeaderMargin, setIsBreakPagePerRecord, setIsDefault, setIsForm, setIsStandardHeaderFooter, setJasperProcess_ID, setName, setPrinterName

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, beforeSave, checkImmutable, clearCrossTenantSafe, 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, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, 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_PrintFormat

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

MPrintFormat

public MPrintFormat(Properties ctx,
                    int AD_PrintFormat_ID,
                    String trxName)

Public Constructor. Use static get methods

Parameters:

ctx - context

AD_PrintFormat_ID - AD_PrintFormat_ID

trxName - transaction

MPrintFormat

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MPrintFormat

public MPrintFormat(MPrintFormat copy)

Parameters:

copy -

MPrintFormat

public MPrintFormat(Properties ctx,
                    MPrintFormat copy)

Parameters:

ctx -

copy -

MPrintFormat

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

Parameters:

ctx -

copy -

trxName -

Method Detail

reloadItems

public void reloadItems()

getLanguage

public Language getLanguage()

Get Language

Returns:

language

setLanguage

public void setLanguage(Language language)

Set Language

Parameters:

language - language

getOrderAD_Column_IDs

public int[] getOrderAD_Column_IDs()

Get AD_Column_ID of Order Columns

Returns:

Array of AD_Column_IDs in Sort Order

getAD_Column_IDs

public int[] getAD_Column_IDs()

Get AD_Column_IDs of columns in Report

Returns:

Array of AD_Column_ID

getAllItems

public MPrintFormatItem[] getAllItems()

Get All Items

Returns:

items

getAllItems

public MPrintFormatItem[] getAllItems(String orderBy)

Get All Items

Parameters:

orderBy -

Returns:

items

getItemCount

public int getItemCount()

Get Item Count

Returns:

number of items or -1 if items not defined

getItem

public MPrintFormatItem getItem(int index)

Get Print Format Item

Parameters:

index - index

Returns:

Print Format Item

setTranslation

public void setTranslation()

Set the translation of the Format Items to the original

setStandardHeaderFooter

public void setStandardHeaderFooter(boolean standardHeaderFooter)

Set Standard Header

Parameters:

standardHeaderFooter - true if std header

setIsTableBased

public void setIsTableBased(boolean tableBased)

Set Table based. Reset Form

Specified by:

setIsTableBased in interface I_AD_PrintFormat

Overrides:

setIsTableBased in class X_AD_PrintFormat

Parameters:

tableBased - true if table based

setTranslationLanguage

public void setTranslationLanguage(Language language)

Set Translation View Language.

Parameters:

language - language (checked for base language)

isTranslationView

public boolean isTranslationView()

Get Translation View use

Returns:

true if a translation view is used

setTranslationViewQuery

public void setTranslationViewQuery(MQuery query)

Update the Query to access the Translation View. Can be called multiple times, adds only if not set already

Parameters:

query - query to be updated

setAD_PrintTableFormat_ID

public void setAD_PrintTableFormat_ID(int AD_PrintTableFormat_ID)

Get Optional TableFormat

Specified by:

setAD_PrintTableFormat_ID in interface I_AD_PrintFormat

Overrides:

setAD_PrintTableFormat_ID in class X_AD_PrintFormat

Parameters:

AD_PrintTableFormat_ID - table format

getTableFormat

public MPrintTableFormat getTableFormat()

Get Table Format

Returns:

Table Format

toString

public String toString()

Sting Representation

Overrides:

toString in class X_AD_PrintFormat

Returns:

info

loadSpecial

protected Object loadSpecial(ResultSet rs,
                             int index)
                      throws SQLException

Load Special data (images, ..). To be extended by sub-classes

Overrides:

loadSpecial in class PO

Parameters:

rs - result set

index - zero based index

Returns:

value value

Throws:

SQLException

saveNewSpecial

protected String saveNewSpecial(Object value,
                                int index)

Save Special Data. To be extended by sub-classes

Overrides:

saveNewSpecial in class PO

Parameters:

value - value

index - index

Returns:

SQL code for INSERT VALUES clause

createFromGridLayout

public static MPrintFormat createFromGridLayout(Properties ctx,
                                                GridTab gridTab,
                                                boolean allColumns)

createFromTable

public static MPrintFormat createFromTable(Properties ctx,
                                           int AD_Table_ID)

Create MPrintFormat for Table

Parameters:

ctx - context

AD_Table_ID - table

Returns:

print format

createFromTable

public static MPrintFormat createFromTable(Properties ctx,
                                           int AD_Table_ID,
                                           int AD_PrintFormat_ID)

Create MPrintFormat for Table

Parameters:

ctx - context

AD_Table_ID - table

AD_PrintFormat_ID - 0 or existing PrintFormat

Returns:

print format

createFromTable

public static MPrintFormat createFromTable(Properties ctx,
                                           int AD_Table_ID,
                                           int AD_PrintFormat_ID,
                                           String trxName)

Create MPrintFormat for Table

Parameters:

ctx - context

AD_Table_ID - table

AD_PrintFormat_ID - 0 or existing PrintFormat

trxName - the transaction

Returns:

print format

createFromReportView

public static MPrintFormat createFromReportView(Properties ctx,
                                                int AD_ReportView_ID,
                                                String ReportName)

Create MPrintFormat for ReportView

Parameters:

ctx - context

AD_ReportView_ID - ReportView

ReportName - - optional Report Name

Returns:

print format

setUniqueName

public static void setUniqueName(int AD_Client_ID,
                                 MPrintFormat pf,
                                 String basename)

copy

public static MPrintFormat copy(Properties ctx,
                                int from_AD_PrintFormat_ID,
                                int to_AD_PrintFormat_ID)

Copy existing Definition To Client

Parameters:

ctx - context

from_AD_PrintFormat_ID - format

to_AD_PrintFormat_ID - format

Returns:

print format

copyToClient

public static MPrintFormat copyToClient(Properties ctx,
                                        int AD_PrintFormat_ID,
                                        int to_Client_ID)

Copy existing Definition To Client

Parameters:

ctx - context

AD_PrintFormat_ID - format

to_Client_ID - to client

Returns:

print format

copyToClient

public static MPrintFormat copyToClient(Properties ctx,
                                        int AD_PrintFormat_ID,
                                        int to_Client_ID,
                                        String trxName)

Copy existing Definition To Client

Parameters:

ctx - context

AD_PrintFormat_ID - format

to_Client_ID - to client

trxName -

Returns:

print format

get

public static MPrintFormat get(int AD_PrintFormat_ID)

Get Format from cache (immutable)

Parameters:

AD_PrintFormat_ID - id

Returns:

Format

get

public static MPrintFormat get(Properties ctx,
                               int AD_PrintFormat_ID,
                               boolean readFromDisk)

Get Format from cache (immutable)

Parameters:

ctx - context

AD_PrintFormat_ID - id

readFromDisk - refresh from disk

Returns:

Format

get

public static MPrintFormat get(Properties ctx,
                               int AD_ReportView_ID,
                               int AD_Table_ID)

Get (default) Printformat for Report View or Table

Parameters:

ctx - context

AD_ReportView_ID - id or 0

AD_Table_ID - id or 0

Returns:

first print format found or null

deleteFromCache

public static void deleteFromCache(int AD_PrintFormat_ID)

Delete Format from Cache

Parameters:

AD_PrintFormat_ID - id

getPrintFormat_ID

public static int getPrintFormat_ID(String formatName,
                                    int AD_Table_ID,
                                    int AD_Client_ID)

Get ID of Print Format use Name

Parameters:

formatName -

AD_Table_ID -

AD_Client_ID -

Returns:

AD_PrintFormat_ID

getAccessiblePrintFormats

public static List<KeyNamePair> getAccessiblePrintFormats(int AD_Table_ID,
                                                          int AD_Window_ID,
                                                          String trxName,
                                                          boolean makeNewWhenEmpty)

Parameters:

AD_Table_ID -

AD_Window_ID -

trxName -

makeNewWhenEmpty -

Returns:

clone

@Deprecated
public MPrintFormat clone()
                   throws CloneNotSupportedException

Deprecated.

Overrides:

clone in class PO

Throws:

CloneNotSupportedException

getZoomWindowID

public static int getZoomWindowID(int AD_PrintFormat_ID)

markImmutable

public MPrintFormat markImmutable()

Description copied from interface: ImmutablePOSupport

mark PO as immutable

Specified by:

markImmutable in interface ImmutablePOSupport

Returns:

PO