Package org.compiere.model
Class GridFieldVO
java.lang.Object
org.compiere.model.GridFieldVO
- All Implemented Interfaces:
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classComparator for GridFieldVO.SeqNo -
Field Summary
FieldsModifier and TypeFieldDescriptionintintColumn IDintField IDintintInfo WindowintAD_Infowindow_ID of containing panelintintProcessintWhen this field is inside process parameter panel, AD_Process_ID_Of_Panel is id of process that will run in this panel.intReference ValueintAD_Tab_IDintTable IDintAD_Winmdow_IDintad_window_id of window show process dialog or infoWindow dialogAlways Updatable LogicCalloutColumn nameintColumnSpan IDEMPIERE368Column sqlContextDate Range OptionDefault Value, never set null for itProcess Parameter Value2DescriptionintDisplay LengthDisplay Logic, never set null for itintDisplayTypeEntityTypeField GroupField Group TypeintField LengthFormat patternLabelHelpintbooleanbooleanAlways UpdateablebooleanAutocompletion for textfields - Feature Request FR [ 1757088 ]booleanCollapse By Default *booleanDefault FocusbooleanDisplayedbooleanDisplayed GridbooleanStorage EncryptionbooleanDisplay EncryptionbooleanField OnlybooleanHeading OnlybooleanbooleanPKbooleanMandatorybooleanFKbooleanIs Process ParameterbooleanbooleanProcess Parameter RangebooleanRead OnlybooleanSame LinebooleanFind SelectionbooleanShow Negate button (only for Chosen Multiple fields)Toolbar ButtonbooleanUpdateableLookup Value ObjectMandatory LogicintNumLines IDEMPIERE368Display ObscureintRead Only LogicintPositionintGrid Display sequenceintSelection column sequenceintOrder ByintTab NobooleanIs the Tab Read OnlyLookup Validation codeLookup Validation code for Find WindowMax.Min.Format enforcementintWindow NointXPosition IDEMPIERE368 -
Method Summary
Modifier and TypeMethodDescriptionAdditional processing after a new vo have been created from db or cloned from cache.clone()clone(Properties ctx, int windowNo, int tabNo, int ad_Window_ID, int ad_Tab_ID, boolean TabReadOnly) Clone Field VO.static GridFieldVOcreate(Properties ctx, int WindowNo, int TabNo, int AD_Window_ID, int AD_Tab_ID, boolean readOnly, ResultSet rs) Create Field Value Object.static GridFieldVOcreateFromResultSet(Properties ctx, int WindowNo, int TabNo, int AD_Window_ID, int AD_Tab_ID, boolean readOnly, ResultSet rs) Create GridFieldVO from db resultset.static GridFieldVOcreateParameter(Properties ctx, int WindowNo, int TabNo, int ProcessIDOfPanel, int WindowIDOfPanel, int InfoWindowIDOfPanel, ResultSet rs) Create Field VO for Process Parameterstatic GridFieldVOcreateParameter(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) static GridFieldVOcreateParameter(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, String EntityType) Create parameter for infoWindowstatic GridFieldVOcreateParameter(Properties ctx, int WindowNo, int ProcessIDOfPanel, int WindowIDOfPanel, int InfoWindowIDOfPanel, ResultSet rs) Create Field VO for Process Parameterstatic GridFieldVOCreate range "to" Parameter Field from "from" Parameter Fieldstatic GridFieldVOcreateStdField(Properties ctx, int WindowNo, int TabNo, int AD_Window_ID, int AD_Tab_ID, boolean tabReadOnly, boolean isCreated, boolean isTimestamp) Create standard field (Created/Updated/By) VO.static StringgetSQL(Properties ctx) Get the SQL statement used forcreate(Properties, int, int, int, int, boolean, ResultSet)orcreateFromResultSet(Properties, int, int, int, int, boolean, ResultSet).protected voidValidate Fields and create LookupInfo if requiredvoidload lookup info.voidsetCtx(Properties newCtx) Set context including context of lookupInfo.toString()String Representation
-
Field Details
-
ctx
Context -
WindowNo
public int WindowNoWindow No -
TabNo
public int TabNoTab No -
AD_Window_ID
public int AD_Window_IDAD_Winmdow_ID -
AD_Process_ID_Of_Panel
public int AD_Process_ID_Of_PanelWhen this field is inside process parameter panel, AD_Process_ID_Of_Panel is id of process that will run in this panel. This is different from AD_Process_ID of field. -
AD_Window_ID_Of_Panel
public int AD_Window_ID_Of_Panelad_window_id of window show process dialog or infoWindow dialog -
AD_InfoWindow_ID_Of_Panel
public int AD_InfoWindow_ID_Of_PanelAD_Infowindow_ID of containing panel -
AD_Tab_ID
public int AD_Tab_IDAD_Tab_ID -
tabReadOnly
public boolean tabReadOnlyIs the Tab Read Only -
isProcess
public boolean isProcessIs Process Parameter -
ColumnName
Column name -
ColumnSQL
Column sql -
Header
Label -
displayType
public int displayTypeDisplayType -
AD_Table_ID
public int AD_Table_IDTable ID -
AD_Column_ID
public int AD_Column_IDColumn ID -
DisplayLength
public int DisplayLengthDisplay Length -
IsSameLine
public boolean IsSameLineSame Line -
IsDisplayed
public boolean IsDisplayedDisplayed -
IsDisplayedGrid
public boolean IsDisplayedGridDisplayed Grid -
SeqNo
public int SeqNoPosition -
SeqNoGrid
public int SeqNoGridGrid Display sequence -
DisplayLogic
Display Logic, never set null for it -
DefaultValue
Default Value, never set null for it -
IsMandatory
public boolean IsMandatoryMandatory -
IsReadOnly
public boolean IsReadOnlyRead Only -
IsUpdateable
public boolean IsUpdateableUpdateable -
IsAlwaysUpdateable
public boolean IsAlwaysUpdateableAlways Updateable -
IsHeading
public boolean IsHeadingHeading Only -
IsFieldOnly
public boolean IsFieldOnlyField Only -
IsEncryptedField
public boolean IsEncryptedFieldDisplay Encryption -
IsEncryptedColumn
public boolean IsEncryptedColumnStorage Encryption -
IsSelectionColumn
public boolean IsSelectionColumnFind Selection -
SeqNoSelection
public int SeqNoSelectionSelection column sequence -
SortNo
public int SortNoOrder By -
FieldLength
public int FieldLengthField Length -
VFormat
Format enforcement -
FormatPattern
Format pattern -
ValueMin
Min. Value -
ValueMax
Max. Value -
FieldGroup
Field Group -
FieldGroupType
Field Group Type -
IsKey
public boolean IsKeyPK -
IsParent
public boolean IsParentFK -
Callout
Callout -
AD_Process_ID
public int AD_Process_IDProcess -
AD_InfoWindow_ID
public int AD_InfoWindow_IDInfo Window -
Description
Description -
Help
Help -
MandatoryLogic
Mandatory Logic -
ReadOnlyLogic
Read Only Logic -
AlwaysUpdatableLogic
Always Updatable Logic -
ObscureType
Display Obscure -
IsDefaultFocus
public boolean IsDefaultFocusDefault Focus -
ValidationCode
Lookup Validation code -
ValidationCodeLookup
Lookup Validation code for Find Window -
AD_Reference_Value_ID
public int AD_Reference_Value_IDReference Value -
isRange
public boolean isRangeProcess Parameter Range -
DefaultValue2
Process Parameter Value2 -
dateRangeOption
Date Range Option -
lookupInfo
Lookup Value Object -
EntityType
EntityType -
AD_Field_ID
public int AD_Field_IDField ID -
XPosition
public int XPositionXPosition IDEMPIERE368 -
ColumnSpan
public int ColumnSpanColumnSpan IDEMPIERE368 -
NumLines
public int NumLinesNumLines IDEMPIERE368 -
Included_Tab_ID
public int Included_Tab_ID -
IsCollapsedByDefault
public boolean IsCollapsedByDefaultCollapse By Default * -
IsAutocomplete
public boolean IsAutocompleteAutocompletion for textfields - Feature Request FR [ 1757088 ] -
IsAllowCopy
public boolean IsAllowCopy -
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
-
Placeholder2
-
IsHtml
public boolean IsHtml -
IsQuickForm
public boolean IsQuickForm -
IsShowNegateButton
public boolean IsShowNegateButtonShow Negate button (only for Chosen Multiple fields)
-
-
Method Details
-
getSQL
Get the SQL statement used forcreate(Properties, int, int, int, int, boolean, ResultSet)orcreateFromResultSet(Properties, int, int, int, int, boolean, ResultSet).- 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- contextWindowNo- windowTabNo- tabAD_Window_ID- windowAD_Tab_ID- tabreadOnly- r/ors- resultset AD_Field_v/AD_Field_vt- Returns:
- 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 InfoWindowIDOfPanel, ResultSet rs) Create Field VO for Process Parameter- Parameters:
ctx- contextWindowNo- windowProcessIDOfPanel-WindowIDOfPanel-InfoWindowIDOfPanel-rs- result set AD_Process_Para- Returns:
- GridFieldVO
-
createParameter
public static GridFieldVO createParameter(Properties ctx, int WindowNo, int TabNo, int ProcessIDOfPanel, int WindowIDOfPanel, int InfoWindowIDOfPanel, ResultSet rs) Create Field VO for Process Parameter- Parameters:
ctx- contextWindowNo- windowTabNo-ProcessIDOfPanel-WindowIDOfPanel-InfoWindowIDOfPanel-rs- result set AD_Process_Para- Returns:
- GridFieldVO
-
createParameter
Create range "to" Parameter Field from "from" Parameter Field- Parameters:
voF- field value object- Returns:
- to GridFieldVO
-
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) -
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, String EntityType) Create parameter for infoWindow- Parameters:
ctx- ctxWindowNo- WindowNoWindowIDOfPanel-infoWindowID-AD_Column_ID- AD_Column_IDColumnName- ColumnNameName- NameAD_Reference_ID- AD_Reference_IDAD_Reference_Value_ID- AD_Reference_Value_IDIsMandatory- IsMandatoryIsEncrypted- IsEncryptedPlaceholder-- Returns:
- GridFieldV0
-
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) Create standard field (Created/Updated/By) VO.- Parameters:
ctx- contextWindowNo- windowTabNo- tabAD_Window_ID- windowAD_Tab_ID- tabtabReadOnly- tab is r/oisCreated- is Created fieldisTimestamp- is the timestamp (not by)- Returns:
- GridFieldVO
-
setCtx
Set context including context of lookupInfo.- 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 VO.- Parameters:
ctx- contextwindowNo- window notabNo- tab noad_Window_ID- window idad_Tab_ID- tab idTabReadOnly- r/o- Returns:
- Field or null
-
clone
-
toString
String Representation
-