com.sabratec.applinx.baseobject.table

Class GXTableColumn

java.lang.Object

com.sabratec.applinx.baseobject.table.GXTableColumn

All Implemented Interfaces:

GXITableColumn, Serializable

public class GXTableColumn
extends Object
implements GXITableColumn, Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.sabratec.applinx.baseobject.table.GXITableColumn

GX_TABLE_COLUMN_DATA_TYPE_ALPHANUMERIC, GX_TABLE_COLUMN_DATA_TYPE_NUMERIC, GX_TABLE_COLUMN_TYPE_APPFIELD, GX_TABLE_COLUMN_TYPE_OTHER, GX_TABLE_COLUMN_TYPE_VARIABLE

Constructor Summary

Constructors

Constructor and Description
GXTableColumn(String name)
GXTableColumn(String name, String[] screenNames)
GXTableColumn(String name, String caption, int dataType)
GXTableColumn(String name, String appFieldName, String[] screenNames, String caption, int dataType)
GXTableColumn(String name, String variableName, String caption, int dataType)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAppFieldFullName()
String	getAppFieldName()
String	getCaption()
int	getCopyCount()
int	getDataType()
String	getName()
String[]	getScreenNames() Used for horizontal scrolling, for tables spanning over more than one identified host screen.
int	getType() Returns the type of the column's mapped object.
String	getVariableName()
boolean	isMasterRow()
boolean	isToCopy()
void	setAppFieldFullName(String appFieldName)
void	setAppFieldName(String appFieldName) Sets the name of the application field that is to be associated with this column.
void	setCaption(String caption) Sets the column's caption.
void	setCopyCount(int copyCount)
void	setDataType(int dataType) sets the table's data type.
void	setIsMasterRow(boolean isMasterRow)
void	setIsToCopy(boolean isToCopy)
void	setName(String name) Sets the name of the column.
void	setScreenNames(String[] names)
void	setVariableName(String name) Sets the name of the variable that is to be associated with this column.
String	toString()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GXTableColumn

public GXTableColumn(String name,
                     String appFieldName,
                     String[] screenNames,
                     String caption,
                     int dataType)

GXTableColumn

public GXTableColumn(String name)

GXTableColumn

public GXTableColumn(String name,
                     String[] screenNames)

GXTableColumn

public GXTableColumn(String name,
                     String caption,
                     int dataType)

GXTableColumn

public GXTableColumn(String name,
                     String variableName,
                     String caption,
                     int dataType)

Method Detail

getDataType

public int getDataType()

Specified by:

getDataType in interface GXITableColumn

Returns:

the column's data type, as defined in the data type constants.

setDataType

public void setDataType(int dataType)

Description copied from interface: GXITableColumn

sets the table's data type.

Specified by:

setDataType in interface GXITableColumn

Parameters:

dataType - table's data type, should be one of the defined types.

getName

public String getName()

Specified by:

getName in interface GXITableColumn

Returns:

column's name.

setName

public void setName(String name)

Description copied from interface: GXITableColumn

Sets the name of the column. A column name should be unique, setting a column's name to a name that already exists will override the existing column.

Specified by:

setName in interface GXITableColumn

Parameters:

name - new column's name.

getAppFieldName

public String getAppFieldName()

Specified by:

getAppFieldName in interface GXITableColumn

Returns:

the name of the application field associated with this column, when this column is an application field column, otherwise null.

setAppFieldName

public void setAppFieldName(String appFieldName)

Description copied from interface: GXITableColumn

Sets the name of the application field that is to be associated with this column. Setting the name also makes the column's type be Application Field based.

Specified by:

setAppFieldName in interface GXITableColumn

Parameters:

appFieldName - the application field's full name (including the folder structure).

getAppFieldFullName

public String getAppFieldFullName()

Specified by:

getAppFieldFullName in interface GXITableColumn

Returns:

the full name of the application field associated with this column, when this column is an application field column, otherwise null.

setAppFieldFullName

public void setAppFieldFullName(String appFieldName)

getVariableName

public String getVariableName()

Specified by:

getVariableName in interface GXITableColumn

Returns:

the name of the variable associated with this column, when this column is a variable column, otherwise null.

setVariableName

public void setVariableName(String name)

Description copied from interface: GXITableColumn

Sets the name of the variable that is to be associated with this column. Setting the name also makes the column's type Variable based.

Specified by:

setVariableName in interface GXITableColumn

Parameters:

name - the variable's name.

getCaption

public String getCaption()

Specified by:

getCaption in interface GXITableColumn

Returns:

the column's caption.

setCaption

public void setCaption(String caption)

Description copied from interface: GXITableColumn

Sets the column's caption.

Specified by:

setCaption in interface GXITableColumn

Parameters:

caption - the new caption.

getScreenNames

public String[] getScreenNames()

Description copied from interface: GXITableColumn

Used for horizontal scrolling, for tables spanning over more than one identified host screen. Multiple screen names are used if the same application field is mapped in more than one screen, but should be collected for the table only from some of the screens.

Specified by:

getScreenNames in interface GXITableColumn

Returns:

the full names of the screens.

setScreenNames

public void setScreenNames(String[] names)

Specified by:

setScreenNames in interface GXITableColumn

Parameters:

names - full screen names (including folder structure).

See Also:

GXITableColumn.getScreenNames()

setIsMasterRow

public void setIsMasterRow(boolean isMasterRow)

Specified by:

setIsMasterRow in interface GXITableColumn

isMasterRow

public boolean isMasterRow()

Specified by:

isMasterRow in interface GXITableColumn

setIsToCopy

public void setIsToCopy(boolean isToCopy)

Specified by:

setIsToCopy in interface GXITableColumn

isToCopy

public boolean isToCopy()

Specified by:

isToCopy in interface GXITableColumn

setCopyCount

public void setCopyCount(int copyCount)

Specified by:

setCopyCount in interface GXITableColumn

getCopyCount

public int getCopyCount()

Specified by:

getCopyCount in interface GXITableColumn

getType

public int getType()

Description copied from interface: GXITableColumn

Returns the type of the column's mapped object. Current possible types are application field and variable array, as defined in the column type constants.

Specified by:

getType in interface GXITableColumn

Returns:

the type of the column's mapped object.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object