org.compiere.controller
Class UITab

java.lang.Object
  org.compiere.framework.VO
      org.compiere.controller.UITabVO
          org.compiere.controller.UITab

All Implemented Interfaces:

Serializable, Map<String,String>

public class UITab
extends UITabVO

User Interface Tab

Version:

$Id$

Author:

Jorg Janke

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class org.compiere.controller.UITabVO

createdMS

Fields inherited from class org.compiere.framework.VO

p_vos, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Constructor Summary

UITab(UITabVO vo)
UI Tab

Method Summary

void	clearLookupCache()
String[]	convertToString(Object[] fromRow) Convert To String
ChangeVO	deleteRow(CContext ctx, int windowNo) Delete existing Row
ArrayList<Object[]>	executeQuery(QueryVO queryVO, HashMap<String,String> context, CContext ctx) Execute Query for Tab
ArrayList<String[]>	executeQueryString(QueryVO queryVO, HashMap<String,String> context, CContext ctx) Execute Query for Tab and return results as String
ChangeVO	fieldChanged(CContext ctx, int windowNo, UIField field, String oldValue, String newValue) Field Changed Consequences
String[]	getColumnNames() Get Column Names
ArrayList<String>	getDependsOnUI() Get the list of column names this tab Depends On for UI.
UIField	getField(String columnName) Get Field
int	getFieldIndex(int AD_Field_ID) Get Field Index
int	getFieldIndex(String columnName) Get Field Index
ArrayList<UIField>	getFields() Get Fields
ArrayList<String>	getIdentifierColumnNames() Get Identifier Column Names ordered
String	getKeyColumnName() Get Key Column Name
ArrayList<String>	getKeyColumnNames() Get Key Columns
int	getKeyColumnPos()
ArrayList<String>	getParentColumnNames() Get parent Columns
int	getRecord_ID(String[] row)
ArrayList<String>	getSavedQueryNames(int AD_Client_ID) Get Saved Query Names
ArrayList<String>	getSavedQueryNamesForUser(int AD_User_ID) Get Saved Query Names
ArrayList<String>	getSelectionColumnNames() Get Selection Column Names ordered
ArrayList<String>	getSummaryColumnNames() Get Summary Column Names ordered
int	getTabNo() Get relative Tab No
protected void	initialize(ArrayList<UIField> fields, ArrayList<UITab> previousTabs, CContext ctx, int windowNo, int tabNo, boolean isSOTrx) Initialize
boolean	isCanExport(Ctx ctx) Whether this tab can be exported by the present role.
boolean	isCanReport(Ctx ctx) Whether this tab can be reported by the present role.
boolean	isDetailTab() Detail Tab
boolean	isSOTrx() Is Window in SO Context
ChangeVO	newRow(CContext ctx, int windowNo) New Row
ChangeVO	processCalloutDirect(CContext ctx, int windowNo, UIField field, String oldValue, String newValue) Preferred Callout.
void	refreshDropDowns(ChangeVO change, int windowNo, CContext newCtx)
ChangeVO	refreshRow(CContext ctx, int windowNo) Refresh (Insert/Update) Row of Tab
ChangeVO	saveRow(CContext ctx, int windowNo, boolean newRecord) Save (Insert/Update) Row of Tab
ChangeVO	saveRow(CContext ctx, int windowNo, boolean newRecord, String[] cachedRow) Save (Insert/Update) Row of Tab
String	toString() String Representation

Methods inherited from class org.compiere.controller.UITabVO

