Package com.softwaremining.ui

Class RequestEntry

java.lang.Object

com.softwaremining.ui.RequestEntry

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

HpRequestEntry, ILERequestEntry

public class RequestEntry
extends Object
implements Cloneable

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ATTR_BLANK_SCREEN
static final int	ATTR_BLINK
static final int	ATTR_BRIGHT
static final int	ATTR_DARK
static final int	ATTR_NORMAL
static final int	ATTR_REVERSED
static final int	ATTR_UNCHANGED
static final int	ATTR_UNDERSCORE
static final int	MODE_BUTTON
static final int	MODE_CHECKBOX
static final int	MODE_DROP_DOWN
static final int	MODE_HIDDEN	used to place additional SPACING on the screen.
static final int	MODE_HIDDEN_INPUT	when an INPUT-Field changes type from INPUT to RADIO-BUTTON ...
static final int	MODE_IMAGE
static final int	MODE_INPUT
static final int	MODE_INPUT_WITH_INDICATOR
static final int	MODE_RADIO
static final int	MODE_STATIC
static final int	MODE_TEXT_FROM
static final int	MODE_TO
static final int	PARAM_TARGET_ARRAY_SIZE
static final int	PARAM_TARGET_BGCOLOR
static final int	PARAM_TARGET_COLUMN
static final int	PARAM_TARGET_FGCOLOR
static final int	PARAM_TARGET_LENGTH
static final int	PARAM_TARGET_ROW
static final int	PARAM_TARGET_VALUE

Constructor Summary

Constructors

Constructor	Description
RequestEntry()
RequestEntry(DisplayRequest _owningDisplayRequest)

Method Summary

Modifier and Type	Method	Description
void	addDynamicParameter(int parameterTarget, String parameterName)
void	addSelectOption(String code, String description, boolean selected)	for dropdown boxes in html (SELECT and each entry is represented by an OTPION)
int	calculateLength()
Object	clone()
Object	clone(DisplayRequest _owningDisplayRequest)
void	copySelectionOptions(HashMap<String,String> groupValues)
boolean	equals(RequestEntry re)
String	formatFor_BMSPicin(String theText)	for internal use only Used in CICS/BMS during a RECIEVE to convert from zzz to 999 format
void	generateInputTag(Element param)	this is a virtual method for benefit of ILERequestEntry
int	getArrayElement()
int	getArraySize()
int	getAttr()
String	getBackgroundColor()
String	getBMSColor()
String	getBmsPicin()
String	getBmsPicout()
String	getCheckedValue()	Checked value is for Check-boxes and Radio buttons.
int	getColumn()
String	getCurrentValue()
String	getDefaultXMLValue()
IFieldContainer	getDisplayObject()
int	getDropDownWidth()
String	getDynamicParameterName(Integer target)
Integer[]	getDynamicParameterTargets()
String	getForegroundColor()
int	getImageHeight()
int	getImageWidth()
protected RequestEntry	getInstance()
int	getLength()	getter for length field
int	getMode()
String	getParamName()
char[]	getParamPicture()
String	getParamPictureString()
int	getRow()
String	getSelectionDefaultValue()
HashMap<String,String>	getSelectOptions()	for dropdown boxes (SELECT in HTML)
String	getValue()
boolean	hasAssociatedInputTag()	this is a virtual method for benefit of ILERequestEntry
boolean	isBmsNormal()
boolean	isBright()
boolean	isChecked()
boolean	isDark()
boolean	isDisabled()
boolean	isFocused()
boolean	isFset()	for handling BMS's FSET attribute
boolean	isModified()
boolean	isNumeric()
boolean	isPassword()
boolean	isRightJustified()
boolean	isUnderline()
boolean	isUsedForInput()	Used in CICS XML direction "io" or "input" changes this to true
boolean	isVisible()	for handling BMS's DRK attribute
void	setArrayElement(int arrayElement)
void	setArraySize(int arraySize)
void	setAttr(int attr)
void	setBackgroundColor(String backgroundColor)
void	setBMSColor(String newVal)
void	setBMSFocus(boolean bmsFocus)	XML focus = true
void	setBmsPicin(String bmsPicin)
void	setChangeIndicatorNumber(String ddsIndicatorNumber)	this is a virtual method for benefit of ILERequestEntry
void	setChecked(boolean checked)
void	setCheckedValue(String groupValue)
void	setColumn(int column)
void	setDisabled(boolean disabled)
void	setDynamicParameterValue(int parameterTarget, ISMObject parameter)	For internal use only this is called when a screen is being sent to HTML
void	setFocus(boolean focus)
void	setForegroundColor(String foregroundColor)
void	setFset(boolean fset)	for handling BMS's FSET attribute XML mark-as-modified = true
void	setImageHeight(int imageHeight)
void	setImageWidth(int imageWidth)
void	setInternalVars(CBLBean fromClass)
void	setLength(int length)
void	setMode(int mode)
void	setModified(boolean modified)
void	setNumeric(boolean numeric)	Used in CICS XML num=true
void	setParamName(String paramName)
void	setParamPicture(String paramPicture)
void	setParamValue(ISMObject parameter)
void	setParamValue(String parameterValue)
void	setPassword(boolean password)
void	setRightJustified(boolean rightJustified)	Used in CICS xml "alignment" = right
void	setRow(int row)
void	setUnderline(boolean underline)
void	setUsedForInput(boolean usedForInput)	Used in CICS XML direction "io" or "input" changes this to true
void	setValue(String value)
void	setVisible(boolean visible)	for handling BMS's DRK attribute
void	setXMLValue(String value)
String	ToJSP(Boolean targetIs_ASPX, JSPScreen xmlJspScreen)
String	toString()
String	toString_Orig()
boolean	usesPicin()

