Package org.compiere.print

Class PrintDataElement

java.lang.Object

org.compiere.print.PrintDataElement

All Implemented Interfaces:

Serializable

public class PrintDataElement
extends Object
implements Serializable

Print Data Element

Version:

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

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	XML_ATTRIBUTE_KEY	XML Attribute Key
static String	XML_ATTRIBUTE_NAME	XML Attribute Name
static String	XML_ATTRIBUTE_PRINTFORMATITEM_ID	XML Attribute PrintFormatItem Id
static String	XML_TAG	XML Element Name

Constructor Summary

Constructors

Constructor	Description
PrintDataElement(int AD_PrintFormatItem_ID, String columnName, Serializable value, int displayType, boolean isPKey, boolean isPageBreak, String format)
PrintDataElement(int AD_PrintFormatItem_ID, String columnName, Serializable value, int displayType, boolean isPKey, boolean isPageBreak, String format, String foreignColumnName)	Print Data Element Constructor
PrintDataElement(int AD_PrintFormatItem_ID, String columnName, Serializable value, int displayType, String pattern)	Print Data Element Constructor
PrintDataElement(int AD_PrintFormatItem_ID, String columnName, Serializable value, int displayType, String pattern, String foreignColumnName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object compare)	Equals
int	getAD_PrintFormatItem_ID()
String	getColumnName()	Get Name
int	getDisplayType()	Get Display Type
String	getForeignColumnName()	Get ForeignName
BigDecimal	getFunctionValue()	Get Function Value
String	getM_formatPattern()
Object	getValue()	Get Node Value
String	getValueAsString()	Get Node Data Value as String
String	getValueDisplay(Language language)	Get Node Value Display
String	getValueKey()	Get Node Value Key
int	hashCode()	HashCode
boolean	hasKey()	Value Has Key
boolean	isDate()	Is Value a date
boolean	isID()	Is Value an ID
boolean	isNull()	Is Value Null
boolean	isNumeric()	Is Value numeric
boolean	isPageBreak()	Column value forces page break
boolean	isPKey()	Is Value the primary key of row
boolean	isYesNo()	Is Value boolean
void	setForeignColumnName(String foreignColumnName)	Set ForeignName
void	setM_formatPattern(String pattern)
String	toString()	String representation
String	toStringX()	String representation with key info

Methods inherited from class java.lang.Object

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

Field Detail

XML_TAG

public static final String XML_TAG

XML Element Name

See Also:

Constant Field Values

XML_ATTRIBUTE_NAME

public static final String XML_ATTRIBUTE_NAME

XML Attribute Name

See Also:

Constant Field Values

XML_ATTRIBUTE_KEY

public static final String XML_ATTRIBUTE_KEY

XML Attribute Key

See Also:

Constant Field Values

XML_ATTRIBUTE_PRINTFORMATITEM_ID

public static final String XML_ATTRIBUTE_PRINTFORMATITEM_ID

XML Attribute PrintFormatItem Id

See Also:

Constant Field Values

Constructor Detail

PrintDataElement

public PrintDataElement(int AD_PrintFormatItem_ID,
                        String columnName,
                        Serializable value,
                        int displayType,
                        boolean isPKey,
                        boolean isPageBreak,
                        String format,
                        String foreignColumnName)

Print Data Element Constructor

Parameters:

AD_PrintFormatItem_ID -

columnName - name

value - display value

displayType - optional displayType

isPKey - is primary key

isPageBreak - if true force page break

foreignColumnName - name foreign

PrintDataElement

public PrintDataElement(int AD_PrintFormatItem_ID,
                        String columnName,
                        Serializable value,
                        int displayType,
                        String pattern,
                        String foreignColumnName)

PrintDataElement

public PrintDataElement(int AD_PrintFormatItem_ID,
                        String columnName,
                        Serializable value,
                        int displayType,
                        String pattern)

Print Data Element Constructor

Parameters:

AD_PrintFormatItem_ID -

columnName - name

value - display value

pattern - Number/date format pattern

displayType - optional displayType

PrintDataElement

public PrintDataElement(int AD_PrintFormatItem_ID,
                        String columnName,
                        Serializable value,
                        int displayType,
                        boolean isPKey,
                        boolean isPageBreak,
                        String format)

Method Detail

getAD_PrintFormatItem_ID

public int getAD_PrintFormatItem_ID()

Returns:

AD_PrintFormatItem_ID

getColumnName

public String getColumnName()

Get Name

Returns:

name

getForeignColumnName

public String getForeignColumnName()

Get ForeignName

Returns:

name

setForeignColumnName

public void setForeignColumnName(String foreignColumnName)

Set ForeignName

Parameters:

foreignColumnName -

getValue

public Object getValue()

Get Node Value

Returns:

value

getFunctionValue

public BigDecimal getFunctionValue()

Get Function Value

Returns:

length or numeric value

getValueDisplay

public String getValueDisplay(Language language)

Get Node Value Display

Parameters:

language - optional language - if null numbers/dates are not formatted

Returns:

display value optionally formatted

getValueAsString

public String getValueAsString()

Get Node Data Value as String

Returns:

data value

getValueKey

public String getValueKey()

Get Node Value Key

Returns:

key

isNull

public boolean isNull()

Is Value Null

Returns:

true if value is null

getDisplayType

public int getDisplayType()

Get Display Type

Returns:

Display Type

isNumeric

public boolean isNumeric()

Is Value numeric

Returns:

true if value is a numeric

isDate

public boolean isDate()

Is Value a date

Returns:

true if value is a date

isID

public boolean isID()

Is Value an ID

Returns:

true if value is an ID

isYesNo

public boolean isYesNo()

Is Value boolean

Returns:

true if value is a boolean

isPKey

public boolean isPKey()

Is Value the primary key of row

Returns:

true if value is the PK

isPageBreak

public boolean isPageBreak()

Column value forces page break

Returns:

true if page break

hashCode

public int hashCode()

HashCode

Overrides:

hashCode in class Object

Returns:

hash code

equals

public boolean equals(Object compare)

Equals

Overrides:

equals in class Object

Parameters:

compare - compare object

Returns:

true if equals

toString

public String toString()

String representation

Overrides:

toString in class Object

Returns:

info

hasKey

public boolean hasKey()

Value Has Key

Returns:

true if value has a key

toStringX

public String toStringX()

String representation with key info

Returns:

info

getM_formatPattern

public String getM_formatPattern()

setM_formatPattern

public void setM_formatPattern(String pattern)