com.ibm.etools.iseries.editor
Class ISeriesEditorPromptGroup

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

All Implemented Interfaces:

IISeriesEditorConstantsPrompt

public class ISeriesEditorPromptGroup
extends Object
implements IISeriesEditorConstantsPrompt

This class represents a group of displayable prompt pages.

Field Summary

protected int	_iMaxLineLength
protected String	_strEmpty
protected Vector	_vectorPageFields
protected Vector	_vectorPageHelpIds
protected Vector	_vectorPageLabels
protected Vector	_vectorPageTemplates
protected Vector	_vectorXmlPageIds
protected Vector	_vectorXmlPages
static String	copyright

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

ALIGNMENT_BOTH, ALIGNMENT_LEFT, ALIGNMENT_NONE, ALIGNMENT_RIGHT

Constructor Summary

ISeriesEditorPromptGroup()
Constructor.

Method Summary

protected ISeriesEditorPromptFieldData	createFieldData(XmlLiteElement elementField) Parses an XML field element for its attributes, and returns the attributes in a field data object.
protected int	getElementAttributeNumericValue(XmlLiteElement element, String strAttributeName) Returns the integer value of an elements attribute given the name of the attribute.
protected String	getElementAttributeStringValue(XmlLiteElement element, String strAttributeName) Returns the string value of an elements attribute given the name of the attribute.
String	getFieldHelpIdFromColumnNumber(int iPageIndex, int iColumnNumber, String strLine, String strEncoding) Returns the Help resource identifier string given the column number of the field.
int	getMaximumLineLength() Returns the maximum line length for all statements.
int	getNumberOfPages() Returns the number of pages in this group.
ISeriesEditorPromptFieldData[]	getPageFieldData(int iPageIndex) Returns an array of data structures containing the data for each field.
String	getPageHelpIdFromPageIndex(int iPageIndex) Returns the Help ID for the given page index.
String	getPageIdFromPageIndex(int iPageIndex) Returns the ID of the page for the given page index.
int	getPageIndexFromPageId(String strPageId) Converts from a string page identifier to a page index number.
String[]	getPageLabels() Returns an array of page labels to be used in a combo.
String	getPageTemplate(int iPageIndex) Returns the string which contains the constant characters for the prompt type.
boolean	loadPageGroup(URL urlPageGroup) Loads and parses a page group XML file from a URL.

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

_vectorPageLabels

protected Vector _vectorPageLabels

_vectorPageHelpIds

protected Vector _vectorPageHelpIds

_vectorPageTemplates

protected Vector _vectorPageTemplates

_vectorXmlPageIds

protected Vector _vectorXmlPageIds

_vectorXmlPages

protected Vector _vectorXmlPages

_vectorPageFields

protected Vector _vectorPageFields

_iMaxLineLength

protected int _iMaxLineLength

_strEmpty

protected String _strEmpty

Constructor Detail

ISeriesEditorPromptGroup

public ISeriesEditorPromptGroup()

Constructor.

Method Detail

createFieldData

protected ISeriesEditorPromptFieldData createFieldData(XmlLiteElement elementField)

Parses an XML field element for its attributes, and returns the attributes in a field data object.

getElementAttributeNumericValue

protected int getElementAttributeNumericValue(XmlLiteElement element,
                                              String strAttributeName)

Returns the integer value of an elements attribute given the name of the attribute.

getElementAttributeStringValue

protected String getElementAttributeStringValue(XmlLiteElement element,
                                                String strAttributeName)

Returns the string value of an elements attribute given the name of the attribute.

getMaximumLineLength

public int getMaximumLineLength()

Returns the maximum line length for all statements.

getNumberOfPages

public int getNumberOfPages()

Returns the number of pages in this group.

getFieldHelpIdFromColumnNumber

public String getFieldHelpIdFromColumnNumber(int iPageIndex,
                                             int iColumnNumber,
                                             String strLine,
                                             String strEncoding)

Returns the Help resource identifier string given the column number of the field. If the help ID for a field begins with "position", then the help ID for the field that has that position (column number) is used.

getPageFieldData

public ISeriesEditorPromptFieldData[] getPageFieldData(int iPageIndex)

Returns an array of data structures containing the data for each field.

getPageHelpIdFromPageIndex

public String getPageHelpIdFromPageIndex(int iPageIndex)

Returns the Help ID for the given page index.

getPageIdFromPageIndex

public String getPageIdFromPageIndex(int iPageIndex)

Returns the ID of the page for the given page index.

getPageIndexFromPageId

public int getPageIndexFromPageId(String strPageId)

Converts from a string page identifier to a page index number.

getPageLabels

public String[] getPageLabels()

Returns an array of page labels to be used in a combo.

getPageTemplate

public String getPageTemplate(int iPageIndex)

Returns the string which contains the constant characters for the prompt type. For instance, for a 'C' spec, the string will contain the 'C'.

loadPageGroup

public boolean loadPageGroup(URL urlPageGroup)

Loads and parses a page group XML file from a URL.