Methods inherited from class java.lang.Object

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

Field Details

ATTR_NORMAL

public static final int ATTR_NORMAL

See Also:

• Constant Field Values

ATTR_BRIGHT

public static final int ATTR_BRIGHT

See Also:

• Constant Field Values

ATTR_DARK

public static final int ATTR_DARK

See Also:

• Constant Field Values

ATTR_BLINK

public static final int ATTR_BLINK

See Also:

• Constant Field Values

ATTR_REVERSED

public static final int ATTR_REVERSED

See Also:

• Constant Field Values

ATTR_BLANK_SCREEN

public static final int ATTR_BLANK_SCREEN

See Also:

• Constant Field Values

ATTR_UNCHANGED

public static final int ATTR_UNCHANGED

See Also:

• Constant Field Values

ATTR_UNDERSCORE

public static final int ATTR_UNDERSCORE

See Also:

• Constant Field Values

MODE_STATIC

public static final int MODE_STATIC

See Also:

• Constant Field Values

MODE_TEXT_FROM

public static final int MODE_TEXT_FROM

See Also:

• Constant Field Values

MODE_TO

public static final int MODE_TO

See Also:

• Constant Field Values

MODE_BUTTON

public static final int MODE_BUTTON

See Also:

• Constant Field Values

MODE_HIDDEN

public static final int MODE_HIDDEN

used to place additional SPACING on the screen. No Fields involved. JSP/ASP will cater for this.

See Also:

• Constant Field Values

MODE_HIDDEN_INPUT

public static final int MODE_HIDDEN_INPUT

when an INPUT-Field changes type from INPUT to RADIO-BUTTON ... it is important to keep tabs on the original field. the information is useful if/when regenerating the screen-buffer databean xml file. As the original program will have references to the field at percisely the original position

See Also:

• Constant Field Values

MODE_IMAGE

public static final int MODE_IMAGE

See Also:

• Constant Field Values

MODE_INPUT

public static final int MODE_INPUT

See Also:

• Constant Field Values

MODE_INPUT_WITH_INDICATOR

public static final int MODE_INPUT_WITH_INDICATOR

See Also:

• Constant Field Values

MODE_RADIO

public static final int MODE_RADIO

See Also:

• Constant Field Values

MODE_CHECKBOX

public static final int MODE_CHECKBOX

See Also:

• Constant Field Values

MODE_DROP_DOWN

public static final int MODE_DROP_DOWN

See Also:

• Constant Field Values

PARAM_TARGET_VALUE

public static final int PARAM_TARGET_VALUE

See Also:

• Constant Field Values

PARAM_TARGET_ROW

public static final int PARAM_TARGET_ROW

See Also:

• Constant Field Values

PARAM_TARGET_COLUMN

public static final int PARAM_TARGET_COLUMN

See Also:

• Constant Field Values

PARAM_TARGET_FGCOLOR

public static final int PARAM_TARGET_FGCOLOR

See Also:

• Constant Field Values

PARAM_TARGET_BGCOLOR

public static final int PARAM_TARGET_BGCOLOR

See Also:

• Constant Field Values

PARAM_TARGET_LENGTH

public static final int PARAM_TARGET_LENGTH

See Also:

• Constant Field Values

PARAM_TARGET_ARRAY_SIZE

public static final int PARAM_TARGET_ARRAY_SIZE

See Also:

• Constant Field Values

Constructor Details

RequestEntry

public RequestEntry()

RequestEntry

public RequestEntry(DisplayRequest _owningDisplayRequest)

Method Details

getDisplayObject

public IFieldContainer getDisplayObject()

clone

public Object clone()

Overrides:

clone in class Object

clone

public Object clone(DisplayRequest _owningDisplayRequest)

calculateLength

public int calculateLength()

getLength

public int getLength()

getter for length field

Returns:

setLength

public void setLength(int length)

setArraySize

public void setArraySize(int arraySize)

getArraySize

public int getArraySize()

setArrayElement

public void setArrayElement(int arrayElement)

getArrayElement

public int getArrayElement()

getMode

public int getMode()

setMode

public void setMode(int mode)

getAttr

public int getAttr()

setAttr

public void setAttr(int attr)

setRow

public void setRow(int row)

getRow

public int getRow()

setColumn

public void setColumn(int column)

getColumn

public int getColumn()

setForegroundColor

public void setForegroundColor(String foregroundColor)

getForegroundColor

public String getForegroundColor()

setBackgroundColor

public void setBackgroundColor(String backgroundColor)

getBackgroundColor

public String getBackgroundColor()

