gov.lanl.Utility
Class InfoItem

java.lang.Object
  |
  +--gov.lanl.Utility.InfoItem

public class InfoItem

extends java.lang.Object

Provides data from the server to the GUI builder, with a key for the data base so that it can be updated. For example, an InfoItem could represent the last name of a person, with the displayable label, the last name, and which group and subgoup it should be displayed in.

Field Summary

static int	ITEM_CHOICE Indicates that the itemValues can only be chosen from the provided values
static int	ITEM_CHOICE_EDITABLE Indicates that the itemValues can only be chosen from the provided values, and edited
static int	ITEM_EDITABLE Indicates that the itemValues are fully editable
static int	ITEM_EDITABLE_PSWD Indicates that the itemValues are passwords, editable but camouflaged
static int	ITEM_FIXED Indicates that the itemValues can not be changed

Constructor Summary

InfoItem()
Construct an InfoItem with all default values

InfoItem(java.lang.String inUse, java.lang.String inName, int inCtlType, int inGroup, int inSubGroup, boolean inSingleValued, boolean inDynamic, java.lang.String inVisWith, boolean inUpdater, java.lang.String inUpdateWith, java.lang.String[] inVal)
Constructs an InfoItem with all the incoming attributes

Method Summary

int	getItemCtlType() Get the itemCtlType
java.lang.String	getItemDisplayName() Get the itemDisplayName
boolean	getItemDynamic() Get the dynamic value
int	getItemGroup() Get the group number
boolean	getItemSingleValued() Get the single value
int	getItemSubGroup() Get the sub group number
boolean	getItemUpdater() Get the updater value
java.lang.String	getItemUpdateWith() Get the itemUpdateWith
java.lang.String	getItemUse() Get the itemUse
java.lang.String[]	getItemValues() Get the itemValues
java.lang.String	getItemVisWith() Get the itemVisWith
java.lang.String[]	getRetValues() Get the retValues
void	setItemCtlType(int inCtlType) set the itemCtlType
void	setItemDisplayName(java.lang.String inName) set the itemDisplayName
void	setItemDynamic(boolean inDynamic) set the dynamic value
void	setItemGroup(int inGroup) set the group number
void	setItemSingleValued(boolean inSingleValued) set the single value
void	setItemSubGroup(int inSubGroup) set the sub group number
void	setItemUpdater(boolean inUpdater) set the dynamic value
void	setItemUpdateWith(java.lang.String inUpdateWith) set the itemUpdateWith
void	setItemUse(java.lang.String inUse) Set the itemUse
void	setItemValues(java.lang.String[] inVal) set the itemValues
void	setItemVisWith(java.lang.String inVisWith) set the itemVisWith
void	setRetValues(java.lang.String[] inRetVal) set the retValues
java.lang.String	toString() Build and return a string representing the InfoItem

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_FIXED

public static int ITEM_FIXED

Indicates that the itemValues can not be changed

ITEM_EDITABLE

public static int ITEM_EDITABLE

Indicates that the itemValues are fully editable

ITEM_CHOICE

public static int ITEM_CHOICE

Indicates that the itemValues can only be chosen from the provided values

ITEM_CHOICE_EDITABLE

public static int ITEM_CHOICE_EDITABLE

Indicates that the itemValues can only be chosen from the provided values, and edited

ITEM_EDITABLE_PSWD

public static int ITEM_EDITABLE_PSWD

Indicates that the itemValues are passwords, editable but camouflaged

Constructor Detail

InfoItem

public InfoItem(java.lang.String inUse,
                java.lang.String inName,
                int inCtlType,
                int inGroup,
                int inSubGroup,
                boolean inSingleValued,
                boolean inDynamic,
                java.lang.String inVisWith,
                boolean inUpdater,
                java.lang.String inUpdateWith,
                java.lang.String[] inVal)

Constructs an InfoItem with all the incoming attributes

Parameters:

inUse - is the unique name for this InfoItem by which data will be retrieved

inName - is the display name for the GUI

inCtlType - is the control type and will be one of: ITEM_FIXED is for a single value which cannot be edited ITEM_CHOICE is for multiple items which cannot be edited ITEM_EDITABLE is for single or multiple items which can be edited ITEM_EDITABLE_PSWD is for single items which are editable but protected from display

inGroup - is the GRP is the row number in which the widget will be inserted, monotonically increasing 0-n

inSubGroup - is the column number for the widget, 0-m

inSingleValued - indicates whether the item is single/multivalued for selections

inDynamic - indicates whether the item is dynamic or not; only one dynamic is allowed; causes only items with the current DYN value to be displayed

inVisWith - indicates which dynamic value(a inUse unique name) this item is visible with.

inVal - is an array of values for the item

InfoItem

public InfoItem()

Construct an InfoItem with all default values

Method Detail

toString

public java.lang.String toString()

Build and return a string representing the InfoItem

Overrides:

toString in class java.lang.Object

Returns:

a string representing this InfoItem contents

setItemUse

public void setItemUse(java.lang.String inUse)

Set the itemUse

Parameters:

inUse - is the new itemUse string

setItemDisplayName

public void setItemDisplayName(java.lang.String inName)

set the itemDisplayName

Parameters:

inName - is the new itemDisplayName

setItemCtlType

public void setItemCtlType(int inCtlType)

set the itemCtlType

Parameters:

inCtlType - is the integer control type

setItemGroup

public void setItemGroup(int inGroup)

set the group number

Parameters:

inGroup - is the integer group number

setItemSubGroup

public void setItemSubGroup(int inSubGroup)

set the sub group number

Parameters:

inSubGroup - is the integer sub group number

setItemSingleValued

public void setItemSingleValued(boolean inSingleValued)

set the single value

Parameters:

inSingleValued - is the boolean value

setItemDynamic

public void setItemDynamic(boolean inDynamic)

set the dynamic value

Parameters:

inDynamic - is the boolean to use

setItemVisWith

public void setItemVisWith(java.lang.String inVisWith)

set the itemVisWith

Parameters:

inVisWith - is the string value

setItemUpdater

public void setItemUpdater(boolean inUpdater)

set the dynamic value

Parameters:

inUpdater - is the boolean to use

setItemUpdateWith

public void setItemUpdateWith(java.lang.String inUpdateWith)

set the itemUpdateWith

Parameters:

inUpdateWith - is the string value

setItemValues

public void setItemValues(java.lang.String[] inVal)

set the itemValues

Parameters:

inVal - are the itemValues as a String[]

setRetValues

public void setRetValues(java.lang.String[] inRetVal)

set the retValues

Parameters:

inRetVal - are the retValues as a String[]

getItemUse

public java.lang.String getItemUse()

Get the itemUse

Returns:

the current itemUse string

getItemDisplayName

public java.lang.String getItemDisplayName()

Get the itemDisplayName

Returns:

the current itemDisplayName

getItemCtlType

public int getItemCtlType()

Get the itemCtlType

Returns:

current value of the control type

getItemGroup

public int getItemGroup()

Get the group number

Returns:

the current group number

getItemSubGroup

public int getItemSubGroup()

Get the sub group number

Returns:

the current sub group number

getItemSingleValued

public boolean getItemSingleValued()

Get the single value

Returns:

the current value of itemSingleValued

getItemDynamic

public boolean getItemDynamic()

Get the dynamic value

Returns:

the current dynamic value

getItemVisWith

public java.lang.String getItemVisWith()

Get the itemVisWith

Returns:

the current value of itemVisWith

getItemUpdater

public boolean getItemUpdater()

Get the updater value

Returns:

the current updater value

getItemUpdateWith

public java.lang.String getItemUpdateWith()

Get the itemUpdateWith

Returns:

the current value of itemUpdateWith

getItemValues

public java.lang.String[] getItemValues()

Get the itemValues

Returns:

the current values in itemValues as a String[]

getRetValues

public java.lang.String[] getRetValues()

Get the retValues

Returns:

the current values in retValues as a String[]