|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.transform.elements.ComponentElement
com.ibm.hats.transform.elements.FunctionKeyComponentElement
public class FunctionKeyComponentElement
This class represents a function key. A function key is made up of the following parts: item, delimiter, and caption. In the following example:
F3=Exit"F3" is the item, "=" is the delimiter, and "Exit" is the description.
| Field Summary | |
|---|---|
protected String |
caption
|
static String |
CLASS_NAME
|
protected String |
delimiter
|
protected HsrAttributes |
extendedAttributes
|
protected String |
fullCaption
|
protected String |
item
|
protected String |
mnemonic
|
protected List |
onSelectActions
|
| Fields inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
consumedRegion |
| Constructor Summary | |
|---|---|
FunctionKeyComponentElement(String item,
String delimiter)
|
|
FunctionKeyComponentElement(String item,
String delimiter,
String caption,
String fullCaption)
Constructs a new FunctionKeyComponentElement object. |
|
| Method Summary | |
|---|---|
protected String |
calculateAidKey(String str)
Deprecated. |
void |
doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
Performs text replacement on this element. |
protected static int |
extractNumberFromString(String str)
|
String |
getCaption()
Returns the caption (e.g. |
String |
getDelimiter()
Returns the delimiter (e.g. |
HsrAttributes |
getExtendedAttributes()
Returns the extended field attributes for the function key item. |
String |
getFullCaption()
Returns the full caption (e.g. |
String |
getItem()
Returns the item (e.g. |
String |
getMnemonic()
Returns the HOD mnemonic that should be sent when the function key represented by this component element is activated. |
List |
getOnSelectActions()
Returns a list of ScriptAction objects representing the set of actions that should be performed when this
function key is selected (e.g. |
String |
getPreviewText()
Returns some form of descriptive text about the component element. |
void |
setCaption(String caption)
|
void |
setDelimiter(String delimiter)
|
void |
setExtendedAttributes(HsrAttributes attribs)
Sets the extended field attributes (color, etc) for the function key item. |
void |
setFullCaption(String fullCaption)
|
void |
setItem(String item)
|
void |
setMnemonic(String mnemonic)
|
void |
setOnSelectActions(List list)
Sets the set of ScriptAction objects representing the actions to perform when this function key is selected. |
String |
toString()
|
| Methods inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
clone, getConsumedRegion, getScreenId, isConsumer, isMatch, isTruncateToPreserveLength, setConsumedRegion, setScreenId, type, type |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String CLASS_NAME
protected String item
protected String delimiter
protected String caption
protected String fullCaption
protected String mnemonic
protected List onSelectActions
protected HsrAttributes extendedAttributes
| Constructor Detail |
|---|
public FunctionKeyComponentElement(String item,
String delimiter)
public FunctionKeyComponentElement(String item,
String delimiter,
String caption,
String fullCaption)
FunctionKeyComponentElement object.
item - item (the aid key is calculated from this value)delimiter - String which separates the item from the captioncaption - String caption of the function keyfullCaption - String full caption (item + delimiter + caption + any extra space between any part)| Method Detail |
|---|
public void setItem(String item)
public void setDelimiter(String delimiter)
public void setCaption(String caption)
public void setFullCaption(String fullCaption)
public String getItem()
public String getDelimiter()
public String getCaption()
public String getFullCaption()
public String toString()
toString in class Objectpublic String getPreviewText()
ComponentElement
getPreviewText in class ComponentElement
public void doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
doTextReplacement in class ComponentElementpair - TextReplacementPair to base replacement oncontextAttributes - context attributesprotected String calculateAidKey(String str)
str - To calculate the aid key from.
protected static int extractNumberFromString(String str)
public List getOnSelectActions()
ScriptAction objects representing the set of actions that should be performed when this
function key is selected (e.g. what happens when the button representing this key is clicked).
ScriptAction objects.public void setOnSelectActions(List list)
ScriptAction objects representing the actions to perform when this function key is selected.
list - public void setMnemonic(String mnemonic)
public String getMnemonic()
public HsrAttributes getExtendedAttributes()
public void setExtendedAttributes(HsrAttributes attribs)
attribs -
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||