getAccessLevel, getAD_Column_ID, getAD_ColumnSortOrder_ID, getAD_ColumnSortYesNo_ID, getAD_CtxArea_ID, getAD_Image_ID, getAD_Process_ID, getAD_Tab_ID, getAD_Table_ID, getAD_User_ID, getAD_UserDef_Tab_ID, getAD_UserDef_Win_ID, getAD_Window_ID, getCommitWarning, getCustomizationName, getDescription, getDisplayLogic, getHelp, getIncluded_Tab_ID, getLinkColumnName, getName, getOrderByClause, getReadOnlyLogic, getReferenced_Tab_ID, getSeqNo, getTableName, getTabLevel, getUserDef_Role_ID, getWhereClause, isAdvancedTab, isDeleteable, isDisplayed, isHasTree, isHighVolume, isInfoTab, isInsertRecord, isReadOnly, isReplicationType, isSecurityEnabled, isSingleRow, isSortTab, isTranslationTab, isView, setAccessLevel, setAD_Column_ID, setAD_Column_ID, setAD_ColumnSortOrder_ID, setAD_ColumnSortOrder_ID, setAD_ColumnSortYesNo_ID, setAD_ColumnSortYesNo_ID, setAD_CtxArea_ID, setAD_CtxArea_ID, setAD_Image_ID, setAD_Image_ID, setAD_Process_ID, setAD_Process_ID, setAD_Tab_ID, setAD_Tab_ID, setAD_Table_ID, setAD_Table_ID, setAD_User_ID, setAD_User_ID, setAD_UserDef_Tab_ID, setAD_UserDef_Tab_ID, setAD_UserDef_Win_ID, setAD_UserDef_Win_ID, setAD_Window_ID, setAD_Window_ID, setCommitWarning, setCustomizationName, setDescription, setDisplayLogic, setHasTree, setHasTree, setHelp, setIncluded_Tab_ID, setIncluded_Tab_ID, setIsAdvancedTab, setIsAdvancedTab, setIsDeleteable, setIsDeleteable, setIsDisplayed, setIsDisplayed, setIsHighVolume, setIsHighVolume, setIsInfoTab, setIsInfoTab, setIsInsertRecord, setIsInsertRecord, setIsReadOnly, setIsReadOnly, setIsSecurityEnabled, setIsSecurityEnabled, setIsSingleRow, setIsSingleRow, setIsSortTab, setIsSortTab, setIsTranslationTab, setIsTranslationTab, setIsView, setIsView, setLinkColumnName, setName, setOrderByClause, setReadOnlyLogic, setReferenced_Tab_ID, setReferenced_Tab_ID, setReplicationType, setReplicationType, setSeqNo, setSeqNo, setTableName, setTabLevel, setTabLevel, setUserDef_Role_ID, setUserDef_Role_ID, setWhereClause

Methods inherited from class org.compiere.framework.VO

clear, clone, containsKey, containsValue, dump, entrySet, get_xmlDocument, get_xmlString, get_xmlString, get, getData, getEmbedded, getHashMap, isEmpty, keySet, put, put, putAll, remove, setEmbedded, setHdrInfo, size, toStringX, values

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

UITab

public UITab(UITabVO vo)

UI Tab

Parameters:

vo - vo

Method Detail

getTabNo

public int getTabNo()

Get relative Tab No

Returns:

getSavedQueryNames

public ArrayList<String> getSavedQueryNames(int AD_Client_ID)

Get Saved Query Names

Parameters:

AD_Client_ID - client

Returns:

saved Queries

getSavedQueryNamesForUser

public ArrayList<String> getSavedQueryNamesForUser(int AD_User_ID)

Get Saved Query Names

Parameters:

AD_User_ID - user

Returns:

saved Queries

initialize

protected void initialize(ArrayList<UIField> fields,
                          ArrayList<UITab> previousTabs,
                          CContext ctx,
                          int windowNo,
                          int tabNo,
                          boolean isSOTrx)

Initialize

Parameters:

fields - fields

previousTabs - previous tabs

ctx - context

windowNo - window

tabNo - relative tab

getDependsOnUI

public ArrayList<String> getDependsOnUI()

Get the list of column names this tab Depends On for UI. (Display, ReadOnly, Mandatory)

Returns:

list of columns

getFields

public ArrayList<UIField> getFields()

Get Fields

Returns:

Fields

getField

public UIField getField(String columnName)

Get Field

Returns:

Field with name or null

getFieldIndex

public int getFieldIndex(int AD_Field_ID)

Get Field Index

Returns:

Field with name or null

getFieldIndex

public int getFieldIndex(String columnName)

Get Field Index

Returns:

Field with name or null

getColumnNames

public String[] getColumnNames()

Get Column Names

Returns:

column names

isDetailTab

public boolean isDetailTab()

