net.rim.device.api.ui.autotext
Class AutoText
java.lang.Object
net.rim.device.api.ui.autotext.AutoText
- All Implemented Interfaces:
- Collection, CollectionEventSource, ReadableSet
public abstract class AutoText
- extends Object
- implements ReadableSet, CollectionEventSource
Interface to an AutoTextEngine.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
|
Field Summary |
|
protected static long |
KEY_NAME
|
|
static int |
SMART_CASE
Constant indicating that the replacement string is to
appear in SmartCase. |
|
static int |
SPECIFIED_CASE
Constant indicating that the replacement string is to appear
exactly as typed by the user. |
KEY_NAME
protected static final long KEY_NAME
- See Also:
- Constant Field Values
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
SMART_CASE
public static final int SMART_CASE
- Constant indicating that the replacement string is to
appear in SmartCase.
- See Also:
- Constant Field Values
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
SPECIFIED_CASE
public static final int SPECIFIED_CASE
- Constant indicating that the replacement string is to appear
exactly as typed by the user.
- See Also:
- Constant Field Values
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
AutoText
public AutoText()
-
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getAutoText
public static final AutoText getAutoText()
- Retrieve the AutoText instance.
- Returns:
- The AutoText instance.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
add
public abstract Object add(String replacedString,
String replacementStringPattern,
int replacementCase,
Locale locale)
- Add an autotext entry for the specified parameters.
- Parameters:
replacedString - The string that will be replaced.replacementStringPattern - The text that will be substituted for
replacedString.replacementCase - The type of case replacement to perform.locale - The locale to add the entry to.
- Returns:
- The object that was added to the autotext collection.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
remove
public abstract void remove(String replacedString,
Locale locale)
- Remove the autotext entry for the given string.
- Parameters:
replacedString - The string that will be replaced.locale - The locale to remove the entry from.- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getReplacedString
public abstract String getReplacedString(Object entry)
- Get the replaced string for the given autotext entry.
- Parameters:
entry - The entry to extract the replaced string from.
- Returns:
- The replaced string if
entry is valid;
null otherwise. - Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getReplacementStringPattern
public abstract String getReplacementStringPattern(Object entry)
- Get the replacement string pattern for the given autotext entry.
- Parameters:
entry - The entry to extract the replacement string pattern from.
- Returns:
- The replacement string pattern if
entry is valid;
null otherwise. - Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getReplacementCase
public abstract int getReplacementCase(Object entry)
- Get the replacement case for the given autotext entry.
- Parameters:
entry - The entry to extract the replacement case from.
- Returns:
- The replacement case. This should be either SMART_CASE or
SPECIFIED_CASE.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getLocaleCode
public abstract int getLocaleCode(Object entry)
- Get the locale code for the given entry.
- Parameters:
entry - The entry to extract the locale code from.
- Returns:
- The locale code.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
checkWord
public abstract Object checkWord(String word)
- Checks to see if the word passed in is a replaced string in the
AutoText word list.
- Parameters:
word - Rhe word to be checked.
- Returns:
- The object representing the autotext entry if
word
exists; null if it does not. - Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getAllKeys
public abstract Enumeration getAllKeys()
- Get all autotext keys that corresponds to the current locale and all
parent locales.
- Returns:
- The enumeration of keys or null if it does not reside in the database.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getWordCount
public abstract int getWordCount()
- Get number of words stored for the current locale.
- Returns:
- The number of words stored for the current locale.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getMacroChoices
public abstract String[] getMacroChoices()
- Get the choices for macro substitution.
- Returns:
- The choices for macro substitution.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getMacroText
public abstract String getMacroText(int index)
- Get the actual macro text for the given macro index.
- Parameters:
index - The index of the macro to receive the text for.
- Returns:
- The macro text for the given index.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
isClauseSeparator
public abstract boolean isClauseSeparator(char c)
- Determine if the given character is a clause separator.
- Parameters:
c - The character to check.
- Returns:
- true if the character is a clause separator; false otherwise.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getClauseSeparatorString
public abstract String getClauseSeparatorString()
- Return a string containing all of the available clause separators.
- Returns:
- A String containing all of the clause separators.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
isNoAutoPeriodCharacter
public abstract boolean isNoAutoPeriodCharacter(char c)
- Determine if the given character is a character after which auto period
should not be triggered.
- Parameters:
c - The character to check.
- Returns:
- true if the character is a "no auto period" character;
false otherwise.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
getNoAutoPeriodCharacterString
public abstract String getNoAutoPeriodCharacterString()
- Return a string containing all of the available
"no auto period" characters.
- Returns:
- A String containing all of the "no auto period" characters.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
isSentenceTerminator
public abstract boolean isSentenceTerminator(char c)
- Determine if the given character is a sentence terminator.
- Parameters:
c - The character to check.
- Returns:
- true if the character is a sentence terminator; false otherwise.
- Category:
- Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
- Since:
- BlackBerry API 4.0.0
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal