com.ibm.etools.iseries.editor
Class ISeriesEditorPromptFieldData

java.lang.Object
  com.ibm.etools.iseries.editor.ISeriesEditorPromptFieldData

All Implemented Interfaces:

IISeriesEditorConstantsPrompt

public class ISeriesEditorPromptFieldData
extends Object
implements IISeriesEditorConstantsPrompt

A structure that contains information about a field, its string identifier, its label, its position, its length, and an optional list of string choices. A combo box is presented if a list of string choices is present. Otherwise, a text field is presented. The field label is represented as two lines of centered text. A combo box, or text widget is placed centered under the label. For a list of choices, the index of the currently selected choice is stored.

Field Summary

boolean	bEditable
static String	copyright
Hashtable	hashChoiceHelpIDs
int	iAlignment
int	iLength
int	iPosition
String[]	straChoices
String	strHelpID
String	strId
protected static String	STRING_EMPTY
String	strLabel
String	strText

Fields inherited from interface com.ibm.etools.iseries.edit.IISeriesEditorConstantsPrompt

ALIGNMENT_BOTH, ALIGNMENT_LEFT, ALIGNMENT_NONE, ALIGNMENT_RIGHT

Constructor Summary

ISeriesEditorPromptFieldData()
Default constructor.

ISeriesEditorPromptFieldData(String strLabel, int iPosition, int iLength, String strHelpID)
Constructor.

ISeriesEditorPromptFieldData(String strLabel, int iPosition, int iLength, String strHelpID, String[] straChoices, Hashtable hashChoiceHelpIDs)
Constructor.

Method Summary

void	addChoice(String strChoice, String strHelpID) Adds the choice string and its help ID
String	getChoiceHelpID(String strChoice) Returns the help ID associated with the choice text string.
void	initialize() Called after field data setup is complete.
void	setLabel(String strLabel) Sets the label for this field.

Methods inherited from class java.lang.Object

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

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

strHelpID

public String strHelpID

strId

public String strId

strLabel

public String strLabel

strText

public String strText

straChoices

public String[] straChoices

hashChoiceHelpIDs

public Hashtable hashChoiceHelpIDs

iPosition

public int iPosition

iLength

public int iLength

iAlignment

public int iAlignment

bEditable

public boolean bEditable

STRING_EMPTY

protected static final String STRING_EMPTY

See Also:

Constant Field Values

Constructor Detail

ISeriesEditorPromptFieldData

public ISeriesEditorPromptFieldData()

Default constructor.

ISeriesEditorPromptFieldData

public ISeriesEditorPromptFieldData(String strLabel,
                                    int iPosition,
                                    int iLength,
                                    String strHelpID)

Constructor.

ISeriesEditorPromptFieldData

public ISeriesEditorPromptFieldData(String strLabel,
                                    int iPosition,
                                    int iLength,
                                    String strHelpID,
                                    String[] straChoices,
                                    Hashtable hashChoiceHelpIDs)

Constructor.

Method Detail

addChoice

public void addChoice(String strChoice,
                      String strHelpID)

Adds the choice string and its help ID

getChoiceHelpID

public String getChoiceHelpID(String strChoice)

Returns the help ID associated with the choice text string.

initialize

public void initialize()

Called after field data setup is complete.

setLabel

public void setLabel(String strLabel)

Sets the label for this field.