SHOW Signed
 

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:
JDE 4.0.0

Field Summary
 Category: Signed protected static long KEY_NAME
           
 Category: Signed static int SMART_CASE
          Constant indicating that the replacement string is to appear in SmartCase.
 Category: Signed static int SPECIFIED_CASE
          Constant indicating that the replacement string is to appear exactly as typed by the user.
 
Constructor Summary
 Category: Signed AutoText()
          
 
Method Summary
 Category: Signed abstract  Object add(String replacedString, String replacementStringPattern, int replacementCase, Locale locale)
          Add an autotext entry for the specified parameters.
 Category: Signed abstract  Object checkWord(String word)
          Checks to see if the word passed in is a replaced string in the AutoText word list.
 Category: Signed abstract  Enumeration getAllKeys()
          Get all autotext keys that corresponds to the current locale.
 Category: Signed static AutoText getAutoText()
          Retrieve the AutoText instance.
 Category: Signed abstract  String getClauseSeparatorString()
          Return a string containing all of the available clause separators.
 Category: Signed abstract  int getLocaleCode(Object entry)
          Get the locale code for the given entry.
 Category: Signed abstract  String[] getMacroChoices()
          Get the choices for macro substitution.
 Category: Signed abstract  String getMacroText(int index)
          Get the actual macro text for the given macro index.
 Category: Signed abstract  String getNoAutoPeriodCharacterString()
          Return a string containing all of the available "no auto period" characters.
 Category: Signed abstract  String getReplacedString(Object entry)
          Get the replaced string for the given autotext entry.
 Category: Signed abstract  int getReplacementCase(Object entry)
          Get the replacement case for the given autotext entry.
 Category: Signed abstract  String getReplacementStringPattern(Object entry)
          Get the replacement string pattern for the given autotext entry.
 Category: Signed abstract  int getWordCount()
          Get number of words stored for the current locale.
 Category: Signed abstract  boolean isClauseSeparator(char c)
          Determine if the given character is a clause separator.
 Category: Signed abstract  boolean isNoAutoPeriodCharacter(char c)
          Determine if the given character is a character after which auto period should not be triggered.
 Category: Signed abstract  boolean isSentenceTerminator(char c)
          Determine if the given character is a sentence terminator.
 Category: Signed abstract  void remove(String replacedString, Locale locale)
          Remove the autotext entry for the given string.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.rim.device.api.collection.ReadableSet
contains, getElements, getElements, size
 
Methods inherited from interface net.rim.device.api.collection.CollectionEventSource
addCollectionListener, removeCollectionListener
 

Field Detail

KEY_NAME

protected static final long KEY_NAME
Since:
JDE 4.0.0
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.

SMART_CASE

public static final int SMART_CASE
Constant indicating that the replacement string is to appear in SmartCase.
Since:
JDE 4.0.0
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.

SPECIFIED_CASE

public static final int SPECIFIED_CASE
Constant indicating that the replacement string is to appear exactly as typed by the user.
Since:
JDE 4.0.0
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.
Constructor Detail

AutoText

public AutoText()
Since:
JDE 4.0.0
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.
Method Detail

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.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.

getAllKeys

public abstract Enumeration getAllKeys()
Get all autotext keys that corresponds to the current locale.
Returns:
The enumeration of keys or null if it does not reside in the database.
Since:
JDE 4.0.0
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.

getAutoText

public static final AutoText getAutoText()
Retrieve the AutoText instance.
Returns:
The AutoText instance.
Since:
JDE 4.0.0
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.

getClauseSeparatorString

public abstract String getClauseSeparatorString()
Return a string containing all of the available clause separators.
Returns:
A String containing all of the clause separators.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.

getMacroChoices

public abstract String[] getMacroChoices()
Get the choices for macro substitution.
Returns:
The choices for macro substitution.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.

getWordCount

public abstract int getWordCount()
Get number of words stored for the current locale.
Returns:
The number of words stored for the current locale.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.

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.
Since:
JDE 4.0.0
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.



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.