java.lang.Object
- org.compiere.model.GridFieldVO

All Implemented Interfaces:

Serializable, Cloneable
```
public class GridFieldVO
extends Object
implements Serializable, Cloneable
```
Field Model Value Object

Version:

$Id: GridFieldVO.java,v 1.3 2006/07/30 00:58:04 jjanke Exp $

Author:

Jorg Janke, Victor Perez , e-Evolution.SC FR [ 1757088 ] , [1877902] Implement JSR 223 Scripting APIs to Callout, Carlos Ruiz, qss FR [1877902], Juan David Arboleda (arboleda), GlobalQSS, [ 1795398 ] Process Parameter: add display and readonly logic

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GridFieldVO.SeqNoComparator

Field Summary

Fields
Modifier and Type	Field	Description
`int`	`AD_Chart_ID`
`int`	`AD_Column_ID`	Clumn ID
`int`	`AD_Field_ID`	Field ID
`int`	`AD_FieldStyle_ID`
`int`	`AD_Infowindow_ID`	AD_Infowindow_ID call process. user in case from info window call process.
`int`	`AD_LabelStyle_ID`
`int`	`AD_Process_ID`	Process
`int`	`AD_Process_ID_Of_Panel`	in case this field lie on parameter process panel, AD_Process_ID_Of_Panel is id of process will run in this panel it's difference with AD_Process_ID
`int`	`AD_Reference_Value_ID`	Reference Value
`int`	`AD_Tab_ID`	AD_Tab_ID
`int`	`AD_Table_ID`	Table ID
`int`	`AD_Window_ID`	AD_Winmdow_ID
`int`	`AD_Window_ID_Of_Panel`	ad_window_id of window show process dialog or infoWindow dialog
`String`	`Callout`	Callout
`String`	`ColumnName`	Column name
`int`	`ColumnSpan`	ColumnSpan IDEMPIERE368
`String`	`ColumnSQL`	Column sql
`Properties`	`ctx`	Context
`String`	`DefaultValue`	Default Value, never set null for it
`String`	`DefaultValue2`	Process Parameter Value2
`String`	`Description`	Description
`int`	`DisplayLength`	Display Length
`String`	`DisplayLogic`	Dislay Logic, never set null for it
`int`	`displayType`	DisplayType
`String`	`FieldGroup`	Field Group
`String`	`FieldGroupType`	Field Group Type
`int`	`FieldLength`	Field Length
`String`	`FormatPattern`	Format pattern
`String`	`Header`	Label
`String`	`Help`	Help
`int`	`Included_Tab_ID`
`boolean`	`IsAllowCopy`
`boolean`	`IsAlwaysUpdateable`	Always Updateable
`boolean`	`IsAutocomplete`	Autocompletion for textfields - Feature Request FR [ 1757088 ]
`boolean`	`IsCollapsedByDefault`	Collapse By Default *
`boolean`	`IsDefaultFocus`	Default Focus
`boolean`	`IsDisplayed`	Displayed
`boolean`	`IsDisplayedGrid`	Displayed Grid
`boolean`	`IsEncryptedColumn`	Storage Encryption
`boolean`	`IsEncryptedField`	Display Encryption
`boolean`	`IsFieldOnly`	Field Only
`boolean`	`IsHeading`	Heading Only
`boolean`	`IsHtml`
`boolean`	`IsKey`	PK
`boolean`	`IsMandatory`	Mandatory
`boolean`	`IsParent`	FK
`boolean`	`isProcess`	Is Process Parameter
`boolean`	`IsQuickForm`
`boolean`	`isRange`	Process Parameter Range
`boolean`	`IsReadOnly`	Read Only
`boolean`	`IsSameLine`	Same Line
`boolean`	`IsSelectionColumn`	Find Selection
`String`	`IsToolbarButton`	Toolbar Button
`boolean`	`IsUpdateable`	Updateable
`MLookupInfo`	`lookupInfo`	Lookup Value Object
`String`	`MandatoryLogic`	Mandatory Logic
`int`	`NumLines`	NumLines IDEMPIERE368
`String`	`ObscureType`	Display Obscure
`int`	`PA_DashboardContent_ID`
`String`	`Placeholder`
`String`	`Placeholder2`
`String`	`ReadOnlyLogic`	Read Only Logic
`int`	`SeqNo`	Position
`int`	`SeqNoGrid`	Grid Display sequence
`int`	`SeqNoSelection`	Selection column sequence
`int`	`SortNo`	Order By
`int`	`TabNo`	Tab No
`boolean`	`tabReadOnly`	Is the Tab Read Only
`String`	`ValidationCode`	Lookup Validation code
`String`	`ValidationCodeLookup`	Lookup Validation code for Find Window
`String`	`ValueMax`	Max.
`String`	`ValueMin`	Min.
`String`	`VFormat`	Format enforcement
`int`	`WindowNo`	Window No
`int`	`XPosition`	XPosition IDEMPIERE368

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GridFieldVO`	`afterCreate()`	Additional processing after a new vo have been created from db or cloned from cache This include asp customization, user customization and loading of lookup info.
`GridFieldVO`	`clone()`
`GridFieldVO`	`clone(Properties Ctx, int windowNo, int tabNo, int ad_Window_ID, int ad_Tab_ID, boolean TabReadOnly)`	Clone Field.
`static GridFieldVO`	`create(Properties ctx, int WindowNo, int TabNo, int AD_Window_ID, int AD_Tab_ID, boolean readOnly, ResultSet rs)`	Create Field Value Object.
`static GridFieldVO`	`createFromResultSet(Properties ctx, int WindowNo, int TabNo, int AD_Window_ID, int AD_Tab_ID, boolean readOnly, ResultSet rs)`	Create GridFieldVO from db resultset.
`static GridFieldVO`	`createParameter(Properties ctx, int WindowNo, int WindowIDOfPanel, int infoWindowID, int AD_Column_ID, String ColumnName, String Name, int AD_Reference_ID, int AD_Reference_Value_ID, boolean IsMandatory, boolean IsEncrypted, String Placeholder)`	Create parameter for infoWindow
`static GridFieldVO`	`createParameter(Properties ctx, int WindowNo, int ProcessIDOfPanel, int WindowIDOfPanel, int adInfoPaneId, ResultSet rs)`	Init Field for Process Parameter
`static GridFieldVO`	`createParameter(GridFieldVO voF)`	Create range "to" Parameter Field from "from" Parameter Field
`static GridFieldVO`	`createStdField(Properties ctx, int WindowNo, int TabNo, int AD_Window_ID, int AD_Tab_ID, boolean tabReadOnly, boolean isCreated, boolean isTimestamp)`	Make a standard field (Created/Updated/By)
`static String`	`getSQL(Properties ctx)`	Return the SQL statement used for the MFieldVO.create
`protected void`	`initFinish()`	Validate Fields and create LookupInfo if required
`void`	`loadLookupInfo()`	load lookup info.
`void`	`setCtx(Properties newCtx)`	Set Context including contained elements
`String`	`toString()`	String Representation

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- ctx
```
public Properties ctx
```
  Context
- WindowNo
```
public int WindowNo
```
  Window No
- TabNo
```
public int TabNo
```
  Tab No
- AD_Window_ID
```
public int AD_Window_ID
```
  AD_Winmdow_ID
- AD_Process_ID_Of_Panel
```
public int AD_Process_ID_Of_Panel
```
  in case this field lie on parameter process panel, AD_Process_ID_Of_Panel is id of process will run in this panel it's difference with AD_Process_ID
- AD_Window_ID_Of_Panel
```
public int AD_Window_ID_Of_Panel
```
  ad_window_id of window show process dialog or infoWindow dialog
- AD_Infowindow_ID
```
public int AD_Infowindow_ID
```
  AD_Infowindow_ID call process. user in case from info window call process.
- AD_Tab_ID
```
public int AD_Tab_ID
```
  AD_Tab_ID
- tabReadOnly
```
public boolean tabReadOnly
```
  Is the Tab Read Only
- isProcess
```
public boolean isProcess
```
  Is Process Parameter
- ColumnName
```
public String ColumnName
```
  Column name
- ColumnSQL
```
public String ColumnSQL
```
  Column sql
- Header
```
public String Header
```
  Label
- displayType
```
public int displayType
```
  DisplayType
- AD_Table_ID
```
public int AD_Table_ID
```
  Table ID
- AD_Column_ID
```
public int AD_Column_ID
```
  Clumn ID
- DisplayLength
```
public int DisplayLength
```
  Display Length
- IsSameLine
```
public boolean IsSameLine
```
  Same Line
- IsDisplayed
```
public boolean IsDisplayed
```
  Displayed
- IsDisplayedGrid
```
public boolean IsDisplayedGrid
```
  Displayed Grid
- SeqNo
```
public int SeqNo
```
  Position
- SeqNoGrid
```
public int SeqNoGrid
```
  Grid Display sequence
- DisplayLogic
```
public String DisplayLogic
```
  Dislay Logic, never set null for it
- DefaultValue
```
public String DefaultValue
```
  Default Value, never set null for it
- IsMandatory
```
public boolean IsMandatory
```
  Mandatory
- IsReadOnly
```
public boolean IsReadOnly
```
  Read Only
- IsUpdateable
```
public boolean IsUpdateable
```
  Updateable
- IsAlwaysUpdateable
```
public boolean IsAlwaysUpdateable
```
  Always Updateable
- IsHeading
```
public boolean IsHeading
```
  Heading Only
- IsFieldOnly
```
public boolean IsFieldOnly
```
  Field Only
- IsEncryptedField
```
public boolean IsEncryptedField
```
  Display Encryption
- IsEncryptedColumn
```
public boolean IsEncryptedColumn
```
  Storage Encryption
- IsSelectionColumn
```
public boolean IsSelectionColumn
```
  Find Selection
- SeqNoSelection
```
public int SeqNoSelection
```
  Selection column sequence
- SortNo
```
public int SortNo
```
  Order By
- FieldLength
```
public int FieldLength
```
  Field Length
- VFormat
```
public String VFormat
```
  Format enforcement
- FormatPattern
```
public String FormatPattern
```
  Format pattern
- ValueMin
```
public String ValueMin
```
  Min. Value
- ValueMax
```
public String ValueMax
```
  Max. Value
- FieldGroup
```
public String FieldGroup
```
  Field Group
- FieldGroupType
```
public String FieldGroupType
```
  Field Group Type
- IsKey
```
public boolean IsKey
```
  PK
- IsParent
```
public boolean IsParent
```
  FK
- Callout
```
public String Callout
```
  Callout
- AD_Process_ID
```
public int AD_Process_ID
```
  Process
- Description
```
public String Description
```
  Description
- Help
```
public String Help
```
  Help
- MandatoryLogic
```
public String MandatoryLogic
```
  Mandatory Logic
- ReadOnlyLogic
```
public String ReadOnlyLogic
```
  Read Only Logic
- ObscureType
```
public String ObscureType
```
  Display Obscure
- IsDefaultFocus
```
public boolean IsDefaultFocus
```
  Default Focus
- ValidationCode
```
public String ValidationCode
```
  Lookup Validation code
- ValidationCodeLookup
```
public String ValidationCodeLookup
```
  Lookup Validation code for Find Window
- AD_Reference_Value_ID
```
public int AD_Reference_Value_ID
```
  Reference Value
- isRange
```
public boolean isRange
```
  Process Parameter Range
- DefaultValue2
```
public String DefaultValue2
```
  Process Parameter Value2
- lookupInfo
```
public MLookupInfo lookupInfo
```
  Lookup Value Object
- AD_Field_ID
```
public int AD_Field_ID
```
  Field ID
- XPosition
```
public int XPosition
```
  XPosition IDEMPIERE368
- ColumnSpan
```
public int ColumnSpan
```
  ColumnSpan IDEMPIERE368
- NumLines
```
public int NumLines
```
  NumLines IDEMPIERE368
- Included_Tab_ID
```
public int Included_Tab_ID
```
- IsCollapsedByDefault
```
public boolean IsCollapsedByDefault
```
  Collapse By Default *
- IsAutocomplete
```
public boolean IsAutocomplete
```
  Autocompletion for textfields - Feature Request FR [ 1757088 ]
- IsAllowCopy
```
public boolean IsAllowCopy
```
- IsToolbarButton
```
public String IsToolbarButton
```
  Toolbar Button
- AD_Chart_ID
```
public int AD_Chart_ID
```
- AD_LabelStyle_ID
```
public int AD_LabelStyle_ID
```
- AD_FieldStyle_ID
```
public int AD_FieldStyle_ID
```
- PA_DashboardContent_ID
```
public int PA_DashboardContent_ID
```
- Placeholder
```
public String Placeholder
```
- Placeholder2
```
public String Placeholder2
```
- IsHtml
```
public boolean IsHtml
```
- IsQuickForm
```
public boolean IsQuickForm
```

Method Detail

getSQL
```
public static String getSQL(Properties ctx)
```
Return the SQL statement used for the MFieldVO.create

Parameters:

ctx - context

Returns:

SQL with or w/o translation and 1 parameter

create

public static GridFieldVO create(Properties ctx,
                                 int WindowNo,
                                 int TabNo,
                                 int AD_Window_ID,
                                 int AD_Tab_ID,
                                 boolean readOnly,
                                 ResultSet rs)

Create Field Value Object. The vo return is not safe to cache directly or through clone

Parameters:: ctx - context; WindowNo - window; TabNo - tab; AD_Window_ID - window; AD_Tab_ID - tab; readOnly - r/o; rs - resultset AD_Field_v
Returns:: MFieldVO

afterCreate
```
public GridFieldVO afterCreate()
```
Additional processing after a new vo have been created from db or cloned from cache This include asp customization, user customization and loading of lookup info.

Returns:

GridFieldVO

createFromResultSet

public static GridFieldVO createFromResultSet(Properties ctx,
                                              int WindowNo,
                                              int TabNo,
                                              int AD_Window_ID,
                                              int AD_Tab_ID,
                                              boolean readOnly,
                                              ResultSet rs)

Create GridFieldVO from db resultset. No further processing is apply to the vo and the vo is safe to cache through clone

Parameters:: ctx -; WindowNo -; TabNo -; AD_Window_ID -; AD_Tab_ID -; readOnly -; rs -
Returns:: GridFieldVO

createParameter

public static GridFieldVO createParameter(Properties ctx,
                                          int WindowNo,
                                          int ProcessIDOfPanel,
                                          int WindowIDOfPanel,
                                          int adInfoPaneId,
                                          ResultSet rs)

Init Field for Process Parameter

Parameters:: ctx - context; WindowNo - window; rs - result set AD_Process_Para
Returns:: MFieldVO

createParameter
```
public static GridFieldVO createParameter(GridFieldVO voF)
```
Create range "to" Parameter Field from "from" Parameter Field

Parameters:

voF - field value object

Returns:

to MFieldVO

createParameter

public static GridFieldVO createParameter(Properties ctx,
                                          int WindowNo,
                                          int WindowIDOfPanel,
                                          int infoWindowID,
                                          int AD_Column_ID,
                                          String ColumnName,
                                          String Name,
                                          int AD_Reference_ID,
                                          int AD_Reference_Value_ID,
                                          boolean IsMandatory,
                                          boolean IsEncrypted,
                                          String Placeholder)

Create parameter for infoWindow

Parameters:: ctx - ctx; WindowNo - WindowNo; AD_Column_ID - AD_Column_ID; ColumnName - ColumnName; Name - Name; AD_Reference_ID - AD_Reference_ID; AD_Reference_Value_ID - AD_Reference_Value_ID; IsMandatory - IsMandatory; IsEncrypted - IsEncrypted
Returns:: GridFieldV0 v0

createStdField

public static GridFieldVO createStdField(Properties ctx,
                                         int WindowNo,
                                         int TabNo,
                                         int AD_Window_ID,
                                         int AD_Tab_ID,
                                         boolean tabReadOnly,
                                         boolean isCreated,
                                         boolean isTimestamp)

Make a standard field (Created/Updated/By)

Parameters:: ctx - context; WindowNo - window; TabNo - tab; AD_Window_ID - window; AD_Tab_ID - tab; tabReadOnly - rab is r/o; isCreated - is Created field; isTimestamp - is the timestamp (not by)
Returns:: MFieldVO

setCtx
```
public void setCtx(Properties newCtx)
```
Set Context including contained elements

Parameters:

newCtx - new context

initFinish
```
protected void initFinish()
```
Validate Fields and create LookupInfo if required

loadLookupInfo
```
public void loadLookupInfo()
```
load lookup info. used by findwindow to loadlookupinfo for invisible field

clone

public GridFieldVO clone(Properties Ctx,
                         int windowNo,
                         int tabNo,
                         int ad_Window_ID,
                         int ad_Tab_ID,
                         boolean TabReadOnly)

Clone Field.

Parameters:: Ctx - ctx; windowNo - window no; tabNo - tab no; ad_Window_ID - window id; ad_Tab_ID - tab id; TabReadOnly - r/o
Returns:: Field or null

clone
```
public GridFieldVO clone()
```
Overrides:

clone in class Object

toString
```
public String toString()
```
String Representation

Overrides:

toString in class Object

Returns:

info

Class GridFieldVO

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ctx

WindowNo

TabNo

AD_Window_ID

AD_Process_ID_Of_Panel

AD_Window_ID_Of_Panel

AD_Infowindow_ID

AD_Tab_ID

tabReadOnly

isProcess

ColumnName

ColumnSQL

Header

displayType

AD_Table_ID

AD_Column_ID

DisplayLength

IsSameLine

IsDisplayed

IsDisplayedGrid

SeqNo

SeqNoGrid

DisplayLogic

DefaultValue

IsMandatory

IsReadOnly

IsUpdateable

IsAlwaysUpdateable

IsHeading

IsFieldOnly

IsEncryptedField

IsEncryptedColumn

IsSelectionColumn

SeqNoSelection

SortNo

FieldLength

VFormat

FormatPattern

ValueMin

ValueMax

FieldGroup

FieldGroupType

IsKey

IsParent

Callout

AD_Process_ID

Description

Help

MandatoryLogic

ReadOnlyLogic

ObscureType

IsDefaultFocus

ValidationCode

ValidationCodeLookup

AD_Reference_Value_ID

isRange

DefaultValue2

lookupInfo

AD_Field_ID

XPosition

ColumnSpan

NumLines

Included_Tab_ID

IsCollapsedByDefault

IsAutocomplete

IsAllowCopy

IsToolbarButton

AD_Chart_ID

AD_LabelStyle_ID

AD_FieldStyle_ID

PA_DashboardContent_ID

Placeholder

Placeholder2

IsHtml