|
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.common.TextReplacementPair
public class TextReplacementPair
An individual mapping between a string that is found in a host screen and the desired replacement text for that string.
| Field Summary | |
|---|---|
static String |
ATTR_IMAGE
|
static String |
ATTR_MATCH_CASE
|
static String |
ATTR_MATCH_LTR
|
static String |
ATTR_MATCH_REVERSE
|
static String |
ATTR_MATCH_RTL
|
static String |
ATTR_REGEX
|
static String |
ATTR_SEPARATOR
|
static Hashtable |
characterMappings
|
static String |
CLASSNAME
|
static String |
VALUES_SEPARATOR
|
| Constructor Summary | |
|---|---|
TextReplacementPair(String settingsString)
Constructs a new TextReplacementPair object from the specified String |
|
TextReplacementPair(String from,
String to,
String toImage,
boolean caseSensitive)
Constructs a text replacement mapping between two strings. |
|
TextReplacementPair(String from,
String to,
String toImage,
boolean caseSensitive,
boolean regularExpression)
Constructs a text replacement mapping between two strings with regular expression support. |
|
TextReplacementPair(String from,
String to,
String toImage,
boolean caseSensitive,
boolean isBidi,
boolean matchLTRVal,
boolean matchRTLVal,
boolean matchReverseVal)
Constructs a text replacement mapping between two strings, with additional Bidi options. |
|
TextReplacementPair(String from,
String to,
String toImage,
boolean caseSensitive,
boolean regularExpression,
boolean isBidi,
boolean matchLTRVal,
boolean matchRTLVal,
boolean matchReverseVal)
Constructs a text replacement mapping between two strings with regular expression support and Bidi options. |
|
| Method Summary | |
|---|---|
Object |
clone()
|
boolean |
containsHTML()
|
String |
getFrom()
Gets the replaced string of this pair. |
String |
getImageName()
Gets the image to replace the specified string, null if only replacing with text. |
String |
getTo()
Gets the replacing string from this pair, null if replacing with an image. |
boolean |
isBIDI()
For BIDI Sessions only Gets whether or not the session is BIDI |
boolean |
isCaseSensitive()
Gets whether or not we are case sensitive in matching on the string to be replaced. |
boolean |
isMatchLTR()
For BIDI Sessions only Gets whether or not we match on LTR screen in matching on the string to be replace. |
boolean |
isMatchReverse()
For BIDI Sessions only Gets whether or not we match on Reversed screen in matching on the string to be replace. |
boolean |
isMatchRTL()
For BIDI Sessions only Gets whether or not we match on RTL screen in matching on the string to be replace. |
boolean |
isRegularExpression()
Gets whether or not regular expressions are being used to find/replace patterns. |
static String |
replaceMapCharacters(String theString)
|
static String |
replaceSpecialCharacters(String theString)
|
void |
setBIDI(boolean isbidi)
For BIDI Sessions only Sets whether or not the session is BIDI |
void |
setCaseSensitive(boolean caseSensitive)
Sets whether or not we are case sensitive in matching on the string to be replaced. |
void |
setFrom(String from)
Sets the replaced string of this pair. |
void |
setMatchLTR(boolean matchLTRval)
For BIDI Sessions only Sets whether or not we match on LTR screen in matching on the string to be replace. |
void |
setMatchReverse(boolean matchReverseval)
For BIDI Sessions only Sets whether or not we match on Reversed screen in matching on the string to be replace. |
void |
setMatchRTL(boolean matchRTLval)
For BIDI Sessions only Sets whether or not we match on RTL screen in matching on the string to be replace. |
void |
setRegularExpression(boolean regularExpression)
Sets whether or not we are case sensitive in matching on the string to be replaced. |
void |
setTo(String to)
Sets the replacing string from this pair. |
void |
setToImage(String toImage)
Sets the replacing image from this pair. |
String |
toSettingsString()
|
String |
toString()
Gets this pair as a string, for debugging purposes. |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String CLASSNAME
public static final String ATTR_MATCH_CASE
public static final String ATTR_REGEX
public static final String ATTR_IMAGE
public static final String ATTR_MATCH_LTR
public static final String ATTR_MATCH_RTL
public static final String ATTR_MATCH_REVERSE
public static final String VALUES_SEPARATOR
public static final String ATTR_SEPARATOR
public static Hashtable characterMappings
| Constructor Detail |
|---|
public TextReplacementPair(String from,
String to,
String toImage,
boolean caseSensitive)
from - the string to be replacedto - the value to replace the from string withcaseSensitive - caseSensitivity for matching on the from string
public TextReplacementPair(String from,
String to,
String toImage,
boolean caseSensitive,
boolean regularExpression)
from - string to be replacedto - value to replace the from string withcaseSensitive - caseSensitivity for matching on the from stringregularExpression - use patterns to match/replace strings
public TextReplacementPair(String from,
String to,
String toImage,
boolean caseSensitive,
boolean isBidi,
boolean matchLTRVal,
boolean matchRTLVal,
boolean matchReverseVal)
from - string to be replacedto - value to replace the from string withcaseSensitive - caseSensitivity for matching on the from stringisBidi - for BIDI SessionsmatchLTRVal - matchLTR for matching on LTR screenmatchRTLVal - matchRTL for matching on RTL screenmatchReverseVal - for matching on reversed screen
public TextReplacementPair(String from,
String to,
String toImage,
boolean caseSensitive,
boolean regularExpression,
boolean isBidi,
boolean matchLTRVal,
boolean matchRTLVal,
boolean matchReverseVal)
from - string to be replacedto - value to replace the from string withcaseSensitive - caseSensitivity for matching on the from stringregularExpression - use patterns to match/replace stringsisBidi - for BIDI SessionsmatchLTRVal - matchLTR for matching on LTR screenmatchRTLVal - matchRTL for matching on RTL screenmatchReverseVal - for matching on reversed screenpublic TextReplacementPair(String settingsString)
TextReplacementPair object from the specified StringFormat: from=to,[matchCase],[matchLTR],[matchRTL],[matchReverse],[toImage] If [toImage] is specified, the "to" string is treated as the path to an image and not just plain text.
| Method Detail |
|---|
public String getFrom()
public String getTo()
public String getImageName()
public boolean isCaseSensitive()
public boolean isRegularExpression()
public boolean isBIDI()
public boolean isMatchLTR()
public boolean isMatchRTL()
public boolean isMatchReverse()
public void setFrom(String from)
public void setTo(String to)
public void setToImage(String toImage)
public boolean containsHTML()
public void setCaseSensitive(boolean caseSensitive)
public void setRegularExpression(boolean regularExpression)
public void setBIDI(boolean isbidi)
public void setMatchLTR(boolean matchLTRval)
public void setMatchRTL(boolean matchRTLval)
public void setMatchReverse(boolean matchReverseval)
public String toString()
toString in class Object
public Object clone()
throws CloneNotSupportedException
clone in class ObjectCloneNotSupportedExceptionpublic String toSettingsString()
public static String replaceMapCharacters(String theString)
public static String replaceSpecialCharacters(String theString)
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||