setBMSColor

public void setBMSColor(String newVal)

getBMSColor

public String getBMSColor()

setParamName

public void setParamName(String paramName)

getParamName

public String getParamName()

setParamPicture

public void setParamPicture(String paramPicture)

getParamPicture

public char[] getParamPicture()

getParamPictureString

public String getParamPictureString()

setXMLValue

public void setXMLValue(String value)

setValue

public void setValue(String value)

getDefaultXMLValue

public String getDefaultXMLValue()

getCurrentValue

public String getCurrentValue()

getValue

public String getValue()

isChecked

public boolean isChecked()

setChecked

public void setChecked(boolean checked)

setCheckedValue

public void setCheckedValue(String groupValue)

getCheckedValue

public String getCheckedValue()

Checked value is for Check-boxes and Radio buttons. E.g a radio button may Display "Yes" - and send checked-value "Y" to server

Returns:

getSelectOptions

public HashMap<String,String> getSelectOptions()

for dropdown boxes (SELECT in HTML)

Returns:

copySelectionOptions

public void copySelectionOptions(HashMap<String,String> groupValues)

addSelectOption

public void addSelectOption(String code,
 String description,
 boolean selected)

for dropdown boxes in html (SELECT and each entry is represented by an OTPION)

Parameters:

code -

description -

selected -

getSelectionDefaultValue

public String getSelectionDefaultValue()

addDynamicParameter

public void addDynamicParameter(int parameterTarget,
 String parameterName)

getDynamicParameterTargets

public Integer[] getDynamicParameterTargets()

getDynamicParameterName

public String getDynamicParameterName(Integer target)

setParamValue

public void setParamValue(String parameterValue)

setParamValue

public void setParamValue(ISMObject parameter)

setDynamicParameterValue

public void setDynamicParameterValue(int parameterTarget,
 ISMObject parameter)

For internal use only
this is called when a screen is being sent to HTML

Parameters:

parameterTarget -

parameter -

isUnderline

public boolean isUnderline()

setUnderline

public void setUnderline(boolean underline)

getImageWidth

public int getImageWidth()

setImageWidth

public void setImageWidth(int imageWidth)

getImageHeight

public int getImageHeight()

setImageHeight

public void setImageHeight(int imageHeight)

getInstance

protected RequestEntry getInstance()

setDisabled

public void setDisabled(boolean disabled)

isDisabled

public boolean isDisabled()

setModified

public void setModified(boolean modified)

isModified

public boolean isModified()

setBMSFocus

public void setBMSFocus(boolean bmsFocus)

XML focus = true

Parameters:

bmsFocus -

setFocus

public void setFocus(boolean focus)

isFocused

public boolean isFocused()

isBright

public boolean isBright()

isDark

public boolean isDark()

setVisible

public void setVisible(boolean visible)

for handling BMS's DRK attribute

Parameters:

visible -

isVisible

public boolean isVisible()

for handling BMS's DRK attribute

Parameters:

visible -

setFset

public void setFset(boolean fset)

for handling BMS's FSET attribute XML mark-as-modified = true

isFset

public boolean isFset()

for handling BMS's FSET attribute

Parameters:

fset -

isPassword

public boolean isPassword()

setPassword

public void setPassword(boolean password)

isRightJustified

public boolean isRightJustified()

setRightJustified

public void setRightJustified(boolean rightJustified)

Used in CICS
xml "alignment" = right

Parameters:

rightJustified -

isUsedForInput

public boolean isUsedForInput()

Used in CICS
XML direction "io" or "input" changes this to true

Returns:

setUsedForInput

public void setUsedForInput(boolean usedForInput)

Used in CICS
XML direction "io" or "input" changes this to true

getDropDownWidth

public int getDropDownWidth()

equals

public boolean equals(RequestEntry re)

hasAssociatedInputTag

public boolean hasAssociatedInputTag()

this is a virtual method for benefit of ILERequestEntry

Parameters:

param -

generateInputTag

public void generateInputTag(Element param)

this is a virtual method for benefit of ILERequestEntry

Parameters:

param -

setChangeIndicatorNumber

public void setChangeIndicatorNumber(String ddsIndicatorNumber)

this is a virtual method for benefit of ILERequestEntry

Parameters:

param -

isBmsNormal

public boolean isBmsNormal()

isNumeric

public boolean isNumeric()

setNumeric

public void setNumeric(boolean numeric)

Used in CICS
XML num=true

Parameters:

numeric -

getBmsPicin

public String getBmsPicin()

setBmsPicin

public void setBmsPicin(String bmsPicin)

getBmsPicout

public String getBmsPicout()

usesPicin

public boolean usesPicin()

formatFor_BMSPicin

public String formatFor_BMSPicin(String theText)

for internal use only Used in CICS/BMS during a RECIEVE to convert from zzz to 999 format

Parameters:

theText -

Returns:

setInternalVars

public void setInternalVars(CBLBean fromClass)

toString_Orig

public String toString_Orig()

toString

public String toString()

Overrides:

toString in class Object

ToJSP

public String ToJSP(Boolean targetIs_ASPX,
 JSPScreen xmlJspScreen)