Detail Tab

Returns:

true if tab level is 0

getKeyColumnNames

public ArrayList<String> getKeyColumnNames()

Get Key Columns

Returns:

list with one or more columns (if no PK)

getKeyColumnName

public String getKeyColumnName()

Get Key Column Name

Returns:

getParentColumnNames

public ArrayList<String> getParentColumnNames()

Get parent Columns

Returns:

list with none or more columns

getIdentifierColumnNames

public ArrayList<String> getIdentifierColumnNames()

Get Identifier Column Names ordered

Returns:

list with identifier columns

getSelectionColumnNames

public ArrayList<String> getSelectionColumnNames()

Get Selection Column Names ordered

Returns:

list with selection columns

getSummaryColumnNames

public ArrayList<String> getSummaryColumnNames()

Get Summary Column Names ordered

Returns:

list with summary columns

isSOTrx

public boolean isSOTrx()

Is Window in SO Context

Returns:

true if window SO

executeQuery

public ArrayList<Object[]> executeQuery(QueryVO queryVO,
                                        HashMap<String,String> context,
                                        CContext ctx)

Execute Query for Tab

Parameters:

queryVO - optional query

context - record context for link columns and other variables

ctx - user context

Returns:

number of records

executeQueryString

public ArrayList<String[]> executeQueryString(QueryVO queryVO,
                                              HashMap<String,String> context,
                                              CContext ctx)

Execute Query for Tab and return results as String

Parameters:

queryVO - optional query

context - record context for link columns and other variables

ctx - user context

Returns:

number of records

convertToString

public String[] convertToString(Object[] fromRow)

Convert To String

Parameters:

fromRow - objects

Returns:

strings

saveRow

public ChangeVO saveRow(CContext ctx,
                        int windowNo,
                        boolean newRecord)

Save (Insert/Update) Row of Tab

Parameters:

ctx - general context

context - current (relevant) context of new row

Returns:

error message or null

saveRow

public ChangeVO saveRow(CContext ctx,
                        int windowNo,
                        boolean newRecord,
                        String[] cachedRow)

Save (Insert/Update) Row of Tab

Parameters:

ctx - general context

context - current (relevant) context of new row

cachedRow - the row cached for this user session

Returns:

error message or null

refreshRow

public ChangeVO refreshRow(CContext ctx,
                           int windowNo)

Refresh (Insert/Update) Row of Tab

Parameters:

ctx - general context

context - current (relevant) context of new row

Returns:

error message or null

deleteRow

public ChangeVO deleteRow(CContext ctx,
                          int windowNo)

Delete existing Row

Parameters:

ctx - general context

context - current (relevant) context of row

Returns:

error message or null

newRow

public ChangeVO newRow(CContext ctx,
                       int windowNo)

New Row

Parameters:

ctx - context

windowNo - window

Returns:

default values for new row

fieldChanged

public ChangeVO fieldChanged(CContext ctx,
                             int windowNo,
                             UIField field,
                             String oldValue,
                             String newValue)

Field Changed Consequences

Parameters:

ctx - context

field - Field

oldValue - old field value

newValue - new Field value

context - current row context

Returns:

Field Change VO

processCalloutDirect

public ChangeVO processCalloutDirect(CContext ctx,
                                     int windowNo,
                                     UIField field,
                                     String oldValue,
                                     String newValue)

Preferred Callout.

Parameters:

ctx - context

windowNo -

field -

oldValue -

newValue -

Returns:

change

isCanExport

public boolean isCanExport(Ctx ctx)

Whether this tab can be exported by the present role.

Parameters:

ctx - context

Returns:

true if role can export

isCanReport

public boolean isCanReport(Ctx ctx)

Whether this tab can be reported by the present role.

Parameters:

ctx - context

Returns:

true if role can export

toString

public String toString()

String Representation

Overrides:

toString in class UITabVO

Returns:

info

refreshDropDowns

public void refreshDropDowns(ChangeVO change,
                             int windowNo,
                             CContext newCtx)

getRecord_ID

public int getRecord_ID(String[] row)

getKeyColumnPos

public int getKeyColumnPos()

clearLookupCache

public void clearLookupCache()