HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.elements
Class EnptuiChoiceComponentElement

java.lang.Object
  extended by com.ibm.hats.transform.elements.ComponentElement
      extended by com.ibm.hats.transform.elements.FieldComponentElement
          extended by com.ibm.hats.transform.elements.EnptuiChoiceComponentElement
All Implemented Interfaces:
Cloneable

public class EnptuiChoiceComponentElement
extends FieldComponentElement

This class represents an ENPTUI choice field (part of a Selection Field) -- 5250 only.


Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.elements.FieldComponentElement
split
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElement
consumedRegion
 
Constructor Summary
EnptuiChoiceComponentElement(EnptuiSelectionComponentElement esce, String text, int startPos, int length, BlockScreenRegion block, boolean isSelected, boolean isEnabled, boolean isCursorable, boolean isPlaceholder)
          Constructs a new EnptuiChoiceComponentElement object.
 
Method Summary
 List getOnSelectActions()
          Returns the list of ScriptAction objects representing the list of actions to perform when this item is selected.
 EnptuiSelectionComponentElement getSelectionField()
          Returns the EnptuiSelectionComponentElement.
 boolean hasIndicator()
          Returns whether an indicator field is set
 boolean is3270()
          Always returns false
 boolean is5250()
          Always returns true.
 boolean isCursorable()
          Returns whether a choice is Cursorable.
 boolean isEnabled()
          Returns whether a choice is Enabled.
 boolean isPlaceholder()
          Returns whether a choice is Placeholder.
 boolean isProtected()
          This method always returns true.
 boolean isSelected()
          Returns whether a choice is selected.
 void setCursorable(boolean cursorable)
          Sets whether a choice is Cursorable.
 void setEnabled(boolean enabled)
          Sets whether a choice is Enabled.
 void setOnSelectActions(List onSelectActions)
          Sets the list of ScriptAction objects representing the list of actions to perform when this item is selected.
 void setPlaceholder(boolean placeholder)
          Sets whether a choice is Placeholder.
 void setScreenId(int id)
           
 void setSelected(boolean selected)
          Sets whether a choice is selected.
 void setSelectionField(EnptuiSelectionComponentElement list)
          Sets the selection field.
 String toString()
           
 
Methods inherited from class com.ibm.hats.transform.elements.FieldComponentElement
doTextReplacement, getActionKey, getBackgroundColor, getBackgroundColor, getExtendedAttributes, getForegroundColor, getForegroundColor, getIsRTL, getLength, getPreviewText, getStartPos, getText, isAllBlank, isAlphaNumeric, isBlink, isHidden, isHighIntensity, isHolderOnly, isMatch, isNumericOnly, isReverseVideo, isSplit, isUnderline, isUnicodeField, set3270, set5250, setActionKey, setExtendedAttributes, setHidden, setHolderOnly, setLength, setProtected, setSplit, setStartPos, setText
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElement
clone, getConsumedRegion, getScreenId, isConsumer, isTruncateToPreserveLength, setConsumedRegion, type, type
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values
Constructor Detail

EnptuiChoiceComponentElement

public EnptuiChoiceComponentElement(EnptuiSelectionComponentElement esce,
                                    String text,
                                    int startPos,
                                    int length,
                                    BlockScreenRegion block,
                                    boolean isSelected,
                                    boolean isEnabled,
                                    boolean isCursorable,
                                    boolean isPlaceholder)
Constructs a new EnptuiChoiceComponentElement object.

Parameters:
text - value of the input field
startPos - linear, 1-based start position of the field
length - length of the field
Method Detail

getSelectionField

public EnptuiSelectionComponentElement getSelectionField()
Returns the EnptuiSelectionComponentElement.

Returns:
The EnptuiSelectionComponentElement.
See Also:
EnptuiSelectionComponentElement

setSelectionField

public void setSelectionField(EnptuiSelectionComponentElement list)
Sets the selection field.

Parameters:
list - The selection field list.
See Also:
EnptuiSelectionComponentElement

getOnSelectActions

public List getOnSelectActions()
Returns the list of ScriptAction objects representing the list of actions to perform when this item is selected.

Returns:
A List containing ScriptAction objects representing the list of action to perform when this item is selected.
See Also:
ScriptAction

setOnSelectActions

public void setOnSelectActions(List onSelectActions)
Sets the list of ScriptAction objects representing the list of actions to perform when this item is selected.

Parameters:
onSelectActions - The onSelectActions to set.
See Also:
ScriptAction

isSelected

public boolean isSelected()
Returns whether a choice is selected.

Returns:
Returns a boolean value indicating whether or not a choice is selected.

setSelected

public void setSelected(boolean selected)
Sets whether a choice is selected.

Parameters:
selected - true or false

isEnabled

public boolean isEnabled()
Returns whether a choice is Enabled.

Returns:
Returns a boolean value indicating whether or not a choice is enabled.

setEnabled

public void setEnabled(boolean enabled)
Sets whether a choice is Enabled.

Parameters:
enabled - true or false

isCursorable

public boolean isCursorable()
Returns whether a choice is Cursorable.

Returns:
boolean

setCursorable

public void setCursorable(boolean cursorable)
Sets whether a choice is Cursorable.

Parameters:
cursorable - true or false

isPlaceholder

public boolean isPlaceholder()
Returns whether a choice is Placeholder.

Returns:
boolean

setPlaceholder

public void setPlaceholder(boolean placeholder)
Sets whether a choice is Placeholder.

Parameters:
placeholder - true or false

toString

public String toString()
Overrides:
toString in class FieldComponentElement

hasIndicator

public boolean hasIndicator()
Returns whether an indicator field is set

Returns:
boolean

isProtected

public boolean isProtected()
This method always returns true.

Overrides:
isProtected in class FieldComponentElement
Returns:
Returns true if the field is protected, false otherwise.
See Also:
FieldComponentElement.isProtected()

is3270

public boolean is3270()
Always returns false
Overrides:
is3270 in class FieldComponentElement
Returns:
Always returns false

is5250

public boolean is5250()
Always returns true.

Overrides:
is5250 in class FieldComponentElement
Returns:
Always returns true.

setScreenId

public void setScreenId(int id)
Overrides:
setScreenId in class ComponentElement

HATS 7.5.1 (201005110649)